You are on page 1of 478

GE Energy

ToolboxST* User Guide


for Mark* VIe Control
GEH-6700J

These instructions do not purport to cover all details or variations in equipment, nor to
provide for every possible contingency to be met during installation, operation, and
maintenance. The information is supplied for informational purposes only, and GE makes
no warranty as to the accuracy of the information included herein. Changes,
modifications and/or improvements to equipment and specifications are made
periodically and these changes may or may not be reflected herein. It is understood that
GE may make changes, modifications, or improvements to the equipment referenced
herein or to the document itself at any time. This document is intended for trained
personnel familiar with the GE products referenced herein.
GE may have patents or pending patent applications covering subject matter in this
document. The furnishing of this document does not provide any license whatsoever to
any of these patents.
This document contains proprietary information of General Electric Company, USA and
is furnished to its customer solely to assist that customer in the installation, testing,
operation, and/or maintenance of the equipment described. This document shall not be
reproduced in whole or in part nor shall its contents be disclosed to any third party
without the written approval of GE Energy.
GE provides the following document and the information included therein as is and
without warranty of any kind, expressed or implied, including but not limited to any
implied statutory warranty of merchantability or fitness for particular purpose.
If further assistance or technical information is desired, contact the nearest GE Sales or
Service Office, or an authorized GE Sales Representative.

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


Revised: 090415
Issued: 070511

* Trademark of General Electric Company


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

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

Todays Date

Your Companys Name and Address

Job Site
GE Requisition No.

If needed, how can we contact you?


Fax No.
Phone No.
E-mail

Your Job Function / How You Use This Publication

Publication No.

Address

Publication Issue/Revision Date

General Rating
Excellent
Contents
{
Organization
{
Technical Accuracy {
Clarity
{
Completeness
{
Drawings / Figures {
Tables
{
Referencing
{
Readability
{

Good
{
{
{
{
{
{
{
{
{

Fair
{
{
{
{
{
{
{
{
{

Poor
{
{
{
{
{
{
{
{
{

Additional Comments
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________

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

Detach and fax or mail to the address noted above.

{ Do not know

Comment ____________________________________________

........................................................................ 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
equipments case must be shielded to prevent contact by
personnel.
To minimize hazard of electrical shock or burn, approved
grounding practices and procedures must be strictly followed.

To prevent personal injury or equipment damage caused by


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

Contents
Chapter 1 About the ToolboxST Application

1-1

System Requirements ................................................................................................................................1-1


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

Chapter 2 System Configuration

2-1

Opening and Creating Systems .................................................................................................................2-1


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

Chapter 3 Software

3-1

Software Configuration Hierarchy ............................................................................................................3-1


Variables ........................................................................................................................................3-2
Function Blocks .............................................................................................................................3-3
User Block Libraries ......................................................................................................................3-3
Instancing.......................................................................................................................................3-4

GEH-6700J ToolboxST

Contents i

Unlink Property..............................................................................................................................3-4
User Block Definitions...................................................................................................................3-7
Library Container Editor ...........................................................................................................................3-8
Adding Libraries ..........................................................................................................................3-11
Library Property Editor ................................................................................................................3-13
Library Summary View................................................................................................................3-13
Library Help Files ........................................................................................................................3-14
Table Definition Property Editor..................................................................................................3-15
Exporting a Table Definition........................................................................................................3-16
Online Display and Changes ........................................................................................................3-17
Using Table Definitions in Software Application Code...............................................................3-18
User Block Definitions.................................................................................................................3-20
User Block Variables ...................................................................................................................3-21
Working with User Blocks ...........................................................................................................3-22
Application Documentation.....................................................................................................................3-28
Application Software Examples ..............................................................................................................3-29
User Block Definition ..................................................................................................................3-29
Linked User Block .......................................................................................................................3-34
Device Attribute ...........................................................................................................................3-40
Block Exclusion with an Instance Script......................................................................................3-43
Text Substitution with an Attribute ..............................................................................................3-44

Chapter 4 Block Diagram Editor

4-1

Diagram Shortcut Menu ............................................................................................................................4-2


Renaming Sheets .......................................................................................................................................4-3
Sheet Names...................................................................................................................................4-3
Customizing Sheet Borders .......................................................................................................................4-4
Border Options ...............................................................................................................................4-5
Preview...........................................................................................................................................4-5
Footer Block...................................................................................................................................4-6
Custom Text ...................................................................................................................................4-7
Sheet Information...........................................................................................................................4-8
Variables and Blocks.................................................................................................................................4-9
Variables with Status......................................................................................................................4-9
Blocks with Status..........................................................................................................................4-9
Block Shapes................................................................................................................................4-11
Variable Input Blocks...................................................................................................................4-12
Layout Modes..........................................................................................................................................4-14
Managing Blocks.....................................................................................................................................4-14
Wiring Block Pins ...................................................................................................................................4-16
Wire Styles and Colors.................................................................................................................4-16
Zoom and Pan Tools ....................................................................................................................4-17
Block Shape Shortcut Menu ....................................................................................................................4-18
Connecting Pins.......................................................................................................................................4-20
Changing a Pin Connection..........................................................................................................4-21
Toggling Live Data Layers......................................................................................................................4-22
Modifying Live Values............................................................................................................................4-23
Shape Drawing Tools ..............................................................................................................................4-25
Variable Rail Tool........................................................................................................................4-26
Adding a Variable Rail.................................................................................................................4-27
Adding Variables to a Variable Rail ............................................................................................4-28
Managing Variables on a Rail ......................................................................................................4-29
Working with Variables ...............................................................................................................4-30
Text Tool......................................................................................................................................4-30
Rectangle/Ellipse Tools................................................................................................................4-31
Image Tool ...................................................................................................................................4-32

ii Contents

GEH-6700J ToolboxST

Additional Toolbar Buttons.....................................................................................................................4-33


Diagram Settings .....................................................................................................................................4-33
Rung Editor .............................................................................................................................................4-35
Contacts........................................................................................................................................4-37
Wires ............................................................................................................................................4-37
Coils .............................................................................................................................................4-38
Adding Rows and Columns .........................................................................................................4-38
Errors............................................................................................................................................4-38

Chapter 5 Sequential Function Chart (SFC)

5-1

Creating an SFC ........................................................................................................................................5-1


Editing an SFC ...............................................................................................................................5-3
Adding a Transition .......................................................................................................................5-6
Adding an End Transition ..............................................................................................................5-8
Variable Connections ...................................................................................................................5-11
SFC Online Operations from the ToolboxST Application ......................................................................5-11
Changing SFC Modes ..................................................................................................................5-12
Publishing an SFC on an EGD Page .......................................................................................................5-13

Chapter 6 Mark VIe Component Editor

6-1

Creation Wizard ........................................................................................................................................6-1


Summary View..........................................................................................................................................6-5
Property Editor ..........................................................................................................................................6-6
Component InfoView ................................................................................................................................6-7
Log Tab..........................................................................................................................................6-8
Data Grids .................................................................................................................................................6-9
Editing Data ...................................................................................................................................6-9
Organizing Columns ....................................................................................................................6-10
Copying and Moving Data ...........................................................................................................6-11
Component Options.................................................................................................................................6-12
Security ...................................................................................................................................................6-13
Passwords.....................................................................................................................................6-13
Password Caching ........................................................................................................................6-14
Viewing Protection Status............................................................................................................6-15
Protected Objects .........................................................................................................................6-16
General Tab .............................................................................................................................................6-17
Attributes......................................................................................................................................6-22
Attribute Value Editor..................................................................................................................6-23
Network Adapters ........................................................................................................................6-24
Auto-Reconfiguration ..................................................................................................................6-26
Upgrading................................................................................................................................................6-27
Compare To Controller ...........................................................................................................................6-29
Compare Devices ....................................................................................................................................6-30
Mark VIe Menus .....................................................................................................................................6-31
Hardware Tab..........................................................................................................................................6-33
Network Redundancy...................................................................................................................6-34
Adding Modules...........................................................................................................................6-35
Organizing Modules.....................................................................................................................6-39
Modifying Modules......................................................................................................................6-40
Viewing Modules.........................................................................................................................6-40
Upgrading Modules......................................................................................................................6-47
Diagnosing Modules ....................................................................................................................6-50
Reporting Board Data ..................................................................................................................6-53
Working Online............................................................................................................................6-55
Software Tab ...........................................................................................................................................6-59
Adding a Program ........................................................................................................................6-60
Adding a Program Group .............................................................................................................6-61
Adding an Existing Program........................................................................................................6-61

GEH-6700J ToolboxST

Contents iii

Library References .......................................................................................................................6-62


Instance All ..................................................................................................................................6-63
Overridable Properties..................................................................................................................6-64
Adding a Task ..............................................................................................................................6-65
Adding a User Block ....................................................................................................................6-66
Unlink Permanently......................................................................................................................6-69
Property Editor .............................................................................................................................6-70
Variables ......................................................................................................................................6-74
Table Definitions..........................................................................................................................6-79
User Block....................................................................................................................................6-83
Dynamic Data Recorder (DDR) Tab .......................................................................................................6-86
Configuring DDR.........................................................................................................................6-86
Status Variables............................................................................................................................6-89
Adding Variables .........................................................................................................................6-89
Updating DDR .............................................................................................................................6-90
Importing and Exporting DDR.....................................................................................................6-91
DDR Setup ...................................................................................................................................6-92
Ethernet Global Data (EGD) Tab ............................................................................................................6-98
EGD Configuration ......................................................................................................................6-98
Produced Pages ............................................................................................................................6-98
Editing Produced Pages................................................................................................................6-99
Page Compression ......................................................................................................................6-101
Variables ....................................................................................................................................6-102
Editing Exchange Signatures and Configuration Time ..............................................................6-103
EGD Diagnostics........................................................................................................................6-105
EGD Configuration Server Tab..................................................................................................6-106
EGD Configuration Server Reports ...........................................................................................6-107
Referenced Devices....................................................................................................................6-108
Modbus Slave Tab.................................................................................................................................6-110
Configuring Modbus Slave ........................................................................................................6-111
Modbus Slave Register Pages ....................................................................................................6-113
Mark VIe Tools .....................................................................................................................................6-115
Reports ..................................................................................................................................................6-115
Creating Reports.........................................................................................................................6-115
Saving, Retrieving and Printing Reports ....................................................................................6-115
Viewing Reports.........................................................................................................................6-116
Filtering Rows............................................................................................................................6-117
Finding Data...............................................................................................................................6-120
Importing an I/O Report from a .csv File ...................................................................................6-120
Coding Practices Report.............................................................................................................6-122
Auto-Reconfiguration Reports ...................................................................................................6-123
Forced Variables ........................................................................................................................6-129
Global Variables.........................................................................................................................6-130
Watch Windows ....................................................................................................................................6-131
Adding a Variable ......................................................................................................................6-136
Managing Variables ...................................................................................................................6-140
Forcing Live Values ...................................................................................................................6-140
Reconciling Constant Differences..............................................................................................6-140
Drag-and-Drop ...........................................................................................................................6-141
Importing and Exporting ............................................................................................................6-141
LiveView ...............................................................................................................................................6-142
Adding and Opening LiveViews................................................................................................6-142
LiveView Editor Features ..........................................................................................................6-147
LiveView Controls .....................................................................................................................6-149
Attaching a Variable...................................................................................................................6-151
Saving a LiveView .....................................................................................................................6-157
Variable Definitions ...................................................................................................................6-157
Control Constants ..................................................................................................................................6-158
Control Constants Window ........................................................................................................6-159
Importing and Exporting Control Constants ..............................................................................6-160
I/O CheckOut .............................................................................................................................6-161

iv Contents

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component

7-1

Connecting to a Controller ........................................................................................................................7-1


Status Tab..................................................................................................................................................7-2
Controller Attributes ......................................................................................................................7-3
Downloading to a Controller .....................................................................................................................7-5
Download Command .....................................................................................................................7-5
Controller Setup .............................................................................................................................7-6
Download Wizard ..........................................................................................................................7-8
Dual Controller Download...........................................................................................................7-11
Upload Wizard .............................................................................................................................7-14
Controller Diagnostics View ...................................................................................................................7-16
I/O Diagnostics View...................................................................................................................7-17
Administer Totalizers ..............................................................................................................................7-18
Totalizer Passwords .....................................................................................................................7-19
Modifying Totalizer Values ....................................................................................................................7-20

Chapter 8 Finder

8-1

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

Chapter 9 Trender

9-1

Accessing a Trender Window ...................................................................................................................9-1


Trender Window Features .........................................................................................................................9-2
Trender Toolbar .............................................................................................................................9-3
Data Toolbar ..................................................................................................................................9-3
Working in Trender ...................................................................................................................................9-4
Acquiring Data...............................................................................................................................9-4
Adding Traces ................................................................................................................................9-4
Live Trends ....................................................................................................................................9-7
Triggered Live Trends....................................................................................................................9-8
Capture Buffer Trends....................................................................................................................9-9
Static File Trends ...........................................................................................................................9-9
Obtaining Data .............................................................................................................................9-10
Trender Concepts ....................................................................................................................................9-11
Chapters .......................................................................................................................................9-11
Cursors .........................................................................................................................................9-11
Value ScreenTips .........................................................................................................................9-12
Events...........................................................................................................................................9-12
Working With Trender Data....................................................................................................................9-13
Graph View Options ....................................................................................................................9-13
Grid Lines ....................................................................................................................................9-13
Sample Markers ...........................................................................................................................9-14
Time Axis.....................................................................................................................................9-15
Traces...........................................................................................................................................9-15
Auto-Range Trace ........................................................................................................................9-15
Manual Range Adjustment...........................................................................................................9-16
Trace Colors.................................................................................................................................9-16
Hiding Traces...............................................................................................................................9-17
Statistical Calculations .................................................................................................................9-17
Exchanging Trender Data........................................................................................................................9-18
Exporting to a File........................................................................................................................9-18
Printing Graphs ............................................................................................................................9-18
Spectral Analysis.....................................................................................................................................9-19
FFT Options .................................................................................................................................9-21

GEH-6700J ToolboxST

Contents v

Chapter 10 EGD Editor for External Devices

10-1

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

Chapter 11 Configuration Management System (CMS)

11-1

Installing the CMS Server .......................................................................................................................11-1


Creating Windows User Accounts ..........................................................................................................11-3
Configuring the CMS Server...................................................................................................................11-7
Accessing the Administrator Tool................................................................................................11-7
Working Folder .....................................................................................................................................11-10
Repository Working Folder........................................................................................................11-11
System Working Folder .............................................................................................................11-12
Add System / System Working Folder.......................................................................................11-13
Recommendations .................................................................................................................................11-14
CMS Stand-alone Client........................................................................................................................11-16
Opening the CMS Stand-alone Client ........................................................................................11-16
Adding a System to a Repository ...............................................................................................11-17
Getting the Latest Version..........................................................................................................11-18
CMS Stand-alone Client Menus.................................................................................................11-19
CMS Integrated Client...........................................................................................................................11-21
Opening the CMS Integrated Client ...........................................................................................11-22
CMS Menu Items .......................................................................................................................11-25
Troubleshooting.....................................................................................................................................11-26

Chapter 12 TreeFileImporter

12-1

Running the Tree File Importer ..............................................................................................................12-1

Chapter 13 Special I/O Functions

13-1

Calibrating Valve Circuits .......................................................................................................................13-1


Availability...................................................................................................................................13-3
Multicasting.............................................................................................................................................13-4
Availability...................................................................................................................................13-7
Configuring a HART Device...................................................................................................................13-8
Availability...................................................................................................................................13-9
PROFIBUS Communications................................................................................................................13-10
Adding a Slave Device...............................................................................................................13-13
Configuring the Master Device ..................................................................................................13-19
Enabling a Slave Device ............................................................................................................13-20
Displaying the PROFIBUS Network .........................................................................................13-20
Standard Diagnostics Tab...........................................................................................................13-23
Device Diagnostics Tab .............................................................................................................13-25
Identifier Diagnostics Tab..........................................................................................................13-27
Channel Diagnostics...................................................................................................................13-28
Availability.................................................................................................................................13-29

vi Contents

GEH-6700J ToolboxST

Mark Ve Retrofit ...................................................................................................................................13-30


Availability ................................................................................................................................13-30
Configuring a PCNO Module................................................................................................................13-31

Glossary of Terms

13-35

Index

13-39

GEH-6700J ToolboxST

Contents vii

CHAPTER 1

Chapter 1 About the ToolboxST


Application
The ControlST* CD includes the ToolboxST* application and support packages for
the various components. Before you install the software:

It is recommended that you exit all Windows programs.

All products are installed under a common folder on your hard disk. You can
define this location the first time you install the CD, but any subsequent releases
will be installed to the previously defined location.

No license key is required to install this product, but to run the ToolboxST
application after installation, a valid hardware key (dongle) plugged into any
Universal Serial Bus (USB) port is required. Refer to the section, Licensing.

System Requirements
The following is the recommended hardware and operating system requirements
needed to run the ToolboxST application.
Recommended
CPU

2.8 GHz Pentium (or faster)

OS

Windows XP Professional

Memory

3 GB RAM (or more)

HD

40 GB (or more)

Video

1280 x 1024 x Truecolor (24 million or better)

Drive

DVD

Network

Ethernet 10/100 mb

USB

Two available USB Ports

Note Windows 2000 Professional is supported for legacy systems only. Windows
Server 2003 is supported using a single user configuration. Windows 64-bit
Operating Systems are not supported.
For assistance, contact the nearest GE Sales or Service office, or an authorized GE
sales representative.

GEH-6700J ToolboxST

Chapter 1 About the ToolboxST Application 1-1

Installation
To install the software
1

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


automatically. The Setup-GE ControlST dialog box displays.

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

1-2 Chapter 1 About the ToolboxST Application

GEH-6700J ToolboxST

If you are upgrading from a previous version, and you


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

Click Next to continue.

Select the installation options to install, then click the Install button.

The Welcome dialog box displays. Click Next. The License Agreement
dialog box displays.

To continue the installation, you must accept this agreement. Select Agree.

Click Next. The User Information dialog box displays.

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.

Click Next. The Select Features dialog box displays and allows you to select
which features to install or not install. All components are installed by default.

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

GEH-6700J ToolboxST

Chapter 1 About the ToolboxST Application 1-3

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

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

1-4 Chapter 1 About the ToolboxST Application

GEH-6700J ToolboxST

To remove or change the ToolboxST application


From the Start menu, select Settings, Control Panel, then Add/Remove
Programs.

Use the scroll bar to find GE


WorkstationST Package.

Click Change or Remove to


change or uninstall features
from the installation.

Command Line Arguments


The ToolboxST application contains the following command line arguments:

EGD Management Tool (EMT) arguments, including


- /EGDAction:ADD /EGDDevice:
- /EGDAction:MODIFY /EGDDevice:

Go To Variable

Go To Hardware Diagnostic

Go To Locator

-NoSplash

Archive a ToolboxST System

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

GEH-6700J ToolboxST

Chapter 1 About the ToolboxST Application 1-5

EMT
The EMT opens a ToolboxST application and navigates to the EGD configuration
tab of a component. It can also add a device with a specified producer ID.
Note If EMT command line arguments are used, the /Variable, /VariableDevice,
/Hardware Diagnostic, and /Navigate to Locator arguments are ignored.
Standard Action Arguments
/EGDAction:ADD /EGDDevice allows a device to be added.
Note Using /EGDAction:ADD requires no /EGDDevice identifier. The application
started determines the ProducerID(s) and device names(s) to be used.
/EGDAction:MODIFY /EGDDevice:<producer ID> allows the device-assigned
Producer ID to be modified.
/EGDCollection:<collection name> is defined for tools that can manage collections
of device configurations. Collection names are defined in the GuiDevice.xml file.
EMT Argument Rules
The following rules apply to EMT arguments:

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


argument.

Only one set of //EGDAction and /EGDDevice pairs should be defined.

The ProducerID value must be represented as a four-byte unsigned integer. An IP


address in dotted-quad format must be converted to the unsigned decimal equivalent
before it can be used in the argument (for example: the IP address 1.2.3.4 converts to
the value 67305985).
To provide consistency, a common set of command arguments are defined for each
application. The standard format is
/<keyword>:<value>
where
/ (slash) is a required delimiter start of an argument.
<keyword> defines the operation or action (the <, > are not used).
: (colon) is a required delimiter that separates the keyword and value.
<value> defines the value to be used in the operation or action (the <, > are not
used).

1-6 Chapter 1 About the ToolboxST Application

GEH-6700J ToolboxST

Formatting Command Line Arguments


The following rules apply to all command line arguments:

Process keywords, ignoring case.

Process values, ignoring case.

Do not use spaces around colons (:) and after slashes (/).

A space is required between keyword-value pairs (Example: after MODIFY and


before /EGDDevice).

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


argument.

Define only one set of //EGDAction and /EGDDevice pairs.

Go To Variable
/Variable:<variableName> [/VariableDevice:<deviceName>] searches a
ToolboxST application for the first write occurrence of the specified variable. If
never written, the first read-only location is used. If the variable is not found, a
message box displays.
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST application is opened.
Note If the EMT command line arguments are used, the /Variable and
/VariableDevice arguments are ignored.
Opening a ToolboxST System
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST application is opened.
Opening a ToolboxST Component and Navigating to a Variable
The format for ToolboxST variable names is
<deviceName>.<variableName>
The search for the variable uses the deviceName component of the system. The
/VariableDevice keyword can also be used to specify a particular device to search.
This is useful for third-party interfaces where you may want to control the device
that is searched (see the third example below). A message displays if nothing is
found in the component.
Examples
ToolboxST /Variable: G1.Var - the G1 component of the most recently loaded
ToolboxST system will be searched.
ToolboxST c:\site\mySystem\mySystem.tcw /Variable: G1.Var - the G1 component of
the c:\site\mySystem\MySystem.tcw system will be searched.
ToolboxST /Variable:ext1.myPermissive /VariableDevice: G2 - the G2 component of
the most recently loaded ToolboxST system will be searched. In this example, G2
references an external EGD device variable. Use the /VariableDevice option to open
the G2 component.

GEH-6700J ToolboxST

Chapter 1 About the ToolboxST Application 1-7

Go To Hardware Diagnostic
/HardwareDiagnostic:<devName> [.HardwareGroup] - navigates to either the
Device Diagnostics window or the Hardware Module Group.
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST system is opened.
Examples
/HardwareDiagnostic:Marky
This causes the last opened system to be opened, the Marky controller to be opened,
and the Device Diagnostic window to display (View/Diagnostics/Controller
Diagnostics item).
/HardwareDiagnostic:Marky.23GROUP
This causes the last opened system to be opened, the Marky controller to be opened,
and the Hardware tab 23GROUP hardware group to be selected.

Go To Locator
This argument opens any locator string displayed in the Find Results tab.
/NavigateToLocator:<locator string shown in Find results>
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST system is opened.
To open a ToolboxST component and navigate to a desired point, use the Finder to
search for a string in a component. Then, from the Find Results tab, select one of the
locator text strings, as shown in the window below.
Copy the selected Find results to the clipboard to
use as a locator command argument. ToolboxST
opens the component, then navigates to the
specified location in the configuration.

1-8 Chapter 1 About the ToolboxST Application

GEH-6700J ToolboxST

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

Archive a ToolboxST System


This argument opens the most recent ToolboxST system, creates a system archive,
then exits the system. Archiving the most recent ToolboxST system can be
overridden by using the first argument to specify the path to the desired system.
The target file name is optional. If not specified, the file name is the ToolboxST
system name plus the creation date and time. If the target file name is a directory, the
archive file is placed in that directory with the file name of the ToolboxST system
name plus the creation date and time.
Examples
ToolboxST /Archive
The most recent system is opened. An archive.zip file, with the opened system name
and date/time, is created. The archive is placed in the parent folder for the
ToolboxST system. If the parent folder cannot be opened, the archive is placed in the
ToolboxST systems working folder.
ToolboxST c:\MySystem.tcw /archive
The system c:\MySystem.tcw is opened. An archive.zip file, with the opened system
name and date/time, is created. The archive is placed in the parent folder for the
ToolboxST system. If the parent folder cannot be opened, the archive is placed in the
ToolboxST systems working folder.
ToolboxST c:\MySystem.tcw
/archive:c:\MyArchiveFolder\MySystemArchive.zip
The system c:\MySystem.tcw is opened. An archive.zip file, with the specified
archive name, is created.
ToolboxST c:\MySystem.tcw /archive:c:\MyArchiveFolder
The system c:\MySystem.tcw is opened. An archive.zip file, with the opened system
name and date/time, is created. The archive is placed in the specified folder.

GEH-6700J ToolboxST

Chapter 1 About the ToolboxST Application 1-9

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

USB Protection Device (UPD or dongle)

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

Installing the UPD


It is very important to NOT plug the UPD into
your computer until after you have installed the
ToolboxST application.
To install the UPD
1

Install the ToolboxST application (refer to the section, Installation (on page
2)).

Plug the UPD into any empty USB port on your computer.

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

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

Reinstalling UPD
To reinstall the UPD
1

Save and close any open applications/systems.

Unplug the UPD.

From Windows, click Start, Settings, and then select Control Panel.

From the Control Panel, select Administrative Tools and Computer


Management and use the Device Manager to reinstall the UPD.

Reinstall the UPD. Windows should now detect the UPD and reinstall it with the
correct drivers.

1-10 Chapter 1 About the ToolboxST Application

GEH-6700J ToolboxST

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

Check that you have


installed the proper UPD
correctly and click Retry.

Acronyms and Abbreviations


EGD

Ethernet Global Data

EMT

EGD Management Tool

EU

Engineering Units

HMI

Human-Machine Interface

NVRAM

OPC

Non-volatile Random Access Memory


OLE (Object Linking and Embedding) process control server

SDB

System Database

SOE

Sequence of Events

TMR

Triple modular redundant

UDH

Unit Data Highway

UDP

User Datagram Protocol

UPD

USB Protective Device

USB

Universal Serial Bus

xml

eXtensible Markup Language

GEH-6700J ToolboxST

Chapter 1 About the ToolboxST Application 1-11

Notes

1-12 Chapter 1 About the ToolboxST Application

GEH-6700J ToolboxST

CHAPTER 2

Chapter 2 System Configuration


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

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

Opening and Creating Systems


To create a new system

GEH-6700J ToolboxST

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

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

Chapter 2 System Configuration 2-1

Enter a name for the system. Some characters are prohibited; if you enter an
invalid character, a small red exclamation mark displays.

Click OK to create the new system. The new system is created, and opens in the
System Editor.

To open an existing system


1

From the File menu, select Open System.

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

When a system is open, the System Editor displays overview information


about all configured components in the system. The window consists of three
major areas as displayed.
The Summary View displays a graphic
representation of all system components and
their network connectivity.

The Tree View


displays a list
of all
components in
the system.

The Property
Editor allows
you to edit the
selected
component.

2-2 Chapter 2 System Configuration

GEH-6700J ToolboxST

Components and Tools


Systems consist of multiple components that display in both the Tree View and the
Summary View of the System Editor. The System Editor serves as a navigation tool
to open more detailed Component Editors for editing or viewing. You can doubleclick most components in either the Tree View or the Summary View to edit them.
ToolboxST component icons that display in the Tree View are as follows:
Icon

Components
System
Group of Components
Mark VIe component

Mark VIeS component

Mark VI component
EX2100ST component

Power Conversion component

WorkstationST
Printer
Library Container
Network
Trender

Watch Windows

LiveView
External Device (not associated
with an application)
Network Switch
Network Time Server

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-3

You can add components to the root component of a system (represented by the
icon) or a group (represented by a
icon). Some components display a
wizard or dialog box that prompts you for additional information when you add them
to the system.

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

Groups

Moving and Copying Components


Components can be moved within a ToolboxST application using a drag-and drop
operation. Drag-and-drop editing is only available if the System Editor is in View By
Group mode, as the components are automatically organized when View By Type
mode is selected. The default drag-and-drop operation for most components is move.
Some components support a secondary drag-and-drop operation (usually copy) that
can be accessed by holding down the CTRL key while dragging.
The cursor changes to one of the following cursors during a drag-and-drop operation
to indicate the predicted outcome of the operation:

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

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

indicates that the item being dragged will be copied and the copy will be
placed at the location beneath the cursor

Most components can be moved and copied in the Tree View, with a few exceptions:

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


copied to the system item and never moved.

When a group is copied, a new group is created. The contents of the old group
remain in place and are not copied to the new group.

No drag-and-drop operations are supported for networks.

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

2-4 Chapter 2 System Configuration

GEH-6700J ToolboxST

System Editor Status


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

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-5

The following status icons can display.


Icon

Status

Indicates

Healthy

Component Diagnostics No

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

NTP Diagnostics No

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

NTP Diagnostics Yes

EGD Diagnostics Yes


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

Logic forcing procedures can result in personal injury or


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

2-6 Chapter 2 System Configuration

GEH-6700J 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 automatically opens the application
associated with the configuration file. In all other cases, you must specify the exact
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.)

In the Property Editor, select the App Path item. Click the ellipsis
at the right side of the text field to display the Open dialog box.

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.

button

Optional procedures:

If the External Device requires a specific configuration file, select the Doc
Path item and provide the location of the file.

If the External Device application requires switches (provided for the external
application on the command line before the contents of Doc Path), configure the
Switches property.

If the External Device application requires a specific working directory (which


is the folder assumed when no path is specified), configure the Start Directory
property.

If the External Device supports Ethernet Global Data (EGD), set the Enable
EGD Editor property to True.

If the external component does not have a configuration file that is associated
with a particular application, select the App Path item. Click the ellipsis button
to display the Open dialog box.

Saving Systems
When you make changes to a system, the changes are stored in memory. Save your
work to prevent your changes being lost.
In the ToolboxST application, Save commands affect only the data in the current
editor. As such, the Save command in the System Editor only saves changes to the
system itself. If you have made changes in any other component editors (like a
controller or a library container), you must select the Save command in each of those
editors, as well.
To save changes to the current system
From the File menu, select Save System. (Or, click the
toolbar.)

GEH-6700J ToolboxST

button on the

Chapter 2 System Configuration 2-7

Configuration Files
Folder Structure
Each system is saved in its own folder. Inside the main system folder is a set of subfolders 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-8 Chapter 2 System Configuration

GEH-6700J 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.
The .xml files used by the ToolboxST application should
NEVER be modified by ANY other application.

Configuration files can be both compressed and encrypted. If you select the
Compress When Saving option in the System Options dialog box, the configuration
data is stored in a compressed format that is not readable with a text editor but
occupies much less disk space. Some portions of .xml configuration files may be also
stored in encrypted format to prevent unauthorized users from viewing the design of
password-protected system components.
Some controller components offer a Build command that produces files to be
downloaded directly to the controller. These files, which are stored in the Output
folder of a component, are in a binary format, and are not human-readable.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-9

System Options
The ToolboxST application provides a variety of settings that change the way
various functions operate. While you can also configure settings from inside the
component that they affect, settings for all available components display when the
Settings dialog box is opened from the System Editor.
To view system options
From the System Editor, select the Options menu, and then select Settings
to display the Settings dialog box.
In the Settings dialog box, categories are listed in the Tree View.

2-10 Chapter 2 System Configuration

GEH-6700J ToolboxST

The System Options category includes options that affect the system as a whole.
It is available in addition to any other component settings that may display in the
Tree View.
Main Font is the font used for most application text.
Build, when set to True, prompts for confirmation before each build.
Developer Mode, when set to True, allows the developer access to the application
on the GE Salem Intranet.
Force Enable UPD, when set to True, makes the UPD a requirement when on the
GE Salem Intranet with privileges.
Auto Backup, when set to True, creates backup copies of configuration files during
the Save command.
Controller Backup Option determines how controller backup files are handled in
the Build and Download commands, as well as the status control.

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


command, and provides an option to download the device.zip in the Download
Wizard.

Manual mode does not create a device.zip file so there is no option to download
back-up files from the Download Wizard.

Incremental Build Enabled, if set to True, enables incremental downloads with


controllers that support them.
Load Last System, when set to True, automatically loads the previously loaded
system when the application starts.
Maximum Build Errors is the maximum number of errors to occur before exiting
a Build. For unlimited errors, set to zero.
User Identification is the three-character ID of the user making the changes.

System Editor Menus


Menu

Command

Use to

File

New System

Create a new system

Open System

Open an existing system

Close System

Close the current system

Save System

Save system-level changes to the current system (does not save


component-level changes)

Save System
As

Save the current system with a new name or to a new location

Archive
System

Select system components to be archived

Recent Files

List the eight most currently accessed systems

Exit

Close the ToolboxST application and all associated component editors

Delete

Remove the item currently selected in the Tree View

Insert New

Add a new component to the current system

Edit

Insert Existing Add an existing component from a folder

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-11

View

Cut

Cut the selected item in the Tree View

Copy

Copy the selected item in the Tree View

Paste

Paste the copied item in the Tree View into the Summary View

System
Information

Display the System Information Editor (refer to the section System


Information Editor)

Selected
component

Display the Component Editor for the item currently selected in the Tree
View

By Type

Automatically organize the Tree View by component type

By Group

Organize the Tree View by components

Track

Synchronize Tree View selections with Summary View selections

Memory Usage Display the currently allocated memory


EGD
Diagnostics

Access the following EGD diagnostic tools:


EGD Management Tool opens the EGD Management Tool (EMT)
View Online Statistics displays EGD exchange status from the selected
component. Only EGD Class 2 or higher components that respond to EGD
Command Message Protocol (CMP) have this diagnostic window.
WorkstationST Capture Live UDP Packets provides an EGD window
only enabled in a WorkstationST component with an OPC DA server
configured. This allows the WorkstationST runtime to capture up to 10,000
EGD UDP messages, then upload them for display, printing, and exporting
to .csv format.
EGD Network Load Calculation provides network load calculation to
determine memory usage.

EGD
Configuration
Server

Perform one of the following:


View Differences opens a configuration view window.
Work Offline allows you to work offline.

Network Status Display defined networks in the system


Viewer
System

Online

Work online

Options

Settings

Configure system settings (refer to the section System Options)

Window

Cascade

Arrange open Component Editors in a layered style

Tile

Arrange open Component Editors in a grid style

Close All

Close all open Component Editors

CMS

Refer to the section CMS Menu Items.

Help

Contents

Display the online product documentation

Release Notes Display current information about your ToolboxST software version.
Send Problem
Report

Send a problem or suggestion to the ToolboxST team

2-12 Chapter 2 System Configuration

GEH-6700J ToolboxST

System Information Editor


The System Information Editor edits alarm classes, format specifications, and other
items available to all components in the system. If access to a System Database
(SDB) is enabled, the contents of the System Information Editor can be stored to the
SDB.
To open the System Information Editor
From the System Editor, select System Information from the Edit menu.
Or,
From the System Editor, double-click the System
View.

item in the Tree

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

GEH-6700J ToolboxST

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

Chapter 2 System Configuration 2-13

From the Tree View, select Alarm Classes. A data grid with the existing
Alarm Classes displays in the Summary View.

2-14 Chapter 2 System Configuration

GEH-6700J ToolboxST

The following properties are available in the Property Editor when an Alarm Class is
selected:
Name displays the name of the Alarm Class. Limited to five characters if using an
SDB.
Description displays the Alarm Classes description. Only the first 50 characters are
stored in an SDB.
Priority shows alarm class priority (1 to 99 where 1 is the highest priority).
Ack Foreground Color shows foreground color for an alarm in the
Acknowledged state.
Ack Background Color shows background color for an alarm in the
Acknowledged state.
Alarm Foreground Color displays the foreground color for an alarm in the Alarm
state.
Alarm Background Color displays the background color for an alarm in the
Alarm state.
Blink Background Color displays the background color for the blink state of the
active unacknowledged alarm.
Blink Enabled, if set to True, enables blinking ability.
Blink Foreground Color displays the foreground color for the blink state of the
active unacknowledged alarm.
Normal Foreground Color displays the foreground color for an alarm in the
Normal state.
Normal Background Color displays the background color for an alarm in the
Normal state.
Sound Reference is the sound definition to select when an active alarm displays
in the WorkstationST Alarm Viewer.

Diagnostic Translations
The Diagnostic Translations option allows you to display alarm diagnostic text in a
second language.
Note The second Language option must be selected in the System Editor Property
Editor.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-15

To export diagnostics to a .csv file


1

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

From the Tree View, right-click


Diagnostic Translations, then
select Export Product
Diagnostics.
The Please select a file to Export
the Product Diagnostic
Translations to window displays.

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

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

2-16 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

Diagnostics text can be translated in either the


.csv file or in the System Information Editor.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-17

Export These Diagnostics

The Export these Diagnostics.


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

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

Validate Diagnostics
If you are using CMS, perform a Get Latest for all controllers on your computer. The
Validate Diagnostics option verifies the I/O packs attached to a particular system,
then checks to see that a translation has been entered for each I/O pack in the list of
required packs.
Any errors or warnings occurring from the Validation display in the Component
InfoView. Double-click an error or warning to be connected to that diagnostic.
The Validation option applies to all translations entered into a system. Even if you
have Common selected when you start to validate, all translations are validated.
Warnings and errors do not prevent controllers from running the Build and
Download commands, but rather ensure that all second-language diagnostic text
displays correctly at run time. If there is no second-language translation for a
particular diagnostic, the text displays in English. .

Delete Diagnostics
Only I/O packs used on your job need to have translations entered. Unused I/O packs
can be selected from the Tree View and deleted. You have the opportunity to cancel
the Delete command before its performed. However, once its performed, it cannot
be Undone.
Note This command only deletes these translation records. If a diagnostic occurs
whose translation record was deleted, it still displays in English.

2-18 Chapter 2 System Configuration

GEH-6700J ToolboxST

To add a missing translation to a running system


1

From the Tree View, select a pack, add the translated text in the Second
Language Message Text column, then click Save.

Open all controllers that use the I/O pack with the missing translation and
perform a Save command.

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


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

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-19

Displaying Second-Language Diagnostics


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

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

From the Property


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

Or

2-20 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

Note When you select Use Second Language from Regional Settings, that becomes
your permanent default setting, regardless of what is configured in the General tab in
the ToolboxST application.
The WorkstationST Alarm Viewer provides a means to override this setting. For
more information, refer to GHT-200009, How to Configure a Second Language for
the ToolboxST Application and HMIs.
The option Select Active Measurement System allows you to specify either English
or metric measurements. Refer to GHT-200016, How to Configure a Measurement
System for Use by ControlST HMI Applications.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-21

Creating a Master WorkstationST


To avoid having diagnostic alarm text stored on every WorkstationST in a system, a
Master WorkstationST can be configured.
To configure a Master WorkstationST

From the System Editor


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

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


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

2-22 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

From the System Editor, select the Edit menu, then select System
Information.
From the Tree View,
select Sounds.
In the Data Grid, enter a
sound Name, for example,
Chimes. Right-click the
Sound Type column, then
select from the drop-down
list (for example, Wave File).
From the Wave File column,
click the ellipsis button to display
a Windows Open screen.

From the Open screen, navigate to


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

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-23

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

Currently configured sounds


display in the Data Grid .

The following properties are available in the Property Editor when a sound is
selected in the Data Grid.
Delay displays the time lapse between sounds (from 100 to 10,000 ms). The Repeat
Quantity property must be 1 or more.
Duration displays the sounds duration (from 100 to 10,000 ms).
Frequency displays the sounds frequency (range is 100 to 500 Hz).
Name is the sounds name.
Repeat Quantity displays the number of times the sound is repeated.
Sound Type displays the type of sound annunciated. The options are Tone, Wave
File, and Text to Speech.
Wave File, if selected as the Sound Type, displays the name of the Wave File.
When the system information is saved, the wave files are published to the Master
WorkstationST.

2-24 Chapter 2 System Configuration

GEH-6700J ToolboxST

Plant Areas
Plant areas are locations that represent a plant or facility within the control system.
These locations are selected from the Plant Area property of all variables defined in
each system component. One or more variables can use the same location. These
locations are used for filtering the alarms that display in the Alarm Viewer.
To edit plant areas
From the System Editor, select the Edit menu, then select System
Information.
Right- click any plant area to display a
drop- down menu with additional options.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-25

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

fs 2

Val

=
fs 2

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


( fs1max fs1min )

+ fs 2 min

: The converted value, in Format Specification 2

Val fs1

: The initial value, in Format Specification 1

fs1max

: The engineering max for Format Specification 1

fs 1min

: The engineering min for Format Specification 1

fs 2 max : The engineering max for Format Specification 2


fs 2 min

: The engineering min for Format Specification 2

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


the HMI as follows:

Val o F =

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


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

(val o c 0) (212 32)


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

2-26 Chapter 2 System Configuration

GEH-6700J ToolboxST

To create a Format Specification Set


1

From the System Editor Edit menu, select System Information.

In the System Information Editor, right-click the Format Specification


Sets item in the Tree View and select Add Format Specification Set.

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.

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


Summary View also display
in the Property Editor for the
currently selected row(s).

GEH-6700J ToolboxST

Click the Name box in the


append row, then enter a new
name to add a new format
specification.

Click in a grid cell


to edit its contents.

Chapter 2 System Configuration 2-27

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.

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

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

2-28 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

Adding and deleting screen files to the system (only from the System
Information Editor)

Editing use of screen files by HMI WorkstationSTs

Downloading screen files from Master location to HMI WorkstationSTs

Editing screen files (from the Master location)


To view HMI screen files from the System Information Editor

GEH-6700J ToolboxST

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

From the Tree View, select HMI Screens. HMI WorkstationSTs and HMI
screen files display in the Summary View.

Chapter 2 System Configuration 2-29

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

Adding and Deleting HMI Screen Files


To add an HMI screen file to the system
1

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

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

2-30 Chapter 2 System Configuration

GEH-6700J ToolboxST

From the Open file window, select the screen file or files you wish to add, then
click Open.

The screen file(s) is added to the system and displays in the Summary View.
To delete an HMI screen file from the system

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

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

Archiving Files
A project (or system) can be archived into a zip file from the System Editor,
however, the archive does not retrieve the files stored in the Master location. Also,
when a archived system is unzipped to a specific location, the files in the archive do
not automatically get distributed to the Master location.
When an archive is unzipped, the HMI screen files are located in a subdirectory
relative to the location of the systems .tcw file. For example, if the system is called
abcSystem, and is stored in C:\Site, the .tcw file is located at
C:\site\acbSystem\abcSystem.tcw. The HMI Screen files are located at
C:\site\abcSystem\HMIScreens. This is the system location of the HMI
screen Files.
To copy files from the system to the Master location or from the
Master location to the System:
1

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

To copy to the Master location, from the System menu, select Copy Local
to Master.

To copy from the Master location to the system, from the System menu,
select Copy Master to Local.

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

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-31

Defining HMI Screen Use


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

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

From the Tree View, select HMI screen.

From the Summary View, select a screen, then in the WorkstationST column
(HMIws1 in the example below), select True to enable HMIws1 to use that
screen or False to disable use.

2-32 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

From the Summary


View, the use of a
particular screen
can be enabled by
selecting True.

From the Tree View,


select a WorkstationST
(for example, HMIws1).

The use of the screen


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

Downloading HMI Screen Files


The HMI screen files are downloaded from the Master location in either the System
Information Editor or a particular HMI WorkstationST component. Downloading
can either occur automatically though a configuration property set for the
WorkstationST component or downloaded manually.
When pre-configured, WorkstationST runtime periodically compares the date of the
Master screen file to the file being used by the HMI project on the WorkstationST.
When an HMI screen file is saved to the Master location, its date changes. The
WorkstationST detects the change and automatically copies the new file to the
WorkstationSTs HMI project.
Note If a WorkstationST is configured for automatic download, a manual download
cannot be performed.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-33

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

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

From the Tree View, select HMI screen or HMI WorkstationSTs.

From the Summary View, select one or more HMI screen files.

From the Summary View, right-click to select Download selected HMI


screens from the short-cut menu.

2-34 Chapter 2 System Configuration

GEH-6700J ToolboxST

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


HMI WorkstationST
1

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

From the Tree View, expand the HMI Workstations item, then select a
WorkstationST component.

Select one or more HMI screen files in the Summary View.

From the Summary View, right-click to select Download selected HMI


Screens from the short-cut menu.

Displaying HMI Screen File Status


The System Information Editor can display the status of HMI screen files, including
the date and size of the master HMI screen file and the WorkstationST components
screen file.
Note The most important status property is whether the HMI WorkstationST screen
file is current with the master file.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-35

To update HMI screen file status


1

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

From the Tree View, select the HMI Screens item, or an HMI
WorkstationST item or a WorkstationST component.

From either the Tree View or the Summary View, right-click to select
Refresh HMI screen data from the short-cut menu.

From the Summary View, the


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

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

Editing an HMI Screen File


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

2-36 Chapter 2 System Configuration

GEH-6700J ToolboxST

To edit an HMI screen file


1

From the System Editor, open a WorkstationST Component Editor.

From the Component Editor, select the HMI Config tab.

From the Tree View, select the HMI Screens item.

From the Summary View, select an HMI screen file.

From the Summary View, right-click to select Edit selected HMI screen
from the short-cut menu.

The process of editing an HMI screen file is different, depending on whether CMS is
enabled.
Editing an HMI screen file with CMS enabled
When CMS is used, the CMS repository is the source of the HMI screen files. When
editing is completed, the screen file is checked back into the CMS repository, then
copied, at the users discretion, to the master location so it can be used by all the HMI
Workstations that are configured to use it.

GEH-6700J ToolboxST

If the HMI screen file is not checked out, you are prompted to check it out.

If you click Yes, the file is checked out and the screen file is opened in the
appropriate editor.

If you click No, you are asked if you wish to edit without CMS. If you click No,
editing does not take place. If you click Yes, the screen file opens in the
appropriate editor. Because the file is read-only, perform a Save As..

Once you save the file and exit the editor, this message displays

If you click Yes, the HMI screen file is copied to the master location. All HMI
WorkstationSTs that have the Auto Download option set to True get the
modified file next time the file status is checked.

If you click No, the HMI screen file remains on the computer from which the
editing occurred.

Check the file back into CMS. Once this is done, you again have the option to
copy the HMI screen file to the master location.

Chapter 2 System Configuration 2-37

Editing an HMI screen file without CMS enabled


The source of these HMI screen files is the master location. When CMS is disabled,
the Check Out function copies the file from the master location to the computer
where the editing is taking place. The file is then checked back in to the master
location.
The edit dialog box that displays depends on the state of both the master file and
your system file.
Note The system file is NOT the one used by the CIMPLICITY application, rather,
it is the one stored in the HMI screens directory that also stores the .tcw file.
There are three possible states, as follows.

The master file is not locked for editing

The master file is locked by another user

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


The master file is not locked for editing

2-38 Chapter 2 System Configuration

GEH-6700J ToolboxST

The options are as follows.


Check out the HMI screen file and edit. This will overwrite your local file
locks the master file so that it cannot be edited by another user. The file is copied to
the computer from which you are running the ToolboxST application, and overwrites
any existing system file.
Check out the HMI screen file, but edit the local file locks the master file so
that it cannot be edited by another user at the same time, but does not copy it to the
computer from which you are running the ToolboxST application. The system file
currently on your computer is opened for editing.
Get the master HMI screen file and edit. This will overwrite your local
file does not lock the master file. It is copied to the computer from which you are
running the ToolboxST application and overwrites any existing system file. When
editing is complete, it cannot be saved to the master location.
Just edit local file does not lock the master file. It is not copied to the computer
from which you are running the ToolboxST application. The system file currently on
your computer is opened for editing. Once editing is complete, it cannot be saved to
the master location.
The master file is locked by someone else

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-39

The options are as follows.


Get the master HMI screen and edit (the edit will be local only) copies to
the computer from which you are running the ToolboxST application and overwrites
any existing system file. The file is then opened for editing. Once editing is
complete, the file cannot be saved to the master location.
Edit only the local file is not copied to the computer from which you are running
the ToolboxST application. The system file currently on your computer is opened for
editing. Once editing is complete, the file cannot be saved to the master location.
Cancel the edit allows you to cancel without saving.

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

The options are as follows.


Get the master HMI screen and edit (the edit will be local only) copies to
the computer from which you are running the ToolboxST application, and overwrites
any existing system file. This file is then opened for editing. Once editing is
complete, you can save the file to the master location.
Edit only the local file is not copied to the computer from which you are running
the ToolboxST application. The system file currently on your computer is opened for
editing. Once editing is complete, you can save the file to the master location.
Cancel the edit allows you to cancel without saving.
When editing the screen file, all edits are saved in the system file. Once you exit
from the edit application, the ToolboxST application provides two options,
depending on the state of the files when you started the edit session.

2-40 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

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

The options are as follows.


Check in the HMI screen file copies the file to the master location, where it is
unlocked so it can be edited by another user.
Check in the HMI screen file, but leave checked out copies the file to the
master location, but the master file is not unlocked. It cannot be edited by another
user.
Do not check in the HMI screen file, but undo the check out does not copy
the file to the master location, but the master file will be unlocked, so another user
can edit it.
Do not check in the HMI screen file, but leave file checked out does not
copy the file to the master location, and the master file is not unlocked. It cannot be
edited by another user.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-41

System Database (SDB)


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

Click the System item in


the Tree View to access
SDB properties.

A Second Language
must be selected before
diagnostic text can be
translated in the System
Information Editor.
This property must be set
to True before other SDB
properties can be
configured.
The host name where
the SDB is located.
The path where the
SDB is located.

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

Open the System Information Editor. From the System menu, select Put
System to SDB. (Refer to the section, System Information Editor.) A dialog
box displays to confirm the destination SDB Host and Path.

Click OK. When the process is complete, the results display on the Log tab of
the InfoView.

2-42 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

From the Tree View,


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

The WorkstationST
where the master
files are located.

The path on the


WorkstationST
where the master
files are located.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-43

EGD Configuration Server


The EGD Configuration Server is a repository for EGD device and system
configurations. Like the SDB, the EGD Configuration Server allows configuration
information to be available to multiple tools or runtime platforms.
The EGD Configuration Server maintains a group of .xml documents for each EGD
device. The EGD Configuration Server also maintains a MasterSymbolTable.xml file
that contains format specifications, alarm classes, and other system-level
information.
The protocol used to get and put these .xml documents to and from the EGD
Configuration Server is a published HTTP protocol. This protocol is available for
other tools, and is currently used by GE Fanucs CIMPLICITY ME. The ToolboxST
application uses the EGD Configuration Server if it has been enabled in the System
Editor.

The EGD Configuration Server properties are as follows:


Base Path is the URL on the EGD Configuration Server where EGD documents
reside. This is normally /EGD.
Note This is normally /EGD and should not be changed unless the system
administrator has installed a custom EGD Configuration Server.

2-44 Chapter 2 System Configuration

GEH-6700J ToolboxST

Enable, if set to True, enables the interface to the EGD Configuration Server. If this
is enabled, the EGD configuration is sent to the server when a device is saved. An
EGD configuration for referenced devices is obtained from the EGD Configuration
Server if the configuration time is newer in the server than in the ToolboxST
application's local directory for that referenced device. For example, if your
ToolboxST system was located at C:\MySystem and a device was referencing a
device Dev1, the EGD configuration for Dev1 would be obtained from the EGD
Configuration Server if that configuration had a newer timestamp than the
configuration at c:\MySystem\Dev1. Otherwise the local c:\MySystem\Dev1
configuration would be used.
Host Name is the Host Name or IP address of the host running the EGD
Configuration Server.
Port is the server port value. The default is 7938.
Note This should not be changed unless the system administrator has installed a
custom EGD Configuration Server.
Timeout is the server connection timeout in milliseconds.
Use IE Proxy selects the Internet Explorer proxy settings, if set to True. If set to
False, no proxy is used. The default is false and it is recommended not to use a
proxy.

Working Online with the EGD Configuration Server


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

ToolboxST/EGD Configuration Server Interaction


When the ToolboxST application is online, and the EGD Configuration Server is
enabled, the application reads any new EGD Configuration Server data. It then saves
or builds to the EGD Configuration Server.
When a component is opened, the configuration of any EGD referenced device is
read from the local file location (in that referenced devices 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.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-45

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

Or

2-46 Chapter 2 System Configuration

GEH-6700J ToolboxST

The following options are available:

View Differences displays a difference report for any consumed or produced data
file that exists in both the server and the local system.
View Server File allows you to view the server version of a selected document.
View Local File allows you to view the local version of a selected document.
Equalize Server to Match all Local System nodes makes equal any node that
is marked Not Equal by publishing the local configuration to the EGD Configuration
Server.
Empty Server, then Send all Local System nodes causes all EGD
configuration server content to be removed before the local system nodes are
published.
Note If a component in a .tcw file is not the latest configuration (for example, if the
most current configuration is on another computer), publishing the local EGD
configuration sends the old configuration to the server.
Send This Node Local To Server sends a local copy of a selected document to
the EGD Configuration Server. If the devices tree node is selected, all documents
under the device are sent to the server.
Delete This Node in Server allows you to delete a selected device in the server.
Refresh Display compares the local system to the EGD Configuration Server and
updates the display.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-47

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
External Device component to represent it. Refer to the section,
an
Components.

Select the external device in the System Editor Tree View. The component
properties display in the Property Editor.

Set the Enable Get from SDB property to True.

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.

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-48 Chapter 2 System Configuration

GEH-6700J ToolboxST

Starting ToolboxST from an Existing System


Configuration
Each system configuration has a top level .tcw file that describes the entire system.
Upon installation, the ToolboxST installer associated these system configuration
files (*.tcw) with a dialog box that automatically starts the ToolboxST application .
This allows you to select a system configuration (xxxx.tcw) by double-clicking it. In
most cases, when there is ONLY one version of ToolboxST.exe, this starts the
compatible version of ToolboxST.exe without displaying any additional user
interface.
When there are either multiple versions of ToolboxST.exe (for example, during an
upgrade) or no installed versions of ToolboxST.exe, this dialog box displays all
versions that are equal to, or at a higher version than the selected .tcw file. When this
happens, the following dialog box displays to allow you to browse to and select an
appropriate version of ToolboxST.exe.

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

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-49

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

CIMPLICITY
Communication
Processes
OPC DA Private Security

CimView/
CimEdit

WorkstationST
OPC DA Server

Get Current User *

OPC DA Private Security

CIMPLICITY
Communication
Processes

CimView /
CimEdit

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

Logon Changed
Intercom Message **

Tray Icon
Security Login
Application

Get Current User *

Get Current User *

WorkstationST
Alarm Viewer

*Request for the current logged-on user update message


.
The requestor sends an
LogonSecurityGetCurrentUserIntercomMsg message
with a scope of Send to Master
**When a user is logged on or off or a request for
current logged-on user is sent , the logon manager
application sends a
LogonSecurityGetCurrentUserIntercomMsg intercom
message with a scope of Send to all Clients
Logged-on response messages contain the Logon
Security object as well as the current user name. For a
logged-on scenario, the new user is sent as
Logged On. When that user is logged off , the previous
user is sent as a logged-on intercom.
Messages also contain the current windows session ID .

ToolboxST, CimView and CimEdit Security Authentication

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

2-50 Chapter 2 System Configuration

GEH-6700J ToolboxST

Configuring SecurityST Logon


Users and roles are configured from the System Information Editor in the ToolboxST
System Component. An example of configured users and roles is as follows.
Each of the five users created
has been assigned a role.

The following property is associated with the Users and Roles item.
Auto LogOff Timeout is the time, in minutes, after which a user who has
temporarily logged on over the existing user, is automatically logged off. If set to 0,
auto logoff does not occur. When the temporary user is logged off, the previous user
is again active.
User settings include the following:
Name is the user name. In Windows Domains, the name can be the
Domain/UserName.
Role is the role associated with the user, which defines the users access privileges.
HMI Resources are the HMI resources associated with a user. They are configured
in the System Information Editor, with assigned variables. Users who have a
resource that matches a variables resource can write to live data for that variable if
that privilege is assigned. If a variable does not have a resource, it defaults to
allowing the user to modify the data if the users role supports that privilege. Users
with an empty list of resources are only allowed to modify variables without an HMI
resource defined.
Role settings include the following:
Name is the role name, which can be assigned to a user with all the privileges of
that role.
Live Data Modify Privilege allows you to modify live values.
Live Data Force Privilege allows you to force live values.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-51

Logic forcing procedures can result in personal injury or death, if not


strictly followed. Only adequately trained personnel should modify
any programmable machine.
Forcing of control logic for an operating process is strongly
discouraged. Forcing of protective functions is never permissible for
an operating unit. All safety measures should be strictly enforced in
conjunction with this procedure.
Alarm Privilege allows you to acknowledge and reset alarms in the WorkstationST
Alarm Viewer.
GoTo Definition From HMI Graphics Privilege allows you to right-click
within an HMI graphics window and enable GoTo Definition in ToolboxST.
Tag Out Privilege allows you to tag out areas of the control system.

Displaying Current User


The SecurityST user interface is displayed by using the WorkstationST icon in the
taskbar notification area.
To display the current SecurityST user
Right-click the WorkstationST icon in the taskbar notification area. A shortcut
menu displays.

Select Show Current


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

The Privilege check


boxes display the
privileges of the current
user.

2-52 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

Logon and replace the current user

Logon to override the current user temporarily


To log on and replace the current user

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


area to display the shortcut menu.
Select SecurityST Log
On. The SecurityST User
Logon Manager dialog
box displays.

From the drop-down list, select the User,


then enter the Password. Click OK.

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

Select the User, then


enter the Password.

Select the Temporary Log On Leaving Current


User Logged On check box, then click OK.

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-53

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

Auto Logging Off


The SecurityST feature LogOff Timeout is activated when one user is logged on over
another user. This feature is set in the Property Editor when the Users and Roles item
is selected in the Tree View.
To set the Auto LogOff Timeout feature time
From the Tree View of the ToolboxST System Editor, double-click
the

icon.

From the Tree


View, select Users
And Roles.

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

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

2-54 Chapter 2 System Configuration

GEH-6700J ToolboxST

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

Select SecurityST Log Off .

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

GEH-6700J ToolboxST

Chapter 2 System Configuration 2-55

Notes

2-56 Chapter 2 System Configuration

GEH-6700J ToolboxST

CHAPTER 3

Chapter 3 Software
There are two system components for creating downloadable application software,
controllers and library containers. Controller components contain the application
software that is downloaded to a particular controller. Library containers contain user
block libraries of reusable blocks that can be referenced and used by controller
components.
Controller application software consists of function blocks that perform logical and
mathematical operations on the block variables. This network of blocks and
connected variables controls a particular machine through physical inputs and
outputs.
Function blocks arranged and connected within a software element are called Tasks.
Tasks are grouped into other software elements called Programs.
User-defined blocks called user blocks are created using existing function blocks, as
well as other user blocks. These user blocks can be used in a task in the same manner
as function blocks.

Software Configuration Hierarchy


Programs and tasks are required elements of software configuration, resulting in at
least two levels of hierarchy as shown in this example:

Program groups can be used to add a level above programs; and together with user
blocks, the levels of hierarchy can be four or more as shown here:

GEH-6700J ToolboxST

Chapter 3 Software 3-1

Variables
Variables can be defined within programs, tasks, and user blocks. Task and user
block variables can be either global or local, but all program variables are global. A
variable must be global to be connected to either Turbine I/O or Ethernet Global
Data (EGD). A local variable is restricted in scope to its task or user block, meaning
it cannot be accessed from other locations. Global variables are referenced through
their Global Name Prefix property.

The levels of programs


and user blocks that are
downloaded to the
controller are all shown
as items in the Tree
View of the Software tab
of the Component
Editor.

Selecting items in the


Tree View displays the
properties of that item in
the Property Editor as
well as pertinent
information in the
Summary View. The
item selected in the Tree
View can be edited in
the Property Editor and
Summary View,
provided the password
protection is unlocked,
and the item is not in a
linked user block.

3-2 Chapter 3 Software

GEH-6700J ToolboxST

Function Blocks
The basic unit of application software in the controller is the function block. Each
function block corresponds to software on the controller and is represented in the
ToolboxST application by block libraries. These libraries are part of the installation
of a particular type of controller.
Blocks have input and output variables, which can be connected to other variables,
Turbine I/O, or EGD variables. Each instance of a block has a name that is unique in
that blocks context. The combination of the variable name with the blocks name
and context give each variable a unique name within the controller. Blocks in the
same user block can reference each others variables using the block name and
variable name separated by a period.
Blocks are typically added to a user block in either a controller component or a user
block library by dragging them from the library palette to the user blocks block
diagram. For more information about editing blocks, refer to the section, Block
Diagram Editor.

User Block Libraries


User block libraries exist within a system component called a library container.
These allow you to create reusable software elements. Programs, tasks, and user
blocks can be designed in these libraries, then used multiple times in different places
(refer to the section Library Container Editor ).
Library definitions can contain tasks and/or user blocks created from other
definitions within the same library container. When a library definition is being
created or edited in the library container, the User Blocks tab on the right side of the
block diagram shows all task and user block definitions that exist in the library
container.
Programs, tasks, and user blocks in a controller component can be created from
library definitions. Once the controller component has referenced one or more user
block libraries, the Add Program, Add Task, and Add User Block dialog boxes allow
selection from the library definitions.

GEH-6700J ToolboxST

Chapter 3 Software 3-3

Instancing
If a library definition is changed, programs, tasks, or user blocks associated with the
definition are NOT automatically updated. This is true within a library container as
well as in a controller component.
The process of updating programs, tasks, or user blocks with current library
definitions is called Instancing.
To instance a single item
From the Software tab Tree View, right-click on a program, then select
Instance to update all software within that program.
To instance an entire system component
From the Software tab Tree View, right-click on the Programs item, then
select Instance All.
Note Definitions can contain user blocks or tasks that were created from other
definitions in a library. To be certain that ALL current definitions have propagated to
all necessary places in a controller component:

Perform an Instance All command in the library container, then save the library
container.

Perform an Instance All command in the controller component.

Unlink Property
All programs, tasks, and user blocks generated from a library definition have a
Boolean property called Unlink, which is False by default. In this state, they are
called linked.
Linked programs, tasks, and user blocks, with very few exceptions, cannot be
changed. They are updated with the current library definition when the Instance
command is performed.
Unlinked programs, tasks, and user blocks are disassociated from the library
definition, and can be modified. They are NOT updated with the current library
definition when the Instance command is performed.
Note Programs, tasks, and user blocks that do not come from a library definition are
called Embedded, and they do not have the Unlinked property.

3-4 Chapter 3 Software

GEH-6700J ToolboxST

To create and use a linked user block


1

From the System Editor, create a library container.

Right-click the Libraries item and select Add Library. The Add New
Library dialog box displays.

In the Add New Library dialog box, type a name for the library, then click
OK.

Right-click the library and select Add User Block Definition.

Save the library by clicking the Save

From the System Editor, open a controller.

Select the Software tab.

Make sure the new library displays in the Summary View. If not, right-click
the Programs node in the Tree View, and then select Library References.

From the Tree View tab, select a Program or right-click to add a new
Program.

button on the toolbar.

Select the new library


checkbox. Click OK.
The new library displays
in the Summary View.

GEH-6700J ToolboxST

Chapter 3 Software 3-5

10 Right-click the program and select Add Task.

11 In the Add Task dialog box, select the Select Library Block checkbox to
show library blocks.
12 Insert a linked user block by selecting the user block definition from the dialog
that displays.
- or Insert an embedded user block, then drag the linked user block from the library
palette onto the block diagram for that embedded user block.
To update a linked user block in either a library or controller
component

3-6 Chapter 3 Software

From the System Editor, open a library component.

From the Tree View, navigate to the user block to update.

Edit the user block using the Summary View or the Property Editor.

Save and close the library.

From the System Editor, open a library or controller component.

From the Tree View, right-click the user block to be updated, then select the
Instance command from the shortcut menu.

GEH-6700J ToolboxST

User Block Definitions


User block definitions consist primarily of function blocks, user blocks, and
variables. The user block definition variables, which can be either local or global, act
as the parameters. User block definitions with global variables can only be used once
in a given controller unless the variable name contains a text substitution or the
variable's Global Name Prefix property is set to Full, Block, Task, or Program.
User block definitions are the source of both linked and unlinked user blocks. Each
user block has a version and description to help manage reusable application
software.
Instance scripts and text substitution allow user blocks to use a set of code in
multiple situations. These work with the ToolboxST automation interface and the
user attributes that belong to either the user block or the controller component.

User Attributes
User attributes are named values that allow you to specialize user block definitions.
They consist of a name, a data type, a description, a value, and a PromptforInput
property.
The PromptforInput property displays a dialog box that allows you to verify the
attribute value when the user block that owns the user attributes is inserted. Named
attributes can be used to change the variable names and connections by substituting
strings specified in user block attributes. User attributes for a user block can be
changed at the Instance command. Refer to the section, Working with User Blocks .

Device Attributes
Device attributes are similar to user attributes. They are named values that consist of
a name, a data type, a description, and a value. However, device attributes are
defined within a device configuration, and can be referenced by any application
software within the device. Device attributes do not have a PromptforInput property.
Refer to the section, Application Software Examples.

Instance Scripts
Instance scripts run when a user block is either inserted or instanced. Their primary
purpose is to exclude particular blocks or user blocks from a user block definition.

Text Substitution
Certain text fields such as variable names, descriptions, and block connections can
have some portion of the text replaced when the user block is inserted or instanced.
To use substitution within a text field, embed a pair of braces {} within the text and
enclose the name of an attribute within the braces. For user attributes, the syntax is
attributeName and for device attributes, the syntax is device.attributeName. Refer to
the section, Application Software Examples .

GEH-6700J ToolboxST

Chapter 3 Software 3-7

Library Container Editor


The Library Container Editor is used to create reusable application software that can
be included in other controller components.
Library containers are added to a system as a separate component. Double-click the
component icon in the Tree View to display the editor as a separate window. Each
library container can contain one or more libraries. Each of these can contain user
block definitions, program definitions, or task definitions. A user block definition is
a collection of function blocks and user blocks with input and output pins. A
program definition is a collection of tasks that can be used in a controller device. A
task definition is a collection of function blocks and user blocks that can be used in a
program. Refer to the section, Software Tab.
The following window displays the major parts of the Library Container Editor and
the terminology used when referring to the editor.
The Validate command checks the
configuration for errors, connection
compatibility, data types, and equations.

The Finder is used to


find and replace items.

The Tree View lists all


items in the Library
Container Editor . It is
also used for adding or
deleting libraries.
The Property Editor is
used to edit the currently
selected item in the Tree
View .

The Component InfoView displays


information about the currently selected
tab.

3-8 Chapter 3 Software

The Summary View is used for editing the


user block selected in the Tree View .

GEH-6700J ToolboxST

To add a Library Container to a system


From the System View, right-click the system name and select Insert New,
Library Container as shown below to display the Library Container
Creation Wizard.

Enter a new Name (up to


32 alpha/numerical
characters) for the
Library Container, then
select the Type. Click
Next to continue.

GEH-6700J ToolboxST

Chapter 3 Software 3-9

Select the Version (defaults to


latest), then select the
Optional Libraries to include.

Click Finish to create a


Library Container.
From the Tree View,
double-click the new
Library Container to
display the Editor window.

Tip Different versions of the controller component can be used as the basis for a
library component. A software block library is always included that contains basic
function blocks, such as Move and Average. There are also optional libraries, which
contain more specialized blocks that can be included in the library container.
When new versions of the controller software are installed, library containers
continue to use their current configuration until they are upgraded. (If the old version
is uninstalled, the library container must be upgraded before it can be opened.)

3-10 Chapter 3 Software

GEH-6700J ToolboxST

To upgrade a Library Container


1

From the Tree View, select any Library Container item.

From the File menu, select Upgrade to display the Upgrade Wizard.

When the introduction page displays, click Next.

Select the
desired version and
click Finish. Verify that
the upgrade completed
successfully by viewing
the Log tab in the
Component InfoView.
You will be informed if
new versions are
unavailable.

Adding Libraries
From the System Editor, double-click the Library Containers item to display the
editor window. Multiple libraries can be added to a library container to break up the
application software into separate pieces. These can be referenced individually in the
controller component.

GEH-6700J ToolboxST

Chapter 3 Software 3-11

To add a new library to a library container


1

From the Tree View, right-click the Libraries item, then select Add Library.
The Add New Library dialog box displays.

Enter a name for the new library and click OK.

Note Each library is contained in an .xml file, and can be imported into other
library containers.
To add an existing library to the library container
1

From the Tree View, right-click the Libraries item, then select Add Existing
Library to display the Select Existing User Block Library dialog box.

Select the desired library (.xml file) and click Open.

Tip The Summary View for the Libraries item displays names and locations of
all the function block and user block libraries defined in this library container. The
version of the function block library used by this library container can be determined
by looking at the Directory field and observing the path to the library.

3-12 Chapter 3 Software

GEH-6700J ToolboxST

Library Property Editor


When a library is selected, the following properties are available.

Description is the description for this library.


Name is a unique name for this library.
Protection
Modify Data allows you to modify data values and forcing of variables.
Logic forcing procedures can result in personal injury or
death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine.
Forcing of control logic for an operating process is strongly
discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly
enforced in conjunction with this procedure.
Modify Design allows you to modify the design of defined blocks in this library.
View Design allows you to view details of the defined blocks in this library.

Library Summary View


The Summary View shows the name, version, category, and description of all User
Blocks in the currently selected Library.

GEH-6700J ToolboxST

Chapter 3 Software 3-13

Library Help Files


The ToolboxST application supports several types of help files that document a
library of user blocks.
Compressed HTML (.chm) contains individual HTML pages compressed
together into a single file. This .chm file, which is used to document an entire library
of user blocks, has the same name as the library (Lib1.chm). It is located in the same
directory as the library .xml file that it documents. The individual HTML pages
within the .chm file must have the same name as the block they document.
MHtml files (.mht) is a file that documents individual blocks in a library. It has the
same name as the block (Block1.mht) and it is located in the HelpFiles subdirectory
located under the library container. This format allows images and text to be
combined on a page, and can be created by Microsoft Word.
HTML files (.htm) is an html file that documents individual blocks in a library. It
has the same name as the block (Block1.htm), and it is located in the HelpFiles
subdirectory in the library container.
Text files (.txt) is a text file that documents individual blocks in a library. It has the
same name as the block (Block1.txt), and it is located in the HelpFiles subdirectory
in the library container.

File Locations (System)


Library container contains

Lib1.xml (contains Block1 and Block2

Lib1.chm (contains the help for Block1 and Block2)

Lib2.xml (contains Block3 and Block4)

Helpfiles contain

Block3.mht

Block4.htm

Search Order
The ToolboxST application first searches for a .chm file that corresponds to the
Library name. If this is not found, it searches in the HelpFiles directory for a help file
that matches the block name. The search order is: .mht, then htm, then .txt.

3-14 Chapter 3 Software

GEH-6700J ToolboxST

Table Definition Property Editor

The Property Editor


allows you to edit all
properties of the table
definition selected in
the Tree View. The
properties are defined
below.

Name is the name of the Table Definition.


Adjust determines whether the table's Z values and limits can be adjusted both in
configurations and online. The Adjust flag is read on import; if it is false, the table
data cannot be changed without another import.
Description is the description of the Table Definition.
Identification is the identification text for the Table Definition.
Revision is the revision text for the Table Definition.
Maximum Z value is the Maximum Z value used to limit the values that can be
entered in the live or initial values.
Minimum Z value is the Minimum Z value used to limit the values that can be
entered in the live or initial values.
Engineering Y Units provides an engineering Y unit's description.
Engineering X Unit provides an engineering X unit's description.
Engineering Z Units provides an engineering Z unit's description.

GEH-6700J ToolboxST

Chapter 3 Software 3-15

Exporting a Table Definition


To export a table definition (.csv)
1

From the Component Editor, click the Software tab.

Expand the Table Definitions item and select the table definition to be
exported, such as
below.

Right-click the table definition


and select Export Table .CSV
File from the shortcut menu.

3-16 Chapter 3 Software

Select the .csv table definition file (.csv) from the browser window and click
Save.

GEH-6700J ToolboxST

Online Display and Changes


Table definition data values can be changed when connected to the controller, if the
table has the Adjust property set to True. When online, the live data values display in
green to indicate that there are no differences between the ToolboxST values and the
controller values.
Double-click a value in
the Data Grid Editor.

Enter the new value,


then click the Send
& Close button.

The Summary View Data Grid displays the differences.

This feature allows you to edit the table data values in the controller. Once the table
data values are correct, click
capture the values in the ToolboxST configuration.

GEH-6700J ToolboxST

at the bottom of the Editor to

Chapter 3 Software 3-17

Using Table Definitions in Software Application


Code
To add a 2D (Univariant) Linear Interpolator block

3-18 Chapter 3 Software

Connect the Table2D pin to the Table\T_ESPBSJ table.

Set the XInput to 40.

Build and download the application code. The output of the block displays as
shown below.

GEH-6700J ToolboxST

To add a 3D (Bivariant) Linear Interpolator block

GEH-6700J ToolboxST

Connect the Table3D pin to the Table\T_DSPNAJ table.

Set the XInput to 30.

Set the Yinput to 4.

Build and download the application code. The output of the block displays as
shown below:

Chapter 3 Software 3-19

User Block Definitions


Adding a User Block Definition
Each library can contain many user block definitions.
To add a user block definition to a system

3-20 Chapter 3 Software

From the Tree View, right-click the library item and select Add User Block
Definition to display the Add New User Block Definition dialog box.

Enter a new name for the library. Click OK.

GEH-6700J ToolboxST

Sorting User Block Definitions


User block definitions can be sorted alphabetically. If additional user block
definitions are added, repeat the sort.
To sort user block definitions alphabetically
Right-click the library item and select Sort Definitions.

User Block Variables


The variables of a user block definition act as its parameters, and can be either local
or global. The following commands are available when a variable item is rightclicked in the Tree View.

Add Variable allows a variable to be added to the selected User Block. Once the
new variable is added, properties become available in the Summary View. Refer to
the section, Property Editor .
Add Undefined Variables allows you to add all undefined variables in the User
Block Definition to the variables of the User Block Definition. Undefined variables
are variables that have been referenced in a User Block Definition but have not yet
been defined as part of the user block variables or user block.

GEH-6700J ToolboxST

Chapter 3 Software 3-21

Working with User Blocks


User Attributes are named values that allow specialization of User Block Definitions.
They consist of a name, a data type, a description, a value and a PromptforInput
property.
The PromptforInput property causes a dialog box to display so that you can verify
the attribute value when the user block that owns the user attributes is inserted.
Named attributes can be used to change the variable names and connections by
substituting strings specified in user block attributes. User Attributes for a user block
can be changed at the instance. Refer to the section, Application Software Examples
for examples on how to use attributes.
To add a user attribute to a user block definition

3-22 Chapter 3 Software

From the Tree View, right-click the User Block Definition (for example,
Lib1Usb1) and select Add User Attribute to display the Add User
Attribute dialog box.

Enter a name for the new attribute, then click OK.

Click the Attributes item in the Tree View to display properties in the
Summary View. The properties can be modified.

GEH-6700J ToolboxST

Instance Scripts
Instance scripts run when a user block is either inserted or instanced. Their primary
purpose is to exclude blocks from a user block definition based on user attributes
defined in the controller component. Refer to the section, Application Software
Examples .
To add an Instance Script
From the Tree View, right-click the User Block Definition (for example,
Lib1Usb1) and select Add Instance Script.

Instance
Select this command to get a new copy of the User Block Definition from the library.
In addition to updating the user blocks, this command causes the instance scripts and
text substitutions for all of the top-level user blocks to run. It is not possible to undo
this command.
To instance a User Block Definition
From the Tree View, right-click the User Block Definition and select
Instance.

Validate
This command checks the selected User Block Definition for errors. Validate checks
connection compatibility, data types, and equations. Validation status displays in the
Log tab. Double-click the error in the Log tab to locate the application software that
caused the problem.
To check a User Block Definition for errors
From the Tree View, right-click the User Block Definition and select Validate.

GEH-6700J ToolboxST

Chapter 3 Software 3-23

Update All Uses


Changes in user block definitions (as well as in task and program definitions) can be
instanced directly (pushed) from a library to the controller as opposed to changes
being pulled from the library from each individual controller.
To update user block definitions
From the Tree View, right-click the user block definition (for example,
Lib1Usb1) and select Update all Uses.

3-24 Chapter 3 Software

GEH-6700J ToolboxST

Note When Update All Uses is selected, you are prompted to save changes if the
system determines that changes have not been saved. Once changes are saved, the
Controllers to Update dialog box displays.

The Status column


displays the state of
each controller.

After selecting the


controllers, click the
Update button to display
the Block Updating
Results.

Note The Enter Password dialog box displays if any password-protected actions are
requested.

GEH-6700J ToolboxST

Chapter 3 Software 3-25

Find All Uses


The Find All Uses option allows you to display a list of all uses for a specific user
block.
To display all uses of a user block
From the Tree View, right-click the user block definition (for example,
Lib1Usb1) and select Find all Uses.

The search results display in the Find Results tab of the Component InfoView.

3-26 Chapter 3 Software

GEH-6700J ToolboxST

User Block Property Editor

Description is the description of this user block.


Name is the unique name of this user block.
Instance Script runs when the block is instanced.
Detached Summary is the path to a summary diagram for the user block
definition.
Enable, when set to True, enables the user block.
Help File is the locally assigned help for this user block.
Help Text is the locally defined help that supersedes any global help for this user
block.
Instance name is the name for a newly created instance.
Protection properties control the View, Modify Data, or Modify Design
permissions for this library (refer to the section, Security .)
Version is the user-defined version of a user block.
Category is the name of a category to which this block belongs.

Summary View
Most of the work in creating a user block definition involves inserting different types
of blocks and connecting them together to perform a function using the Block
Diagram Editor. Refer to Chapter 4, Block Diagram Editor.

GEH-6700J ToolboxST

Chapter 3 Software 3-27

Application Documentation
For documentation purposes, the ToolboxST application can print detailed
information about a component's entire configuration. However, if you select a
Program or User Block in the Software tab, only the selected item is printed.
Note In some locations, including Reports and the Block Diagram Editor, shortcut
menus contain commands that allow single pages or reports to be printed.
To print a component configuration
Open the Component Editor for the component to be printed. From the File
menu, select Print to display the Print Options dialog box.
Page Options tab allows you
to change the paper size,
margins, and orientation.

Print Settings tab allows


you to change the
destination printer and its
associated settings.

Print Profile tab manages


saved print settings. It stores all
the settings from both the
Options and Page Option tabs.

Page Numbering
options control page
number assignment.
Linear pages number
sequentially start with
page one.
Hierarchical page
numbers are same as
linear pages but also
numbers each section
and sub-sections, such
as 1., 1.1, 1.2.1 and so
on.

Prints a summary of
configuration settings
for the component.

Includes a list of
sections and page
numbers.
Includes a symbol
quick reference
guide.
Prints all software
programs in the
component.
Prints a reference to
all variables in the
component.

3-28 Chapter 3 Software

Displays a Print Preview


window with the document
exactly as it will appear on
paper.

Click this button to


print the document.

GEH-6700J ToolboxST

Application Software Examples


Five separate, but associated procedures related to application software design are
described below. These procedures build on each other to create a system, so you
must complete them in the order given. They include:

User block definition

Linked user block

Device attribute

Block exclusion with an instance script

Text substitution with an attribute

User Block Definition


To add a user block definition to a library
1

Open the ToolboxST application. From the File menu, select New System to
display the New System dialog box.

Enter a name for the new system, then click OK to display the System Editor.

In the Tree View,


right-click the
system item.

Click Insert New,


then select Library
Container from the
drop-down list.

GEH-6700J ToolboxST

Chapter 3 Software 3-29

The Library Container Creation Wizard opens.

Enter a new Name (up to


32 alpha/numerical
characters) for the
Library Container, then
select the Type. Click
Next to continue.

On the Product Version page, click Finish to accept the default library
version and optional libraries.

A new library container is added to the system and the Tree View updates to reflect
the change.
4

From the Tree View, double-click the Libraries item to open the Library
Editor.

Open the Library


Editor by doubleclicking the libraries
item in the Tree View.

3-30 Chapter 3 Software

GEH-6700J ToolboxST

Right-click the Libraries item and


select Add Library . The Add
New Library dialog box displays.

Right-click the new library item and


select Add User Block Definition.
The Add New User Block
Definition dialog box displays.

GEH-6700J ToolboxST

Chapter 3 Software 3-31

Click OK to accept the default user


block name. The user block definition
is created and the Tree View is again
updated to reflect the changes.

With the Lib1Usb1 item highlighted in the Tree View, the Libraries tab
displays on the right side of the block diagram.

From the Library


Block tab, scroll to
select the Type
Conversion category.

3-32 Chapter 3 Software

GEH-6700J ToolboxST

Drag a MOVE block from the Type Conversion category to the Block
Diagram Editor to add it to the user block. Repeat this process once more until
two MOVE blocks display on the block diagram.

Save the library container by clicking the Save


close the editor by clicking the Exit

GEH-6700J ToolboxST

button on the toolbar and

button in the upper right corner.

Chapter 3 Software 3-33

Linked User Block


To insert a linked user block in a controller
1

Open the System Editor for the test system created in the previous procedure.

From the Tree View, right-click the system


shortcut menu.

item to display the system

From the shortcut


menu, click Insert
New.

Then click Controller, and Mark VIe


Controller. The Mark VIe Creation Wizard
opens.

3-34 Chapter 3 Software

GEH-6700J ToolboxST

Enter a Name for the new


controller (up to 32 alpha/
numerical characters)

If you do not have the


configuration for a particular
controller, but know its IP
address, click to select
Upload from Controller.

GEH-6700J ToolboxST

When Specify Controller Information


is selected, enter the Name, then
select the Application ( the default is
General Purpose) and Version (the
default is the latest version)

Enter the IP
Address.

Click Next
to continue.

Chapter 3 Software 3-35

Click Finish to accept the default libraries.


A new controller component is added to
the system and the System Editor
updates to reflect the changes.

3-36 Chapter 3 Software

GEH-6700J ToolboxST

Click the Software tab, then right-click the Programs item in the Tree View
to display the Programs shortcut menu.
Select Library References
to display the Library
References dialog box.

Click the check box to


the left of library Lib 1,
and then click OK to
add a reference to the
library.

GEH-6700J ToolboxST

Chapter 3 Software 3-37

3-38 Chapter 3 Software

Right-click the Programs item again and select Add Program from the
shortcut menu. The Add New Program dialog box displays.

GEH-6700J ToolboxST

Right-click the Prog1 item in the Tree View to display the Program shortcut
menu.
Click Add Task to display
the Add Task dialog box.

Enter a Name to insert an


embedded task.
OR
Click the Select Library Block
check box to insert a linked task.

Select a category and a


definition from that category.
Enter a name for the linked task.
Click All to display all of
the Categories and
Definitions.
Click None to de-select
all Categories.

Save the changes by clicking the Save button


editor by clicking the Close button

GEH-6700J ToolboxST

on the toolbar, and close the

Chapter 3 Software 3-39

Device Attribute
To add a device attribute
1

Open the System Editor for the test system created in the previous examples.

From the System Editor, open the controller Component Editor by doubleclicking the controller in either the Tree View or the Summary View.

From the Component


Editor General tab,
select Attributes.

3-40 Chapter 3 Software

GEH-6700J ToolboxST

Click theName
cell on the
append row
(indicated by
an asterisk*)
and typeAttr1
to name the
new attribute.

GEH-6700J ToolboxST

Change the data type to BOOL by clicking the Type cell on the Attr1 row and
then selecting BOOL from the drop-down list.

Chapter 3 Software 3-41

Change the initial value to False by clicking the Value field of the Attr1 row,
then clicking the ellipsis button
to display the Modify Value dialog box.

Select False from


the drop-down list.

Click OK to accept
the new value.

3-42 Chapter 3 Software

Save the changes by clicking the Save button


editor by clicking the Close button .

on the toolbar, then close the

GEH-6700J ToolboxST

Block Exclusion with an Instance Script


To exclude a function block from a user block with an instance
script
1

Open the System Editor for the test system created in the previous examples.

From the System Editor, open the Library Container Editor by doubleclicking the Libraries item in the Tree View.

Repeat these steps for the MOVE_3 block item.

From the Tree View, select the MOVE_3 block item in the Tree View. In the
Property Editor, select the Instance Script field and click the ellipsis button
. The Edit Text dialog box displays with the default Instance Script:
Block.Include = Device.Attribute("Attr1").BoolValue

Add the text NOT between the equal sign and the word Device in the script to
negate the expression as follows: Block.Include = NOT
Device.Attribute("Attr1").BoolValue

Save the library container by clicking the Save button


close the editor by clicking the Close button .

Open the controller component by double-clicking it in the System Editor.

Click the General tab. From the Tree View, select the Attributes item. From
the Summary View, click the Value cell of the Attr1 row, then click the
ellipsis button
to display the Modify Value dialog box.

Change the value to True using the drop-down box, then click OK.

Click the Plus symbol


to expand the items
Lib1 and Lib1Usb1
and display blocks.

Right-click the
Move_2 block
item to display the
block shortcut
mentu, then
select Add.

on the toolbar, then

10 Click the Software tab. From the Tree View, locate the Prog1 item. If it is
collapsed, click the plus symbol to expand it.
11 From the Tree View, right-click the user block Lib1Usb1, then select
Instance from the shortcut menu to update the user block. The user block
contents display in the Summary View with MOVE_1 and MOVE_2 blocks.
The block MOVE_3 was excluded by the instance script created in step 8
because Attr1 is set to True.
12 Click the General tab. From the Tree View, select Attributes. As before,
button. In the
click the Value cell in the Attr1 row, then click the ellipsis
Modify Value dialog box, set the attribute value to False and click OK.

GEH-6700J ToolboxST

Chapter 3 Software 3-43

13 Return to the Software tab. Right-click the user block Lib1Usb1 and select
Instance from the shortcut menu. This is the same operation that was
performed before, but since Attr1 is now set to False, the instance scripts
causes the block MOVE_2 to disappear and the block MOVE_3 to display on
the diagram instead.
14 Save the component by clicking the Save button
the editor by clicking the Close button .

on the toolbar, then close

Text Substitution with an Attribute


To substitute text into a user block with an attribute

3-44 Chapter 3 Software

Open the System Editor for the test system created in the previous examples.

From the System Editor, open the Library Container Editor by doubleclicking the Libraries item in the Tree View.

From the Tree View, expand the item Lib1 and right-click the Lib1Usb1 user
block to display the shortcut menu.

From the shortcut menu, select Add User Attribute to display the Add New
User Attribute dialog box.

Change the attribute name to Attr1_u to differentiate it from the previously


created Attr1 and click OK. A new Attributes item displays in the Tree View
under the user block definition Lib1Usb1.

GEH-6700J ToolboxST

From the Tree View, select the Attributes item. The Summary View
displays a list of attributes.

Change the Attr1_u data type to STRING by clicking the Type cell (which
currently contains UNDEFINED), then selecting STRING from the drop-down
list.

Change the PromptForInput cell of Attr1_u to True. (You may have to


scroll right in the Summary View to locate the PromptForInput column.)

Now that the attribute has been created, create a user block variable with text
substitution in its name. From the Tree View, click Variables.

10 From the Summary View, click the Name cell in the Append row (indicated
by an asterisk *) and {Attr1_u}_thing as shown below. Leave the data type set
to the default value, BOOL.

11 Text substitution can also be used in variable connections. To connect the


variable that was just created, click the MOVE_1 block in the Tree View to
display the Block Diagram Editor.

GEH-6700J ToolboxST

Chapter 3 Software 3-45

12 In the Summary View, double-click the enable pin of the block MOVE_1.
The Connect Pin dialog box displays.

13 Click to select Local Variable. Then, enter the variable name


{Attr1_u}_thing in the text box and click OK. The block diagram updates to
reflect the new connection.

14 Save the library container by clicking the Save button


close the editor by clicking the Close button

on the toolbar, then

15 To see the text substitution in action, open the Component Editor for the
controller by double-clicking G1 in the System Editor.
16 Click the Software tab. From the Tree View, locate the Prog1 item. If it is
collapsed, click the plus symbol to expand it.
17 From the Tree View, right-click the user block Lib1Usb1, then select
Instance from the shortcut menu to update the user block. An Attributes item
is added to the Tree View.
18 From the Tree View, click the Attributes item. The attribute Attr1_u created
in step 5 displays in the Summary View.
19 Click the Initial Value cell of the Attr1_u row. Click the Ellipsis button to edit
the value, then enter the text ABCDEFG to be substituted. Click OK to close
the Modify Value dialog box.

3-46 Chapter 3 Software

GEH-6700J ToolboxST

20 From the Tree View, right-click the Lib1Usb1 user block , then select
Instance. The value entered for Attr1_u is substituted into the variable
{Attr1_u}_thing and into the MOVE_1 ENABLE pin connection, creating a
variable named ABCDEFG_thing.

21 To verify that the variable name substitution has occurred, click the Variables
item under the user block Lib1Usb1. The ABCDEFG_thing variable displays
in the Summary View.

22 Save the component by clicking the Save button


the editor by clicking the Exit button

GEH-6700J ToolboxST

on the toolbar, then close

Chapter 3 Software 3-47

Notes

3-48 Chapter 3 Software

GEH-6700J ToolboxST

CHAPTER 4

Chapter 4 Block Diagram Editor


Application software in the controller consists of blocks that perform control logic
functions. The controller runtime provides a library of standard blocks that can be
combined to form user blocks. The Block Diagram Editor allows you to create and
edit user blocks using a visual interface and drag-and-drop tools. The Block Diagram
Editor displays in the Summary View when a user block is selected in the Tree
View.

Click for a
wiring tool.

Click to
Click for shapezoom in
drawing tools.
and out.

Click to display
Detached
View.

The Library View is divided


into multiple categories,
each containing one or
more blocks that perform
similar functions.

Select a user
block in the Tree
View. The Block
Diagram Editor
displays in the
Summary View.

Additional editing tools display on the toolbar, and a sidebar called the Library View
displays on the right side of the Summary View to allow you to make changes to a
user block.
Note If the user block is read-only or linked, an error message displays. If the user
block is protected, you are prompted to enter the appropriate password.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-1

Diagram Shortcut Menu


When you right-click an empty portion of the diagram, the Diagram shortcut menu
displays.

Auto-Layout Mode controls how the blocks on the diagram are arranged. Refer to
the section, Layout Modes .
Diagram Settings... displays the Diagram Settings.
Append Sheet adds a new drawing sheet at the end of the drawing.
Insert Sheet inserts a sheet immediately before the current sheet in manual mode.
Delete Sheet deletes the current sheet in manual mode.
Rename Sheetsopens the Rename Sheets dialog box.
Print Sheet... prints the current sheet.
Zoom adjusts the zoom level to either a preset zoom level or a custom value.
View Settings contains options to toggle the rulers, library view, and print border.
Paste inserts the contents of the clipboard at the selected location.

4-2 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Renaming Sheets
Individual sheets can be renamed to follow any standard naming convention needed
for a particular system. The sheet names are used in page numbering and cross
references, and must be unique within a particular device.
To rename sheets
From the Tree View, right-click the Programs item or right-click anywhere in
the empty portion of the diagram. The Rename Sheets dialog box displays.
Software path and sheet number

User-defined custom sheet

Click the Rename button to


rename the sheet(s). This
cannot be undone.

Sheet Names
For a particular sheet, you can enter a complete sheet name or use certain
substitution characters to automatically number or letter the sheets within a particular
diagram.
Substitution
Character

Represents

Sheet number

Sheet letter

Example

One of the 26 uppercase ASCII letters (A-Z)

{AttributeName} Attribute

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-3

Customizing Sheet Borders


By default, each sheet in a Blockware diagram has a border that consists of a
rectangle with grid coordinates and a footer that contains information about the
diagram. The footer information is selected to be as universal as possible, but there is
often additional information required. Both the border and the footer can be
customized to show the specific information needed for a particular system.
To customize the sheet border
From anywhere in the Block diagram, right-click and select Edit Sheet
Border. The Sheet Border Editor displays.

Select Border or
Footer Options

Display a
preview of
selected
options

Edit
the
footer

Select Export or
Import to allow the
reuse of the border.

4-4 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Border Options
Border Name and Border Description are text fields to describe the border.
Coordinates, when selected, draws the grid of letters and numbers on the border.
Outer Line, when selected, draws a rectangle around the outer edge of the border.
Inner Line, when selected, draws a rectangle around the inner edge of the border.
Footer, when selected, draws the footer. When unchecked the Footer Options and
Footer Block section of the dialog is grayed out.
Footer Height is the total vertical space allocated to the footer.
Footer Rows is the number of rows in the footer; each row is allocated vertical
space equal to the footer height divided by the number of rows.
Footer Columns is the number of columns in the footer; each column is allocated
horizontal space equal to the border width (which is paper size- dependent) divided
by the number of columns.

Preview
The Preview section allows you to display what the border looks like with the
current options. You can scroll the preview and zoom in and out. The footer cell
being edited in the Footer Block section is highlighted in the preview, and you can
left-click a footer block to select it for editing. You can also press and hold the left
mouse button and drag a footer block to move it around the footer.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-5

Footer Block
The currently selected cell in the footer can be modified in the Footer Block section.
Next Cell selects the next cell in the footer (list is sorted in Z order back to front)
Previous Cell selects the previous cell in the footer (list is sorted in Z order back to
front)
Delete Cell removes the current cell from the footer. The button is only visible if a
cell is selected.
Create Cell adds a new cell to the footer at the current Row and Column. The
button is only visible if no cell is currently selected. Clicking an empty spot on the
footer in the Preview makes the Create Cell visible and preset the Row and Column
fields to where you clicked in the preview.
Row is the top-most Footer row for the current cell. It does not need to be within the
footer boundaries, which allows special effects like non-rectangular footers.
Column is the left-most Footer row for the current cell.
Height is the number of rows taken up by the current cell.
Width is the number of columns taken up by the current cell.
Empty, when selected, causes the cell to show no content.
Text allows you to enter custom text into the cell.
Sheet Information allows you to display a pre-defined cell.
Image allows you to display an image in the cell.
Export saves the current border from the editor to a specific .xml file.
Import loads a specific border .xml file into the editor.
Cancel closes the editor without saving changes.
OK saves the editor to the .xml file for the current device. The border .xml file is
always named SheetBorder.border.xml, and is saved in the same location as the
device .xml file.

4-6 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Custom Text
Select this option to edit the following:
Caption is text displayed in a smaller font on first line of the cell
Text is text displayed in a larger font on the second line of the cell.
For both fields, text is clipped to the size of the cell (no wrapping), and both support
Attribute substitutions. For example if the custom Text for a border cell is Custom
Text with {Attr1} substitution, the {Attr1} is replaced with the current value of the
User Attribute Attr1 in whatever context the border is drawn. If Attr1 is not defined,
it is removed from the text. These attribute substitutions allow you to customize
footer contents for specific programs, tasks, or user blocks; you can also define
attributes at the device level.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-7

Sheet Information
Select this option to edit the following:
Information Type provides a drop-down list of different pre-defined cells
Requisition information from the system and device includes:

Customer Site

Customer Name

Drawing Number

Engineer

Requisition Number

Process Application

Shop Order Number

DM Number

Serial Number

Machine Size

Automatically generated configuration data includes:

User Block Revision

Major Build Revision

Minor Build Revision

Last Modified

Print Date

ToolboxST Version

Component Name

Software Path

Sheet Number

Next Sheet Number

There is also a special automatically generated cell called Title. This cell displays the
Description text associated with the User Block or Task. If that Description is blank,
Title looks for the first block contained in the User Block or Task that has a
Description that is not blank. If no block Description is found, Title looks for the first
Text Shape drawn in the User Block or Task.
Certain user blocks and library blocks are designed to be dragged from the
ToolboxST Software tab to the CIMPLICITY application. This screen-building
software allows you to create graphical objects to represent a block, as well as
automatically configure the graphical objects to use global variables defined by the
block.

4-8 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Variables and Blocks


Many blocks in the ToolboxST standard block libraries support a special type of
variable that contains both a value and an enumerated status. The value can be any of
the analog data types, while the status is a UINT with pre-defined enumeration
values.

Variables with Status


While task and user block variables can be configured to have status, program
variables cannot.
To create a variable with status
From the variable Data Grid, select a variable.
In the Interface Definition column for the
selected variable, set the definition to
AnalogWithStatus.

Blocks with Status


Many blocks have pins that are AnalogWithStatus variables. Some are optional, for
example, there is both a status and a non-status version of most Math blocks (Add,
Mult, and such).

An example of
bad status

An example of
good status

GEH-6700J ToolboxST

Bad status
flows through
the Add block.

Chapter 4 Block Diagram Editor 4-9

Certain blocks, such as the analog input (AI) block always use status. Pins that have
status contain a small slash, which indicates that more than one value is represented
by the line. Status pins can be connected to each other or connected to non-status
pins or immediate values. If a non-status variable or immediate is connected to a
status input pin, the pin always has the default status value.

Status Combine and Status Split Blocks


It is sometimes necessary to create a status variable from a normal analog and a
particular status value. Analog and status values can be split into separate variables
by using the STATUS_COMBINE and STATUS_SPLIT blocks, as displayed below.
Analog value

Live value in
(paranthesess)

Status value

4-10 Chapter 4 Block Diagram Editor

Combined is an
AnalogWithStatus

GEH-6700J ToolboxST

Block Shapes
Blocks can have powerful animated graphical representations. Block shapes, which
are defined for each block in the standard block library and in certain optional
libraries, greatly enhance readability of blockware diagrams as displayed in the
examples below.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-11

Variable Input Blocks


Certain blocks (for example, Add, And), referred to as rubber blocks, have a variable
number of pins and are drawn differently as shown below.

Some complex blocks have functional groups of input and output pins.

Grouped
input pins

Certain blocks automatically hide pins that do not apply to the configured mode of
operation, as shown below.
Note Pins hidden by animations always display if they are connected to a variable.

4-12 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

MODE_OPT
set to NONE

MODE_OPT
set to AUTO
displays Auto
mode pins

GEH-6700J ToolboxST

Auto
mode
pins

Chapter 4 Block Diagram Editor 4-13

Layout Modes
When blocks and wires are added to a diagram, they are arranged according to the
rules of the current layout mode. By default, diagrams are created in Classic Layout
mode, where the blocks are arranged in order with a focus on optimal use of space.
Toolbox Classic Layout mode automatically places wires and creates new sheets
as necessary, making it appropriate for small-to-medium sized diagrams.
List Layout mode arranges blocks in execution order in one column, with inputs
and outputs lined up on the edges of the sheet. All Rung blocks appear as Rung
diagrams instead of as blocks. This mode is ideally suited for sequencing and can be
used to simplify very large diagrams where wiring becomes confusing.
Manual Layout mode does not arrange blocks or wires, but leaves all layout tasks
to the user. It is ideal for users familiar with a sheet-oriented approach to design or
for applications where very specific documentation standards must be met.

Managing Blocks
To add a block from the Library View
Select the category in the Library View that contains the desired block, then
drag the block to the Block Diagram Editor. The block displays on the Block
Diagram.
Or,
From the Tree View, right-click a task, a user block, or a block, then select
Add Block. The Select Block to Insert dialog box displays. Select the
desired block and click OK to add it to the Block Diagram .

4-14 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

To edit the properties of a block


Click a block in the Block Diagram Editor. The block is selected and its
properties display in the Property Editor.
The following properties are available in the Property Editor when a block is
selected:
Block Type displays the name of the library block from which this block was
created.
Description is text describing the selected block.
Instance Name displays a unique identifier that allows the block (as well as its
attributes and pins) to be referenced from other places in the ToolboxST application.
Height displays the height of the block in the diagram.
Left displays the location of the left of the block in the diagram.
Selected Pin displays the pin currently selected in the block highlighted in the
Block Diagram Editor.
Show Description, when set to True, displays the description text for this block on
the diagram.
Top displays the location of the top of the block in the diagram.
Width displays the width of the block in the diagram.
Block Data Type displays the name data type for variant pins on the currently
selected block.
Instance Script is a script that runs when the block is instanced.
Version displays as read-only the version number of the source for this block
instance.
Execution Order determines when the block is executed. Setting this property
automatically renumbers other blocks in this user block. (Execution begins with
block zero and proceeds in increasing order.)

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-15

Wiring Block Pins


Block pins are wired together to direct the flow of data through the software. You
can form a connection by using the pointer tool to drag one pin to another pin. The
destination pins Connection property is set to the block that was the source of the
to form pin
drag-and-drop operation. You can also use the Wiring Tool
connections, which forms connections to both normal blocks and to blocks with a
configurable number of inputs (called Rubber Pins).

Source of the Wiring Tool


drag-and-drop operation

Destination (a
new rubber pin)

Wire Styles and Colors


Wires connecting blocks are solid for analog variables (any numeric data type) and
dashed for Booleans. When the ToolboxST application is not online with the
controller, wires are drawn in black. When online, wires are drawn in different
colors to indicate values and quality.
Wire Styles and Colors

Online analog, solid


Quality

Color

Normal

Black

Poor

Magenta

Online Boolean, dashed


True

Red

False

Gray

Forced True

Orange

Forced False

Blue

Logic forcing procedures can result in personal injury or


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

4-16 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Zoom and Pan Tools


To pan the block diagram
From anywhere in the diagram, press and hold the right-mouse button. The
cursor displays as a hand, allowing you to pan in any direction.
To use zoom in the block diagram
Select the zoom tool

Highlight an area to zoom to

Note While using the zoom tool, hyperlinks in the diagram are active.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-17

Block Shape Shortcut Menu


When you right-click a block, a shortcut menu displays:

4-18 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Block Help shows reference documentation on the selected block type in a help
window.
Add To Trend allows you to open a new Trender window. The block is
automatically added to the new Trender.
Add to Watch allows you to open a new Watch Window. The block is
automatically added to the Watch Window.
Go To Definition allows you to locate the variable definition.
Compare To Definition allows you to display a difference report that compares
the userblock instance and its library definition.
Show Description on Diagram toggles the display of description text for the
block. This text is the most effective way to document a block, as the text stays
attached to the block when the diagram is rearranged.
Edit Block Pins displays the Edit Block Connections dialog box.
Unhide all Pins causes the pins to display.
Copy allows you to copy a block. Paste displays to allow you to paste the copy to
the Block Diagram Editor.
Cut allows you to cut a block from the Block Diagram Editor.
Delete allows you to delete a block from the Block Diagram Editor.
Bring to Front and Send to Back reorder blocks, causing them to appear above
or below all other blocks and shapes on the diagram when overlap occurs.
Paste After allows you to insert whatever is on the clipboard but sets the execution
order of the blocks to be immediately after the right-clicked block.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-19

Connecting Pins
To connect a single pin
From the Block Diagram Editor, double-click a pin. The Connect Pin
dialog box displays.
This tab is a quick reference
showing the variables
connected to the selected pin.

Click to access local


variables and
enumeration values.

Connect a pin to any


variable or immediate
value by typing the
name of the variable
or the value.

Creates a new
variable in the
user block.

Browse buttons display


the Select a Variable
dialog box.

4-20 Chapter 4 Block Diagram Editor

Option buttons
specify the type of
connection.

GEH-6700J ToolboxST

To connect multiple pins


Double-click a block in the Block Diagram Editor. The Edit Block Pin
Connections dialog box displays.
Pins and parameters
display separately.

If you are online, the live


values display in this column.
Double-click a value to edit it.

The Connection
column can be edited.

Sorted
columns

Parameters are typically constant


configuration and tuning values.

Pins represent inputs and outputs of a block. Parameters are a special type of Pin that
are always Inputs, and are usually constant values that control block operation. Most
Parameters are drawn on the Blockware diagram under the block; typically, they do
not display if they are left to their default initial value.

Changing a Pin Connection


To change a pins connection
From the Connection column, select the cell for the desired pin. Either enter a
new value or click the down arrow to select a value.
Note Clicking the Connection column displays a drop-down list that includes
Browse Globals and Browse Locals. If either of these is selected, the Select a
Variable dialog box displays to allow you to select a variable. Any enumerated
values that are legal for the selected pin also display in the drop-down list.
Note All block pin connection changes take effect immediately (there is no OK or
Cancel button in the Edit Block Pin Connections dialog box). From the Edit menu in
the Component Editor, select the Undo option to reverse any changes.

Tip Pressing Enter while entering text selects the next pin on the block, allowing
rapid entry of connections.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-21

Toggling Live Data Layers


To reduce information clutter in the online blockware diagram, you can toggle live
data or variable names on and off with various toolbar buttons.
To toggle between live variables and values
From the diagram Layer toolbar, click the down arrow to select the desired
action.

Buttons on the Layer toolbar allow you to display the following.


Mode

Toolbar
Button

Displays:

Value Only (VAL)

Live value only:

Variable Only (VAR)

Variable only:

Value and Variable


(VAL/VAR)

Variable name and live value


Value Over Variable displays the live value larger
than the variable:

Variable Over Value displays the variable name


larger than the live value:

4-22 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Variable Inline with Value both display larger and may


overlap other shapes in the diagram:

Modifying Live Values


While you are connected online to a controller, and the controller is not in Locked
mode, you can change the current value stored in a variable. Optionally, you can also
force the new value, which prevents programs defined in block diagrams from
overwriting your choices.
Logic forcing procedures can result in personal injury or
death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine. Forcing
of control logic for an operating process is strongly
discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly enforced
in conjunction with this procedure.
To change the value of a variable while online
From anywhere variables are used in the Software tab, double-click a variable
value to display the Send Value dialog box. A dialog box displays that is
appropriate to the data type of the variable. Refer to the following variables.
Note When the controller is in Locked mode, double-clicking on a variable value
displays the following message.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-23

Boolean Values

Displays the current


value of the
variable.
Select an option to
select a True or False
value for the variable.
Check this box to
prevent programs from
overwriting your selected
value.

Click here to send the Next


Value to the controller and
close the dialog box.

Click here to invert the current


value and immediately send it
to the controller without closing
the dialog box.

Numerical Values

Current value
of the variable
Enter new
variable value.

Enter a value to
be added to , or
subtracted from ,
the variable.

Select the Force


Value check box to
prevent programs
from overwriting
your select value.

Click to send the


Next Value to the
controller and close
the dialog box.

4-24 Chapter 4 Block Diagram Editor

Click the Send button to


send the Next Value to
the controller without
closing the dialog box.

Click to increase or
decrease the variable
by the delta value and
send to the controller.

GEH-6700J ToolboxST

Array Values
When you are finished
changing values, click here
to close the dialog box.

Double-click an element of
the array to display the
associated Send Value
dialog box.

Shape Drawing Tools


Several drawing tools allow you to customize the Block Diagram. These drawing
tools create shapes, which are elements of graphics or text that provide additional
visual information on a drawing sheet. They are accessed from the Block Diagram
Editor toolbar.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-25

Variable Rail Tool


The Variable Rail Tool
arranges inputs along the left side of a particular
sheet and outputs along the right side to improve readability. It inserts a variable
reference that can be wired to a block pin and moved around freely.
Outputs

Inputs

Variable displays the variable represented by the shape.


Top displays the top location of the variable shape.
Left displays the left location of the variable shape.
Width displays the width of the variable shape.
Variables on a variable rail display with symbols and cross references that indicate
the role of the variable in the system.
Note The Variable Rail tool is only used in Manual Layout mode (refer to the
section, Layout Modes). When you select the Variable Rail tool, a message box
displays that allows you to switch to this mode.

4-26 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Local
input
Global
variable
Undefined
variable

EGD
variable
Pin
callout

Note For each variable on the rail, cross references to other variable usages display.

Adding a Variable Rail


To add a variable rail
1

From the Block Diagram Editor, select the Variable Rail drawing tool.

Press and hold the left-mouse button on the blockware diagram sheet, then drag
the mouse until the size and location of the new variable rail displays. Release
the mouse button when you are satisfied with the location of the rail.

To define a rectangular
area for the rail, click
and drag the cursor.

Note Clicking in the right or left two inches of the sheet docks the rail to the sheets
edge.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-27

Adding Variables to a Variable Rail


To add a variable to a rail
From anywhere within
the rail, double-click
then enter the variable
name in the text box
that displays.

OR
Drag a pin or variable
from a block to the rail.

OR

Right-click the
rail to add
either a Global
Variable, a
Local Variable
or select from a
list of recently
used variables.

4-28 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Note Variables from other windows (Watch Windows, Trenders, and such) can be
dragged and dropped into a variable rail, as well.
Click to select a desired variable, then drag the variable from the rail and drop it
onto a Block pin to form a wired connection.

Managing Variables on a Rail


Variables attached to a rail can be manipulated in different ways.
To connect variables on a rail to a block pin
Drag a variable from the rail and drop it into a block pin to form a wired
connection.
To move variables on a rail
Select and drag the variable from the rail to the desired location.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-29

Working with Variables


To work with variables
Right-click anywhere in the Variable Rail to display the following shortcut
menu.

Go To Where Used displays a list of all places that the selected variable is used
(hardware I/O, EGD page, and such)
Add To Trend add the selected variable to a defined Trender.
Add To Watch adds the selected variable to a defined Watch Window.
Go To Definition navigates to the location where the variable is defined. It
automatically selects the Where Used tab in the Component InfoView.
Change Live Value displays the Change Live Value dialog box (you must be
online to use this menu option).
Add To EGD allows you to set the EGD page for the selected variable.

Text Tool
The Text Tool allows you to enter text anywhere on the diagram. While this tool is
useful in Manual Layout mode, the Description property of each block may be a
more appropriate way to add text when working in one of the two automatic layout
modes.

4-30 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

To use the Text Tool


Click at the desired upper left corner of the text field, drag to the desired lower
right corner and release the mouse button. Enter the text in the dialog box that
displays and click OK. The new shape is added to the drawing.
The shape created by the text tool has the following properties:
Text displays the text displayed by the text shape.
Text Font displays the font used to display the text.
Foreground Color displays the color of the text.
Filled, if set to True, causes the text shape to use the Fill Color as a background
color.
Fill Color displays the background color shown behind the text if Filled is set to
True.
Top displays the top location of the text shape.
Left displays the left location of the text shape.
Height displays the height of the text shape.
Width displays the width of the text shape.

Rectangle/Ellipse Tools
The Rectangle and Ellipse Tools draw simple geometric shapes with
configurable line and fill colors.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-31

To use the Rectangle or Ellipse Tool


Click the desired upper left corner of the shape, drag to the desired lower right
corner and release the mouse button. The new shape is added to the drawing.
The Rectangle and Ellipse shapes have the following properties:
Line Color displays the color of the shape's line.
Line Thickness displays the thickness of the shape's line.
Filled when set to True, causes the shape to be filled with the color specified in the
Fill Color property.
Fill Color displays the color the shape is filled with when Filled is set to True.
Top displays the top location of the shape.
Left displays the left location of the shape.
Height displays the height of the shape.

Image Tool
The Image Tool inserts a Windows Metafile (.wmf) or Enhanced Metafile (.emf)
into the diagram.
To use the Image Tool
Click the desired upper left corner of the shape, drag to the desired lower right
corner, and release the mouse button.Then, in the Browse for Image dialog
box, provide the path to the .wmf or .emf file that contains the image and click
OK. The image is added as a shape to the drawing.
Note The image file is not embedded in the diagram. All images must be distributed
separately from the .xml files for the diagram.
Image shapes have the following properties:
Metafile Path displays the path to the .wmf or .emf file containing the image that is
displayed.
Left displays the left location of the shape.
Top displays the top location of the shape.
Width displays the width of the shape.
Height displays the height of the shape.
Tip To ensure that images can be found when the diagram is moved on the hard
disk, avoid hard-coded path names or mapped drive names. Relative names, such as
..\Metafiles\bom1.wmf are best.

4-32 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Additional Toolbar Buttons


Full Screen Editing toggles the Library View, InfoView, and TreeView on and
off. When in full screen mode, more space is allotted to the Block Diagram Editor
for working with large drawings.
Detached View Window displays a new window containing a Block Diagram
Editor by itself (without the TreeView or InfoView). The new window displays the
same diagram as the main view, but can be scrolled and zoomed independently.
Tip You can have as many detached views as desired, which can be convenient for
moving pins from one drawing to another drawing.
Alignment Tools are available when multiple drawing shapes are selected (either
by drawing a selection rectangle around multiple shapes using the Pointer tool or by
holding the CTRL key while selecting additional shapes). The tool modifies the
location, width, or height of each shape to match the selected aspect of the primary
selected object (denoted with green selection handles). The Top, Bottom, Left, and
Right alignment tools affect location, while Width and Height adjust size. Arrange
Horizontal and Arrange Vertical equally space all of the selected shapes along the
Horizontal or Vertical axis.

Diagram Settings
The Diagram Settings dialog box contains options that change how the Diagram
Editor operates, as well as style options such as paper size. In most situations, these
settings are consistent across all diagrams in a system, but occasionally a particular
drawing may need custom settings. The diagram settings are arranged hierarchically
with system level settings in effect unless other settings are configured. These
settings can be overridden by the device or library settings, which take effect at the
Component Editor level. The user settings, saved on a per user basis, override the
device or library settings, and finally the diagram settings are saved per diagram and
override all other settings.

Diagram
User
Device or Library
System

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-33

For example, if the system settings specify the paper size as Letter, the library and
user settings specify Use Parent Setting, and the diagram settings set the paper size to
Legal, that diagram would be shown on legal-size paper while all other diagrams
would be shown on letter-size paper.
To configure diagram settings
1

Right-click an open area of a diagram while in Edit mode and select Diagram
Settings. A dialog box displays with the available scopes.

Select a scope to edit System, Device or Library, User, or Diagram


and click OK. The Edit Dialog Settings dialog box displays.

4-34 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

The Edit Diagram Settings dialog box allows you to edit the following options:
Size selects the paper size.
Landscape, when checked, makes the longest dimension of the paper, the
horizontal dimension, creating a drawing that is wider than it is tall.
Font Sizes controls the font sizes in the diagram.
Hide Unused Pins, when checked, hides unconnected pins.
Show Block Drawings, when checked, graphically displays block operation
whenever possible.
Show Wired Pin Connection Text, when unchecked, hides the connection text
for wired pins, reducing clutter on the drawing.
Tip Selecting the Default to parent setting or a dimmed check box indicates that
you have no preference at the current level. The diagram uses the settings from the
next level down in the hierarchy.

Rung Editor
Boolean logic functions are added to a block diagram inside special blocks called
rung blocks. Rung blocks are named after a component of a Relay Ladder Diagram
(RLD). In a RLD, one or more contacts (which function similarly to a mechanical
relay switch) are connected as a control network for a single coil, or output. As the
diagram is formed with two vertical buses, one representing power and one
representing ground, the completed diagram resembles a ladder, with each coil and
associated contacts resembling a ladder rung. Rung blocks, like the rungs in a relay
ladder diagram, control a single output.

GEH-6700J ToolboxST

Chapter 4 Block Diagram Editor 4-35

The Rung block controls variable values using Boolean logic equations. While you
can specify a Boolean logic equation directly by connecting it to the EQN pin of the
rung block, a graphical RLD Editor is also available to simplify the process.
To open the RLD Editor
From a Block Diagram, double-click a Rung Block.
or,
Right-click a Rung Block. From the shortcut menu, select Edit Ladder
Logic.
The RLD Editor window consists of both a 16x16 or smaller grid of cells that can
contain contacts or wires and a set of tools used to edit the contents of the cells.

Wiring tools

Display the current


equation or error message.

Drag separators to add


or remove columns.

Click OK to save or Cancel


to discard changes.

Drag separators to
add or remove rows.

4-36 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

Contacts
Each contact represents a virtual relay switch that is controlled by a Boolean
variable. Contacts that either represent a variable directly
or the negation of the
variable are added to a ladder diagram using the contact tools.
To add a contact

that matches the type of contact you want

Select the contact tool

changes to reflect the selected contact type.

to add. The mouse cursor


2

Click a cell to add a new contact.

Double-click inside the cell above the newly inserted contact to open the
Connect Contact dialog box.

Check this box to change


all references to the listed
variable in the rung.

Enter or select a variable


to connect to the contact.

Wires
Wires are used to connect contacts to the coil and to each other.
To add a wire

Select the Wire tool

, and then click a location on the grid.

Wires can only be drawn vertically or horizontally, as demonstrated below:

A good wire

GEH-6700J ToolboxST

A bad wire

Chapter 4 Block Diagram Editor 4-37

Coils
The diagram always has one coil.
To connect the coil to a variable
Double-click the coil to open the Connect Contact dialog box. (Refer to the
section, Contacts .)

Adding Rows and Columns


Up to 16 rows or columns can be added to the grid to provide enough space for large
logic diagrams.
To add or remove rows or columns
Drag the boundary between any row or column. Blue text will display indicating
the result of the action.

Errors
You can create rung diagrams in the RLD Editor that do not convert to compatible
Boolean logic functions. Typical errors include not connecting a contact to a
variable, creating a wire or contact that is not connected to power and ground, or
creating a short circuit. If you make one of these mistakes, text will display on the
status bar to help you resolve the error. (When the output equation is displayed on
the status bar, the diagram is correctly drawn and no errors are detected.)

4-38 Chapter 4 Block Diagram Editor

GEH-6700J ToolboxST

CHAPTER 5

Chapter 5 Sequential Function Chart


(SFC)
A Sequential Function Chart (SFC) is a graphical programming model that allows
you to organize an application by creating a state machine containing three types of
components: Steps, Actions, and Transitions. Begin by opening a ToolboxST system
and creating a Mark VIe component (refer to Chapter 6, the section Creation
Wizard.

Creating an SFC
To create an SFC
1

From the Mark VIe Component Editor, select the Software tab, then rightclick the Programs item and select Add Program to add a program.
Right-click Prog1, then select
Add Special Task and Add
Sequential Function Chart
from the drop-down list. The
Add Sequential Function
Chart dialog box displays.

GEH-6700J ToolboxST

From the Add a Sequential Function Chart dialog box, add an SFC, then
click OK. The new SFC displays in the Tree View.

Chapter 5 Sequential Function Chart (SFC) 5-1

From the Tree View, click newSFC


to display the SFC logic editor .

From the toolbar, click the Edit SFC


button to allow changes to the logic.

From the logic editor, you can define and edit the SFC.
Note When the SFC is created, the Initial Step is already defined.
The following properties are available in the Property Editor when the SFC item is
selected in the Tree View:
Description provides a description of the SFC.
Name is the name of the SFC.
EGD is the EGD page that contains all published variables from the SFC.
New Transition Condition Options sets the default contents of the Transition
condition logic.
Protection provides access rights.
Put Action of Interest Status on EGD, if set to True, publishes the Action of
Interest status variables on the EGD page.
Put Step Active Times on EGD, if set to True, publishes the Active Time
variable for each Step on the EGD page.
Put Transition Progression Status on EGD, if set to True, publishes the
Transition progression status variable for each Transition on the EGD page.
Version is the user-defined version of an SFC.

5-2 Chapter 5 Sequential Function Chart (SFC)

GEH-6700J ToolboxST

Editing an SFC
To edit an SFC
From the toolbar, click the Edit SFC

button.

The button changes to display


Editing SFC and the toolbar is
populated with additional buttons.

Toolbar Buttons

Button

Use to
Toggle between editing and viewing modes

Edit SFC
Run the SFC
Run SFC
Pause the SFC
Pause SFC
Reset a paused SFC (if the SFC is running, Reset is disabled)
Reset the SFC
Place a Hold on every Transition in the SFC
Single Step
SFC Status

Display the following states:

(Offline) indicates that the ToolboxST application is not online with the controller
PAUSED indicates that the SFC is not running (Action and Transition condition
logic is not running)
RUNNING indicates that the SFC is active (Action logic in active Steps is running,
and Transitions are being evaluated
SINGLE STEP indicates that the SFC is active, but a Hold was placed on all
Transitions.

COMPLETE indicates that the END Transition was reached and the SFC is
complete
Change the zoom level of the SFC logic editor
Zoom In, Zoom Out
Select Steps and Transitions
Select Tool
Create a new Step
Step Tool
Create a new Transition
Transition Tool
Create a new END Transition
END Transition Tool
Align multiple selected shapes
Alignment Tool

GEH-6700J ToolboxST

Chapter 5 Sequential Function Chart (SFC) 5-3

To add a Step
From the SFC toolbar, click the Step button

When you click the Step button and move the


cursor to the logic sheet, Click to add Step
displays. Click to display the Add Step dialog box.

Enter a name, then click OK. The


new Step displays in the logic editor.

To add an Action
From the SFC toolbar, click the Select button
The Edit actions for step dialog box displays.
Click the Add Action
button to add an action.

From the Qualifier column, select the


action qualifier (refer to the table below).

From the Action Logic Sheet column,


click Edit Action Logic to edit the
blockware logic for the action.

5-4 Chapter 5 Sequential Function Chart (SFC)

, then double-click a step.


Select the check box to make
this an Action of Interest.

From the Qualifier drop-down list, select


P:Pulse (Action runs once), which causes
the Action to run only once when the Step
becomes active.

GEH-6700J ToolboxST

Action Qualifiers
Qualifier

Description

The Action runs every frame that the Step is Active.

The Action runs for a specific number of milliseconds while the Step is
Active, indicated by the Time value, then stops running.

The Action does not run until the number of milliseconds indicated by the
Time value has been reached, after which the Action runs every frame the
Step is Active.

The Action runs only once and is triggered by a rising edge on the Actions
Pulse Input.
L and D Action Qualifiers: A Time value, either a reference variable or an
immediate value, must be specified in the Time column for the Action.
P Action Qualifier: A Pulse Input Boolean value must be specified in the Pulse
Input column for the Action.
By default, a PERMIT block is automatically created in a new Transition. The output
of the PERMIT is connected to the Transition_Condition_Value, and any conditions
for the Transition can be connected to the PERMITs inputs.

The PERMIT standardizes the Transition conditions so that HMI screens have a
common method to display information about Transitions.
Note The Active and Finished fields indicate the status of the Action.
To define an Actions logic
From the SFC toolbar, click the Select button, then double-click a step. The
Edit actions for step dialog box displays.
An Action can be authored in Terms of Blockware in the logic sheet.
Note Always connect the Action_Finished local variable to a Boolean expression.
The Action_Finished variable enables the Actions of Interest feature to know that the
Action has finished its operation. This is recommended even if the application does
not use Actions of Interest.

GEH-6700J ToolboxST

Chapter 5 Sequential Function Chart (SFC) 5-5

Adding a Transition
To add a Transition
From the toolbar, click the Transition button
, then move the cursor to the
sheet and click. The Add Transition dialog box displays.

Enter a name, then click OK. The new


Transition displays in the logic editor.

To define a Transitions condition logic


From the toolbar, click the Select button, then double-click a Transition.
A Transition Condition can be authored in Terms of Blockware.
Note Always connect the Transition_Condition_Value local variable to the result of
the Transition Condition Boolean expression. The Transition_Condition_Value
variable enables the SFC to progress if the Transition Condition Value evaluates
True when the Transition is Active.

5-6 Chapter 5 Sequential Function Chart (SFC)

GEH-6700J ToolboxST

To use a Steps Action of Interest status in a Transition condition


From the toolbar, click the Select button, then double-click a Transition.

GEH-6700J ToolboxST

Chapter 5 Sequential Function Chart (SFC) 5-7

Using a Transition conditions Boolean expression, such as defining whether or not


the configured Actions of Interest for the Initial Step have been completed, add a
Move Block whose source (SRC) pin is
MySFC.Initial_Actions_Of_Interest_Status global variable and whose destination
(DEST) pin is Transition_Condition_Value local variable.

A Steps Action of Interest Status is referenced from a Transition Condition.

Adding an End Transition


To add an End Transition
1

From the toolbar, click the End Transition button

Move the cursor to the SFC logic sheet to place the End Transition. The Add
Transition dialog box displays. Enter a name, then click OK.

5-8 Chapter 5 Sequential Function Chart (SFC)

GEH-6700J ToolboxST

To move a Step or Transition

GEH-6700J ToolboxST

From the toolbar, click the Select button, then click the Step or Transition to
be moved.

Move the Step or Transition to its destination.

Chapter 5 Sequential Function Chart (SFC) 5-9

To connect Steps to Transitions


From the toolbar, click the Select button, then click the Step to be linked.

Move the cursor to the


Transition to be linked.

5-10 Chapter 5 Sequential Function Chart (SFC)

GEH-6700J ToolboxST

Variable Connections
There are several required variable connections when defining SFCs in the
ToolboxST application. When defining a Transitions Transition Condition, always
connect the Boolean expressions output to the Transition_Condition_Value local
variable. This enables the Transition to progress.
When defining a Steps Action Logic, always connect a Boolean expression to the
Action_Finished local variable. This enables Actions of Interest Control to be used in
the SFC by having the Action state when it has finished. This is recommended even
if Actions of Interest Control is not being used in the application. It makes using the
Actions of Interest Control feature in the application much easier later in
development if needed.

SFC Online Operations from the ToolboxST Application


To run an SFC in a controller from the ToolboxST application
1

From the Mark VIe Component Editor, click the Go On/Offline icon to go
online with the controller.

From the Software tab Tree View, select the SFC item to open the logic sheet
.

From the toolbar, click the Run button


displays.

. The Run SFC dialog box

Click OK to
continue.

To pause the SFC, click the Run button to display the Pause SFC dialog box,
then click OK.

To reset an SFC back to its Initial Step


From the toolbar, click Reset button
to display the Reset SFC dialog
box, then click OK. The reset Initial Step displays green.
Note The SFC must be either paused or complete to reset.

GEH-6700J ToolboxST

Chapter 5 Sequential Function Chart (SFC) 5-11

Changing SFC Modes


To change an SFCs mode
to display the Single Step

From the toolbar, click the Mode button


Mode SFC dialog box, then click OK.

To place the SFC back into Free Running mode, click the Mode button again to
display the Free Running mode SFC dialog box, then click OK.

Note When the SFC is placed into Single Step Mode, all Implicit Holds are removed
from Transitions, and previously set Operator Holds are restored.
To apply or remove Operator Holds
1

From the logic sheet, right-click the Transition, then select Apply HOLD to
Transition to display the Apply HOLD to Transition dialog box.

Click Yes to apply


an Operator Hold
to the Transition.

To remove an Operator Hold, right-click on Transition, then select Remove


HOLD from Transition.
To acknowledge a HOLD applied to a Transition
From the logic sheet, right-click the Transition that has a HOLD applied, then
select Acknowledge Hold to display the Acknowledge Hold dialog box.

Click Yes to
acknowledge
the Hold.

Note If the Transition Condition for Trans1 was set to True at the time the HOLD
was acknowledged, the SFC would continue.

To apply a FORCE to a Transition


From the logic sheet, right-click the Transition then select Force Transition
to display the Force Transition dialog box.

Click Yes to force the


Transition to proceed.

5-12 Chapter 5 Sequential Function Chart (SFC)

GEH-6700J ToolboxST

Publishing an SFC on an EGD Page


AN SFCs Control and Monitor interface, which can be placed on an EGD page,
includes the following items.

Run

Reset

Transition Hold

Transition Hold Acknowledge

Transition Force variables

In addition, the SFCs Step Active Flags, Transition Active Flags, and Transition
Condition Value are placed onto EGD automatically.
The user has an option to place items from the SFC Monitor Interface on EGD.
These items include Action of Interest Status, Transition Progression Status, and
Step Active Times variables. By default, the Step Active Times are automatically
placed on EGD in the ToolboxST application.
To place an SFC and its Control Interface on EGD
1

From a Mark VIe Component Editor, select the Software tab, then from the
Tree View, select an SFC.
From the Property Editor, select EGD
Page. From the drop-down list, select
the EGD page on which the SFC and its
control interface will be published.

GEH-6700J ToolboxST

To remove the SFC from EGD, use the same drop-down list and select the blank
entry.

Chapter 5 Sequential Function Chart (SFC) 5-13

To place other SFC activities on an EGD page


From the Property
Editor, select True for
each of the SFC
activities to place them
on an EGD page.

5-14 Chapter 5 Sequential Function Chart (SFC)

GEH-6700J ToolboxST

CHAPTER 6

Chapter 6 Mark VIe Component


Editor
Creation Wizard
Mark VIe components are created from the System Editor by using the Mark VIe
Creation Wizard screens.
To create a component
From the System Editor Tree View, right-click the system name and select
Insert New from the shortcut menu.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-1

Enter a Name for the new


controller (up to 32 alpha/
numerical characters)

If you do not have the


configuration for a particular
controller, but know its IP
address, click to select
Upload from Controller.

6-2 Chapter 6 Mark VIe Component Editor

When Specify Controller Information


is selected, enter the Name, then
select the Application ( the default is
General Purpose) and Version (the
default is the latest version)

Enter the IP
Address.

Click Next
to continue.

GEH-6700J ToolboxST

Click Finish to accept the default libraries.


A new controller component is added to
the system and the System Editor
updates to reflect the changes.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-3

The Mark VIe component editor displays in the Tree View and in the Summary
View.

6-4 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To open the Mark* VIe Component Editor


From either the System Editor Tree View or the Summary View, doubleclick the Mark VIe component. The Mark VIe Component Editor displays.
The Summary View provides an
overview of the item selected in the
Tree View . It can be used to monitor or
edit an item.
Tabbed pages organize
the different elements of
the components
configuration.
The Tree View lists all
major component items.
The list changes when a
different tab is selected.
The Property Editor
allow you to edit the item
selected in the Tree or
Summary View.

The Component
InfoView displays
feedback information on
the currently selected tab.

To edit the component


From the Component Editor, click an item in the Tree View. The
configuration information for that item displays in the Summary View and
Property Editor.
Existing components can also be imported from a file.
To import an existing component
In the Tree View, right-click a parent component (either a system or a group),
select Insert Existing, then select Device. Select the Device .xml file for the
component to be imported and click Open.

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

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-5

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
resize the Tree View and
the Property Editor
within their shared view.

Double-click on the
double bar to view the
Property Editor in a
separate detached
window.

The List by Category


button allows you to view
the list of properties
organized by category.

The Alphabetical List


button allows you to 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
Click the

button to change the value from a dialog box.

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.

6-6 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

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

The Component InfoView contains several tabs that provide status information.
(Depending on the open component type, additional tabs may also be available.)
Log tab displays messages related to user commands or system events issued in the
ToolboxST configuration.
Tip If there is a build problem, the error is listed on the Log tab. Double-click the
error. The input focus goes to the location in the component configuration where the
error occurred.
Status tab displays operating state and equality information about the Mark* VIe
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-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-7

Log Tab
When the Log tab is selected, three buttons display in the toolbar at the bottom of the
Component Editor.
Click each of the buttons to hide the corresponding
items (for example, click the Warning button to hide
the warnings in the Log tab).

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

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


then select Go To.

6-8 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

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.

Click to select
entire grid.

Sort indicator

Drag borders to
resize columns

Column
headers

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
same value for multiple rows

GEH-6700J ToolboxST

Left-click the row header for the first row to be edited. 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.)

Chapter 6 Mark VIe Component Editor 6-9

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

Do this:

Resize a column

Drag the vertical bar on the right of the column header to a new location.

Quickly remove a single column

Right-click the column header and select Hide Column.

Move a column to a different location

Drag the column header to a new location.

Sort by a column

Click a column header. The column sorts in ascending order. To sort in


descending order, click the column header again.

Reset columns to the original


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

Remove selected
columns from the
data grid.

Move the
selected
column up or
down in the
column order.

Remove all
columns from the
data grid.

6-10 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

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
in the destination grid and select Paste Row(s) to insert the row into its
row
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, rightin the destination grid and select Paste
click the header for the append row
Row(s) to insert the rows into their new location.

Copy and paste a range of two or


more cells

Click the top left cell of the desired range and drag to the bottom right cell. Rightclick 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,


Trender window or Watch Window
from a data grid

Arrange windows on screen so both the source grid and a destination block
diagram, Trender window or watch window are visible. Then, drag the row header
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.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-11

Component Options
The ToolboxST application provides settings that change the way various functions
within the component operate.
To open the Settings dialog box
From the Component Editor, select the Options menu, then select Settings
to display the Settings dialog box.
Note In the Settings dialog box, categories are listed in a Tree View on the left side
of the dialog box.

The Mark VIe Controller options include the following.


Controller Parallel Online Download, when set to True, allows you to
download application code to redundant controllers in parallel.
Show Boot Loader displays the boot loader in the Download Wizard when it does
not have to be downloaded.
Enable I/O diagnostic Alarm Events, when set to True, makes available I/O
diagnostic alarm events for automatic updates in the I/O Diagnostic Viewer.
Show Diagnostic Icons, when set to True, displays diagnostic icons in the Tree
View and serves as a permissive to show more enhanced diagnostic icons in both the
Tree View and the Summary View.
Show More Enhanced Diagnostic Icons, when set to True, displays enhanced
diagnostic icons in the Tree View and the Summary View (Show Diagnostic Icons
must be set to True for this option to be enabled).

6-12 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Security
The security provided in the ToolboxST application is based on passwords entered
by the user. Passwords ensure that only authorized persons can view or make
changes to system components.
The two types of protection available are called Access Rights.

Modify Data allows you to make changes to data values associated with an
object without changing how it works. For example, it protects the initial value
of a variable defined in a controller. The purpose of this right is generally to
keep unauthorized persons from making unsafe changes to settings.

Modify Design allows you to change the way a protected object works. For
example, this protects block creation and editing of connections within a library
block diagram. The purpose of this right is to limit the ability to change how the
system works to authorized persons.

A protected object can have one or more of these access rights (refer to the section,
Protected Objects ). Each right can have a different password set. Some objects can
be protected if they are contained in another parent object, which is protected by its
own password(s).

Passwords
Whenever you attempt to perform an operation on a protected object, the Enter
Password dialog box displays.
The title bar indicates which access right is protected.

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

Enter the password, then


click OK.

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

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-13

To change an existing password


1

From the Property Editor, expand the Protection item.

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

The title bar indicates


which access right the
change will apply to, for
example, Modify Design.
Enter the new
password twice. A valid
password consists of
six or more characters,
letters, or numbers, and
is case-sensitive.

Click OK to apply
the change.

Password Caching
The security system caches passwords that were previously entered so that once you
enter a unique password, you dont have to enter that password again. Separate
caches are maintained for the system and each major component (such as a Library
Container). A cached password remains until the component is closed.
Note From the Device menu, select Restore Password Protection to clear all
passwords and protect the component.
Tip If you have performed an operation in the ToolboxST application that requires
entering a password, it is recommended to close the protected component when you
are done so that an unauthorized user does not gain inappropriate access.

6-14 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Viewing Protection Status


The protection status for a component displays in the Property Editor. The following
example shows the protection for a Mark VIe component.

From the Property Editor,


expand the Protection item
to display the access rights
for a Mark VIe component.

The Protection properties are as follows:


Modify Data allows you to modify data values and forcing of variables.
Logic forcing procedures can result in personal injury or
death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine.
Forcing of control logic for an operating process is strongly
discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly
enforced in conjunction with this procedure.
Modify Design allows you to modify the component design.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-15

Protected Objects
Specific actions governed by each access right depend on the specific component
type. Examples of protected objects are:
System can only have a Modify Design password. If present, it prevents you from
adding or deleting system components.
Device can have Modify Data and Modify Design passwords. Modify Data prevents
you from saving changes or changing initial values for variables defined in the
component's application software. Modify Design prevents you from modifying any
aspect of the hardware or software configuration for the component.
User Block Library can have passwords for all three access rights. They have no
direct effect on the block library, but are inherited by all block definitions within that
library.
User Block Definition can have passwords for all three access rights. If block
passwords are not applied, the passwords on the library container apply to the
definition.
User Block Instanced in a program can be given its own passwords for Modify
Data, Modify Design, or View Design. If none are assigned, it takes on the Modify
Data and Modify Design protection for the parent component. The passwords
assigned to an instance of some block in a user block library are initially set to the
passwords that were in force in the definition of that block. Once instanced though,
any changes to the protection on the block definition do not propagate to instances of
that block.

6-16 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

General Tab
The General tab allows you to configure general properties and attributes of a Mark
VIe controller, including redundancy (simplex, dual, or Triple Modular Redundant
(TMR)) and frame rate (its basic scheduling rate).
To configure Mark VIe general features
From the System Editor, double-click the Mark VIe Component to display
the Mark VIe Component Editor. The General tab is selected by default.

The Tree View lists the


items that can be configured
on the General Tab .
The list of items changes
when a different tab is
selected.

Property Editor
allows you
to edit the item
currently selected in the
Tree View.

The Component InfoView


displays feedback
information about the
currently selected item.
The Summary View provides an
overview of the controller.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-17

The following properties are available in the Property Editor when the General item
is selected in the Tree View:
Command Event Log stores information about alarm transitions, event
transitions, variable set commands, and such on the controller file system. This data
can be viewed for analysis by an external client through a web interface.
% Command Size specifies the maximum size (as a percentage) of both the
command and event portions of the Command and Event log.
% Event Size specifies the maximum size (as a percentage) of the event portions of
the Command and Event log.
Log to Disk specifies whether Command events should be logged to the
CompactFlash on the controller.
Time specifies the number of days that the Command and Event log is kept if the
allocated space is not exceeded.
Compressed Data Log activates the compressed data logging, which causes
selected variables to be collected in the controller data log file.
Note The Compressed Data Log property is only available when the application
running is a 1.5 MW Wind Turbine.

6-18 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

% Size specifies the maximum size (as a percentage) of the Compressed Data log.
Average Interval Time specifies the interval in minutes over which the data is
averaged and stored.
Enable Compressed Data Log, when set to True, activates the Compressed Data
Log. This causes selected variables to be collected in the controller data log file.
Time specifies the number of days the Compressed Data log will be kept so long as
the allocated space is not exceeded.
Controller Web Pages, when set to True, enables access to controller web pages
if they are provided by the controller or another product. The controller can provide a
set of default pages as part of the firmware download. Product web pages can also be
downloaded to the controller. For example, the 1.5MW Wind Turbine uses productspecific web pages that are downloaded separately.
Enable Controller Web Pages, when set to True, activates the Web server on the
controller. It also displays the Web Page Tab.
Password allows you to create or change a password.
Web File Path is the directory used as the web page source when downloading
product web pages to the controller.
Application reflects the application type.
Controller Backup Option determines how backup files are handled during the
Build and Download commands.

Automatic, the default, creates backup files in a device.zip file during a Build
command, and provides an option in the Download Wizard to download the
device.zip file.

Manual mode does not create a device.zip file so there is no option to download
backup files from the Download Wizard.

Enable Auto-Reconfiguration, if set to False, disables the AutoReconfiguration feature (the default is True).
Enable Incremental Build, if set to False, disables the Incremental Build feature
(the default is True).
Major Revision is the time of the build performed after the most recent major
change. (Major changes require the controller to be restarted after download.)
Minor Revision is the time of the build performed after the most recent minor
change (minor changes do not require a controller restart).
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 can only be changed from the
System Editor.
NTP Configuration Mode determines how the Network Time Protocol client
synchronizes the controller time. Valid options are:

GEH-6700J ToolboxST

Disabled The controller does not perform any time synchronization.

Broadcast The client listens for NTP broadcasts on the network.

Unicast The client uses the specified servers to obtain the time.

Chapter 6 Mark VIe Component Editor 6-19

Configuration Manual Override, when set to True, allows you to manually


override all settings for the local device rather than use the settings configured at the
system level.
Mode is the mode of the NTP client.
NTP Configuration Primary Server is the IP address of the primary server used
when unicast mode is selected.
NTP Configuration Secondary Server is the optional IP address of a secondary
(backup) server used when unicast mode is selected.
Platform is the type of hardware on which the Mark VIe control code is started.
Product Version is a read-only property that reflects the version of the Mark VIe
product associated with the selected component. The version number is set when the
configuration is first created, and is updated with each upgrade operation.
Profiler Enabled determines if the controller load profiler is enabled.
Protection provides the following two access rights:

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

Modify Design permits modification of the design of the controller.

Redundancy determines the level of redundancy of the controller. The following


choices are available:

Simplex a single non-redundant controller.

Dual a two-controller configuration where one controller provides backup for


the other.

TMR a triple module redundant configuration where there are three controllers
that vote on decisions for reliability.

OPC Properties includes the following two properties:


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 a
diagnostic alarm in the normal condition. This value is used for display purposes on
the WorkstationST Alarm Viewer.
Background Period reflects the timeframe, in seconds, of blocks with background
methods.
Frame Period determines the frame period in milliseconds. A frame is the basis for
Mark VIe scheduling; the frame period determines the fastest scan time, the rate at
which first class I/O is scanned, and the fundamental frequency for the scheduling of
all tasks.

6-20 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Note he two properties below are only available when the application running is a
1.5 MW Wind Turbine.
Enable Wind Farm Management System, when set to True, allows a wind
turbine to be controlled by the wind farm controller.
Wind Farm Management Server IP Address displays the IP address of the
Wind Farm Management Server.
Note The four properties below are only available when the application running is a
Wind Control.
Max Wind Farm Turbines is the maximum number of wind turbines for this
Wind Control. If this number is reduced after the turbines have connected, those
turbines are disconnected from Wind Control when the timeout parameter set in the
Wind Turbine Timeout (sec) property is reached.
Wind Farm Master Number is the master plant number for this Wind Control.
Wind Farm Update Time (ms) is the time, in milliseconds, to update all wind
turbines.
Wind Turbine Timeout (sec) is the time, in seconds, at which timeout data is
received from the wind turbines.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-21

Attributes
Attributes are device-level values that affect how the configuration is generated.
When the Attributes item is selected in the Tree View, those controller attributes can
be edited in the Summary View data grid.

The following columns are available:


Name is a unique identifier for the attribute.
Description stores added comments about the attribute.
Value displays and modifies the current attribute value.

6-22 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Attribute Value Editor


The Attribute Value Editor allows you to enter values for a wide variety of data
types.
To open the Attribute Value Editor
From an attribute Data Grid, click a Value Cell, and then click the ellipsis
button. The Modify Value dialog box displays.
If the attribute uses an
enumeration, use this drop-down
list to select a predefined value.

The name of
the attribute
being modified

The value of
the attribute

If checked, the
attribute values
are restricted to
an enumeration
(a predefined set
of allowable
values).

To add a value to the enumeration, enter the Name,


Value, and (optionally) a Description, then click OK.

GEH-6700J ToolboxST

The Data Type


of the attribute

Chapter 6 Mark VIe Component Editor 6-23

Network Adapters
The network adapters that are present in the controller display as items in the Tree
View. The number of adapters depends on the controllers hardware type and
configuration. In most applications, Mark VIe controllers have four network
adapters. The first adapter provides connectivity to the Unit Data Highway (UDH),
and any additional adapters are used for I/O networks. Some adapter properties may
be disabled in certain configurations.

6-24 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

When a Network Adapter item is selected in the Tree View, the following properties
display in the Property Editor:
Enabled, if set to False, disables the selected network adapter.
Host Name is the Internet Protocol (IP) host name for the selected network adapter.
IP Address is the IP Address for the selected network adapter.
Wire Speed is the speed of the network to which the selected adapter is connected.
Network sets the network connected to the selected adapter. (Available networks
are determined in the System Editor.)
Subnet Mask controls which portions of the IP address are deemed significant.
(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.)

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-25

Auto-Reconfiguration
The ToolboxST application provides a feature called Auto-Reconfiguration, which
allows you to replace a pack and have the necessary configuration files downloaded
when that I/O pack is replaced. It requires no user interaction once power is restored
to the pack after replacement. The Auto-Reconfiguration feature can be disabled
from the Property Editor. This feature is available with GE ControlST release
V03.05 or higher.

From the General


tab Property
Editor, select False
to disable AutoReconfiguration.

Note The Auto-Reconfiguration feature applies only to I/O packs; it is not available
for controllers or terminal boards. Refer to GEH-6721, Vol II, Mark VIe Control
System Guide for a list of I/O packs.

6-26 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Upgrading
To upgrade the ToolboxST application
Install the new version. Refer to the section, Installation (on page 2). The icons
on your desktop and in your Start menu are updated to start the most recently
installed version.
The GE ControlST CD supports a variety of control equipment. These products
include updated firmware for the equipment and configuration tools that are
available as component editors inside the ToolboxST application. When you install a
new version of the CD, newer versions of some components may be installed as
well. To use the new versions, you must upgrade each component separately.
To upgrade a component
1

Install new software for the component type that you want to upgrade by
installing the latest version of the ToolboxST application.

Start the ToolboxST application and open the system file. Double-click a
component to open its Component Editor.

From the File menu, select Upgrade. The Product Upgrade Wizard
displays.

Click Next.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-27

Select the new


version, and then
click Finish to
upgrade the
component.

6-28 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Compare To Controller
This feature allows you to generate a report that compares the configuration in the
ToolboxST software to the controller configuration.
To generate a Compare to Controller report
1

From the System Editor Tree View, double-click the Mark VIe component
to display the Mark VIe Component Editor.

From the File


menu, select
Compare to
Controller.

The Select Channel dialog box displays.

Select the desired channel, and click OK.

The report displays configuration differences in areas such as hardware and software.
Differences are arranged in appropriate groups and sub-groups.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-29

Compare Devices
This feature allows you to compare the configurations of two different components.
To generate a Compare Devices report

From the File menu, select


Compare Devices
When the Pick Items to
Compare dialog box
displays, select the
component to be compared,
then click the Compare
button.

A Compare Results: window displays differences between the two selected


components, as shown in the example below.

6-30 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Mark VIe Menus


Menu

Command

Use to

File

Save

Save changes to the current system

Print

Generate a paper copy of the entire component configuration

Upgrade

Change the version of the component support software

Compare to
Controller
Compare Device by
Program(s)
Compare Devices Compare ToolboxST component configurations

Edit

View

Import

Import an I/O Variable Report, a global Variables Report or a Block Pin Report from a .csv
file

Close

End the component editing session and return to the System Editor

Undo

Remove the item currently selected in the Tree View

Redo

Add a new component to the current system

Cut

Cut the selected item in the Tree View

Copy

Copy the selected item in the Tree View

Paste

Paste the copied item in the Tree View into the Summary View

Delete

Display the System Information Editor (refer to the section System Information Editor)

Find

Display the Component Editor for the item currently selected in the Tree View

Bookmarks

Mark and toggle between items in the Tree View

Go Back

Return to the view that immediately preceded the current view in the history

Go Forward

Return to the view that immediately follows the current view in the history

Forced Variables

Display a list of forced variables

Logic forcing procedures can result in personal injury or death, if not


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

Display a list of global variables

Trenders

Display a list of Trenders for this component (refer to Chapter 8, Trender)

Watch Windows

Display a list of Watch Windows for this component (refer to the section, Watch Windows)

Live Views

Display live data from the open component

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-31

Reports

Generate any of the following reports:

Variable generates a report of all global or configuration variables in the component. You
can also generate a Web variable report, a Compressed Data Log variable report, or an
EGD point list report.

Block Pin generates a list of all block pins in the configuration.


I/O generates an I/O variable report or an I/O configuration report.
Alarm generates a list of all variables marked as alarms.
Hold generates a list of all variables marked as holds.
Event generates a list of all variables marked as events.
NovRAM generates a report of all variables marked as non-volatile.
IONet EGD provides network status values of all IONet communication displayed in the
current component.

I/O Diagnostics generates a report of all faults, revisions, communication, and hardware
issues.

Coding Practices generates a list of unwritten variables, a list of multiple writes, and a
list of unused I/O variables.
Auto Config generates either a Configuration report or a Difference report.

Device

Control Constants

Generate a list of control constants (refer to the section, Control Constants).

Diagnostics

Display regular and advanced controller diagnostics, as well as I/O status.

Profiler

Display the Controller Load Profiler window

EGD Management
Tool

Start the EGD Management Tool (refer to GEI-100619, EGD Management Tool (EMT).

Online

Connect or disconnect from a controller

Build

Convert the current configuration into binary files that can be downloaded to a controller

Download

Perform any of the following download functions:

Controller Setup opens a wizard that allows you to perform basic configuration tasks.
Download Wizarddownloads base load, firmware, and application code to the
controller and distributed I/O modules.
Update Dynamic Data Recorder exchanges updated information with the DDRs in
the controller.

View/Set Timedisplays a dialog box that manages the controller time.


Upload

Retrieve configuration information from the controller and uses it to create a new controller
component in the system.

Put Device to SDB

Store the component configuration to a System Database (SDB).

Compress Variables Rearrange variables to minimize the amount of space used.


Administer
Totalizers

Open the View/Set Totalizers dialog box.

Restore Password
Protection

Clear all passwords and protect the component.

Options

Settings

Display a dialog box with Mark VIe controller settings.

Help

Contents

Open the Mark VIe editor help file.

Controller Help

Open the Mark VIe controller help file.

Distributed IO Help

Displays a list of pack help files to open.

Release Notes

Display any of the following release notes:


ToolboxST displays current information about your version.
Mark VIe displays current information about your version of the Mark VIe support software.
Distributed IO allows you a list of pack help files to open.

About

Display version and copyright information.

6-32 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Hardware Tab
The ToolboxST application manages I/O packs and terminal boards through a logical
unit called an I/O module. An I/O module consists of up to three I/O packs
connected to a main terminal board and (optionally) one or more auxiliary terminal
boards. The configuration is known as a simplex configuration when one I/O pack is
present, dual if two I/O packs are present, and TMR if three I/O packs are present.
(The configuration of module redundancy is independent of the network redundancy
and controller redundancy settings.)
To help with identification and version management, each I/O pack has an I/O
compatibility code and a configuration compatibility code. These codes identify the
I/O map layout and the configuration area for a pack. For each compatibility code
set, there are multiple hardware forms used to identify physical characteristics of the
pack. Each I/O pack module that can be added to a Mark VIe controller is identified
by both its hardware form factor and its compatibility codes. For example,
PDOA_2_2 represents the discrete output module with I/O compatibility code 2 and
configuration code 2.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-33

Network Redundancy
A controller can have one, two or three I/O networks in a simplex, dual or TMR
configuration. The configuration of network redundancy is separate from controller
redundancy and module redundancy.
To change the network redundancy
From the Hardware tab Tree View, select the Distributed I/O item.

Select the Network


Redundancy item in the
Property Editor, then
select Simplex, Dual, or
TMR from the drop-down
list.

6-34 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Adding Modules
To add a module to a component configuration
From the Hardware tab, right-click the Distributed I/O item in the Tree
View and select Add Module to display the Add Module Wizard.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-35

Select the I/O pack


Redundancy type:
Simplex if one I/O pack is
present, Dual if two I/O
packs are present, and
TMR if three I/O packs are
present. The HotBackup
option provides dual I/O
packs with one active
gateway and one backup.

Select a module type. (The


types of available modules
vary based on I/O pack
redundancy.

Click Next.

Note If the module being added does not have an auxiliary terminal board, the
window shown below does not display.

6-36 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Use the Version drop-down list to select a module


version. Listed module versions depend on the available
compatibility codes.

Click the Release


Notes button to
view additional
information about
the currently
selected module
version.
If the Module Required
check box is selected,
the module must be
present and functioning
for the controller to go
online.
Edit the Bar Code by
clicking the ellipsis button
(the ellipsis button
displays if you are online
when the wizard is
opened).
Click Next to
preview
configuration
information.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-37

Review the configuration summary,


and then click Finish to add the new
module.

6-38 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Organizing Modules
Modules can be organized into groups.
To create a group
From the Hardware tab Tree View, right-click the Distributed I/O item and
select Add Group. The Add Group dialog box displays.
Select the Type (Cabinet or General)
from the drop-down list. Selecting
General changes the icon to a folder
labeled I/O.

Enter a Name (up to eight


alphanumeric characters).

Enter a
Description of
the group
(optional).
Select the Icon to
display in the Tree
View.

Click OK.

To add modules to a group


From the Hardware tab Tree View, drag a module to the desired group. When
the mouse pointer changes to a
the module.

GEH-6700J ToolboxST

symbol, release the mouse button to move

Chapter 6 Mark VIe Component Editor 6-39

Modifying Modules
To modify an existing module
From the Tree View, right-click the module to modify, then select Modify...
from the shortcut menu to display the Modify: [module name] dialog box.

Viewing Modules
Group Layout

Click the folder


icon to select
group layout.

6-40 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Network Layout
Click the folder
icon to select
network layout.

When you select a module from the Tree View, several tabs display in the Summary
View. Each module contains four common tabs (Summary, Parameters, Variables,
and Diagnostics). Many modules also contain custom tabs that configure available
I/O capabilities. For information about the settings configured by I/O pack-specific
tabs, refer to the I/O pack documentation.
For example, the following set of tabs (taken from a PDOA module) contains the
base set, as well as two other tabs, Inputs and Outputs.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-41

Summary Tab
The Summary tab displays a graphical overview of the selected module.

Parameters Tab
The Parameters tab allows you to configure all module-specific parameters. After a
parameter is changed, updated psuedocode files must be downloaded to the I/O
packs, but the download operation is done online and does not require a reboot of
either the controller or the I/O packs.
Note Some infrequently used parameters are classified as Adva
nced and are
hidden by default. To display Advanced parameters, click the Show/Hide
Advanced button on the toolbar.

6-42 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Variables Tab
The Variables tab displays available variables from the module that have no physical
endpoint. These variables exist only internally in the module, and can be connected
to another variable for use in code.

Inputs/Outputs Tabs
This tab contains I/O points (with associated screws in sub-tabs) that have no
meaning to software or firmware, such as those used for excitation.

ExtraCircuits Tab
This tab contains input/output variables found on the module terminal boards, which
can be associated with the application software. For some modules, these tabs are
split into more module-specific input/output tabs that better define their function.

Inputs/Outputs Tabs
These tabs contain input/output variables found on the module terminal boards,
which can be associated with the application software.
Note For some modules, these tabs are split into more module-specific input/output
tabs that better define their function.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-43

It is possible to attach a software variable to an I/O variable. A software item


(programs, tasks, and such) must be defined in the Component Editor Software tab
before this feature can be performed.
To attach a software variable to an I/O variable
From the Data Grid, select a variable.

From the Connected Variable


column, click the Ellipsis button.

The Select a Variable dialog box displays.


Select a defined variable and click OK. The Select
a Variable dialog box closes and the selected
variable displays in the Hardware tab Data Grid.

If the variable is not


defined, enter the
variable name in the
Variable Name field,
then clickOK. The
Undefined Variable
dialog box displays.
Click Yes to display the
Select Where to Place
Variable dialog box.

6-44 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Select the software


item in which to
place the variable,
then click OK.

Alternately, use the following method to attach variables.


Type the variable name,
then press the Enter key.

If the variable name entered is a defined variable, it continues to display and the
cursor moves to the next field.
If the variable name entered is undefined, the Undefined Variable dialog box
displays. Click Yes to select the desired software item, as shown above.

ExtraCircuits Tab
This tab contains I/O variables (with associated screws in sub-tabs) that have no
meaning to software or firmware, such as those used for excitation.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-45

Diagnostics Tab
The Diagnostics tab allows you to check the I/O pack alarms and errors that exist on
I/O packs. Each pack has a unique set of diagnostic signals that can be monitored.
For more information about the fault codes used in an I/O pack, refer to the
Diagnostics section of the I/O pack documentation.
The state
of the fault

Information about icons:


Inactive Alarm(s)
Active Alarm(s)

Status Tab
The Status tab allows you to check the I/O pack version and network communication
status.

Prod ID

EGD producer ID of this exchange

Exch ID

EGD exchange ID

Health

EGD health status

Period

The cyclic period (ms) in which this exchange is transmitted

Size

The size of the exchange in bytes

Port

Port connectivity (IONet connection)

Recv Cnt

The number of times the exchange was received

Missed Cnt The number of times the exchange was not received
Late Cnt

The number of times the exchange was later than expected


I/O pack version equal
I/O pack version unequal

6-46 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Upgrading Modules
It is possible to perform an upgrade to the runtime and the I/O firmware
simultaneously. The component and specific I/O modules can be upgraded to a
newer version of the runtime and firmware, as well.
To perform a unified upgrade
From the File
menu, select
Upgrade. The
Mark VIe Product
and IO Pack
Version Upgrade
Wizard displays.

Click Next to continue.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-47

From the New column,


select the new version
for the upgrade.

Note Modules can be upgraded to a different compatibility code set if one is


available.

6-48 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To upgrade a single module


From the Hardware tab Tree View, right-click the module to be upgraded and
select Upgrade. The Upgrade Module Wizard displays.
For the example module shown below, there are two module versions available: a
PDOA with compatibility code set 2,1 and a PDOA with compatibility code set 3,1.

Click a new
module version
to upgrade the
module.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-49

Enter the Bar Code for


the Terminal Board.

Click Next to continue to the


configuration display screen,
then click Finish.

Note When the ToolboxST V3.05 application is installed, the Upgrade option
allows you to upgrade Mark VIe-related packs to work with the AutoReconfiguration feature (refer to the section, Auto-Reconfiguration). After a
component has been upgraded, you cannot undo the upgrade. You also cannot
upgrade a component to its current or a previous revision. Only newer revisions
display in the drop-down list of revision options in the Upgrade Wizard.

Diagnosing Modules
When a problem with a module is detected, symbols display in the Summary tab. All
symbols provide ToolTips.
The I/O Diagnostic viewer provides a utility to interrogate I/O pack faults, version,
and diagnostic communication data. Diagnostic I/O pack reports can be generated on
a pack, module, or component level.
Note You must be online to view diagnostics (except for reports).

6-50 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

The following are Tree View Symbols:


Error (ex.link unhealthy)
Warning (ex. active alarm)
Informational (ex. inactive alarm)
Normal

The Summary tab, with diagnostic information displayed, is shown below.

The following are Summary tab diagnostic symbols:


Inactive Alarm(s)
Active Alarm(s)
I/O pack version unequal
I/O pack version status indeterminate
Link broken
Link error
Link warning
Link information

Note Place the mouse over the icon to display detailed messages regarding the
problem.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-51

I/O Diagnostic Viewer


To start an I/O diagnostic viewer
From the Summary tab, left-click an I/O pack or terminal board, then select
Troubleshoot and Status from the context menu to display the viewer.

Note For more information, refer to the section, Diagnostics Tab .

6-52 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

I/O Diagnostics Report


To create an I/O diagnostic report
Left-click an I/O pack or terminal board in the Summary tab, then select
Create pack Report. The desired I/O pack report is created.

Reporting Board Data


The ToolboxST application can generate the following I/O-related reports:

I/O module Fault Report

I/O module Revision Report

I/O module Communication Report

I/O module Hardware Report

Each report contains configuration or diagnostic details about the I/O hardware in a
component.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-53

To view or print a module report


From the Hardware tab Tree View, right-click Distributed I/O and select
Create Module Report.

The I/O report for the component displays.

6-54 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Working Online
Downloading Parameters
After modifying parameters in a module, you must download to the module before
the new settings take effect. Downloads to a module are separate from downloads to
a controller.
To download parameters to a module
From the Hardware tab Tree View, right-click the module to be downloaded
and select Download Parameters.

Comparing Parameters
While making changes to a modules configuration, it is often useful to compare the
downloadable configuration items currently stored in the pack with the current
configuration of the same items in the ToolboxST application.
As module parameters directly affect the operation of the
controller and associated I/O modules, always check the
Compare Parameters dialog box before downloading new
parameter values to a component to reduce the risk of improper
operation or damage to the unit.
To open the Compare Parameters dialog box
From the Hardware tab Tree View, right-click a module to compare and select
Compare Parameters. The Differences dialog box displays.
The differences between the controller
and the ToolboxST configuration are
displayed in a hierarchical tree view.

Click OK to upload the selected


values from the controller into
ToolboxST, replacing your changes.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-55

Send Controller Problem Report


This feature allows you to report problems with the controller and/or any configured
I/O modules. The report is generated, then attached to an email to the ToolboxST
support team.
To send a controller problem report

From the Help menu (when the


Hardware tab is selected), select Send
Controller Problem Report. The Select
IO Module(s) dialog box displays.
Select the I/O modules to be included
in the report, then click OK. When the
progress bar displays complete, the
Submit SCR dialog box displays.

6-56 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To send an I/O module report


From the Tree View, rightclick a pack item, then select
Troubleshoot and Send
Problem Report.
When the progress bar
displays complete, the
Submit SCR dialog box
displays.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-57

To submit an SCR

Enter the appropriate information,


then click the Send button.
To save the report, click the Save
to File button.

To display a report preview,


click the Preview button.

Sample Problem Report Contents

File

Type

Provides

Error Log (controller and I/O


module)

.txt

All timestamped alarms in the controller. Each alarm


message also contains the code file name and line
number.

Event Log (controller and I/O


module)

.txt

All timestamped events in the controller. Each event


message also contains the code file name and line
number.

Diagnostic History (controller and


I/O module)

.txt

All diagnostic messages sent to the ToolboxST


application and other clients.

EGD Info History (controller)

.txt

EGD information/statistics for the controller (for


example, number of produced/consumed exchanges,
late counts, missed counts)

Revision Info (I/O module)

.xml

Boot/base/firmware revision data for I/O packs present


in the ToolboxST configuration and in the I/O pack to
confirm revision equality.

System topology history (controller) .xml

6-58 Chapter 6 Mark VIe Component Editor

Information about the I/O pack configuration (for


example, module name, redundancy, parameters)

GEH-6700J ToolboxST

Software Tab
The Software tab in the Component Editor contains all application software
downloaded to that controller.
The Tree View displays an
outline of the application
software. When Programs is
expanded, all programs in the
controller display.
Under the Programs item are
tasks, which can be scheduled.
Each user block contains
variables, attributes, and blocks.
The Summary View displays
all software files associated
with this controller, including
function block library DLLs,
user block libraries and
program files.

The Programs item at the top of the Tree View holds all programs in the controller.
Its shortcut menu contains actions that affect all programs, such as changing library
references and instancing all linked user blocks. The shortcut menu also contains
commands to add a new or existing program to the controller.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-59

Adding a Program
The Programs item allows you to add programs to a controller.
To add a program
From the Tree View, right-click the Programs item to display the Programs
shortcut menu.

From the shortcut


menu, select Add
Program. The Add
Program dialog
box displays.

6-60 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Adding a Program Group


To add a program group
From the Tree View, right-click the Programs item to display the Programs
shortcut menu.
Select Add Program
Group from the
shortcut menu to
display the Add New
Program Group
dialog box.

Enter a name for the new


program group then click OK.

The new program group item displays in the


Tree View. Block library information displays
in the Summary View.

Adding an Existing Program


To add an existing program
From the Tree View, right-click the Programs item to display the Programs
shortcut menu.
Note The Add Existing Program command reads an .xml file from another system
or controller into the current controller.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-61

Select Add Existing Program


from the shortcut menu. The
Select Existing Program
screen displays to allow you to
select the desired .xml file.

Library References
A controller has two types of libraries:

Function block libraries that describe software that comes as part of the
controller firmware

User block libraries that combine these function blocks into user blocks
To reference a user block library

From the Tree View, right-click the Programs item, then select Library
References. The Library References dialog box displays all block libraries
in two tabs.

From the User Block Libraries tab, select the check box next to libraries that
you want to reference in this controller. Clear check boxes for libraries that
should not be referenced.

If all system libraries are


included, select the toplevel check box. If all the
blocks of a Library
Container are included,
select the check box for an
item at the third level.

6-62 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To reference a function block library


1

From the Tree View, right-click the Programs item, then select Library
References. The Library References dialog displays all available user
block libraries.

From the Optional Libraries tab, select the check box next to libraries that
you want to reference this controller. Clear check boxes for libraries that should
not be referenced.

Click the Add Library button to


add an external function block
library. A Browser window
displays the available .dll files.
This command is a special case
where the .dll file contains
controller firmware and is
not covered in this document.

Instance All
The Instance All command creates a new copy of all linked user blocks from the
referenced user block libraries. In addition to updating the user blocks, this command
causes the instance scripts and text substitutions to run.
Note It is not possible to undo this command.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-63

Overridable Properties
It is possible to select properties to be overridden.
To select overridable properties

From the Tree View, rightclick the Programs item,


then select Overridable
Properties. The
Overridable Properties
dialog box displays.

Select the properties


to be overridden, the
click the arrow button.

The Protection
property defines
access rights to
the overridable
properties list.

6-64 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Adding a Task
Tasks can be inserted within a program:
To add a task
From the Tree View, right-click on an embedded or unlinked program name to
display the shortcut menu.
Right-click the
program name,
then select Add
Task to display
the Add Task
dialog box.

Enter a Name to insert an


embedded task
OR
Click the Select Library Block
check box to insert a linked task.

Select a category and a


definition from that category.
Enter a name for the linked task.
Click All to display all of
the Categories and
Definitions.
Click None to de-select
all Categories.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-65

Adding a User Block


To add a user block

From the Tree View, right-click


the task name to select Add
User Block from the shortcut
menu. The Add User Block
dialog box displays.

Note The Add Task and the Add User Block dialog boxes are identical except for
the title bar, which shows how the new user block is used.
A user block can either be linked from a user block library, or embedded, acting as a
container for function and user blocks.
Instancing a user block updates it to the latest version from the user block library.
Embedded and unlinked user blocks are disconnected from the library, so instancing
goes through the blocks in that user block and instances the linked user blocks.
To instance a user block

Right-click the user


block to select
Instance from the
shortcut menu.

6-66 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

The Summary View of a user block displays the block diagram for either the user
block selected in the Tree View or its container.
If the task is selected, the block
diagram displays the contents of
the task, as follows.

If a user block is selected within a task, and the


contents of the selected block are collapsed and not
visible, the block diagram displays the contents of the
task with the user block selected in the Summary View.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-67

If the selected block is a user block within a task,


and the contents of the selected block are expanded
and visible, the block diagram displays the content
of the selected user block, as follows:

Finally, if the selected block is a function block,


the block diagram displays the contents of the
container user block with the function block
selected in the Summary View, as follows:

6-68 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Unlink Permanently
A program that is linked to a library container can be permanently unlinked from the
component.
To unlink a program
From the Tree View, right-click a program item, then select Unlink
Permanently.
The linked icon next to the item in the Tree View changes and the program is
unlinked from the library.
Note Linked tasks and user blocks can also be unlinked permanently.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-69

Property Editor
The Property Editor displays different properties, depending on which item is
selected in the Tree View.

Programs Item Property Editor


The Programs Property Editor displays the following property.

Use the drop-down list


to select.

Remove Unused Variables removes the unused variables for all linked user
blocks in this device when the user block is instanced.

Program Property Editor


The Program Property Editor displays the following properties.

Click the ellipsis


button to display the
Edit Text dialog box.

6-70 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Description allows you to describe the program. Click Description and then click
to enter text.
Library Type is only used for legacy Mark VI software conversion.
Name allows you to name the program.
Protection expands to show the access rights for this program.
Execution Order sets the order of execution of this program in the controller.

Task Property Editor


The Task Property Editor displays the following properties.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-71

BlockType is the name of the user block definition in the library from which this
user block started.
Description is the description of this user block.
Name is the name of this user block.
Protection expands to show the access rights for this user block definition.
Version is the user-defined version of a user block.
Execution Order sets the order of execution in the program.
Frame Multiplier is the number of frames at which the user block runs.
Schedule Offset is the offset from beginning of frame at which the user block
runs.

User Block Property Editor


The Property Editor displays the following properties.

Block Type is the name of the library block that the selected block is an instance
of.

6-72 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Instance Name is a unique identifier that allows the block to be referenced from
other locations in ToolboxST.
Instance Script causes the script to run when the block is instanced.
Height is the height of the selected block in the diagram.
Left is the location of the left of the selected block.
Selected Pin is the pin currently highlighted in the diagram.
Show Description, when set to True, displays the description of the selected
block.
Top is the location of the top of the selected block.
Width is the width of the selected block.
Block Data Type is the data type for variant pins in the selected block instance.
Detached Summary File is the backsheet for the selected block.
Enable, when set to True, enables variables for the selected block.
Version is the version number for the source of the selected block instance.
Execution Order determines when this block is started.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-73

Variables
Program variables are global variables associated with a particular program. The
variables display under the Programs item in the Tree View. Undefined variables for
a program are global variables that have been referenced in a controller, but have not
been defined as part of a program or user block. Undefined variables for tasks and
user blocks are local variables that have been referenced within the task or user
block.
To add a variable to a program
From the Software tab, expand the Programs item.

Right-click the Variables item


and select either Add Variable
or Add Undefined Variables
from the shortcut menu.

The Add New Variable dialog box displays.

Enter the variable


name, then click
OK. The new
variable displays
in the Data Grid.

User block and task variables are local by default, and display under the associated
user block item in the Tree View.

6-74 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Editing Variables
Variables can be edited in the Data Grid and Property Editors. The Data Grid is used
to view or edit variable definitions, and can be configured to display a subset of the
variable properties. Refer to the section, Data Grids .
Note Variables can also be added in the Summary View by directly editing the last
row of the variable grid.
Click a program or task variable to
display and edit a list of variables
and their properties in the Data
Grid Editor.

The Property Editor


allows you to edit
properties of the
variable you select
from the Data Grid
.
Editor.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-75

Alarm Severity is the value assigned to an alarm in the active state. The valid
range is 1through 1000, where 1 is the least severe.
Alarm, if set to True, enables the variable as an alarm. Alarms are used for problems
that require the operators attention and acknowledgement. The alarm queue consists
of a list of time-tagged alarm state transitions.
Alarm Class selects a System Configured Alarm Class, used by the HMI to
classify and colorize alarms.
Alarm On Zero, if set to True, causes the alarm on a 1-to-0 transition. Requires that
the Alarm be set to True.
Event, if set to True, enables the variable as an Event. Events are stateless messages
that are not queued within the controller. When an event occurs, a time-tagged
transition message is sent to any HMIs that have signed up for events.
Hold, if set to True, enables the variable as a Hold, which is similar to an alarm. The
hold queue contains a list of time-tagged hold states in the turbine startup sequence.
Normal Severity is the value assigned to an alarm in the normal state. The valid
range is 1through 1000, where 1 is the least severe.
Plant Area places variables into logical plant groupings for display in the
WorkstationST Alarm Viewer.
SOE Description cannot be modified. It is automatically entered from the
hardware library if the hardware point is defined as a Sequence of Event (SOE).
SOEs are similar to event messages except they are associated with I/O transitions,
instead of application-variable transitions. They are also typically timestamped to a
much finer resolution (1ms) than alarms or events.
Visibility determines when the pin is shown on the block diagram.
Display High Limit is the default upper limit for displays on the HMI (for
example, bar-graph or trending displays). If a Format Spec has been specified and
this display-high property is not specified, the Format Spec Engineering Max is used.
Display Low Limit is the default lower limit for displays on the HMI (for example,
bar-graph or trending displays). If a Format Spec has been specified and this displaylow property is not specified, the Format Spec Engineering Min is used.
Display Screen is the default HMI screen for this variable.
Entry High Limit is the default upper limit for setpoint entry on HMI (for example,
bar-graph or trending displays). If a Format Spec has been specified and this entryhigh property is not specified, the Format Spec Engineering Max is used.
Entry Low Limit is the default lower limit for setpoint entry on HMI (for example,
bar-graph or trending displays). If a Format Spec has been specified and this entrylow property is not specified, the Format Spec Engineering Min is used.
Format Spec can be assigned to a variable. These are system-owned format
specifications unique for each measurement system and grouped into sets. (For
example, a temperature set may contain a format specification for English in degrees
Fahrenheit and one for metric in degrees Celsius.
HMI Resource allows access and visibility of variable and alarm data to be
customized.

6-76 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Precision determines the number of digits to show to the right of the decimal point.
This is the default for precision when displaying the number on HMI. If a Format
Spec has been specified and this precision attribute is not specified, the Format Spec
Precision is used.
Units are engineering units. If a Format Spec has been specified and this Units
attribute is not specified, the Format Spec Units is used. If you are using the SDB
version of the HMI device, this attribute is not used. Only the format specification's
Units string is used.
Array is the number of elements in this array variable.
Connection allows a variable to be connected to another variable.
Description is the variable description.
Enumerations are values represented in separate .csv files.
Full Name is the fully qualified name of the variable. For example, a variable name
gas_fuel_opt in a user block named Config under the Program CORE would have a
full name of CORE.Config.gas_fuel_opt.
Initial Value allows array length, data type, and enumeration editing.
Name is the variable name.
Nonvolatile indicates that the variable should be saved in non-volatile RAM.
Type is the variable data type.
Historian Deadband enables the automatic collection by the Historian when:
Boolean and set to Logged on Change
Analog and set to 0 or higher
Historian Deadband Definition defines the deadband value as either engineering
units or percent of range.
Recorder Deadband enables the automatic collection by the Recorder when:
Boolean and set to Logged Continuous or Logged on Change
Analog and set to 0 or higher
Recorder Deadband Definition defines the deadband value as either engineering
units or percent of range.
Control Constant allows a variable to be configured as a setting that is initialized
at startup to its initial value. Control constants can be viewed from the toolbar by
clicking View\Control Constant.
Download Info, if set to True, downloads extended information to the controller
that is used by the web server, as well as other processes.
EGD Page is used to assign the variable to an Ethernet Global Data Page.
External Access is used primarily for EGD.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-77

ReadOnly variable can be read on EGD.


ReadWrite variable can be written to through EGD.
NoAccess variable cannot be changed with the ToolboxST application.
Global Name Prefix is the variable's global name prefix type (None, Full, Block,
Program, Task). This controls the form of the global name that displays on the EGD
page. For example, the name for variable IGVA in user block VG_Health in task
Task1 in program CORE would display (depending on the Global Name Prefix) as:
None

IGVA

Full

CORE.VG_Health.IGVA

Block

VG_Health.IGVA

Program

CORE.IGVA

Task

Task1.IGVA

Scope is the variable's scope (Global, Local.) If a variable is local, it can only be
used in the program or user block in which it is created. If it is global, it can be used
in other programs and user blocks. A variable must be global to be used on EGD.
Usage defines the behavior of pins on a user block.
Input pins are shown on the left of the user block.
Output pins are shown on the right side of the user block.
State pins are shown on the right side of the user block.
Constant entry is a number. No live data is provided for this pin.
Virtual HMI Point, if set to True, imports the variable into the HMI as a virtual
point.
Controller Collected, if set to anything other than Not Logged, logs the value to
the Compressed Data Log in the controller.
Note The Controller Collected property is only available when the application
running is a 1.5 MW Wind Turbine.
Override Properties, if set to True, allows certain properties of a linked variable
to be modified. The allowable properties are defined in the Overridable Properties
dialog box.
Note The Override Properties property is only available for global variables that are
contained within a linked program, task, or user block.
Override Value, if set to True, allows the Initial Value of a linked variable to be
modified.
Note The Override Value property is only available for control constants that are
contained within a linked program, task, or user block.

6-78 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Table Definitions
Many complex mechanical interactions can be modeled using lookup tables. The
controller implements these tables using table definitions. A table definition is
similar to a signal definition, as both are similarly named and are used in instruction
blocks. Table definitions are added under the Programs item in the Tree View. Refer
to the section, Importing Table .csv Files.
A table definition consists of a name, note, identification string, revision string,
engineering units (EUs), data array dimensions, adjust flag, minimum and maximum
Z values, and data. The data consists of one or two independent arrays (X and Y) and
a dependent array (Z).
Tables with a single independent array are sometimes called univariant tables and
consist of X and Z linear arrays of the same length. Tables with two independent
arrays are sometimes called bivariant tables and consist of X and Y linear arrays and
a Z two-dimensional array. Bivariant table definitions display in the Summary View
as follows:

Importing Table .csv Files


Table definitions are multi-dimensional variables used on specific interpolator
blocks. They have either one or two input arrays and a matching one or twodimensional output array. A block input is interpolated against the input array or
arrays, and an output is interpolated from the corresponding output array. A single
data-structure is provided for this function instead of a block so that it can be better
identified, maintained, and tracked. Table definitions have special Version and ID
text fields, and can be imported and exported to a .csv file.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-79

To add a table definition


1

From the Software tab, select a Program in the Tree View.

Right-click the program name and select Import Table.csv file from the
shortcut menu to display the Table Definition dialog box.

Select the desired table definition file and click Open. The Table Definition file
is inserted into the program.

6-80 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Program Variables
Program variables are global variables associated with a particular program. The
variables display under the Programs item in the Tree View. Undefined variables for
a program are global variables that have been referenced in a controller, but have not
been defined as part of a program or user block.
To add a variable to a program
1

From the Software tab, expand the Programs item.

Right-click the Variables item


and select either Add Variable
or Add Undefined Variables
from the shortcut menu.

Enter the new variable name in the Add New Variable dialog box and click
OK. The new variable is added to the list in the Summary View.

Note Variables can also be added in the Summary View by directly editing the last
row of the variable grid.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-81

Summary View
The Summary View displays all user blocks and associated scheduling information
in that program. The Frame Multiplier and Schedule Offset fields can be changed
from this view (see below). The available columns are as follows:
Execution Order sets the order of execution in the program.
Task Name is the name of this task.
Frame Multiplier is the number of frames at which the user block runs.
Schedule Offset is the offset from beginning of frame at which the user block
runs.
Period, in milliseconds, is the period at which this user block runs. Calculated by
multiplying the frame multiplier by the controllers frame period, which is set on the
General tab.
Description is the description of this user block.

To change the frame multiplier or the schedule offset


Click the Frame Multiplier or
Schedule Offset cell, then
select from the drop-down list.

Note Since the schedule offset depends on the frame multiplier, it is possible to
select a frame multiplier for which the current schedule offset is invalid. This will
cause a validation error when you build the application.

6-82 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

User Block
The user blocks of a controller program display in the Tree View below the
Programs item under tasks, or other user blocks.

User Block

Instancing a user block updates it to the latest version from the user block library.
Embedded and unlinked user blocks are disconnected from the library, so instancing
goes through the blocks in that user block and instances the linked user blocks.
To instance a user block

Right-click the user


block to select
Instance from the
shortcut menu.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-83

User Block Variables


User block variables are considered local to a user block, and display under the
associated user block item in the Tree View. The variables can only be modified if
the user block is either embedded or unlinked, and not locked with password
protection. Undefined variables for an embedded or unlinked user block are local
variables that have been referenced in the user block.
To add a variable to a user block
1

From the Software tab, expand the User Block item to display the Variables
item.

Right-click the Variables item


and select either Add Variable
or Add Undefined Variables
from the shortcut menu.

Enter the new variable name in the Add New Variable dialog box and click
OK. The new variable is added to the list in the Summary View.

Note Variables can also be added in the Summary View by directly editing the
append row of the variable grid.

User Attributes
User block attributes only display on linked or unlinked user blocks whose user
block definition contained attributes in the library. They can be modified so that
when their parent user block is instanced, the modified attributes are used in the
scripts and text substitutions that access them. Refer to the section, Working with
User Blocks .

6-84 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

User Block Properties


The Property Editor for a user block displays slightly different information
depending on whether it is a task or just a user block inserted under another user
block. Tasks contain scheduling information, but a user block contained within
another user block does not.

Unlink unlinks the user block from the definition.


BlockType is the name of the user block definition in the library from which this
user block started.
Description is the description of this user block.
Name is the name of this user block.
Protection expands to show the access rights for this user block definition.
Version is the user-defined version of a user block.
Execution Order sets the order of execution in the program.
Frame Multiplier is the number of frames at which the user block runs.
Schedule Offset is the offset from beginning of frame at which the user block
runs.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-85

Dynamic Data Recorder (DDR) Tab


The Dynamic Data Recorder (DDR) feature collects data when specified trigger
events occur. The advantage of using DDRs over capture blocks is that DDRs can be
reconfigured without having to download application code to the controller. This
enables changes to be made to the DDRs without disrupting the controller during
runtime. Up to 12 DDRs can be configured for the controller.

Configuring DDR
To configure a DDR
From the System Editor, double-click the Mark VIe Component. The
Component Editor displays.
From the Component Editor, click
the Dynamic Data Recorder tab.

From the Tree View,


select the DDR that
you want to configure.

6-86 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Specific DDR information displays in the


Summary View. Edit this information in
the Property Editor below.

The Property Editor


displays specific
information for the
selected DDR. Click
any item in the left
column to display a
description of that item.
Click the right column
to edit. Descriptions of
each item are provided
below.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-87

Appearance
Name is the user-defined description for this DDR, which is used for the filename.
Setup
Auto Enable, if set to True, automatically re-enables the DDR after 60 seconds
once it is uploaded.
Buffer Control
Normal causes the DDR to collect pre-samples before a trigger event and thereafter
continue collecting until Enable transitions False or the collection fills the buffer.
Circular causes the DDR to collect data indefinitely until Enable transitions False.
The buffer will be filled with the newest samples. No trigger is used.
Only causes the DDR to evaluate the trigger each execution and only collect data
when the trigger condition is satisfied. Data is collected until Enable transitions False
or the collection fills the buffer.
Frame Period Multiplier extends the sampling period by this multiple. The base
sampling period is the frame period.
Upload Type
Manual allows the user to manually upload the DDR.
Automatic is an automatic upload by the data collection.
Trip is an automatic upload by the data collection, then added to the trip log.
Enable is the setup variable that enables the DDR.
Trigger is the setup variable that triggers the DDR.
Post Trigger Samples are the number of samples collected after the trigger
including the trigger sample.
Pre-trigger Samples are the number of samples collected before the trigger.
Setup Variables
Enable enables the DDR.
Trigger triggers the DDR.
Trigger Setup
Trigger Comparison Type
EQ is the value of the trigger variable, which must be equal to the trigger value.
GT is the value of the trigger variable, which must be greater than the trigger value.
GE is the value of the trigger variable, which must be greater than or equal to the
trigger value.
LT is the value of the trigger variable, which must be less than the trigger value.

6-88 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

LE is the value of the trigger variable, which must be less than or equal to the trigger
value.
NE is the value of the trigger variable, which must not be equal to the trigger value.
Trigger Comparison Value is the value compared to the value of the trigger
variable to determine the presence of a trigger. For Boolean trigger variables, the
only valid values for the trigger value are 1.0 for TRUE and 0.0 for FALSE. Note
that if an analog trigger variable of a different data type is configured, it may be
possible to specify a trigger value that cannot be exactly represented by the trigger
variable. Users should be aware of this limitation when specifying the EQ trigger
condition.
Trigger Type
Edge is triggered on the rising edge of the trigger variable.
Level is triggered on the true condition of the trigger variable.

Status Variables
Status variables, which indicate the status of the associated DDR, are used to
determine when to upload the data. Status variables are always integers, and are
automatically defined and placed on the EGD status page.

Adding Variables
Variables can be added to a DDR. When a trigger occurs, these variables are
collected by the buffer and are subsequently uploaded by the Recorder and/or
Trender. Each variable is sampled for the total number of samples configured. This
means that if the DDR is set up to record 100,000 samples with three variables
assigned, 300,000 items will be acquired. Up to 96 variables can be assigned to each
DDR.
Note There is a 12 MB size limit on the memory that can be allocated to the DDRs.
If this memory allocation is exceeded, an error is reported during validation.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-89

To add a variable
1

From the Component Editor, select the Dynamic Data Recorders tab to
display the DDR list.
Right-click the desired
DDR and select Add Variable.

The Select a Variable dialog box displays.

Select the desired variables and click OK to insert the variables.

Updating DDR
DDRs can be updated separately from the application code download.
To update a DDR
From the Device menu, select Download, and then select Update Dynamic
Data Recorder. Or, click the Update Dynamic Data Recorder button
.
Note DDRs cannot be downloaded if there is a major difference in the device. In
this case, the application code must be downloaded.

6-90 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Importing and Exporting DDR


To import a DDR from a .tre file
1

From the Component Editor, select the desired DDR.

Right-click the DDR


and select Import
Configuration.
.

From the Import File dialog box, select the .xml file that corresponds to the
DDR you wish to import. Click Open.

Note If the .xml file being imported contains the formatting flags %n, it is replaced
by the Mark VIe component Design Memo (DM) number. This is a GE Power
Systems project number and can be edited by selecting the General tab and
Requisition Info.
To export a DDR to a .xml file

GEH-6700J ToolboxST

From the list of DDRs, select the DDR to be exported.

From the File menu, select Export, and Selected Item. Or, right-click a DDR
in the list and select Export Configuration from the shortcut menu.

Select the desired file and click Save.

Chapter 6 Mark VIe Component Editor 6-91

DDR Setup
This procedure explains how to set up a DDR to capture two variables.
1

From the Software tab, right-click Programs to add a program.

Right-click the Prog1 item and select Add Variable. In the Add New
Variable dialog box, enter DDREnable (Boolean), which is used to enable
the DDR.

From the Add New Variable dialog box, add a variable DDRTrigger (Real),
which is used to trigger the DDR.

From the Add New Variable dialog box, add two variables TriangleOut and
SineOut, which are connected to the output of the function blocks. These
variables are added to the DDR variable collection.

Create a User Block in the program, and add two FuncGen blocks. These are
in the Data Collection section. Set up the pins on the two blocks as shown
below. FuncGen1 is set up as a Sine wave generator and FuncGen2 is set up
as a Triangle wave generator.

Set up the DDR as shown below.

Add the two variables SineOut and TriangleOut to the DDR. Set the Frame
Period Multiplier to 3, which means a sample is collected every 120 ms. The
base frame period is typically 40 ms. Set the PreTrigger samples to 20 and the
Post Trigger samples to 100, so that the entire capture takes 14.4 seconds.

6-92 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

GEH-6700J ToolboxST

The DDR is enabled with the DDREnable variable and the Trigger uses the
DDRTrigger variable. The DDR is triggered when the DDREnable is True
and the DDRTrigger is greater than or equal to 5.

Build and download the application code.

Go Online to the controller. From Prog 1, select the Variables item. Doubleclick the green live data for the DDREnable variable. Set to True and send to
the controller.

Chapter 6 Mark VIe Component Editor 6-93

The status of the DDR can be checked on the EGD page. When the DDREnable is
True and the DDR is not triggered, it is in the Waiting state, as shown below.

6-94 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

10 Set the value of the DDRTrigger variable equal to or greater than 5, then send
to the controller. The status indicates the Capturing state.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-95

When the capture is complete, the status indicates Done, and the DDR can be
uploaded.

11 The Trender is used to upload the capture buffer. From the View menu, select
Trenders to add a new trend. The Trender window displays.

6-96 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

12 Select + and the Trender wizard displays. Select Capture Buffer to select the
DDR to upload. The uploaded DDR variables are shown below.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-97

Ethernet Global Data (EGD) Tab


The Ethernet Global Data (EGD) protocol allows you to share information globally
between controller components 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 protocol supports a large number of controller components
capable of both producing and consuming information.

EGD Configuration
To configure EGD for a component
1

From the System Editor, double-click on a Mark VIe component to display


the Component Editor.

From the Component Editor, select the EGD tab.

From the Tree View, select Ethernet Global Data.

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). 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 samples configured to be available to other components on
the network.
To add a new Produced Page
From the Tree View, right-click the Produced Pages item, then select Add
Page. The Page Name dialog box displays.
Note When the first Produced Page is created, it automatically becomes the Default
page.

6-98 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To display standard variables


1

From the EGD tab Tree View, select Produced Pages.

From the Property Editor, select the Default Page Property, then select the
desired page from the drop-down list.

Tip Any variable defined with $Default as the EGD page name is automatically
placed on the currently selected Default page.
To delete a page
From the Tree View, right-click the page you wish to delete and select Delete.

Editing Produced Pages


To configure a Produced Page
From the EGD tab Tree View, expand Ethernet Global Data.

From the Tree


View, select the
desired page.

The properties
for the selected
page display in
the Property
Editor.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-99

The following properties are available for configuration when a Produced Page is
selected in the Tree View:
Ethernet 0, if selected, causes EGD to be broadcast on Ethernet Adapter 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, the page is only sent to a single destination.
Exchanges indicates the number of exchanges in the selected page. It is updated
after a build.
Default Page can be set to True if the selected page is the Default Page. To change
the default page, refer to the section, Produced Pages .
Layout Mode, if set to Auto, automatically assigns exchange numbers and offsets
assigned at build time. If set to Manual, exchange numbers and offsets can be
entered manually.
Minimum Length sets the minimum length of the exchanges on this page. Some
components look only at the length of the exchange. This property can be set to a
value larger than the current size of the exchange so that as variables are added, the
component continues to receive the exchange.
Name renames the selected page.
Period indicates the transmission period of the page in milliseconds.
Period Multiplier multiplies the value by the Controller frame period to obtain the
EGD page period. (The results display in the Period property.)
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 exchanges skew
by exactly this value. For example, if you have three exchanges in a page and a skew
value of 2, the first exchanges skew is two, the second exchanges skew is four and
the third exchanges 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.
Status Page is used by WorkstationST to provide standard variable information.

6-100 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Page Compression
When a page compression is performed, the variables are located in increasing size
order, starting with Booleans, then Words, Double Words, and finally all other
variables. A page compression causes an exchange major signature. Consumers can
mark the exchange variables as unhealthy until the consumed configuratuion can be
rebound.
To compress a single page
From the Tree View, right-click the page to compress, and then select
Compress.

To compress all Produced Pages in a component


From the Tree View, right-click Produced Pages, and then select
Compress All.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-101

Variables
To add a variable to an EGD page
1

From the Component Editor Tree View, right-click the desired page, and
then select Add Variable. The Select a Variable dialog box displays.

From the Select a Variable


dialog box, select one or more
variables, then click OK.

The Summary View updates to


display the new variable(s). The
exchange IDs and locations are
assigned during the Build
.

6-102 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Tip If the variable to be added to the EGD page is already in use on the Software
tab, you can add the variable without using the EGD tab. To add a variable from the
Software tab, select the desired variable(s) in the Summary View, and then set the
EGD Page property using either the Summary View or the Property Editor.
To delete a variable from an EGD Page
From the Summary View, right-click the variable to delete, 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 Comma Separated Value (csv) format.

Editing Exchange Signatures and Configuration


Time
Normally, the exchange signature is managed automatically. The major signature
must be incremented when the exchange content changes in any way other than
additions to the end. If you are using the EGD Device Editor to configure EGD for a
device and the device signature changes only when the manufacturer updates the
configuration, you may need to manually set the signature.
Note To edit exchange signatures and configuration time, set Layout Mode to
Manual.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-103

To edit exchange signatures and configuration time


1

From the EGD tab, select the Configuration tab, then select a Produced
Page in the Tree View.

Right-click an exchange in the Summary View, then select Edit Exchange


Signatures and Configuration Time.

Review the warning about manual Exchange Signature editing, then click
OK.

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

6-104 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

EGD Diagnostics
The EGD protocol includes a command mechanism that obtains the status of a Class
2 or higher EGD device. Mark VIe is a Class 3 EGD device. When any EGD item in
the Tree View other than a referenced device is selected, the EGD Statistics from
[Device] tab displays the statistics from the open component. When a Referenced
Devices item is selected, the statistics are obtained from that referenced device, and
the name of the tab page changes accordingly.
Note You must be online to view diagnostic information.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-105

Status columns in the Summary View include the following:


Exchange is the Exchange identifier <device name>.<exchange number>
Configuration Time is the time that the exchange was configured
Due Time is the time that a consumer data packet must be received for an exchange
to remain valid
Status is the health of the exchange
Length is the value for a produced exchange. This length may be the highest
variable offset in the exchange or the highest offset of a variable, which may have
been removed. For a consumed exchange, the value may be the highest variable
offset used or the length of the produced exchange, depending on the bind algorithm
of the individual tool.
Message Count is the number of data production packets produced or consumed
since initialization
Missed Count is the number of data production packets missed since initialization.
A missed packet occurs when a data production message is received that has a
request ID greater by more than one than the last message received (accounting for
counter roll-over).
Refresh Errors are the number of times a refreshment fault has occurred. A
refreshment fault occurs when a subsequent data production packet (or initial packet
at startup time) does not arrive at a consumer within a pre-defined update period.

EGD Configuration Server Tab


The EGD Configuration Server tab in the Summary View allows you to view and
delete EGD nodes currently residing in the configuration server. The configuration
server used is the one defined in the System Editor in the Tree View. If the server is
enabled, this tab displays information from that server.
Note The EMT provides a detailed view of the configuration server contents.

The tab control contains a toolbar with two buttons:


The Filter Toggle button defaults to a filtered state. It displays items that have
the same name but have a different Producer ID as the open component.
The Delete button deletes the selected item(s). If the item(s) were saved as part
of the configuration, they can be added again.
The EGD configuration server uses the producer ID to store all the documents for an
EGD node.
Note A system can have one EGD Configuration Server only.

6-106 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

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.

EGD Configuration Server Reports


With the System item selected in the System Editor, set the EGD Config Server
Enable to True in the Property Editor. Refer to Chapter 2, System Configuration , the
section System Database (SDB) . When enabled, the Produced Pages item has two
additional menu items, Compare and UnConsumed Data.

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


with the EGD configuration servers content.
UnConsumed Data command generates a report showing variables produced by
this component that are not listed in any other devices consumed data file.
Note You can select devices to search against. The individual pages, with just
variables, perform the same Compare.
The Referenced Devices item on the EGD tab also has a Compare command that
compares the consumed variable information for the open component against the
EGD configuration servers content.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-107

Referenced Devices
The EGD variables defined in other components can be added to the current
components 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, 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 are loaded and the variables display
in the Summary View.
Note When EGD configurations are edited in remote devices, you must refresh the
configuration to ensure that the latest variable information is used. The configuration
is automatically refreshed when a component is opened, and when a Build is
performed in the component.
To refresh the configuration of a referenced device
From the Tree View, right-click the device to be refreshed, and select
Refresh.

6-108 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Creating Undefined Variables


The Create Undefined Variables option allows you to create variables in a
component created from a referenced device. The list of undefined variables is
generated when a Build command is performed. As the variables become available
from the referenced device, they are deleted from the list.
To create undefined variables for a referenced device
From the Tree View, right-click the device, and select Create Undefined
Variables.

To create undefined variables for all referenced devices


From the Tree View, right-click Referenced Devices item, then select
Create Undefined Variables.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-109

Modbus Slave Tab

The Modbus slave feature allows a Modbus master to read and/or write data
directly from the Mark VIe, using the Modbus protocol over Ethernet or serial ports.
This feature can be implemented using the existing controller (referred to as Mark
VIe integrated Modbus) or an additional controller (referred to as Mark VIe gateway
Modbus).
Using the existing controller allows for a direct Modbus interface, but would expose
the controller to the extra loading and burden of serial interrupts when serial
communication paths are needed. Because a serial interrupt is critical, the Modbus
slave feature supports both serial and Ethernet/TCP capability on Mark VIe gateway
Modbus, while only Ethernet/TCP capability is supported on Mark VIe integrated
Modbus.
Mark VIe gateway Modbus is always run in simplex controller mode without
sequencing blocks.

Modbus Overview

6-110 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Configuring Modbus Slave


To configure Modbus slave for a device
From a Component Editor, click the Modbus Slave tab.

From the Tree View select


the Modbus Slave option.
Configuration properties
display in the Property
Editor.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-111

Ethernet
Connection Timeout specifies the time in minutes that the slave remains
connected to the master over Ethernet when no requests are being received. The valid
range is one to 10.
Ethernet Port specifies the Ethernet port to be used for slave-Ethernet
communication. The valid port choices are 502 and 503.
Interface
Interface sets the interface type:
Serial is only supported on Mark VIe gateway Modbus.
Ethernet is supported on both.
Shared (both Ethernet and serial) is only supported on Mark VIegateway Modbus.
None indicates that the slave feature is not available.
Serial Settings
Baud Rate specifies serial communication rate (bits per second). The valid choices
are 2400, 4800, 9600, 19200, 38400, and 57600.
Data Bits specifies number of bits per character. Only eight bits is supported.
Inter-Character Timeout (ICT) specifies the timeout period expressed as
character time X 10. For example, 35 represents 3.5 character times, or 0.0036
seconds at 9600 baud, 1 start bit, no parity, 1 stop bit. The valid range is 35 to 1000.
Parity specifies check character. The choices are None, Odd, Even, Mark, and
Space.
Port specifies the serial communication port (COM2).
Response Delay is an additional delay time in milliseconds before the slave
responds to a master request. The valid range is 0 to 999.
Station specifies the slave address associated with the serial port. The valid range is
1 to 255.
Stop Bits specifies serial stop-bits. The valid choices are 1 and 2.
These additional settings apply to both Ethernet and serial communications.
Command Limit limits the number of commands processed per second. This is
based on commands that have changed, not commands that are identical to
previously received commands. The valid range is 0 to 25.
Data Swapped changes the transmission order if the data is greater than 16 bits
when set to True. Refer to the example below.

6-112 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Data Swapped Examples

Settings

Example

If set to True

32-bit example: 0x01234567 would be transmitted as 0x45 0x67 0x01


0x23
64-bit example: 0x0123456789ABCDEF would be transmitted as 0xCD
0xEF 0x89 0xAB 0x45 0x67 0x01 0x23
32-bit example: 0x01234567 would be transmitted as 0x01 0x23 0x45
0x67

If set to False

64-bit example: 0x0123456789ABCDEF would be transmitted as 0x01


0x23 0x45 0x67 0x89 0xAB 0xCD 0xEF

Mode is the mode for serial communication. Only Binary is supported.


NAK Code specifies the Negative Acknowledge code to be used if data is requested
from a controller that is incapable of receiving the Modbus request. Code options are
4, 6 or None. None is selected only if the master needs no reply when
communication fails between the Mark VIegateway Modbus and the target
processor.

Modbus Slave Register Pages

The Modbus Slave tab contains four pages that are used to exchange data with a
Modbus Master. The pages differ by the access the master receives to the data (readonly or read/write) and the type of data (a Boolean or a 16-bit word) as follows:
Data Types

GEH-6700J ToolboxST

Page

Data Type

Access

Holding Register

16-bit Register

Read/Write

Coil

Single Bit

Read/Write

Input Register

16-bit Register

Read-only

Input

Single Bit

Read-only

Chapter 6 Mark VIe Component Editor 6-113

The ToolboxST application allows you to specify the variables on each page using a
Data Grid. When you add a variable to a page, both the Modbus slave and the
selected page are enabled on the controller. As you add and remove variables, the
controller is updated so that only pages containing variables are enabled. To
completely disable the Modbus slave, remove all variables on all pages or select
None as the Interface in the Property Editor.
When a variable is added, the following columns display:
Connected Variable is the variable that is read or written from the device or the
referenced device. A variable must be on an EGD page before it can be added to a
Modbus slave page. A connected variable must be added before the other columns
become active.
Point Data Type determines the variable data type and the registers used to
transmit the variable data over a Modbus connection as follows:

BOOL is one bit of a 16-bit word. (This is the only option if the connected
variable is a BOOL.)

INT is a signed 16-bit word that takes one register

UINT is an unsigned 16-bit word that takes one register

DINT is a signed 32-bit word that takes two registers

UDINT is an unsigned 32-bit word that takes two registers

REAL is a signed 32-bit float that takes two registers

LREAL is a signed 64-bit float that takes four registers

Address specifies the register address. When a variable is created, the address is
automatically set to a value adjacent to the highest address previously on the page,
but the automatic value can be modified. Any data types that are 32 bits or more
(DINT, UDINT, REAL, and LREAL) should be placed on odd addresses. The valid
range for addresses is 1 to 65534. When specifying an address for a BOOL variable,
the bit 0-15 within the 16-bit word is represented by a decimal. For example, 1.00
selects register address 1 and bit 0, and 10423.7 selects register address 10423 and
bit 7.
Raw Min, Raw Max, Eng Min, and Eng Max are columns that convert Modbus
slave variable data into engineering units. The Raw Min and Raw Max columns
control the minimum and maximum for the raw data. The Eng Min 0 and Eng Max
columns control the minimum and maximum engineering units to which the raw data
will be scaled. (The BOOL data type cannot be scaled.)
Name is a read-only identifier automatically generated from the register page name,
the address, and, if necessary, an added unique number.
For more information, refer to the following links:
For Modbus resources, go to: http://www.modbus.org http://www.modbus.org
For Modbus protocol, go to: http://www.modicon.com/techpubs/toc7.html
http://www.modicon.com/techpubs/toc7.html

6-114 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Mark VIe Tools


Reports
Reports provide a variety of controller information in a viewable format. Reports are
displayed in a separate window and can be viewed, printed, and saved for later use.
When viewing a report on screen, you can also sort, filter, and search the report to
quickly locate information.

Creating Reports
To create a report
Open a Mark VIe Component Editor. From the View menu, select Reports,
then select the desired report type from the drop-down list. Refer to the section,
Report Types. The I/O Report displays in a new window.

Saving, Retrieving and Printing Reports


To save a report
From the File menu, select Save Report. In the Save Report dialog box,
enter a file name and click Save.
To open a saved report
From the File menu, select Open Report. In the Open Report dialog box,
locate the report in .csv format and click Open.
To print a report
From the File menu, select Print. In the Print dialog box, verify that the
settings are correct, then click OK.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-115

Viewing Reports
To change the zoom level of a report
From the Report View menu, select Zoom, then select the desired zoom value
from the submenu.

To sort a column
From the Report window, click any column heading to apply a sort to the
associated column. The first click sorts the column ascending; a second click
switches the column to a descending sort.
To change report columns
From the Report menu, select Change Columns to display the Select E1
Attribute Values Report Columns dialog box.

6-116 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Filtering Rows
The report filter feature applies rules to a report to display a specific subset of the
original report.
To apply a report filter
From the Report window, select the Report menu, then click Apply Filter to
open the Edit Report Filter dialog box.
Lists available
comparison and
Boolean operators
(double-click an
operator to add it to
the equation).

Lists available
columns (doubleclick a column to
add it to the
equation).

Click to add
parentheses to
your equation.

In this box,
enter the filter
equation to be
used.

Click OK to accept the


filter equation as shown.

Click Clear to erase the Click Cancel to cancel the


current filter equation.
equation without changing
the current filter settings.

The following operators are available for use in a report:


<

Left expression must be less than the right expression.

>

Left expression must be greater than the right expression.

<=

Left expression must be less than or equal to the right expression.

>=

Left expression must be greater than or equal to the right expression.

<>

Left expression must not equal the right expression.

Left expression must be exactly equal to the right expression.

LIKE

Expression to the left of the operator must match the wildcard expression to the right of the
operator.

AND

Expressions to the left and right of the AND operator must both be True.

OR

Either the expression to the left or to the right of the operator must be True.

NOT

Expression to the right of the operator must be False.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-117

In addition, the following rules apply:

You can use as many groups of parentheses as necessary to define an


expression.

Any string values must be enclosed in single quotes: 'string'

When using the LIKE operator, you can prefix or suffix a wildcard character
like * to the right-hand value. This wildcard character * can stand for any
number of alphanumeric characters, including zero. The wildcard character *
can only be present at the beginning and/or the end of the right-hand value (for
example, *value or value* or *value*)

In this example , the


filter for the I / O report
selects all screw
names that begin with
Pos and are unused .

6-118 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

The filter expression shown below selects all contact and input digital I/O points
[IOVariable] LIKE Contact* AND [ModuleName] LIKE PDIA*

To remove a report filter


From the Report window, select the Report menu, then click Remove Filter.
The filter is removed and all available rows display.

To save a filtered report


From the Report window, select the File menu, then click Save Report.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-119

Finding Data
The report Find feature allows text searches to be performed within the report.
To find text within the report
From the Report window, select the Report menu, then click Find to display
the Find dialog box.
Click to locate and highlight
the next instance of the
search text in the report.

Enter the
search text.

If selected, the
capitalization in the
report and the
search string must
exactly match.

If selected, the find string


must be found as a whole
(for example, day would not
match Monday)

Determines the direction


in which the next search
will proceed.

Importing I/O Reports from a .csv File


To import an I/O variable report
1

From the Hardware tab Tree View, select Distributed I/O.

From the File menu, select Import, then select I/O Variable Report to
display the Open Report... dialog box.

From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.

6-120 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To import an I/O Configuration report


1

From the Hardware tab Tree View, select Distributed I/O.

From the File menu, select Import, then select I/O Configuration Report to
display the Open Report... dialog box.

From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.
To import a Global Variable report

From the File menu, select Import, then select Global Variable Report to
display the Open Report... dialog box.

From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.
To import a Block Pin report

GEH-6700J ToolboxST

From the File menu, select Import, then select Block Pin Report to display
the Open Report... dialog box.

From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.

Chapter 6 Mark VIe Component Editor 6-121

Coding Practices Report


The Coding Practice report allows you to generate four reports:

Unwritten Variables report

Multiple Writes report

Multiple Output Assigned Variables report

Unused I/O report

To generate a Coding Practices report

From the View


menu, select
Reports, then click
Coding Practices.

The Options dialog box displays. Select the reports to generate.

6-122 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Unwritten Variables are used in blockware logic, but have no assigned values.
Multiple Writes are variables used in multiple locations, such as blockware logic,
EGD, or I/O point configuration.
Multiple Output Assigned Variables displays all variables attached to more
than one output.
Unused I/O are connected I/O values that are not used anywhere.
Spares are unconnected and unused I/O values.
An example of a Coding Practices report is as follows:

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-123

Auto-Reconfiguration Reports
The Auto-Reconfiguration reports include: Configuration and Difference. If one or
more I/O packs are configured in the Hardware tab, the Configuration report displays
details about what files are downloaded for the packs. Each pack must have a unique
barcode (configured in the Add Module Wizard when the pack is added) or it is not
included in the report.
Note The contents of both types of reports can be exported to a .csv file.

Configuration Report
To generate an Auto-Reconfiguration Configuration report
From the View menu, select Reports, Auto-Reconfiguration, and
Configuration. The Auto-Reconfiguration Configuration Report screen
displays.

6-124 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

An example of a Configuration report is as follows:


The Configuration Report includes all packs in
the ToolboxST configuration, as well as the files
(and their sizes) associated with each pack.

The download size of the total


Auto-Reconfiguration displays.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-125

Difference Report
An example of a Difference report is as follows.
The Item column
displays each
configured pack.

The Tool column displays


information about files
configured in the AutoReconfiguration server.
.

6-126 Chapter 6 Mark VIe Component Editor

The Controller columns compare


the state of each controllers
configuration to the configuration in
the Auto-Reconfiguration server.

GEH-6700J ToolboxST

If Difference Report is selected from the View menu, but no differences exist
between the ToolboxST configuration and the Auto-Reconfiguration server, the
following message displays.

This example of a full report displays


three controllers whose configurations
are all equal to the configuration in the
Auto-Reconfiguration server.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-127

Status Tab
The Status tab at the bottom of the Component Editor displays four different states.
Equal displays if there are no differences between the ToolboxST configuration and
the Auto-Reconfiguration server.
Unequal displays if there are differences between the ToolboxST configuration and
the Auto-Reconfiguration server.
Disabled displays if the Auto-Reconfiguration property is set to False in the
General tab Property Editor.
Downloading displays if a download is occurring.

6-128 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Forced Variables
Forced variables are variables and I/O points whose value is permanently overridden
with a specific value. They are managed using the Forced Variables window while
connected to a controller.
Logic forcing procedures can result in personal injury or death, if
not strictly followed. Only adequately trained personnel should
modify any programmable machine. Forcing of control logic for
an operating process is strongly discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly enforced in
conjunction with this procedure.
To open the Forced Variables window
Open a Mark VIe Component Editor. From the View menu, select Forced
Variables to display the Forced Variables window.

To force a value or change a previously forced value


From the Forced Variables window, double-click a value to display the Send
Value dialog box. (For more information about the Send Value dialog box,
refer to the section, Modifying Live Values .)
To remove a single forced value
Right-click a forced variable and select Remove Selected Forces.
To remove all forced values
Right-click anywhere inside the Forced Variables window and select
Remove All Forces.
To print a report
From the File menu, select Print. In the Print dialog box, verify that the
settings are correct, then click OK.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-129

Global Variables
The Global Variables window displays all controller variables that have been
configured as Global in one central location.
To display the Global Variables window
Open a Mark VIe Component Editor. From the View menu, select Global
Variables.
The Property Editor displays
properties for the currently
selected row in the data grid.

Click to toggle between a display of


all global variables and a display of
only modifiable global variables.

The Global Variables window is particularly useful when you want to modify a
property for multiple variables. For example, to move multiple variables onto an
EGD page, select the rows for the desired variables and then change the EGD Page
property in the Property Editor. Refer to the section, Data Grids .
Because only existing global variables can be changed, new variables cannot be
added from the Global Variables window. You cannot make any change that affects
the name of the global variable (like Name or Global Name Prefix). Finally,
variables from an instanced library user block can only be modified if the Merge
Variables at Instance property of the Programs item on the Software tab is set to
True.

6-130 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Watch Windows
A Watch Window is a collection of variables that display, along with their attributes
and live values, in a stand-alone window. The Watch Windows feature can also be
accessed from the ToolboxST System Editor, as well as from the individual
Component Editors. Once a Watch Window is created, it can be exported to .xml and
.csv files.
To open a stand-alone Watch Window
From the Start menu, select All Programs, GE ControlST, ToolboxST,
and Watch Window.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-131

To open a Watch Window from the System Editor


From the Tree View, right-click the system and select Insert New. From the
sub-menus, select Tool and Watch Window.

The New Watch Window dialog box displays.

Enter a Name for the


Watch Window, add a
Description (optional),
then click OK.

6-132 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

The Watch Window displays as an item in the Tree View.

Export button

Add Variable Remove Selected


Variable(s) button
Import button button

Note If this is the first time the Watch Windows dialog box has been opened for
the selected component, the list is empty. Add or import a new Watch Window.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-133

To open an existing Watch Window


From the System Editor Tree View, right-click the system and select Insert
Existing. From the sub-menu, select Watch Window.

The Watch Window dialog box displays.


To open a Watch Window from a Component Editor
1

From the View menu, select Watch Windows.

6-134 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

The Watch Window dialog box displays.

GEH-6700J ToolboxST

From the Watch Window dialog box, either add a new Watch Window or
double-click to open an existing one.

Chapter 6 Mark VIe Component Editor 6-135

Adding a Variable
Use the Add Wizard to add a variable to a Watch Window.
To add a variable
1

From the Tree View, double-click a Watch Window to open it.

From the Edit menu, select Add Variable and Using Add Wizard

The Add Item Wizard displays.

6-136 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Click the Next button to continue.

Select the data


source from which
to add the variable,
then click Next.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-137

If you selected
System Component
in the previous
screen, select the
desired component
from the drop- down
list, then click Next.

Click the Add


button to
display the
Select a
Variable
dialog box.

6-138 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

From the list, either


double-click a
variable, or select
one and click OK.

To remove a
variable, select it
and click the
Remove button.
When all variables
have been added,
click Finish.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-139

Managing Variables
Once a variable has been added to a Watch Window, right-clicking the variable
allows you to perform the following actions.
Add Variable allows you to add additional variables.
Select All selects all variables for removing, pasting, or copying to the clipboard.
Remove Variable(s) removes selected variables.
Go to Definition allows you to display the variable definition from its location.
Change Live Value allows you to change the live value when the Watch Window
is online with the controller.
Copy to Clipboard allows you to copy the selected variable to the clipboard.
Paste allows you to paste a variable to another location, such as a Trender.
Add to Trender allows you to add selected variables to a Trender.

Organizing Watch Window Columns


To organize columns in a Watch Window
From the View menu, select Organize Columns from the drop-down list. The
Organize Columns dialog box displays. Refer to Chapter 4, the section
Organizing Columns.

Forcing Live Values


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

From the Watch Window, double-click the live value of a selected variable.
The Send Value dialog box displays.

Enter the desired value, select the Force Value check box, then click Send
and Close.

The forced value is sent to the controller.

Reconciling Constant Differences


The Reconcile Constant Differences feature allows you to synchronize the live value
and the initial value for constants. The live value is the value of the constant
currently being used in the running controller. The initial value is the value of the
constant in the ToolboxST configuration.
Note The initial value for a variable is not available from the OPC Server.

6-140 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To reconcile differences in the constants


1

From the File menu, select Reconcile Constant Differences. The


Constants Reconciliation dialog box displays all constants in which the
Live Value and the Initial Value are different.

Select the check box next to the correct value to synchronize the constant, then
click OK.

The constants are synchronized as follows.

For constants in which the Initial Value was checked, the Initial Value is sent to
the controller, making the Live Value equal to the Initial Value.

For constants in which the Live Value was checked, the Initial Value is set equal
to the Live Value.

Drag-and-Drop
Variables can be moved to other windows and editors using the drag-and-drop
feature. For example, you can drag:

A block pin from the Block Diagram Editor, and drop it into a Watch Window.

A variable in the Watch Window to a block pin on the Block Diagram Editor,
forming a connection.

A variable from one Watch Window to another Watch Window, copying the
selected variable into the target window.

Importing and Exporting


Watch Windows only exports
grid columns necessary to
retrieve variable information.
As an example,
DatasourceName from the
exported file is used to retrieve
the variables remaining
properties from the system.
User-defined columns such as
User Comment are also
included.

A Watch Window can be saved to either an .xml or a .csv file, which can then be
imported into another component. This allows you to use a previously selected
collection of variables.
To export a Watch Window to an .xml file
1

From the Watch Windows dialog box File menu, select Save As. The Save
Watch Window File dialog box dipslays.

Select the desired destination, then click Save.


To export a Watch Window to a .csv file

In the Watch Windows List dialog box, select the desired Watch Window,
then click the Export button. The Export Watch Windows dialog box
displays.

Select the desired destination, then click Save.


To import a Watch Window from a .csv file

In the Watch Windows List dialog box, click the Import button. The Import
Watch Windows dialog box displays.

Select the desired .csv file, then click Open.


To add a .watch file

GEH-6700J ToolboxST

From the Watch Windows List dialog box File menu, select Add Existing.
The Add Existing Watch Window dialog box displays.

Select the desired .watch file, then click Open.

Chapter 6 Mark VIe Component Editor 6-141

LiveView
LiveView allows you to display a graphical representation of live data from various
sources in the system. LiveViews can be added to a ToolboxST system or
component. Once added, they can be edited.

Adding and Opening LiveViews


To add a LiveView from the System Editor
From the Tree View, right-click the system and select Insert New. From the
sub-menus, select Tool and LiveView.

The New LiveView dialog box displays.


Add a Name and
a Description
for the Live View,
then click OK.

6-142 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

To add an existing LiveView from the System Editor


From the Tree View, right-click the system and select Insert Existing. From
the sub-menus, select LiveView.

To edit a LiveView from the System Editor


From the Tree View, right-click a LiveView, then select Edit System
Component.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-143

To start a LiveView
From the Tree View, double-click the LiveView item. The LiveView
displays.

To add a LiveView from a Component Editor


From the View menu, select LiveViews. The LiveViews dialog box displays.

6-144 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

From the File menu,


select Add New. The
New LiveView dialog
box displays.

Enter a Name and a


Description
(optional), then click
OK. The new
LiveView displays in
the LiveViews dialog
box.

To open an existing LiveView in the Edit Mode from the Component


Editor

GEH-6700J ToolboxST

From the View menu, select LiveViews. The LiveViews dialog box displays.

Right-click the desired LiveView, then select View. The LiveView displays.

Chapter 6 Mark VIe Component Editor 6-145

Right-click the desired


LiveView and select
View to display it.

To open a existing LiveView in Run mode from a Component Editor


1

From the View menu, select LiveViews. The LiveViews dialog box displays.

Right-click the desired LiveView, then select View. The LiveView displays.

6-146 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

LiveView Editor Features


The Tools window
contains General and
Animation controls.

The Properties window


displays the properties of
the selected control(s).

The Log Control displays error/


informational messages.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-147

Standard Toolbar
The standard toolbar contains the following buttons.
Stop the
running
LiveView

Delete
Save

Cut

Show / Hide the


ToolBox

Redo

Copy

Paste
Undo

Show / Hide the


PropetyGrid

Run the
Liveview

Show / Hide the


Event Viewer

Layout Toolbar
Additional layout buttons are as follows.
Make Control Width
Equal
Align Rights

The width of the selected


controls are made equal to
the primary selection

Align Centers

The selected controls Rights The selected controls vertical


are made equal to right of the center are aligned to the
Primary selection
vertical center of the Primary
selection

Center Vertically
The selected controls are
centered vertically to the
panel

Make Control Height


Equal
The Height of the selected
controls are made equal to
the primary selection

Align Lefts

Tab Order

The selected controls Lefts


are made equal to left of the
Primary selection

Displays Tab Order of each


control

Full Screen
Toggles between full
screen and normal
mode

Advanced Mode
Toggles between
Simple and
Advanced Mode

Align Centers
The selected controls
Horizontal center are aligned
to the horizontal center of the
Primary selection

Send to Back
Bring to Front

Align Tops
The selected controls Top are
aligned to the top of the
Primary selection

Align Bottoms

Center Horizontally

The selected controls Bottom The selected controls are


are aligned to the bottom of
centered horizontally to the
the Primary selection
panel

6-148 Chapter 6 Mark VIe Component Editor

Control Width and


Height
Both the width and height of
the selected controls are
made equal to the primary
selection

GEH-6700J ToolboxST

LiveView Controls
The General controls are as follows.
Label is a convention
label control.

Live Value is a live


value as label text.

Setpoint Button is a control to


force a value to the associated
variable.

GEH-6700J ToolboxST

Var:Live is a splitter control


variable name in the first half and
a live value in the second half.

Hyperlink Button is a control to


navigate to another LiveView, a chm
file, or any web URL.

Chapter 6 Mark VIe Component Editor 6-149

The Animation controls are as follows.


Analog Meter the pointer is
deviated with respect to the live
value of the variable.

Bar Graph the bar fills with the


live value of the variable.

Status Indicator indicates the


status of a Boolean variable

6-150 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Attaching a Variable
Use the Add LiveView Item Wizard to add a variable to a LiveView.
To attach a variable
1

From the Tools window, either double-click or drag Var:Live onto the design
surface.

Right-click Var:Live, then


select Attach Variable
and Using Wizard

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-151

Or

Click the ellipsis button


to open the Attach
Variable Wizard.

6-152 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

The Attach Variable Wizard displays. From the welcome screen, click Next.
The data source of the variable is selected from the next wizard screen .

Click Next

Select either System Component or OPC


Server as the data source of the variables to
be added to the LiveView, then click Next.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-153

If you selected System Component in the


previous screen, select the desired component
from the drop-down list, then click Next.

Click the Add button to


display the Select a
Variable dialog box.

6-154 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

GEH-6700J ToolboxST

From the Select a Variable dialog box, select the desired variable, then click
OK. The variable displays in the wizard screen.

Chapter 6 Mark VIe Component Editor 6-155

Click Finish to add


the selected variable
to the LiveView.

Once variables have been attached to a LiveView by using the wizard, additional
variables can be attached directly from the system component.
To attach additional variables
Right-click the variable property, then
select Attach Variable and From G1.
The Select a Variable dialog box displays.

Note You can also attach a variable by entering the variable name in the variable
property.

6-156 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Saving a LiveView
To save a LiveView

From the File menu,


select Save As

Variable Definitions
It is possible to find and display a variable definition.
To display a variable definition

Right-click the variable,


then select Go to
Variable Definition.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-157

Control Constants
Control constants are special read-only variables that are important to key control
algorithms. Control constants must always have a Global scope.
To convert a variable to a control constant
1

From the Software tab, locate and select the variable to convert to a control
constant.

From the Property Editor, locate the Scope property and verify it is set to
Global.

From the Property Editor, change the value of the Control Constant
property to True.

From the Property Editor, assign an Initial Value and edit to Property
Editor. (Optional)

6-158 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

Control Constants Window


All control constants display in the Control Constants window, where the constants
can be reviewed and the Initial Values can be modified.
To display the Control Constants window
Open a Mark VIe Component Editor. From the View menu, select Control
Constants.
Enter a new value into the Initial
Value box. Initial Value is the only
column that can be modified from
the Control Constants screen.

GEH-6700J ToolboxST

Click to display the


Modify Value dialog box.

Chapter 6 Mark VIe Component Editor 6-159

Importing and Exporting Control Constants


The control constants for a controller can be exported to a comma separated value
(.csv) file for external viewing and changes. Previously exported control constant
files can be imported back into the controller. During an Import, the initial values of
the control constants are updated according to the values in the .csv file. A sample
.csv file is provided below to illustrate the output format:
NAME,VALUE,TYPE,UNITS,DESCRIPTION,FORMAT SPECFICATION
ControlConstant3,6.234,REAL,,,
ControlConstant2,55,DINT,,,
ControlConstant6[0],true,BOOL,,,
ControlConstant6[1],false,BOOL,,,
ControlConstant6[2],true,BOOL,,,
ControlConstant6[3],false,BOOL,,,
ControlConstant6[4],true,BOOL,,,
ControlConstant4,8769.876,LREAL,,,
ControlConstant5[0],20.1,REAL,,,
ControlConstant5[1],23.2,REAL,,,
ControlConstant5[2],34.5,REAL,,,
ControlConstant5[3],40.6,REAL,,,
ControlConstant5[4],55.5,REAL,,,
ControlConstant1,1,BOOL,,,
Note If any fields other than the Value field have been modified in the .csv file, the
control constant is not updated.
To export control constants to a .csv file
Open the Control Constants window. From the File menu, select Export to
csv. In the dialog box that displays, select a location for the exported data and
click Save.
To import control constants from a .csv file
Open the Control Constants window. From the File menu, select Import
from csv. In the dialog box that displays, select a location for the imported data
and click Save.
Note During an Import, the Override Value property of all control constants that are
linked to a library and have a different initial value from the value in the.csv file are
set to True.

6-160 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

I/O CheckOut
The I/O CheckOut feature allows you to verify the operation of each I/O point.
To display the I/O CheckOut points
From the Hardware tab Tree View, right-click a board.
From the View menu, select I/O
CheckOut . The I/O CheckOut for
[component name] screen displays.

GEH-6700J ToolboxST

Chapter 6 Mark VIe Component Editor 6-161

Notes

6-162 Chapter 6 Mark VIe Component Editor

GEH-6700J ToolboxST

CHAPTER 7

Chapter 7 Working Online With a


Mark VIe Component
The Mark VIe component is used for control, protection, and monitoring of turbine
and driven load equipment. Vital subsystems, such as servo control, vibration
protection, and synchronization are embedded in the I/O with on-board processors to
optimize performance.
The ToolboxST configuration is the maintenance software tool for Mark VIe
components. The system has a CompactPCI controller with networked I/O. The I/O
processors are located on the terminal boards instead of in centralized board racks.
This configuration digitizes the signals on the terminal boards, which can be
mounted local or remote, individually or in groups.

Connecting to a Controller
Many actions in the Mark VIe Component Editor require an active connection to a
controller.
To connect to a controller
From the System Editor, open a Mark VIe Component Editor. From the
Device menu, select Online or from the System Editor, open a Mark VIe
Component Editor. From the toolbar, click the Online

button.

If you are connecting to a simplex controller, a connection is automatically


established with the R controller. In a dual or Triple Modular Redundant (TMR)
configuration, a dialog box displays to select either a redundant controller (either R,
S, or T) or the controller currently designated as the supplier of initialization data.

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-1

Status Tab
When the ToolboxST application is connected to a Mark VIe component, operating
state and equality information is available from the Status tab of the Component
InfoView window. When used in a redundant controller configuration, the status is
shown individually for each controller in the redundant set.
The color on the Status
tab indicates the overall
state of the controller.

Color

Conditions

Green

All controllers functioning normally.


- Control state is controlling
- Controller Equality equal
- DDR Equality equal

Yellow

One or more of the following:


- Control state not controlling
- Controller equality not equal
- DDR equality not equal
- Frame Idle time < 20%

Red

One or more of the following:


- Control state is failed
- Controller equality has a major difference

7-2 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

The following example displays the unequal state for a dual redundant control. The
DDR Equality attribute text is orange to indicate that DDR Equality is not equal, and
the Controller Equality attribute text is red to indicate that a major difference exists.
Since the Controller Equality attribute takes precedence over the DDR Equality
attribute as indicated in the above table, the Status tab is red.

Controller Attributes
Control State indicates the current state of the controller. When a controller is turned
on, it transitions through several states before arriving at the normal controlling state.
Valid Control States are as follows:
State

Description

Powerup

Power up controller

Master initialization

Initialize controller

Designated controller determination

Determine which controller is designated in a redundant controller


configuration

Data initialization

Perform initialization of non-designated controllers with NVRAM,


command variables, and constants

Inputs enabled

Wait in this state for all required I/O packs to start transmitting inputs

Input voting

Check voting inputs prior to execution of application code

Exchange initialization

Populate redundant controllers with dc state variables prior to voting

Exchanging

Exchange state variables so that a controller joining a running system


wont have a step in its initial calculations

Sequencing

Turn on the application code and execute each task at least once
before driving outputs

Controlling

Turn on outputs

Loading

Online load is in progress

Load complete

Online load has finished. Wait for re-synchronization of redundant


controllers

Fail

Failure has occurred.

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-3

If the indicated Control State is not Controlling, the ToolboxST application can
provide additional information as follows:
Select the Control State.

Or, double-click Control State to display the information in a separate window.


Controller Equality indicates whether equality exists between the software
configuration in the ToolboxST application and the configuration currently running
in the controller. Valid states are Equal, Not Equal, and Major Difference. Refer
to the section, Downloading to a Controller .
DDR Equality indicates whether equality exists between the Dynamic Data
Recorder configuration in the ToolboxST application and the configuration currently
running in the controller. Valid states are Equal and Not Equal.
Designated Controller indicates the controller that is designated as the supplier of
initialization data to the other controllers.
UDH Communicator indicates the controller responsible for communicating on
the Unit Data Highway (UDH) for the Mark VIe component. The UDH
Communicator performs tasks such as sending the EGD exchanges and alarms
produced by the device.
Frame Idle Time is the percentage of CPU time left in the controller after the
critical control functions of input, compute, and output have been completed. If there
is less than 20% idle time, the status is shown in yellow.
System Idle is the percentage of CPU time left in the controller after all functions
have been completed. It accounts for the critical control functions, as well as
background processing and toolbox communication overhead.
System Idle Time Shows:
Number of Forced Variables displays the number of forced variables in the
controller.
Logic forcing procedures can result in personal injury or death, if
not strictly followed. Only adequately trained personnel should
modify any programmable machine. Forcing of control logic for
an operating process is strongly discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly enforced in
conjunction with this procedure.
Heart Beat indicates whether the controllers are exchanging the Control state
variables. If the number shown is incrementing, the Control state variables are being
exchanged.
Controller Time shows the time that the controller is using.

7-4 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

Downloading to a Controller
The ToolboxST application is used to configure both a Mark VIe component and its
distributed I/O modules. Both the component and the I/O modules have four items of
software that can be downloaded:
Boot Loader starts the operating system for the controller and modules, much like
the BIOS on a desktop computer. Changes to the boot loader are very infrequent.
Base Load contains the operating system for the controller and I/O modules. While
changes to the base load are more likely than changes to the boot loader, they still
occur infrequently.
Firmware provides the functionality of the controller and I/O modules. It can be
updated over the lifetime of the controller to incorporate new features and bug fixes.
Application Code contains the configuration of the controller as created in the
ToolboxST application. Whenever a change is made to the configuration, the
application code must be downloaded. There are two types of application code
download, online and offline. An online download, which is common, changes the
configuration without interrupting control; the new configuration takes effect
between control frames. An offline download requires a controller restart, and is
much less frequent. The type of download needed is determined by the types of
changes that have been made to the controller configuration.
Boot loader, base load, firmware, and offline application code
downloads all require the target device to be restarted. Before
downloading new code to a controller, take necessary steps to
secure the controlled equipment to prevent equipment damage
and/or personal injury.

Download Command
The Download item in the Device menu displays a submenu of commands. Besides
the Controller Initial Setup and Download Wizard commands, the following
commands are available:
Controller Flash Boot Loader is used to install the controller's boot loader on a
CompactFlash memory card. To use this command, you must have a compatible
CompactFlash reader attached to your computer.
Update Dynamic Data Recorders updates the standalone data collectors that can be
reconfigured without affecting any of the control code.
View / Set Time is used to set the time on a controller.

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-5

Controller Setup
The Controller Setup wizard prepares a controller for use by configuring its IP
address and redundancy information. A controller cannot communicate on a network
until these setup tasks are complete.
To set up a controller
1

Connect a serial cable from the main board of the controller to a free serial port
on your computer.

Open the Mark VIe Component Editor for the controller to be configured.

From the Device menu, select Download, and then Controller Setup. When
the Welcome window displays, click Next to continue.

Click Next to continue.

7-6 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

Select the desiredChannel, then click Next to continue. A


progress dialog box displays the status of the setup.

If Format Flash is selected, click Next to


re-program the selected CompactFlash.

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-7

Click the Scan


button to search for
available
CompactFlash
cards.
To configure TCP/IP
Settings, select the
available channel(s),
then enter a Host
Name, a Gateway IP
Address , an IP
Address, and a
Subnet Mask for
each.

Click the Finish button.

Note If the controller is configured as either simplex or dual, some channels may
not be available.

Download Wizard
The Download Wizard is the primary method of transferring software to a Mark VIe
component and its distributed I/O modules over an Ethernet connection. The wizard
can automatically examine the configuration of the system to locate out-of-date
software, or you can manually select individual items to download.
Boot loader, base load, firmware, and offline application code
downloads all require the target device to be restarted. Before
downloading new software to a controller, take necessary steps to
secure the controlled equipment to prevent equipment damage
and/or personal injury.
To download software to a controller
1

Open a Mark VIe Component Editor. From the Device menu, select
Download, and then Download Wizard to display the Download Mark VIe
Controller wizard.

If you have changed configuration settings since the last Build operation, a
message box displays indicating that the software is out of date. Click Yes to
build the current configuration. The Download Mark VIe Controller wizard
opens.

7-8 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

Click the Next button to advance past the wizards introductory page.
If the Scan I/O checkbox is selected, the scan
command determines whether I/O module
software needs to be downloaded.

Click Next.

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-9

Displays overall progress.

Shows status of individual


download operations.

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.

7-10 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

Dual Controller Download


The ToolboxST application supports the ability for downloading controllers that
have dual redundancy. This feature allows you to select one of the two controllers to
download, then provides a configured time period to review the changes running on
the downloaded controller. Based on that review, the changes can either be
downloaded with the new configuration or reverted to the other controller. That
controller assumes control and the previously running configuration is restored on
the downloaded controller.
To download a dual controller
1

GEH-6700J ToolboxST

From the Download MarkVIe Controller wizard, select a dual controller to


download. The Mark VIe Dual Online Download Manager displays.

Chapter 7 Working Online With a Mark VIe Component 7-11

If you do not select the recommended First Download, a message box


displays.

If you selected the


recommended First
Download, the
selected controller is
downloaded.

The Accept and Revert buttons become


available, and a two-minute timer begins.

Note During this time period, the controller Editor window displays to allow you to
confirm that the code changes being downloaded are functioning properly. You can
navigate the configuration, as well as access the Trender, Watch Windows and
LiveView features.

If the changes are okay, click the Accept button


in the previous screen. Click the Close button.

7-12 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

If you are not satisfied with the code changes during the two-minute time period,
click the Revert button. This causes the second controller to become the
designated controller and causes the first controller to revert its running
configuration to the previous version.

If you initiate a
download after
performing the
revert function, the
second controller
displays as the
designated
controller.

Note If you do not click either the Accept or Revert buttons during the two-minute
time period, the revert function is automatically invoked.

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-13

Upload Wizard
The ToolboxST application can retrieve existing configuration information from a
Mark VIe component using the upload wizard. When a configuration is uploaded, it
is stored as a new Mark VIe component in the currently open system. The uploaded
configuration is useful as a reference for comparisons with other components and for
retrieval of existing code.
To upload the configuration from a Mark VIe component
1

Open a Mark VIe Component Editor. From the Device menu, select
Upload to display the Upload Controller wizard.

Click Next to advance past the introductory page of the Upload Controller
wizard. If the Mark VIe is configured as a redundant component, the following
page displays with an option button for each available redundant component.

Select a controller
and then click Next.

7-14 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

GEH-6700J ToolboxST

When the upload completes, click Next to display the final page of the wizard.

Chapter 7 Working Online With a Mark VIe Component 7-15

Controller Diagnostics View


The Controller Diagnostics View displays diagnostic messages for a controller
component. Diagnostic messages are errors or warnings that occur in the hardware
component and could cause the component to function improperly. Retrieving these
messages should be one of first steps in diagnosing any problems with hardware,
communications, or other related ToolboxST subsystems.
To open Controller Diagnostics view
1

From the Main menu, select View.

From the View menu, select Controller, then Controller Diagnostics.

The Controller Diagnostics dialog box displays.


Click this button to clear
diagnostic messages with the
status of 0. Only these inactive
messages may be reset.

Click this button to


manually retrieve
diagnostic messages.

Select this check box to show


diagnostic messages with status
of 1 only. Clear this box to show
all messages.

In a Duplex or TMR
configuration, use this
drop-down list to
select the desired
redundancy
component for which
to retrieve diagnostic
messages.
Displays the
timestamp of the
message.

The fault code of


the message.

7-16 Chapter 7 Working Online With a Mark VIe Component

The status of
the message
(0-inactive,1- active).

The human
readable description
of the message.

GEH-6700J ToolboxST

I/O Diagnostics View


The I/O diagnostics view displays diagnostic messages for a component hardware
I/O module. Retrieving these messages should also be one the first step in diagnosing
any problems with hardware I/O.
To open I/O Diagnostics view
1

From the Main menu, select View.

From the View menu, select Diagnostics, then I/O Diagnostics. The I/O
Diagnostics View displays.

For more information, refer to Chapter 4, the section Diagnostics Tab .

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-17

Administer Totalizers
Each Mark VIe controller maintains a set of 64 counters in non-volatile RAM
(NOVRAM) known as Totalizers. Each Totalizer counts the number of times that a
particular event has occurred. Events are assigned to Totalizers by configuring a
Totalizer block. Only one Totalizer block is allowed per controller. Any user may
view the current values of the Totalizers, but to protect data integrity, a special
password from GE is required to change them.
Note Before modifying Totalizer values in a redundant controller, connect to the R
controller and make sure all other redundant controllers are healthy and
communicating.
To view Totalizer values
1

Establish a connection to the R controller. For more information, refer to the


section, Connecting to a Controller .

From the Device menu, select Administer Totalizers to open the View/Set
Totalizers dialog box.

The name of the Totalizer


block pin connected to the
totalizer. (If blank, the Totalizer
has not been configured.)

The name of the


variable connected to
a configured pin.

The current value of the


counter. The values displayed
are retrieved live from the
controller and are updated
once per second as long as the
dialog box is open.

7-18 Chapter 7 Working Online With a Mark VIe Component

Click here to
close the dialog
box.

GEH-6700J ToolboxST

Totalizer Passwords
All users can view Totalizer values, but modifying the values requires a temporary
password obtained from GE Energy.
Note Totalizer passwords are specific to the connected redundant controller (R, S,
or T) and cannot be used on other controllers.
To request a Totalizer password
1

Establish a connection to the R controller. For more information, refer to the


section, Connecting to a Controller .

From the Device menu, select Administer, and then Totalizers to open the
View/Set Totalizers dialog box.

Under Totalizer Identifier and Password, click the Request button. A file
named Totalizer_ID.txt is created in the same folder as the controller
configuration files on your disk. Open the file in Notepad.

To obtain a password,
follow the appropriate
directions.

Copy the password to


the Windows
clipboard, then return
to the View/Set
Totalizers dialog box.

Paste the password in the Password: text box. If the password is valid, a
countdown timer displays to indicate the time remaining before the password
expires.

Note Totalizer passwords are usually valid for 24 hours from


time of creation.

GEH-6700J ToolboxST

Chapter 7 Working Online With a Mark VIe Component 7-19

Modifying Totalizer Values


Once you have entered a valid password, you can modify Totalizer values. (For
assistance with Totalizer passwords, refer to the section, Totalizer Passwords .)
To modify a Totalizer value
Open the View/Set Totalizers dialog box and enter a valid password.

From the Totalizers list,


click the Totalizer to
change, and then click
the Modify Selected
button to display the
Modify Totalizer Value
dialog box.

Enter a new value for the


Totalizer in the New Value
box, and then click theOK
button. The value is
immediately sent to the
controller.

7-20 Chapter 7 Working Online With a Mark VIe Component

GEH-6700J ToolboxST

CHAPTER 8

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

-orFrom the Edit menu, select Find.


Select Match
Case to
distinguish
between upper
and lower case
in the search

Enter text to
search for

Select a
search type

Click to display
available wildcards

Click Find to
begin search
process
Click Replace
for options to
replace text

Select to
include variable
descriptions in
the search

Select Entire
System to search
every component in
the System Editor

Select to include
libraries in the
search if a library
editor is open
Select to
include block
diagram items
in the search
Select to search inside
blocks below the current
location. If not selected, only
the current level is searched.

Select Open
Components to
search all those
open in the
System Editor
Select to keep
Select to search
Finder open
inside the current
between searches component

Select to search
inside the currently
selected item

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-6700J ToolboxST

Chapter 8 Finder 8-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.

8-2 Chapter 8 Finder

GEH-6700J 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-6700J ToolboxST

Chapter 8 Finder 8-3

Replace Options
Besides performing simple searches, the Finder also supports search-and-replace
operations.
To display the Replace options
In the Finder window, click the Replace button. The window expands to
include new options.
In the Replace With:
text box, add the text
to be substituted

Select to keep the


Finder open between
searches

8-4 Chapter 8 Finder

The Replace button replaces The Find First button


the currently displayed Find
navigates to the next
text with the Replace With text occurrence of the Find text

Replaces all occurrences


of the Find text with the
Replaced With text

GEH-6700J ToolboxST

CHAPTER 9

Chapter 9 Trender
The Trender is a tool used to capture and display trend graphs of variables in the
system. It can collect and display values in real time from controllers and other
sources, and can display data collected by high-speed coherent data collection
systems, such as capture buffers and dynamic data recorders. The Trender also can
display previously captured data from a saved data file.

Accessing a Trender Window


Before you can analyze data trends, you must first open a Trender window. A
Trender window displays a collection of traces and data that is saved between uses.
You can open a Trender window from inside the ToolboxST application or
separately from the Start menu. If you open a Trender window from inside the
ToolboxST application, the window is stored inside a component or the system, and
you can create as many Trender windows as necessary. If you open the Trender from
the Start menu, files are saved with a .trend file extension.
To create a Trender window outside the ToolboxST application
From the Start menu, select All Programs, GE Control ST, and
ToolboxST. Click Trender. A new Trender window displays.

GEH-6700J ToolboxST

Chapter 9 Trender 9-1

To create a Trender window from the System Editor


From the Tree View, right-click the system name, then select Insert New,
Tool, and Trender. A new Trender window displays.
To create a Trender window from a Component Editor
From the Component Editor, click Device and select Trenders. A new
Trender window displays.
To save a Trender window
From the Trender toolbar, select the Save button. If you opened the current
Trender window from within the ToolboxST application, the Trender window
saves automatically. If you opened the Trender window from the Start menu,
the Trender window saves to a file.
Note While Trender windows opened from the Component Editor are associated
with one particular component for storage purposes, they are not restricted to
trending only that component, and may be used to monitor any variables.

Trender Window Features


Trender toolbar
contains commands
for commonly used
tasks in the Trender
window.

Graph View
contains the trend
graphs, which
display the values
represented by
each trace.
X-Axis markers
designate alarm
and event times.
Property Editor
allows you to change
settings that affect the
capture and display of
data.
Data toolbar
contains commands
that manipulate the
current data.
Traces tab
displays traces
currently being
monitored by the
Trender window.

User Note tab


Sources tab
allows you to save displays sources
comments,
where data is
instructions, and
collected.
notes about the
current chapter.

9-2 Chapter 9 Trender

Events tab lists


all events that
have occurred
during the
current chapter.

Auxiliary View
Mode Indicator
contains tabs that displays the
display
current mode
information about (Live or Replay).
the current data.

GEH-6700J ToolboxST

Trender Toolbar
Note The Trender toolbar may have fewer buttons if the current Trender window
was opened from the ToolboxST application.
Open existing
Trender window

Save current
Trender

Undo

Redo

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
live source

Pause

GEH-6700J ToolboxST

Add traces

Remove
selected traces

Zoom In &
Zoom Out

Time Axis Reverse


& Forward

Auto-range
selected traces

Chapter 9 Trender 9-3

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 .)
To add traces
1

From the Edit menu in the Trender window, select Add Traces. If there are
currently no traces on the Trender, the Trender Add Trace Wizard
Welcome screen displays. From the Welcome screen, click Next to continue.

From the following wizard screen, select the data type you wish to trend.
Historical data is stored in all
Historians associated with the
currently configured controller.

Static data is stored in .csv files in


the currently configured controller.

9-4 Chapter 9 Trender

From the next wizard screen, select the data source from which to add the
variables to trend.

From the next wizard screen, select the specific component from which to select
the variables to trend.

GEH-6700J ToolboxST

From the next wizard screen, select the time period at which the variables will
trend.

The final wizard screen allows you to select variables to trend.

Click the Add button to display the


Select a Variable dialog box.

GEH-6700J ToolboxST

Chapter 9 Trender 9-5

Select a variable,
then click OK.

The selected variable displays in the wizard


screen. Click the Add button.

If there are already traces on the Trender, you can add additional traces from the
same component.

9-6 Chapter 9 Trender

GEH-6700J ToolboxST

To add additional traces


1

From the Edit menu, select Add Traces. The Select a Variable dialog box
displays available variables for that component.

Add variables from a different component by clicking the drop-down button


next to the Add Traces button.

Note You can add traces from the currently selected component or add traces from
a new component by selecting Add using Add Trace Wizard from the drop-down
list.
The selected variable displays in the Traces tab in
the Trender windows Auxiliary View.

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

GEH-6700J ToolboxST

If the Trender window to which you would like to add the trace is not already
open, refer to the section, Accessing a Trender Window .

From the Edit menu, select Add Traces. (or click the Add Traces button on
the data toolbar). If there are already traces on the trender, the Select a
Variable dialog box for the current data source displays, which you can use to
select the variables to monitor. If there are no traces on the trender, the Add
Trace Wizard displays. If there are traces and you would like to add traces for
a different live data source, you can also invoke the Add Trace Wizard by
clicking the drop-down list attached to the Add Traces button.

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.

Select System Component, then click Next.

Chapter 9 Trender 9-7

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.

Select the component from which you wish to trend variables, then click Next.

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

From the next wizard screen, click the Add button to display the Select a
Variable dialog box, then select one or more variables to monitor. When you
are finished, click OK in the Select a Variable dialog box, then click Finish
in the wizard screen. The newly created traces display in the Traces tab.

Triggered Live Trends


The Trender supports triggered live trends, which allow you to collect incoming data
for specific triggered events in the control system. A triggered trend can capture data
for a predetermined period before and after the trigger event occurs.
To configure a triggered trend
1

Add a live trend, as described previously.

From the File menu, select Properties or click the Trender Properties
button. The Settings dialog box displays.

9-8 Chapter 9 Trender

Enter values for the Triggered Recording properties.

GEH-6700J ToolboxST

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.

From the Edit menu, select Add Traces. The Add Trace wizard displays.

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.

Select the component from which to trend variables, then click Next. A list of
all available capture buffers displays.

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.

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

GEH-6700J ToolboxST

If the Trender window to contain the new trace is not already open, refer to the
section, Accessing a Trender Window.

From the Edit menu, select Add Traces. The Add Trace wizard displays.

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.

Select the type of data source to import from and click Next to display an Open
dialog box.

Select the desired static file source, then click Open.

The Select Variables wizard page displays. Click the Add button to display
the Select a Variable dialog box. The ToolboxST application analyzes the
selected file and displays a list of available variables. Select one or more
variables to convert to traces. When you are finished, click OK in the Select a
Variable dialog box, then click Finish in the wizard. The newly created traces
display on the Trace tab.

Chapter 9 Trender 9-9

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
button on the Trender toolbar. (If any of the source
Select the Online
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
button. The Trender
On the Data toolbar, select the Record Data
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
button. Data continues to be
On the Data toolbar, select the Pause
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
returns to Replay mode.

button. The Trender

To retrieve data from a capture buffer


On the Data toolbar, select the Upload

9-10 Chapter 9 Trender

button.

GEH-6700J ToolboxST

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
or Next
Chapter button on the Data
Click the Previous Chapter
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.

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

GEH-6700J ToolboxST

Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired value.

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.

Chapter 9 Trender 9-11

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

9-12 Chapter 9 Trender

Select an active cursor.

From the Edit menu, select Add User Event. (Or, press the shortcut keys
CTRL+M.)

Enter a name for the new event, and select OK.

GEH-6700J ToolboxST

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

GEH-6700J ToolboxST

Chapter 9 Trender 9-13

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.

From the Property Editor, locate the category Grid Lines and set the values
for Horizontal and Vertical to either True or False.

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

9-14 Chapter 9 Trender

From the Options menu, select Settings. The System Options dialog box
displays with Trender selected in the Tree View.

In the Property Editor, under the category General, enter a new value for
Sample Markers.

Click OK to close the Settings dialog box.

GEH-6700J ToolboxST

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

GEH-6700J ToolboxST

button on the Data toolbar.

Chapter 9 Trender 9-15

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.

In the Property Editor, locate the Pen category and select the Color
property.

Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.

Click the square that corresponds to the desired trace color. The trace updates
automatically.
To modify the default trace colors

9-16 Chapter 9 Trender

From the Options menu, select Settings.

Locate and select the Trender item in the Settings window.

In the Property Editor, select the number of the trace (for example, 2nd Trace)
to be changed.

Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.

Click the square that corresponds to the desired trace color.

When you have finished changing trace colors, click OK.

GEH-6700J ToolboxST

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.

From the Edit menu, select Hide Selected Traces, or right-click on the
selected traces and select Hide Selected from the context menu.

-or

Select the check box next to the variable name in the Traces tab or the
Auxiliary View to hide or show the trace on the graph.
To show or hide a trace
From the Edit menu, select Show Traces. Select and clear the check boxes
next to the trace names as desired, then click OK.

-or

Select the check box next to the variable name in the Traces tab or the
Auxiliary View to hide or show the trace on the graph.

Statistical Calculations
The Trender can calculate a set of basic one variable descriptive statistics for
collected data while in the Replay mode. These statistics, which are calculated only
on data in the time range selected by the two cursors, include average, standard
deviation, minimum, maximum, and difference (calculated as final initial). The
calculated values display as columns on the Trend tab when enabled.

To display statistical calculations

GEH-6700J ToolboxST

From the Options menu, select Settings.

Locate and expand the Trender item in the Settings window. Under the
Trender item, select Replay Columns.

In the Available list, select one or more columns to enable. (To make multiple
selections, hold down the CTRL key while selecting additional items.)

Click the Add

When you have finished enabling statistics, select OK.

button to move the statistics to the Selected list.

Chapter 9 Trender 9-17

Exchanging Trender Data


Exporting to a File
The Trender can export all traces contained in a Trender window to a file for external
analysis. This file can be imported into third-party applications or exchanged with
other users. All traces, including ones currently hidden, are exported.
To export all traces to a file
1

From the File menu, select Export Data.

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

Select OK when you have finished selecting options. A Save dialog box
displays.

Select a location for the exported file and click OK.

Controls whether the first line of


the exported file contains header
information for each column.

Controls the character


used to separate values
in the exported file.

Controls whether a
column containing
timestamps is added
to the output.

Controls the text


exported when no
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.

9-18 Chapter 9 Trender

GEH-6700J ToolboxST

Spectral Analysis
The Trender provides the ability to perform a spectral analysis on a dataset.
To perform a spectral analysis
From the View menu, select Spectral Analysis.

A digital spectrum analysis of a waveform changes this time domain data into
frequency domain data, also called a frequency spectrum of the dataset. This is also
referred to as a Fast Fourier Transform (FFT).
The effect of an FFT on a sample dataset is shown below. The first is an input
dataset showing actual generator speed (RPM) and PWA accelerometer Y/Z
direction data (force in Gs).
Note The spectral analysis of this data is able to quickly isolate the most common
frequencies at which this data is varying.

GEH-6700J ToolboxST

Chapter 9 Trender 9-19

In the example above, analyzing the input waveform (top) produces the frequency
spectrum below it, where three distinct groupings display at frequencies centered on
0.1, 0.35, and 0.9.

9-20 Chapter 9 Trender

GEH-6700J ToolboxST

FFT Options
The Fast Fourier Transform (FFT), activated by the Spectral Analysis option, is
configurable.
To access FFT settings

Click the Trender Properties


icon. The Trender Settings
dialog box displays.

FFT options include the following:


Between Cursors, if set to True, applies an FFT between the left and right cursors
that can be positioned inside the graphics window.
Padding Factor provides a way to interpolate between real points with copies of
the same data, which enhances the spectrum resolution.
Remove Mean, if set to True, improves the ability to scale the data for
visualization.
Windowing Mode affects the equations used by the FFT. The following
windowing modes are available:

GEH-6700J ToolboxST

None

Hann

Hamming

Barlett

Welch

Chapter 9 Trender 9-21

Notes

9-22 Chapter 9 Trender

GEH-6700J ToolboxST

CHAPTER 10

Chapter 10 EGD Editor for External


Devices
The EGD Component Editor for external devices allows you to configure Ethernet
Global Data (EGD) for an external or third-party device. The EGD protocol allows
controller devices (sometimes known as nodes) to share information in a networked
environment. EGD allows one controller device, referred to as the producer of the
data, to simultaneously send information to any number of peer controller devices
(consumers) at a fixed periodic rate. This network supports a large number of
controller devices capable of both producing and consuming.

Network Adapters
The General tab configures Ethernet adapters for an external EGD-capable
components. One adapter is created by default, and up to four adapters can be added.
To add a network adapter
1

From the System Editor, right-click an external device, then select Edit
Selected Component. (If Edit Selected Component is not available, the
EGD Editor Enable property of the component may be set to False.) The
EGD Component Editor opens.

From the Component Editor, select the General tab.

From the Tree View, right-click the Network Adapters item, then select Add
Adapter.

To remove a network adapter

GEH-6700J ToolboxST

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.

From the Component Editor, select the General tab.

From the Tree View, right-click the network adapter to be removed, then select
Delete Adapter.

Chapter 10 EGD Editor for External Devices 10-1

The following properties are available for configuration when a Network Adapter is
selected in the Tree View:

Configuration options for the Network Adapter are as follows:


Adapter Settings Category

Host Name

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

IP Address

This is the IP address for the selected network adapter.

Wire Speed

This is the speed of the connected network.


Network Settings Category

Network Name

This is the name of the connected network.

Subnet Mask

This is the subnet mask associated with the connected network.


Network Switch Connection Settings Category

Network Switch

This is the network switch the network adapter is attached to.

Port Number

This is the network switch port the network adapter is attached to.

10-2 Chapter 10 EGD Editor for External Devices

GEH-6700J 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.)

From the Component Editor, select the EGD tab.

In the Tree View, select Ethernet Global Data. The Ethernet Global Data
properties display in the Property Editor.

In the Tree View, select


Ethernet Global Data.
The Ethernet Global Data
properties display in the
Property Editor.

These properties are available for configuration when Ethernet Global Data is
selected in the Tree View:
Collection controls the Collection to which this EGD component belongs when
viewed in the EMT tool. This information is published to the EGD Configuration
server in the GUI component document, GUIDevice.xml.
Producer ID sets and displays the EGD Producer ID for this component. This is
assigned when the component is created. The Property Editor displays the EGD
Producer ID formatted as an unsigned integer, but dotted and hexadecimal
button.
representations are available by clicking the ellipsis

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.

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-6700J ToolboxST

Chapter 10 EGD Editor for External Devices 10-3

Editing Produced Pages


To configure a Produced Page
From the Tree View, select the EGD tab, then expand the Produced Pages.

From the Tree View


Produced Pages item,
select the desired page.

The page properties


display in the
Property Editor.

10-4 Chapter 10 EGD Editor for External Devices

GEH-6700J ToolboxST

The following properties are available for configuration when a Produced Page is
selected in the Tree View:
Destination Category

Destination IP
Address

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

Ethernet 0

If set to True, EGD is broadcast on Ethernet 0. (If more than one Ethernet
Adapter has been configured for EGD, additional Ethernet properties display.)

Mode

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


supported by the components EGD implementation profile.
- Broadcast sends the page to all EGD components.
- Unicast sends the page to a single destination.
- Multicast sends the page to the specified multicast addresses.
General Category

Exchanges

This indicates the number of exchanges in the selected page. It is updated


after selecting the Build command.
Setup Category

Layout Mode

This determines whether the exchange numbers and offsets are assigned
automatically at build time or are entered manually.

Name

Use this property to rename the selected page.

Period

This is the transmission period of the page in milliseconds.

Skew

This is used to prevent exchanges with the same period from being produced
at exactly the same instant. The skew for the first exchange in the page is set
to this value, and each additional exchange skew differs from the previous
exchanges skew by exactly this value (in nanoseconds). For example, if you
have three exchanges in a page and a skew value of 2, the first exchanges
skew is two, the second exchanges skew is four and the third exchanges
skew is six.
Note The Skew property will not be visible if it is not supported in the
implementation profile configuration.

Starting
Exchange ID

GEH-6700J ToolboxST

This sets the Exchange ID used for this page. Each additional exchange will
be incremented from the number.

Chapter 10 EGD Editor for External Devices 10-5

Page Compression
When a page compression is performed, the variables are located in increasing size
order, starting with Booleans, then Words, Double Words, and finally all other
variables. A page compression causes an exchange major signature. Consumers can
mark the exchange variables as unhealthy until the consumed configuratuion can be
rebound.
To compress a single page
From the Tree View, right-click the page to compress, and then select
Compress.

To compress all Produced Pages in a component


From the Tree View, right-click Produced Pages, and then select
Compress All.

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.

10-6 Chapter 10 EGD Editor for External Devices

GEH-6700J ToolboxST

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.

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

GEH-6700J ToolboxST

From the EGD tab, select the Configuration tab, then select a Produced
Page in the Tree View.

Right-click an exchange in the Summary View, then select Edit Exchange


Signatures and Configuration Time.

Review the warning about manual Exchange Signature editing, then click
OK.

Chapter 10 EGD Editor for External Devices 10-7

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

10-8 Chapter 10 EGD Editor for External Devices

GEH-6700J ToolboxST

Implementation Profile
Each EGD node type has a set of supported EGD features. For example, a device
might have an EGD implementation that only supports broadcast-produced data. The
implementation profile contains details about the EGD implementation of a
particular device.

GEH-6700J ToolboxST

Chapter 10 EGD Editor for External Devices 10-9

The following properties are available when editing an Implementation Profile:\


Configuration Category
Configuration Support

Allows you to edit various configuration features as follows:

Accepts Deletes indicates device support for HTTP deletes.

Accepts Puts indicates device support for HTTP Put commands.

Multiple Producer IDs indicates device support for multiple producer


IDs.

Zip Content indicates device support for zipped transfers.


Data Category

Data Types

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

Double Word Alignment The offset of a DWORD length variable must be evenly divisible by this
number.
This is set to True if the component requires that all WORD length variables
be aligned on an even boundary.

Word Alignment

Feature Support Category


Broadcast

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

Masked Write

This is set to True if the component supports the MaskedWrite command and
False otherwise.

Max Coherent Data

This returns the maximum size (in bytes) of a variable that still is guaranteed
coherent transfer. If the attribute is not present, then all data is guaranteed
coherent transfer regardless of size. It is optional and is initialized to 0.

Max Exchanges

This returns the maximum number of exchanges supported by the device. It is


optional and is initialized to 0.

Max String

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

Multicast

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

Skew

This is a Boolean value representing the capability of the producer to support


the skewing of produced exchanges with respect to time.

Unicast

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

Device Class

This is the class of the device as defined in the EGD Protocol Specification:
Class Description
0

Supports only the configuration port.

Supports the data port and the Data Production PDU.

2
Supports all class 1 services, plus at least acts as a responder for the
command port, and the commands associated with that port.
3
Supports all class 2 services, plus the configuration port, and the required
commands associated with that port. Such devices support responding to
configuration requests but do not dynamically bind their consumed variables.
4
Supports all class 3 services, plus dynamically binding consumed
variables.
Device Name

This is the name of the class of device to which this device belongs

10-10 Chapter 10 EGD Editor for External Devices

GEH-6700J 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-6700J ToolboxST

Chapter 10 EGD Editor for External Devices 10-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.

10-12 Chapter 10 EGD Editor for External Devices

GEH-6700J ToolboxST

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 Configuration Server Tab


The EGD Configuration Server tab in the Summary View allows you to view and
delete EGD nodes currently residing in the configuration server. The configuration
server used is the one defined in the System Editor in the Tree View. If the server is
enabled, this tab displays information from that server.
Note The EMT provides a detailed view of the configuration server contents.

The tab control contains a toolbar with two buttons:


The Filter Toggle button defaults to a filtered state. It displays items that have
the same name but have a different Producer ID as the open component.
The Delete button deletes the selected item(s). If the item(s) were saved as part
of the configuration, they can be added again.
The EGD configuration server uses the producer ID to store all the documents for an
EGD node.
Note A system can have one EGD Configuration Server only.
If you open two systems, then point to the same configuration server and save a
device of the same name with two different producer IDs to that server, you can end
up with two producer ID nodes with the same device name.

GEH-6700J ToolboxST

Chapter 10 EGD Editor for External Devices 10-13

External Device Menus


Menu

Command

Use to

File

Save

Update the EGD configuration files, refreshes consumed exchanges


and variables, assigns produced variables to exchanges, and, if an
EGD configuration server has been specified, publishes the
configuration to the server

Import and Export Transfer produced data, consumed data, symbols, implementation

profiles, and GUI device EGD configuration files to and from a variety
of file formats

Edit

View

Print

Print the summary grid view with the column selection, order, and width
currently visible in the view

Close

Close the currently opened device

Undo

Remove the item currently selected in the Tree View

Redo

Add a new component to the current system

Cut

Cut the selected item in the Tree View

Copy

Copy the selected item in the Tree View

Paste

Paste the copied item in the Tree View into the Summary View

Delete

Display the System Information Editor (refer to the section System


Information Editor)

Find

Display the Component Editor for the item currently selected in the
Tree View

Go Forward

Return to the view that immediately follows the current view in the
history.

EGD Management Open the EGD Management Tool screen.


Tool
Device

Help

Online

Send CMP messages to EGD Class 2 or higher devices to view live


values from the device.

Bind and Build

Refresh the consumed information for all referenced devices,


automatically sets the layout of any unassigned produced variables,
and, if no errors occur, publishes the configuration to the EGD
configuration server.

Put Device to
SDB

Store the current EGD configuration to the System Database (SDB). It


is only available if the system has an SDB enabled and configured.

Release Notes

Display the release notes for the current version of the application.

About

Display version and copyright information about the application.

10-14 Chapter 10 EGD Editor for External Devices

GEH-6700J ToolboxST

CHAPTER 11

Chapter 11 Configuration
Management System (CMS)
Installing the CMS Server
A CMS server must be installed separately on a single master computer and
configured for a specific site. A user must have administrator privileges to control
access to the systems and perform certain tasks.
The CMS server uses a repository to track system changes, and to control client
access. Each repository contains a list of CMS users and permissions for the
repository. The repository maintains the revision change history for ToolboxST
systems that are added to the repository. A CMS server can have one or more
repositories, and each repository can contain one or more ToolboxST systems.
To install the CMS server
1

Place the CD in the CD-ROM drive. The installation starts automatically. The
Setup dialog box displays.

From the Setup GE


ControlST dialog
box, select the GE
CMS Server check
box.

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-1

The GE CMS Server option is typically only installed on one


computer at a site. Therefore, if either of these options is selected,
a message displays asking you to verify that you want to install the
option at more than one location.
2

The Welcome dialog box displays. Click Next. The License Agreement
dialog box displays.

To continue the installation, you must accept this agreement. Select Agree.

Click Next. The User Information dialog box displays.

Click Next. The Destination Folder dialog box displays. If this is the first
time the ToolboxST application has been installed on this computer, the Browse
button allows you to change the default install location (C:\Program
Files\GE Energy\). If this is a subsequent installation, this dialog box
displays where this version of the product is installed.

Continue to click the Next until the installation starts. Click Finish when the
installation has completed successfully.

Note For the CMS server to work correctly, the Use Simple File Sharing option
check box must be cleared.
Right-click Start and select Explore. From
the Tools menu, select Folder Options to
display the Folder Options dialog box.

From Advanced settings, clear the Use


simple file sharing check box, then click OK.

11-2 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

Creating Windows User Accounts


Note You must have administrator privileges to create user accounts on the server
computer.
CMS uses Windows security (domain or workgroup) for authentication. All CMS
user names must exist in Windows (domain or workgroup) before they can be added
in the CMS server.
For workgroup security, the CMS user names only need to be added as Windows
users on the CMS server computer (users do not need to be added on all CMS client
computers).
For domain security, the CMS user names must be added by the domain
administrator if they do not exist.
To create users in Windows
1

From the Start menu, select Control Panel, Administrative Tools, and
Computer Management. The Computer Management screen displays.

From the tree view, select


Local Users and Groups.
Right-click Users and
select New User.

GEH-6700J ToolboxST

The New User dialog box displays.

Chapter 11 Configuration Management System (CMS) 11-3

Enter the User


name. Enter
an optional
Full name and
Description, if
desired.
Enter a
Password,
then re-enter
it to confirm.
Select any of
these options,
if necessary,
then click the
Create button.

Note When creating accounts specifically for CMS use in a workgroup, select the
options User cannot change password, and Password never expires.

11-4 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

To make the new user an administrator


1

From the Computer Management screen, right-click the new user and select
Properties. The Properties dialog box displays.

Select the Member Of


tab.
Select the
Administrators group
and click Apply and
OK.
If the Members Of
tab is blank, click the
Add button.
The Select Groups
dialog box displays.

Click the Advanced


button to select the
Administrators group.

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-5

Click the Find Now


button to display
available groups.

Select
Administrators
then click OK.

The dialog box closes and the previous Select Groups dialog box displays again,
with the Administrators group displayed in the object name text box.
2

Click OK. The User Properties dialog box displays again with the Member
Of tab selected.

From the Member Of tab, select the Administrators group, click Apply and
OK.

11-6 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

Configuring the CMS Server


The CMS administrator tool is installed with the CMS server. The tool allows you to
perform administrator tasks on the server as follows:
Menu

Command

Repository Select

Users

Tools

Use to
Select a repository to store and maintain files.

Create

Create a new repository.

Delete

Delete an existing repository. It is a good idea to back up the repository


before deleting it.

Backup

Create a copy of the repository.

Restore

Restore a repository from a backup copy.

Add

Add a new user. Enter the user ID and configure Permissions. If you select
User can modify system, that user cannot access the CMS Administrator.

Delete

Remove a user from the system.

Edit

Edit permissions for a particular user.

Server

Start and stop the server.


Note: Stopping the server disables all repository operations.

Settings

Select the User Type depending on the Windows security model for your
site. Changing this option will delete all repositories on the server. You will
be prompted to backup all repositories.
Note: If you select Domain Users you must know the Administrator domain
name and password.

Accessing the Administrator Tool


To access the Administrator Tool
1

GEH-6700J ToolboxST

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

Chapter 11 Configuration Management System (CMS) 11-7

When the CMS Administrator Tool is started for the first time, the CMS Settings
dialog box displays.
Note To run the Administrator Tool and log in, you must have administrative
permissions on your computer. The first time you start the CMS Administrator Tool,
you must select the user type (before login). This determines the security model to be
used with the CMS server.

Select CMS Users are


Workgroup Users,
then click OK.

11-8 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

If there are any existing repositories with current user types, use this dialog box to
back up all existing repositories in the CMS server.

The repositories
to be backed up
display in the list
box.

Click the Browse


button to specify
the backup
location, then
click OK.

The Please Login to CMS Server dialog box displays.

GEH-6700J ToolboxST

Enter a Name and Password, then click OK. The CMS Administrator
dialog box displays.

Select the Create a new Repository option and click OK.

Chapter 11 Configuration Management System (CMS) 11-9

The Create New Repository dialog box displays. Enter the path or click
Browse to find the repository location. To create a new repository folder, click
Browse to open the Browse For Folder and select Make New Folder.

Enter the folder and the name of the repository and click OK. The CMS
Administrator screen displays.

Working Folder
CMS has two types of working folders:

Repository working folders are the root folder location for systems from the
repository

System working folders have a folder location for each system configuration
added to the repository, or obtained from the repository.

Note Working folders are specific to a particular user. Different users cannot
designate the same working folder.
If a user attempts to use a working folder already selected by another user, the
following message displays:

11-10 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

Repository Working Folder


The repository working folder is the primary root folder location for a user. Before
adding a system to CMS, the system configuration files are copied under the users
repository working folder, then added to CMS. Each user must specify a repository
working folder the first time they log on to CMS. A dialog box displays to enter this
information.

Note Anytime CMS requests a working folder, it is requesting the repository


working folder.
The user must enter the root location as the working folder, not the system working
folder (described in next section).
CMS maintains a list of users and their repository working folders on each computer.
The repository working folder for a user is only shown in the CMS Stand-alone
client (with repository name selected).

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-11

System Working Folder


Similar to the repository working folder, the system working folder must be unique
for each user. However, each users system working folder is initially determined in
one of two ways:.

If the user is adding the system to the repository, that users system working
folder is set to the current location of the system configuration.

If a new user performs a Get Latest command on a system that was not added by
them, the system working folder defaults to a location under the repository
working folder (and the Get Latest command places a copy of the system
configuration in that location).

The system working folder is not the repository working folder. Typically, the
system working folder is located in the repository working folder (but it can also be
in any folder). This location can also be changed from within the Stand-alone client
(but is not recommended).
The users system working folder is shown in the Stand-alone client when a system
name is selected.

11-12 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

For the Integrated client, the current folder location of the system (.tcw file) is
assumed to be the working folder for that user. The CMS logon fails, and an invalid
working folder dialog box displays if a different user is associated with the system in
that location.

Add System / System Working Folder


When a system configuration is added to CMS, several things occur:

A copy of the system is placed in the repository. This serves as the starting point
to begin CMS revision tracking for all CMS users.

The users system working folder is set to the current location of the system
configuration.

Changes are made to the system in the system working folder for use by CMS.

A CVS folder (hidden) is added at the system level and in each component in the
system

System and component configuration files (cf.dat and .xml ) are made Read-only

Once a system configuration is added to the repository, any user can log on to the
CMS Server to begin using CMS . After log on, the user obtains the current copy of
the configuration (Get Latest), modifies a component (Check Out), then saves the
changes (Check In).

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-13

Recommendations

Use only one CMS user and one working folder for all workstations. This user
should have administrator privileges.

When accessing a system through CMS for the first time, use the Stand-alone
client to log on and assign the working folder.

Do not add system to a different repository through the Integrated client. Do not
add a system through the Integrated Client. If you choose to do this, make sure
to first save the desired systems .tcw file to the working folder and add it to the
selected repository from that location.

The following are recommended settings to enable auto log in to the CMS
Integrated Client when a system configuration is opened in the ToolboxST
application.

In the System View, select the Options menu,


Settings, System Options, and General. Then set
Load Last System to True.

11-14 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

In the System View, select the Options menu, Settings,


System Options, CMS, and General. Then set Get
Latest Files to True and Work Local to False. Also, set
the CMS User Name to the one designated user.

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-15

CMS Stand-alone Client


The CMS Stand-alone client allows you to Check Out individual components of a
master configuration (.tcw file), make edits, and then Check In the component.

Opening the CMS Stand-alone Client


To open the CMS Stand-alone client
From the Start menu, select All Programs, GE ControlST, and
ToolboxST. Click Configuration Management System. The CMS
Login dialog box displays.

Verify, or enter the IP


address for the CMS
Server where the
repository is located.

Enter the User Name


and Password, then
select the Repository
from the drop-down list.
Click OK.

Note The repositories available are those that were created using the CMS
Administrator.

11-16 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

The Configuration Management System window displays.


The Systems View
displays a
repository as an
item that contains
systems.
The Component
View displays all
components within
the system that is
currently selected in
the Systems View.
The Log View
displays all
messages, events,
and error
associated with the
selected
component.

Adding a System to a Repository


After successfully logging on, you can add systems to a repository.
To add a system to a repository
1

From the File menu, select Add System. The Add System dialog box
displays.

Locate and select the system to be added, then click OK. The system displays in
the Tree View.

Or
From the Tree View,
right-click the
Repository item and
select Add System.
The Add System
dialog box displays.
Locate and select the
system to be added
then click OK. The
system displays in the
Tree View.

Note When a system is added to a repository, the current folder where the system is
located becomes the working folder for that system.
Note Once a system is added, all CMS operations are enabled.

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-17

Getting the Latest Version


To get the latest version

From the Tree View,


right-click the system
item, then select Get
Latest Version. The
Recursive Get
dialog box displays.

If a component is checked
out, the Overwrite
Components dialog box
displays. Select any
components to overwrite,
then click OK.

Note A Recursive Get command retrieves a copy of the system, as well as all
configured components.

11-18 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

CMS Stand-alone Client Menus


Menu

Command

Use to

Log In

Log on to the CMS server

Log Out

Log off the CMS server

Add System

Add a new system to the CMS Stand-alone client. Enter a name for the
system, then browse to the configuration file, for example, a .tcw file.

File

Note: Select the repository item to display the system in both the
Systems and the Component View; select the system item to display the
component(s) in the Component View.

View

Delete System

Delete an existing system from the CMS Stand-alone client

Set Working
Folder

Change the path to the destination folder for checking out and checking
in system configuration files.

Refresh/System
Repository

Get the current system status. The status conditions include: Equal,
Checked Out, Unknown, or Missing.

Note: If Missing displays in the Status column, do a Get Latest Version.


Clear Status
Window
Source

Clear the Log View of all error and event information

Get Latest Version Retrieve the last checked-in version of the configuration files from the

repository. Components under CMS control will always be Read-Only


until the component is Checked Out.

Attention: When you perform a Get Latest Version, all files that you
currently have checked out are overwritten.
Check In

Check a file back into the repository and save changes

Check Out

Check a file out of the repository to make changes

Undo Check Out

Return a checked-out file to the repository without saving changes

Label

Mark the current repository component with a text label. If the label is
assigned to the system component, the system and all components in
the system are assigned the same text label. The label displays in the
History screen when you select Show History. The label can be used for
specific version identification, as well as for future file retrievals.

Show Differences

Display the differences between the master copy in the repository and
the local copy in the working folder

Tools

Note: From the Show History window, you can select a version and
click the Diff button to compare the selected version in the repository
with the local copy in the working folder. You can also select two
versions and click the Diff button to compare the two selected versions
in the repository.
Show History

Display the versions/modifications for a selected configuration file

Note: From the Show History window, you can select a version and
click the Diff button to compare the selected version in the repository
with the local copy in the working folder. You can also select two
versions and click the Diff button to compare the two selected versions
in the repository.
Help

Contents

Open the help file for the Stand-alone Client

About

Display the software version information

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-19

A sample Show History dialog box is shown below.


User that made the change.

User comments
entered at check in.

Label is
additional text
to identify a
specific
version.
Sequential
version
numbers
assigned to
each change at
check in.

11-20 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

CMS Integrated Client


The Integrated client provides many of the Stand-alone client functions from within
the ToolboxST application. It allows you to check out individual components of a
master configuration, make edits, and then check in the component. The Integrated
client is accessed through the ToolboxST application.
Note The CMS menu item is disabled until a system is opened.
The CMS Integrated client operation is controlled by ToolboxST option settings
saved at each computer.
To configure CMS settings
From the ToolboxST Options menu, select Settings. The Settings dialog
box displays.

UserName is the default user name used to logon to CMS.


Get Latest Files, when set to True, gets the latest version upon logon.
Work Local, when set to True, opens the system disconnected from the CMS
server. This is the default when the ToolboxST application is installed, and opens the
system without the CMS Integrated client.
Work Local, when set to False, opens the system connected to the CMS server, and
displays the CMS LogIn dialog box.

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-21

Opening the CMS Integrated Client


To open the Integrated client
From the Start menu, select All Programs, GE ControlST, ToolboxST,
and then ToolboxST.

The CMS LogIn dialog box displays.


Note You must connect to the correct CMS server to log on.
Note The CMS LogIn dialog box does not automatically display unless the
ToolboxST Work Local option was set to False.

11-22 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

Confirm the correct CMS


Server IP address, then
click Connect.
The Connect button
changes to display
Change Server.

Enter the User Name


and Password, then
select the Repository
from the drop-down
list and click OK.

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-23

If you clicked Cancel, you are not logged into CMS. One of three scenarios occurs,
depending upon your local ToolboxST settings.
An empty ToolboxST window displays, a local system opens, or a Read-Only
system opens.
To access a system file
Select File and Open System. Browse to the working folder you created, then
select the ToolboxST system .tcw file. The .tcw file opens in Read-Only mode.

To change the server (if not logged on)


1

From the ToolboxST CMS menu, click Connect to Server. The CMS
Server Details dialog box displays.

Enter the IP Address


or Name of the
computer on which
the server is installed,
then click OK.

When the CMS LogIn dialog box displays, enter your User Name (if not
displayed), Password, and Repository, then click OK.

11-24 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

Note If a question mark icon displays next to the system item in the ToolboxST
System Editor Tree View, perform a Get Latest Version.

CMS Menu Items


Command

Use to

Connect to
Server

Connect to the correct server to log on to CMS

Login

Log on to the CMS Integrated client.


Note: You must be connected to the correct server to log on.

Logout

Log off the CMS Integrated client

Work
Disconnected

Use CMS without connecting to a server.


Note: None of the CMS menu options can be performed while working
disconnected. This mode is for testing.

Refresh

Refresh the systems and components that display

Add System to
Repository

Add a new system to the repository you are working in

Add System to
Different
Repository

Add a new system to a different repository. This action is not


recommended.

Get Latest
Version

Retrieve the last check-ed in version of the configuration files from the
repository. Components under CMS control will always be Read-Only until
the component is Checked Out.

Attention: When you perform a Get Latest Version, all files that you
currently have checked out are overwritten.
Check Out

Check a file out of the repository to make changes

Check In

Check a file back into the repository and save changes

Undo Check Out

Return a checked-out file to the repository without saving changes

Label

Mark a checked-out copy of the file with identifying text. The label can be
used for future file retrievals.

Show History

Display the versions/modifications for a selected configuration file

Note: From the Show History window, you can select a version and click
the Diff button to compare the selected version in the repository with the
local copy in the working folder. You can also select two versions and click
the Diff button to compare the two selected versions in the repository.
Show Differences Display the differences between the master copy in the repository and the
local copy in the working folder.

Note: From the Show History window, you can select a version and click
the Diff button to compare the selected version in the repository with the
local copy in the working folder. You can also select two versions and click
the Diff button to compare the two selected versions in the repository.

GEH-6700J ToolboxST

Chapter 11 Configuration Management System (CMS) 11-25

Troubleshooting
If any of the following issues occur, perform the Clean Get procedure below.

Missing or Unknown status displays for systems and/or components in the


Stand-alone and/or Integrated clients

Message box displays "The same working folder appears to be used by a


different user account"

Message box displays informing you of CVS issues and states cvs [server
aborted]: correct above errors first!

If troubleshooting issues occur, perform a clean Get as follows:


3

Open Windows Explorer.

Navigate to your system working folder.

Delete all contents in your system working folder.

From the Stand-alone Client window, select Get Latest Version.

11-26 Chapter 11 Configuration Management System (CMS)

GEH-6700J ToolboxST

CHAPTER 12

Chapter 12 TreeFileImporter
The Tree File Importer is a companion application that converts software tree files
from the Control System Toolbox application to the new .xml file format used by the
ToolboxST application.
The Tree File Importer helps the conversion process by
providing a baseline for further revision and refinement. As
configuration files produced by the converter may contain
errors and/or omissions, all converted components and
library containers must be thoroughly reviewed and verified
before use. A failure to thoroughly verify any software or
configuration may result in equipment damage and/or
malfunction and subsequent bodily harm or loss of life.
To use the Tree File Importer
1

From the Control System Toolbox, export the tree files for a particular
device using the Export All command on the File menu. Make sure the device
is valid before proceeding.

From the ToolboxST application, create a system, add a library container, and
then add an empty component corresponding to the device type that you
exported from the Control System Toolbox. (The ToolboxST application
uses the term component in place of the older term device from the Control
System Toolbox.)

Run the Tree File Importer. Select the system and library container you
created in Step 2, then select the project file from Step 1 to import the macro and
module library tree files. Each use of the Tree File Importer imports a single
file; importing a project file includes all tree files for a device and is the quickest
way to perform a conversion. Refer to the section, Running the Tree File
Importer .

From the ToolboxST System Editor, open the controller and add a reference
to the libraries that were imported in Step 3.

Exit the ToolboxST application and return to the Tree File Importer. Select
the system and device you created in Step 2, then select the project file from
Step 1 to import the function tree files.

Note Information from Control System Solution toolbox system files (files ending
in .syb) are not imported. This includes scales, enumerations, and resources. Use the
toolbox SDB browser to display this information in the ToolboxST system
information editor.

GEH-6700J ToolboxST

Chapter 12 TreeFileImporter 12-27

Running the Tree File Importer


Before beginning, make sure you have created a system to contain the imported
configuration and that the system contains a component of the correct type. (For
example, you would need a system with at least one Mark VIe component to import
a Mark VIe controller configuration.) Also, make sure that the ToolboxST
application is not running.
To run the Tree File Importer
1

From the Start menu, select Programs, GE ControlST, ToolboxST, and


then Tree File Importer to display the Tree File Importer wizard.

12-28 Chapter 12 TreeFileImporter

GEH-6700J ToolboxST

Click the Browse button. From the Open Workplace window, locate and
select the system .tcw file containing the component to receive the imported
configuration, then click Open. Click Next to continue to Page 2 of the Wizard.
The ToolboxST application opens the system and displays a list of available
controller and library container components.

Select a component to receive


the imported configuration, then
click Next .

GEH-6700J ToolboxST

Chapter 12 TreeFileImporter 12-29

Click the Browse


button. The Select
Project or Tree File
screen displays.

Click the arrow and select All


Files to display all available files.

From the Select Project or Tree File screen, locate and select a source .prj or
.tre file, and then click Open. When you have selected a source file, click Next
to begin the import process.

12-30 Chapter 12 TreeFileImporter

GEH-6700J ToolboxST

The Application Code Conversion Type dialog box opens. Unless you are
certain another setting applies, select Straight variable name conversion,
then click OK.

When the import process is completed, Page 4 of the wizard displays with a log of
errors and warnings that occurred. Warnings are minor problems that do not prevent
the import from being saved (for example, a function block that cannot be imported).
Errors are major problems that prevent the import from completing (for example, a
missing library reference.)
Errors and Warnings displayed by the Tree File Importer are
designed to provide helpful information about the import
process. They are by no means complete, and the lack of any
errors or warnings does not necessarily indicate that a fully
functioning and correct component was created by the
import. Before using any application code or settings
imported by the wizard, thoroughly review every aspect of the
system for errors, omissions and/or inconsistencies.

GEH-6700J ToolboxST

After reviewing the log, click Next to save the updated system and complete the
wizard.

Click Finish to exit the wizard.

Chapter 12 TreeFileImporter 12-31

Notes

12-32 Chapter 12 TreeFileImporter

GEH-6700J ToolboxST

CHAPTER 13

Chapter 13 Special I/O Functions


Several I/O functions are available with the Mark VIe component as follows:

Valve calibration

Multicasting

Configuring an enabled analog I/O module

Configuring PROFIBUS communications

Retrofiting a Mark Ve component

Calibrating Valve Circuits


Valve calibration allows you to configure the valve circuits of both the Servo Control
(PSVO) pack (refer to GEI-100586, PSVO Servo Control), and the Core Analog
(PCAA) module (refer to GEI-100612, PCAA Core Analog Module). The Calibrate
Valve dialog box provides an automated sequence as well as a verification
mechanism to configure and maintain values for each valve circuit.
Note Only one valve can be calibrated at one time.
To calibrate valve circuits
1

From the Component Editor, click the Hardware tab.

From the Tree View, select the desired PSVO or PCAA.

From the Summary View, select the Variables tab, and then click the
On/offline button on the taskbar to go online.

In the Variables tab, scroll to CalibEnab1, then double-click it in the row


header.

Note Only enabled regulators can be calibrated.

GEH-6700J ToolboxST

From the Summary View, click the Regulators tab.

From the Regulators drop-down list, select the desired regulator.

Click to select the Enable check box.

Chapter 13 Special I/O Functions 13-1

10 Click the Calibrate button. The Calibrate Valve dialog box displays.

11 Click the Calibration Mode button to enable all command buttons and to start
the calibration command in each I/O pack. A Trender window displays dynamic
signals.
Note Do not make any changes to the regulator configuration during valve
calibration. Each calibration command is monitored by the ToolboxST application to
verify performance.
12 To exit calibration mode, click the Calibration Mode button again.
Auto Calibrate commands occur in the following sequence:
13 Click Minimum End to stroke the actuator to the minimum end position.
14 Click Fix Minimum End to read the voltage at the minimum end position.
15 Click Maximum End to stroke the actuator to the maximum end position.
16 Click Fix Maximum End to read the voltage at the maximum end position.
17 Click Calibrate to use the calculated values.
18 Click Save to save the calculated values.
Note Only one command state can be active at any one time.

13-2 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

The calculated values are saved to the application code area of each I/O pack, and to
the current configuration loaded in the ToolboxST application.
Verification commands, which are not performed in any sequence, are as follows:

Click Position to step and monitor the position.

Click Current to step and monitor the current.

Click Manual to enable manual movement of the actuator (used in conjunction


with the Send button).

Click Send to send the value in the SetPoint textbox to the I/O pack.

Click OFF to exit verification mode.

Note LVDT voltages are the values that represent the minimum and maximum
actuator positions stored in the I/O pack. These values are not live data. They display
after the Save button is selected.
The ToolboxST application monitors the calibration permissive and calibration
command. If the permissive is lost, all calibration and verification buttons on the
dialog box are disabled. If the calibration command cannot be activated or is lost, all
calibration and verification buttons, with the exception of the Calibration Mode
button, are disabled.

Availability
This function is available with the following packs:

GEH-6700J ToolboxST

Servo Control (PSVO)

Core Analog (PCAA)

Chapter 13 Special I/O Functions 13-3

Multicasting
A ToolboxST function called power load unbalance (PLU) allows you to configure a
multicast connection between a PGEN I/O pack and a PDOA I/O pack on the same
IONet.
To configure multicasting
1

From the Component Editor, click the Hardware tab.

From the Tree View, right-click the Distributed I/O item and select Add
Module to display the Add Module Wizard.

From the
Module
Redundancy:
list, select TMR.

From theSelect
Type: list, select
PGEN, then
click Next.

13-4 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Select the check


box for PLU
Function Enabled,
then click Next.

GEH-6700J ToolboxST

When the module configuration information displays, click Finish.

From the Hardware tab Tree View, right-click the Distributed I/O item and
select Add Module to display the Add Module Wizard.

Chapter 13 Special I/O Functions 13-5

From the Module


Redundancy:
list, select TMR.

From the Select


Type: list, select
PDOA, then click
Next.

13-6 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

From the I/O


Module Trip from
drop-down list,
select PGEN[PLU]21], then click Next.

When the module configuration information displays, click Finish.

Availability
This function is available with the following packs:

GEH-6700J ToolboxST

Turbine-Generator Monitor (PGEN)

Discrete Output (PDOA)

Chapter 13 Special I/O Functions 13-7

Configuring a HART Device


Note To add HART I/O devices to a component configuration, a PHRA module
(refer to GEI-100597, PHRA HART Enabled Analog Input/Output) must be added in
a cabinet group in the Mark VIe Component Editor Hardware tab.

To configure PHRA module for HART Devices


1

From the Component Editor, click the Hardware tab.

From the Tree View, select the PHRA I/O module.

From the Summary View, click the Parameters to configure PHRA module
for an Asset Management System (AMS), if applicable.

From the Summary View, click the Inputs and Outputs tabs. Enable and
configure each input and/or output needed for the HART devices.

Note I/O Input Type must be configured for 0-20ma.

To upload HART device IDs


1

From the Component Editor, click the Hardware tab.

From the Tree View, select the PHRA I/O module.

13-8 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Right-click module and click Upload Hart IDs.

Availability
This function is available with the HART Enabled Analog I/O (PHRA).

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-9

PROFIBUS Communications
The PROFIBUS master gateway (PPRF) is a PROFIBUS DPV0, Class 1 master that
maps I/O from PROFIBUS slave devices to Mark VIe controllers on the I/O Ethernet
(refer to GEI-100614, PPRF PROFIBUS Master Gateway). There are two
redundancy options:

Simplex provides a single I/O pack gateway to the PROFIBUS network.

HotBackup provides dual I/O packs, with one active gateway and one backup.

Note Only one I/O pack can be actively communicating with its associated
PROFIBUS network.
To add a PPRF module
1

From the Component Editor, click the Hardware tab.

From the Tree View, right-click the Distributed I/O item and select Add
Module. The Add Module Wizard dialog box displays.

Select the I/O Pack


Redundancy type:
either Simplex (if
one I/O pack is
present) or
HotBackup (if dual
I/O packs, one active
and one backup, are
present).

Select the
PPRF module,
then click Next.

13-10 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Use the Version drop-down list to select a


module version. Listed module versions depend
on the available compatibility codes.

Click the Release Notes button to


view additional information about the
currently selected module version.

If the Module
Required check
box is selected,
the module must
be present and
functioning for
the controller to
go online.

Click Next to
preview
configuration
information.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-11

Click Finish to add


the new module.

13-12 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Adding a Slave Device


To add a PROFIBUS slave device
1

From the Component Editor Tree View, right-click the Distributed I/O
item, then select GSD Manager.

Note The GSD Manager is not available until a PPRF module has been added.

The GSD Manager dialog box displays.

The Add File button


adds selected
PROFIBUS device
file(s) to the
configuration.

The Remove File


button removes
selected
PROFIBUS device
file(s) from the
configuration.

GEH-6700J ToolboxST

Select a file(s), then click the Add File button.

Chapter 13 Special I/O Functions 13-13

From the Hardware tab, Tree View, highlight the PPRF module, then click
the PROFIBUS Network tab in the Summary View to configure the
network.

PROFIBUS Network view

Slave device

Slave Device
view

From the Device view, insert the slave device into the network by selecting and
dragging the device to the purple-colored line in the PROFIBUS Network
view.

The slave device displays as a


graphic. Double-click on the
device to begin configuration.

Note Any changes made in the PROFIBUS Network tab cannot be undone through
the ToolboxST Undo option under Edit.

13-14 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

The slave device opens with the Modules view displayed.

Click the pushpin


icon to expand and
collapse the
Tree View.

From the Available


Modules list, select the
desired module. Then
either double-click the
module name or click
the Append button to
add this module to the
Configured Modules
list. You can also click
the Insert button to add
the module before the
selected configured
module.
Click the Remove
button to remove a
selected module from the
Configured Modules list.
If a change is made,
click the Apply
button, then click
OK to return to the
Hardware tab.

Note If any changes are made to the slave device configuration and the OK button
is clicked, the pack is restarted after the controller and pack are downloaded.

Click the General


item to display the
General View.

The Station Address,


which is read-only
from this view, displays
the device address.

Click to enable
Watchdog Control,
which allows this device
to enter fail-safe mode if
an error occurs. The
Interval is the time period
that elapses before failsafe mode. The default
time interval is 200 ms.

Click theOK
button to return
to the Hardware
tab.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-15

From the Tree View, click the Parameters item to configure parameters for
this module.

Select a
parameter,
then use the
drop-down
list to set
the value.

Click the OK
button to
return to the
Hardware
tab.

From the Tree View, click the Groups item to add the slave device to an I/O
group.

Note Groups are not supported by the PPRF.

Click the OK button to


return to the Hardware
tab.

For detailed information


about groups, click the
Help button.

13-16 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

From the Tree View, click the Extensions item to configure advanced values
for this device.

Click the OK button


to return to the
Hardware tab.

For descriptions of
values, click the
Help button.

From the Tree View, click the DPV1 item to display the screen below.

Note This screen is only active if DPV1 is supported by this device, but this feature
is not supported by the PPRF.

Click the OK
button to return to
the Hardware tab.

For detailed
information, click
the Help button.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-17

From the Tree View, Device Description, click the Device or the GSD
items to display information about the slave device.

Click the OK button


to return to the
Hardware tab.

10 From the Tree View, click the GSD item to display the contents of the GSD
file(s).

Click the OK button


to return to the
Hardware tab.

13-18 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Configuring the Master Device


To configure the master device

In the Hardware tab


Summary View,
PROFIBUS Network
tab, double-click on the
PPRF device.

The netDevice window for configuring the master device displays.


Select a master
device profile from
the drop-down list.

Bus Parameters
displays PROFIBUS
network properties.

Bus Monitoring
displays how the
PROFIBUS network
will be monitored by
the gateway.

Note If any changes are made to the master device configuration and the OK button
is clicked, the pack must be restarted after the controller and the pack are
downloaded.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-19

Enabling a Slave Device


To enable the slave device
From the Tree View, click Station Table to display the window below.

Displaying the PROFIBUS Network


To display the PROFIBUS network overview
From the Tree View, click the Address Table item. The Address View
displays.

PROFIBUS slave
addresses are
changed here.

13-20 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

To configure I/O variables

From the Hardware


tab, Tree View,
select a slave device.

The following information displays in the Summary View.


Click in the columns to
change values.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-21

The Variables data grid displays the PROFIBUS configuration, which is defined as a
number of module input and output bytes or words. By default, slave inputs are
followed by slave outputs. Successive rows may be grouped as necessary to create
actual point values that span multiple rows. Packed Boolean values are expanded
into a separate data grid as shown so that Boolean MarkVIe variables can be attached
to the individual bits. The Variables tab contains the following columns.
Connected Variable displays the connection to other defined variables in the
ToolboxST application.
Var Data Type displays the data type of the variable configured in the MarkVIe
component. Space can be reserved for unused inputs and outputs, enabling
subsequent online loads when variables are added.
Fieldbus Point Data Type displays the data type of the slave device I/O point. If
the size of the point spans multiple rows of input or output bytes or words,
subsequent rows display Continued. The default byte data type for rows associated
with configuration bytes must be changed to a supported data type shown in the table
below.
Note The Direction, Module, and Fieldbus Point Offset columns are read-only.
PROFIBUS Point
Data Type

Mark VIe Variable


Data Type

Boolean

Boolean

Integer16

Integer

Scaling

Float
Integer32

Double integer
Float

Unsigned16

Unsigned integer
Float

Unsigned32

Unsigned double integer


Float

Floating point (32 bits)

Float

Note Only certain point-to-variable data transfer conversions are supported.


Raw Min, Raw Max, Eng Min, and Eng Max are values used to calculate scaling
from raw units (the PROFIBUS point) to engineering units (the MarkVIe variable).
Boolean transfers are expanded into individual bits and displayed in the Booleans
tab below the Variables tab.
Input Event Enabled, if set to True, enables input event scanning on a Boolean
transfer.
Note An input event is similar to an SOE, but has a 10ms resolution.
Note Any field except Var Data Type and Fieldbus Point Data Type It can be
modified without restarting the controller or I/O pack.

13-22 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

To configure PROFIBUS diagnostics


From the Hardware tab, Tree View, click the
PPRF, then click the PROFIBUS
Diagnostics tab.

If any PROFIBUS device generates a non-status only diagnostic, the ProfibusDiag


variable has a value of True. For applications that require diagnostic presence
indication, attach a defined BOOL-type variable to ProfibusDiag.
Non-status diagnostics are ones that indicate problems. Status-only diagnostics
contain only the standard portion (the first six octets). These, in addition to the
master address and identification number, have one or more of the following
diagnostics values set.

Master_Lock (slave parameterized by another master; octet 1, bit 7

Bit always set to True (octet 2, bit 3)

WD_On (watchdog on; octet 2, bit 3)

Freeze_Mode (slave freeze mode activated; octet 2, bit 5)

Sync_Mode (slave sync mode activated; octet 2, bit 5)

Reserved bits (octet 3, bits 0-6)

Ext_Diag_Overflow (slave error message overrun; octet 3, bit 7)

Note The connected variable may be added, changed, or removed and loaded
without restarting the controller or I/O pack.

Standard Diagnostics Tab

From the Hardware


tab, Tree View,
select a slave device.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-23

The Standard Diagnostics View displays as follows.


From the Summary View, select the Standard
Diagnostics tab. In the Connected Variables column,
add desired variables. Entries in all other columns are
read-only.

The values that display in the Standard Diagnostics tab are the standard portion of a
PROFIBUS diagnostic message (the first six octets). Except for the Master_Addr
(master address) and Ident_Number (identification number) values, which are UINT
types, the remaining values are BOOL types. The connected values must have
matching data types.
Note The last value in the Standard Diagnostics tab, Station_Diagnostic, is not part
of the PROFIBUS standard diagnostic message. It provides a station diagnostic
present indication. It is set to True if the slave device generates a non-status only
diagnostic. For applications that require station diagnostic presence indication, attach
a defined Boolean-type variable to the Station_Diagnostic.

13-24 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Device Diagnostics Tab

The byte offset


range is 0-61.

The bit offset


range is 0-7.

The Bit length range is 0-8. This must


be 0 for multi-byte data widths, 1 for
BOOLs, and 1-8 for bit fields (which
may not cross byte boundaries).

The connected variable must be a BOOL if the


bit length is 1, or an integer if the bit length is 18. When the bit length is 0, the variables data
type determines the byte length.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-25

The Device Diagnostics tab, which is initially empty, is used to connect variables to
data fields within the Device-related portion of a diagnostic message. Entries in the
Diagnostic Byte Off, Diagnostic Bit Off, and Diagnostic Number Of Bits columns
identify bits, bit fields, and analog values within the Device-specific diagnostic,
which is exclusively defined on a per-device basis.
To specify a bit-wide diagnostic value
Enter the byte and bit offset values, then enter 1 in the Diagnostic Number of
Bits column.
You can also connect a Boolean-type variable to the specified diagnostic bit. (If the
connected variable is not provided, it may be added and downloaded. However, since
the ToolboxST configuration assumed an integer type because of the blank variable
field, the I/O pack is restarted.)
To specify a bit field diagnostic value
Enter the byte and bit offset values and the Diagnostic Number of Bits
value.
The specified bit field must fit within an 8-bit boundary and may extend from 1 to 8
bits. You can also connect an integer variable (not a BOOL or FLOAT).
A connected variable can be added and downloaded later without restarting.
To specify an analog diagnostic value
Enter the byte offset value, then enter 0 for the bit offset and number of bits.
The analog value, which must fit within a 32-bit boundary, is treated as a Big Endian
(high byte followed by low byte) value. You can also connect an analog variable to
define the data type of the diagnostic value. (A connected variable can be added and
downloaded later without restarting.) No type conversions are performed.
Note The I/O pack must be restarted if lines are added or removed from the Data
Grid, or if an existing entrys connected value is changed from a Boolean to an
analog-type or vice versa. All other changes to existing entries can be made and
downloaded without restarting the controller or I/O pack.
Note To add a line without specifying the connected variable, you must enter a
space in the Connected Variable field to enable the other fields for data entry.

13-26 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Identifier Diagnostics Tab


The Date Type for the Connected
Variable must be a BOOL.

The Identifier Number


range is 0-495.

The Identifier Diagnostics tab, which is initially empty, is used to connect variables
to bits within the Identifier-related portion of a diagnostic message. Each bit, which
corresponds to a module in the slave device, is set to True to indicate a problem.
To specify an identifier diagnostic
Enter the Identifier Number and (optionally) connect a BOOL-type variable.
Note If lines are added or removed from the Data Grid, the I/O pack must be
restarted after being downloaded. Existing Data Grid modifications (adding,
removing, or changing connected variables, changing the Identifier Number and
such) can be downloaded without restarting the controller or the I/O pack.
Note To add a line without specifying the connected variable, you must enter a
space in the Connected Variable field to enable the other fields for data entry.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-27

Channel Diagnostics
The Data Type for the
Connected Variable must
be an UINT.
.

The Identifier Number The Channel Number


range is 0-63.
range is 0-495.

Select the Channel Direction and


Diagnostic Type from the drop-down lists.

The Channel Diagnostics tab, which is initially empty, is used to connect variables to
the type octet of the Channel-related portion of a diagnostic message. The channel
diagnostic type octet contains two fields, a 3-bit channel type, and a 5-bit error type,
whose values are defined in the PROFIBUS standard. (The error type field values of
16-31 are manufacturer-specific).
To specify a channel diagnostic
Enter the Identifier Number, Channel Number, Channel Direction, and
Diagnostic Type, and optionally connect a UINT-type variable. (A connected
variable can be added and downloaded later without restarting.)
Note If lines are added or removed from the Data Grid, the I/O pack must be
restarted after it is downloaded. Existing Data Grid modifications (adding, removing,
or changing connected variables, changing the Identifier Number and such) can be
downloaded without restarting the controller or the I/O pack.
Note To add a line without specifying the connected variable, you must enter a
space in the Connected Variable field to enable the other fields for data entry.
To display advanced diagnostics
From the Hardware tab Tree View, right-click the PPRF, then select
Troubleshoot Module and Advanced. The Advanced Diagnostics
Commands window displays.
Note The system must be running, and the ToolboxST application must be able to
connect to the Mark VIe component.

13-28 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

The Advanced Diagnostics window below displays no diagnostics.

An example of a PROFIBUS diagnostic is shown below.

Availability
This function is available with the PROFIBUS Master Gateway (PPRF).

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-29

Mark Ve Retrofit
The Mark Ve PMVE control I/O pack (based on the UCSx processor board) is an I/O
subsystem that communicates and controls one or more I/O agents across the highspeed serial link (HSSL). The PMVE currently supports the MVRA and MVRF
boards in a TMR configuration, as well as an MVRC board in a simplex
configuration. Refer to GEI-100689, PMVE Control I/O Pack.

Availability
This function is available with the Control I/O Pack (PMVE).

13-30 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

Configuring a PCNO Module


The CANopen Input/Output (PCNO) pack is an NMT CANopen master that maps
I/O from either CANopen Woodward GS6 or GS16 valves to Mark VIe controllers
on the I/O Ethernet. Refer to GEI-100737, PCNO CANopen Master Gateway.
A PCNO module is added from the Hardware tab. Refer to Chapter 5, the section
Hardware Tab, for instructions to add a module.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-31

To configure a PCNO module


From the Tree View, expand the PCNO item. Each PCNO module supports up
to five CANopen slave devices.

For each device, right-click, then


select Attach and either GS6 Fuel
Valve or GS16 Fuel Valve. The
Data Grid displays three tabs:
Variables, Inputs, and Outputs.
The CANopen node-id and the device
number are the same. For example, if a
GS6 fuel valve is attached to Device 2,
the CANopen node-id number is 2.

Variables tab

Click the ellipsis button in the


Connected Variable column to
display the Select a Variable
dialog box and add a variable.

Note Each configured PCNO module supports up to five GS16 or GS6 fuel
valves. CANopen devices cannot be mixed.

13-32 Chapter 13 Special I/O Functions

GEH-6700J ToolboxST

The Variables tab contains a list of counters that provide an indication of CANopen
message transmission and reception. Each time the pack sends a message to a slave
device, the corresponding RPDO count is incremented. Each time the pack receives a
message from a slave device, the corresponding TPDO count is incremented.
A connected variable can be changed with an online load. Adding or removing
CANopen devices requires an offline load.

GEH-6700J ToolboxST

Chapter 13 Special I/O Functions 13-33

Notes

13-34 Chapter 13 Special I/O Functions

GEH-6700J 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.

baud
A unit of data transmission. Baud rate is the number of bits per second transmitted.

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.

GEH-6700J ToolboxST

Glossary of Terms 13-35

configure
To select specific options, either by setting the location of hardware jumpers or
loading software parameters into memory.

Control Constant
Control Constant is a signal with an initial value that is read and never written.

designated controller
In a Mark VIe dual controller system, the designated controller (DC) is the controller
to which the I/O packs listen for outputs when they have the option to listen to
multiple controllers. In a TMR system, the DC is the controller that initilizes the
other controllers.

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.

fault code
A message from the controller to the HMI indicating a controller warning or failure.

Finder
A subsystem of the ToolboxST application for searching and determining the usage
of a particular item in a configuration.

firmware
The set of executable software that is stored in memory chips that hold their content
without electrical power, such as flash memory.

flash
A non-volatile programmable memory device.

font
One complete collection of letters, punctuation marks, numbers, and special
characters with a consistent and identifiable typeface, weight, posture, and size.

forcing
Setting a variable signal to a particular value, regardless of the value blockware or
I/O is writing to that signal.

13-36 Glossary of Terms

GEH-6700J ToolboxST

gateway
A device that connects two dissimilar LANs or connects a LAN to a wide-area
network (WAN), PC, or a mainframe. A gateway can perform protocol and
bandwidth conversion.

health
A term that defines whether a variable is functioning as expected.

heartbeat
A signal emitted at regular intervals by software to demonstrate that it is still active.

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.

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.

GEH-6700J ToolboxST

Glossary of Terms 13-37

reboot
To restart the controller.

register page
A form of shared memory that is updated over a network. Register pages can be
created and instanced in the controller and posted to the SDB.

relay ladder diagram (RLD)


A ladder diagram has a symbolic power source. Power is considered to flow from the
left rail through a contact to the coil connected to the right.

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.

Rubber block
A block that can extend to include a variable number of pins.

runtime
See product code.

ToolboxST
A Windows-based software package used to configure controllers.

trend
A time-based plot to show the history of values.

Trender
A subsystem of the ToolboxST application that monitors and graphs signal values
from a controller.

validate
Makes certain that items or devices do not contain errors and verifies that the
configuration is ready to be built into application code.

variable
The basic unit for variable information. Variables are the placeholders for memory
locations in the toolboxs 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.

13-38 Glossary of Terms

GEH-6700J ToolboxST

Index
A
acronyms and abbreviations 13
alarm classes 13
application
documentation 27
software examples 28
Auto-reconfiguration 26
reports 125

B
Block
block shape shortcut menu 18
diagram editor 1
shapes 11
border options 5

C
CMS
accessing CMS administrator tool 7
configuring 6
creating user accounts 3
installing 1
CMS recommendations 14
CMS stand-alone client
menus 18
opening 16
CMS troubleshooting 25
CMS working folder
repository 10
system 12
command
download 5
command line arguments 5
Component Infoview 7
components
grouping 4
moving and copying 4
configuring
Dynamic Data Recorder 88
HART I/O device 8
control constants 36
window 161

D
data grids
copying 10
editing 9
organizing 9
DDR setup 94

diagnostic views
controller 17
I/O 18
download command 5
Dynamic Data Recorder tab
configuring 88, 93
updating 92

E
editor
attribute value 23
library container 8
rung 35
system information 13
EGD configuration server reports 109
Ethernet 99, 36
Ethernet Global Data Configuration server
configuring an external EGD device 47
viewing differences 46
Ethernet Global Data tab
EGD configuration 99
page compression 103
produced pages 100
referenced devices 110

F
filtering rows 119
find methods 2
forced variables 131
format specifications 26
function blocks 3

G
General tab 17
global variables 132
grid lines 14

H
Hardware tab 33
HMI resources 28

I
I/O diagnostic
report 54
viewer 53
implementation profile 9
installation 2

L
library container editor
property editor 15
licensing 11
Live trends 8
LiveView 143
editor features 149

M
Measurement systems 28
menus 18
Modbus Slave register pages 115
mode
layout 14
modifying totalizer values 21
modules
adding 35
diagnosing 51
modifying 40
organizing 39
upgrading 48
viewing 40

N
network
adapters 24

P
page compression 103
Parameters tab 42
passwords 13
PCNO 31
pins
connecting 20
wiring block 16
produced pages 100, 3
PROFIBUS 9
property editor 6
protected objects 16

R
reports
creating 117
saving, retrieving and printing 117
viewing 118
running the tree file importer 27

S
security
passwords 13
Software tab
table definitions 82
variable editors 78
Status tab 46, 2
summary view 6

40

Index

system database 42
system editor
configuration files 8
opening and creating systems 1
saving systems 7
system information editor
alarm classes 13
format specifications 26
HMI resources 28
measurement systems 28
System Requirements 1

T
tab
diagnostics 46
Dynamic Data Recoder 87
EGD configuration server 108
Ethernet Global Data 99
General 17
Hardware 33
Modbus Slave 112
Software 61
Summary 42
variables 43
time axis 15
Totalizers
administer 19
passwords 20
Tree File Importer
running 27
Trender
adding traces 4
capture buffer trends 9
concepts 12
cursors 12
events 13
exporting to a file 18
hiding traces 17
live trends 8
obtaining data 11
printing graphs 18
trace colors 16
Trender concepts 12
Trender window features
data toolbar 4
Trender toolbar 4

U
UPD
installing 12
reinstalling 12
user block
definitions 7
libraries 3
user block definition

adding 19
sorting 19

V
variable editors 78
variables
adding 91
forced 131
global 132
status 91

W
Wizard
download 9
upload 15

Index

41

GE Energy
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
1 540 387 7000
www.geenergy.com

You might also like