You are on page 1of 292

GE Energy

ToolboxST™ Guide
for Mark VIe™ Control
GEH-6700C

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

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

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


Service Office, or an authorized GE Sales Representative.

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

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


CompactFlash is a trademark of Sandisk Corporation.
CompactPCI is a registered trademark of PICMG.
ControlST, Mark VIe, ToolboxST, and WorkstationST are registered trademarks of General
Electric Company, USA.
Ethernet is a registered trademark of Xerox Corporation.
Modbus is a registered trademark of Schneider Automation.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
g
To:

Reader Comments GE Energy


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

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


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

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

Publication Issue/Revision Date

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

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

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

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

Detach and fax or mail to the address noted above.


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

____________________________ Place
stamp
____________________________ here.

____________________________

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

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


Safety Symbol Legend

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


strictly observed, could result in personal injury or death.

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


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

Indicates a procedure, condition, or statement that should be


strictly followed in order to optimize these applications.

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


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

Isolation of test equipment from the equipment under test


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

To minimize hazard of electrical shock or burn, approved


grounding practices and procedures must be strictly followed.

To prevent personal injury or equipment damage caused by


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

Chapter 1 About ToolboxST 1-1


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

Chapter 2 System Configuration 2-1


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

Chapter 3 Software 3-1


Software Configuration Hierarchy .................................................................................................3-1
Variables ........................................................................................................................................3-2
Function Blocks .............................................................................................................................3-2
User Block Libraries ......................................................................................................................3-3
Instancing.......................................................................................................................................3-3
Unlink Property..............................................................................................................................3-4
User Block Definitions...................................................................................................................3-6
Library Container Editor ...........................................................................................................................3-8
Library Container Editor/Libraries...............................................................................................3-11
Property Editor.............................................................................................................................3-14
Exporting a Table Definition .......................................................................................................3-15
Online Display and Changes........................................................................................................3-16
Using Table Definitions in Software Application Code...............................................................3-17
Adding a User Block Definition...................................................................................................3-18
Sorting User Block Definitions ....................................................................................................3-19
User Block Variables ...................................................................................................................3-19

GEH-6700C ToolboxST Contents • i


Summary Tab ..........................................................................................................................................3-23
Block Diagram Editor..............................................................................................................................3-24
Diagram Shortcut Menu ...............................................................................................................3-25
Layout Modes...............................................................................................................................3-25
Managing Blocks .........................................................................................................................3-26
Wiring Block Pins ........................................................................................................................3-27
Block Shape Shortcut Menu.........................................................................................................3-28
Connecting Pins ...........................................................................................................................3-29
Modifying Live Values ................................................................................................................3-30
Shape Drawing Tools ...................................................................................................................3-32
Additional Toolbar Buttons..........................................................................................................3-35
Diagram Settings..........................................................................................................................3-35
Rung Editor ..................................................................................................................................3-37
Application Documentation .........................................................................................................3-40
Application Software Examples...................................................................................................3-40

Chapter 4 Mark VIe Component Editor 4-1


Summary View..........................................................................................................................................4-2
Property Editor ..........................................................................................................................................4-2
Component InfoView ................................................................................................................................4-3
Security......................................................................................................................................................4-4
Passwords.......................................................................................................................................4-4
Password Caching ..........................................................................................................................4-5
Viewing Protection Status ..............................................................................................................4-6
Protected Objects ...........................................................................................................................4-7
Data Grids..................................................................................................................................................4-8
Editing Data ...................................................................................................................................4-8
Organizing Columns ......................................................................................................................4-9
Copying and Moving Data ...........................................................................................................4-10
General Tab .............................................................................................................................................4-11
Attributes......................................................................................................................................4-13
Attribute Value Editor..................................................................................................................4-14
Network Adapters ........................................................................................................................4-15
Hardware Tab ..........................................................................................................................................4-16
Network Redundancy...................................................................................................................4-17
Adding Modules...........................................................................................................................4-18
Organizing Modules.....................................................................................................................4-21
Modifying Modules......................................................................................................................4-22
Special Modules ...........................................................................................................................4-22
Viewing Modules .........................................................................................................................4-41
Inputs/Outputs Tabs .....................................................................................................................4-43
ExtraCircuits Tab .........................................................................................................................4-43
Reporting Module Data................................................................................................................4-45
Upgrading Modules......................................................................................................................4-47
Working Online............................................................................................................................4-47
Diagnosing Modules ....................................................................................................................4-49
Software Tab ...........................................................................................................................................4-52
Programs Item ..............................................................................................................................4-52
Adding a Program ........................................................................................................................4-55
Adding a Task ..............................................................................................................................4-56
Adding a User Block ....................................................................................................................4-57
Table Definitions..........................................................................................................................4-57
User Block....................................................................................................................................4-61
Editing Variables..........................................................................................................................4-66
Dynamic Data Recorder (DDR) Tab .......................................................................................................4-69
Configuring DDR.........................................................................................................................4-69
Status Variables............................................................................................................................4-71
Adding Variables .........................................................................................................................4-72
Updating DDR .............................................................................................................................4-73

ii • Contents GEH-6700C ToolboxST


Importing and Exporting DDR.....................................................................................................4-73
DDR Setup ...................................................................................................................................4-74
Ethernet Global Data (EGD) Tab ............................................................................................................4-78
EGD Configuration ......................................................................................................................4-79
Produced Pages ............................................................................................................................4-79
Editing Produced Pages................................................................................................................4-80
Page Compression........................................................................................................................4-81
Variables ......................................................................................................................................4-82
Editing Exchange Signatures and Configuration Time ................................................................4-83
EGD Diagnostics..........................................................................................................................4-85
EGD Configuration Server Tab....................................................................................................4-87
EGD Configuration Server Reports .............................................................................................4-88
Referenced Devices......................................................................................................................4-88
Modbus Slave Tab...................................................................................................................................4-90
Configuring Modbus Slave ..........................................................................................................4-91
Ethernet ........................................................................................................................................4-91
Interface .......................................................................................................................................4-91
Serial Settings ..............................................................................................................................4-92
Additional Settings.......................................................................................................................4-92
Mark VIe Tools .......................................................................................................................................4-94
Reports .........................................................................................................................................4-94
Forced Variables ........................................................................................................................4-102
Global Variables ........................................................................................................................4-103
Watch Windows.........................................................................................................................4-104
Control Constants.......................................................................................................................4-105
Importing and Exporting Control Constants ..............................................................................4-107

Chapter 5 Working Online With a Mark VIe Component 5-1


Connecting to a Controller ........................................................................................................................5-1
Status Tab..................................................................................................................................................5-2
Controller Attributes ......................................................................................................................5-3
Downloading to a Controller .....................................................................................................................5-5
Download Command .....................................................................................................................5-5
Controller Initial Setup...................................................................................................................5-6
Download Wizard ..........................................................................................................................5-7
Upload Wizard ...............................................................................................................................5-9
Diagnostics Views...................................................................................................................................5-11
Controller Diagnostics View........................................................................................................5-11
I/O Diagnostic View ....................................................................................................................5-12
Administer Totalizers ..............................................................................................................................5-12
Totalizer Passwords .....................................................................................................................5-14
Modifying Totalizer Values ....................................................................................................................5-16

Chapter 6 Finder 6-1


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

Chapter 7 Trender 7-1


Accessing a Trender Window ...................................................................................................................7-1
Trender Window Features .........................................................................................................................7-2
Trender Toolbar .............................................................................................................................7-3
Data Toolbar ..................................................................................................................................7-3
Working in Trender ...................................................................................................................................7-3
Acquiring Data...............................................................................................................................7-3
Adding Traces ................................................................................................................................7-3
Live Trends ....................................................................................................................................7-4

GEH-6700C ToolboxST Contents • iii


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

Chapter 8 EGD Editor for External Devices 8-1


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

Chapter 9 Configuration Management System (CMS) 9-1


Accessing the CMS Administrator Tool....................................................................................................9-1
Repository Menu .......................................................................................................................................9-4
Selecting a Repository....................................................................................................................9-5
Creating a Repository.....................................................................................................................9-6
Deleting a Repository.....................................................................................................................9-6
Backing Up a Repository ...............................................................................................................9-7
Restoring a Repository ...................................................................................................................9-7
Users Menu................................................................................................................................................9-8
Adding a User ................................................................................................................................9-8
Deleting a User...............................................................................................................................9-9
Editing a User.................................................................................................................................9-9
Tools Menu..............................................................................................................................................9-10
Starting the Server........................................................................................................................9-10
Stopping the Server ......................................................................................................................9-10

iv • Contents GEH-6700C ToolboxST


Adjusting the Settings ..................................................................................................................9-11
CMS Client Interface...............................................................................................................................9-12
File Menu ................................................................................................................................................9-14
Connecting to the Server..............................................................................................................9-14
Adding a System ..........................................................................................................................9-14
Deleting a System ........................................................................................................................9-14
Setting Working Folder................................................................................................................9-14
View Menu..............................................................................................................................................9-15
Refreshing System View..............................................................................................................9-15
Clearing Status Window ..............................................................................................................9-15
Source Menu ...........................................................................................................................................9-15
Retrieving a Configuration...........................................................................................................9-15
Modifying a Configuration ..........................................................................................................9-16
Labeling a Configuration .............................................................................................................9-16
Tools Menu .............................................................................................................................................9-17

Chapter 10 Tree File Importer 10-1


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

Chapter 11 Reference 11-1


Menus......................................................................................................................................................11-1
Edit Menu.....................................................................................................................................11-1
View Menu...................................................................................................................................11-2
Device Menu ................................................................................................................................11-2
Options Menu...............................................................................................................................11-3
Help Menu ...................................................................................................................................11-3

Glossary of Terms G-1

Index I-1

GEH-6700C ToolboxST Contents • v


Notes

vi • Contents GEH-6700C ToolboxST


CHAPTER 1

Chapter 1 About ToolboxST


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

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

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


sales representative.

GEH-6700C ToolboxST Chapter 1 About ToolboxST • 1-1


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

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

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

To select components not


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

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

1-2 • Chapter 1 About ToolboxST GEH-6700C ToolboxST


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

Use the scroll bar to find Click Change to and or


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

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

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

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

To upgrade the ToolboxST application


Install the new version. Refer to the section, Installation. The icons on your
desktop and in your Start menu will be updated to start the most recently
installed version.
GE ControlST software supports a variety of controllable equipment. This support
software contains updated firmware for the equipment and configuration tools that
are available as component editors inside a GE ControlST system. When you install
a new version of the application, newer versions of some components may be
installed as well. To use the new versions in an existing system, you must upgrade
each component separately.

GEH-6700C ToolboxST Chapter 1 About ToolboxST • 1-3


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.
2 Start the ToolboxST application and open the system file. Double-click a
component to open its Component Editor.
3 From the File menu, select Upgrade. The Product Upgrade Wizard
displays.

Click Next.

Select the new


version, and then
click Finish to
upgrade the
component.

1-4 • Chapter 1 About ToolboxST GEH-6700C ToolboxST


Command Line Arguments
ToolboxST contains the following command line arguments:

• EGD Management Tool (EMT) arguments, including


/EGDAction:ADD /EGDDevice:
/EGDAction:MODIFY /EGDDevice:
• Go To Variable
• Go To Hardware Diagnostic
• Go To Locator
• -NoSplash
• Archive a ToolboxST System

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

EMT

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

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

Standard Action Arguments

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

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


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

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


Producer ID to be modified.

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


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

EMT Argument Rules

The following rules apply to EMT arguments:

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


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

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

/<keyword>:<value>

GEH-6700C ToolboxST Chapter 1 About ToolboxST • 1-5


where

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

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

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

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

Formatting Command Line Arguments

The following rules apply to all command line arguments:

• Process keywords, ignoring case.


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

Go To Variable

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


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

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

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

Opening a ToolboxST System

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

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.

1-6 • Chapter 1 About ToolboxST GEH-6700C ToolboxST


Examples

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


ToolboxST system will be searched.

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


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

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


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

Go To Hardware Diagnostic

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


Device Diagnostics window or the Hardware Module Group.

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

Examples

/HardwareDiagnostic:Marky

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

/HardwareDiagnostic:Marky.23GROUP

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

Go To Locator

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

/NavigateToLocator:<locator string shown in Find results>

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

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.

GEH-6700C ToolboxST Chapter 1 About ToolboxST • 1-7


Copy the selected find results to the clipboard to
use as a locator command argument. ToolboxST
will open the Mark VIe component, then navigate
to the specified CALC block in the software.

-NoSplash

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

Archive a ToolboxST System

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

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

Examples

ToolboxST /Archive

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

ToolboxST c:\MySystem.tcw /archive

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

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

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


archive name, is created.

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

1-8 • Chapter 1 About ToolboxST GEH-6700C ToolboxST


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

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

USB Protection Device (UPD or dongle)

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

Installing the UPD

It is very important to NOT plug the UPD into your computer


until after you have installed the ToolboxST application.

To install the UPD


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

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

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

Reinstalling UPD
To reinstall the UPD
1 Save and close any open applications/systems.
2 Unplug the UPD.
3 From Windows, click Start, Settings, and then select Control Panel.
4 From the Control Panel, select Administrative Tools and Computer
Management and use the Device Manager to reinstall the UPD.
5 Reinstall the UPD. Windows should now detect the UPD and reinstall it with the
correct drivers.

GEH-6700C ToolboxST Chapter 1 About ToolboxST • 1-9


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

Check that you have


installed the proper UPD
correctly and click Retry.

Acronyms and Abbreviations


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

1-10 • Chapter 1 About ToolboxST GEH-6700C ToolboxST


CHAPTER 2

Chapter 2 System Configuration

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

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

Opening and Creating Systems


To create a new system
1 From the File menu, select New System to display the New System dialog
box.

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

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-1


To open an existing system
1 From the File menu, select Open System.
2 Locate the .tcw configuration file for the system and select Open. The system
displays in the System Editor.

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

The Summary View displays a graphic


representation of all system components
and their network connectivity.

The Tree View


displays a list of
all components
in the system.

The Property
Editor allows
you to edit the
selected
component.

2-2 • Chapter 2 System Configuration GEH-6700C ToolboxST


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

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

Icon Component

System

Group of Components

Printer

Library Container

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

You can add components to the root component of a system (represented by the
icon) or a group (represented by a icon). Some components display a wizard or
dialog box that prompts you for additional information when you add them to the
system.
To add a component
In the Tree View, right-click a parent component (either a system or a group),
select Insert New, then select the desired component type.
Existing components can also be imported from a file.
To import an existing component
In the Tree View, right-click a parent component (either a system or a group),
select Insert Existing, then select Device. Select the Device .xml file for the
component to be imported and click Open.
To open the editor for a component
In the Tree View, select a component. Then, from the Edit menu, select
Selected Component.
Or,

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


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

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-3


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

Groups

Moving and Copying Components


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

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

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

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

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

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


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

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

2-4 • Chapter 2 System Configuration GEH-6700C ToolboxST


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

If the configuration for the external device is stored in a file with a special extension,
you can specify the path to the configuration file and omit the path to the external
application. The ToolboxST application will automatically open the application
associated with the configuration file. In all other cases, you must specify the exact
application to be run for the external device.
To configure an external device
1 From the Tree View, select an External Device to configure. (External
devices that have not been configured are represented by a question mark
icon.)

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

Optional procedures:

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

Saving Systems
When you make changes to a system, the changes are stored in memory. If you do
not save your work your changes will be lost.

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

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

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-5


Configuration Files
Folder Structure

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

System Editor Tree View Windows Explorer Folder View

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

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


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

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

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

2-6 • Chapter 2 System Configuration GEH-6700C ToolboxST


BlockwareDiagrams, a folder containing the diagrams for user blocks defined in each
library.

File Formats

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

While .xml files can be opened and read in a text editor,


do not modify them. The .xml files modified using a text
editor do not work with the ToolboxST application.

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

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


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

System Options

The ToolboxST application provides a variety of settings that change the way
various functions operate. While you can also configure settings from inside the
component that they affect, settings for all available components display when the
Settings dialog box is opened from the System Editor.
To open the Settings dialog box
From the System Editor, select the Options menu, and then select Settings
to display the Settings dialog box.
In the Settings dialog box, categories are listed in a Tree View on the left side of the
dialog box. Each category contains one or more settings that display in the Property
Editor on the right side of the dialog box.

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-7


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

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

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


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

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

Menu Reference
File Menu
New System creates a new system.

Open System opens a previously created system.

Close System closes the current system.


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

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

Insert New adds a new component to the system.


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

2-8 • Chapter 2 System Configuration GEH-6700C ToolboxST


View Menu
By Type automatically organizes the Tree View by component type.
By Group enables manual organization of the Tree View with group
components.
Track keeps selections in the Tree View and Summary View
synchronized.
Memory Usage displays the total allocated memory.
EGD Diagnostics provides access to several Ethernet Global Data
(EGD) diagnostic tools.
EGD Management Tool opens the Ethernet Global Data (EGD)
Management Tool (EMT).
View Online Statistics provides a view of EGD exchange status from
the selected device. Only EGD Class 2 or higher devices that respond to
EGD Command Message Protocol (CMP) will have this diagnostic window.

WorkstationST Capture Live UDP Packets provides an EGD
window that is only enabled when you select a WorkstationST component
with an OPC DA Server configured. The feature allows the WorkstationST
Runtime to capture up to 10,000 EGD UDP messages, then upload them
for display, printing, and exporting to csv format.
EGD Configuration Server
View Differences opens a configuration view window.
Work Offline allows you to work offline.

Options Menu
Settings displays a dialog box with system settings.

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

Tile arranges open Component Editor windows in a grid style.

Close All closes all open Component Editor windows.

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

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-9


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

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

Alarm Classes
Alarm classes are groups or collections of related alarms that share a common
priority and color scheme.
To edit Alarm Classes
1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select Alarm Classes. A data grid with the existing
Alarm Classes displays in the Summary View.

2-10 • Chapter 2 System Configuration GEH-6700C 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 (0 to 99 where 0 is the highest priority).

Ack Foreground Color shows foreground color for an alarm in the


Acknowledged state.

Ack Background Color shows background color for an alarm in the


Acknowledged state.

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

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

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

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

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


highest severity).

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


highest severity).

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-11


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

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

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


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

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

Val fs1 : The initial value, in Format Specification 1

fs1max : The engineering max for Format Specification 1

fs 1min : The engineering min for Format Specification 1

fs 2 max : The engineering max for Format Specification 2

fs 2 min : The engineering min for Format Specification 2

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


the HMI as follows:

(val οc − fs οCmin ) ∗ ( fs οFmax − fs οFmin )


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

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


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

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

2-12 • Chapter 2 System Configuration GEH-6700C ToolboxST


To create a Format Specification Set
1 From the System Editor Edit menu, select System Information.
2 In the System Information Editor, right-click the Format Specification
Sets item in the Tree View and select Add Format Specification Set.
3 Enter a name for the new set and click OK.
To add format specifications to a Format Specification Set
1 From the System Editor Edit Menu, select System Information.
2 In the System Information Editor Tree View, click a Format
Specification Set. A grid of format specifications displays in the Summary
View.

The properties from the Click the Name box in the


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

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-13


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

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

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

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

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

Units displays the text that identifies the format specification unit.

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


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

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

Measurement Systems
Each format specification is assigned to a measurement system. Within a format set,
which represents a particular type of measurement (like temperature), only one unit
per measurement system can be created. (For example, you could not add both
Celsius and Kelvin within the Metric system as units of temperature.) You can select
the two measurement systems that are stored in the SDB in the System Information
Editor.
To select the measurement systems used by the SDB
1 In the System Information Editor Tree View, select Format
Specification Sets.
2 Click SDB Meas Sys 1 or SDB Meas Sys 2 in the Property Editor, then
select a measurement system from the drop-down list.

HMI Resources
A resource is a way for an HMI (Human-Machine Interface), to organize and tailor
access to alarms and live data. Variables have an HMI resource property that can be
set to one of the HMI resources defined here. Each resource has a name and an
optional description.

2-14 • Chapter 2 System Configuration GEH-6700C ToolboxST


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

Click the System item in


the Tree View to access
SDB properties.

This property must be set


to True before other SDB
properties can be
configured.

The host name where


the SDB is located.

The path where the


SDB is located.

The ToolboxST configuration for alarm classes and format specifications can be
stored, or put, to an SDB from the System Information Editor.
To put the system configuration to an SDB
1 Open the System Information Editor. From the System menu, select Put
System to SDB. (Refer to the section, System Information Editor.)
2 A dialog box displays confirming the destination SDB Host and Path. Click OK.
When it is complete, the results display on the Log tab of the InfoView.

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-15


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

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

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

The EGD Configuration Server properties are as follows:

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

2-16 • Chapter 2 System Configuration GEH-6700C 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
system's local directory for that referenced device. For example, if your ToolboxST
system was located at C:\MySystem and a device was referencing a device Dev1, the
EGD configuration for Dev1 would be obtained from the EGD Configuration Server
if that configuration had a newer timestamp than the configuration at
c:\MySystem\Dev1. Otherwise the local c:\MySystem\Dev1 configuration would be
used.

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

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

Timeout is the server connection timeout in milliseconds.

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

Working Online with the EGD Configuration Server


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

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

ToolboxST/EGD Configuration Server Interaction


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

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


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

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


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

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-17


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.

The following options are available:

2-18 • Chapter 2 System Configuration GEH-6700C ToolboxST


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

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

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

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

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

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

Configuring an External EGD Device


The EGD configuration for a device in the SDB can be retrieved for use in a
ToolboxST system. Before you can reference an external device in the SDB, the
SDB Enable property of the system must be set to True. Refer to the section, System
Database (SDB).
To get an external device?s EGD configuration from the SDB
1 If the external device does not already exist as a ToolboxST component, create
an External Device component to represent it. Refer to the section,
Components.
2 Select the external device in the System Editor Tree View. The component
properties display in the Property Editor.
3 Set the Enable Get from SDB property to True.
4 Right-click the external device in the Tree View and select Get EGD from
SDB. A dialog box displays confirming the destination SDB Host and Path.
5 Click OK to proceed with the Get EGD from SDB operation. When it is
complete, the results display on the Log tab of the InfoView.

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

GEH-6700C ToolboxST Chapter 2 System Configuration • 2-19


Notes

2-20 • Chapter 2 System Configuration GEH-6700C 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 called a Task.
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-6700C 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.

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 block’s context. The combination of the variable name with the block’s name
and context give each variable a unique name within the controller. Blocks in the
same user block can reference each other’s 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 block’s block
diagram. For more information about editing blocks, refer to the section, Block
Diagram Editor.

3-2 • Chapter 3 Software GEH-6700C ToolboxST


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.

A user block library is a collection of user block definitions and task definitions.
User block definitions can be used as templates for programs, tasks, or user blocks,
while task definitions can only be used as templates for tasks.

Task and user block definitions can contain tasks and/or user blocks created from
other definitions within the same library container. When a task or user block
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.

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, and


• Perform an Instance All command in the controller component.

GEH-6700C ToolboxST Chapter 3 Software • 3-3


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.

To create and use a linked user block


1 From the System Editor, open a library container.
2 Right-click the User Block Libraries item and add a library.
3 Right-click the library and add a user block definition.

4 Save the library by clicking the Save button on the toolbar.


5 From the System Editor, open a controller.
6 Select the Software tab.

3-4 • Chapter 3 Software GEH-6700C ToolboxST


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

Select the new library


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

8 From the Tree View tab, select a Program or right-click to add a new
Program.
9 Right-click the program and add a task.

10 In the Add Task dialog box, select the Select Library Block checkbox to
show library blocks.
11 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
1 From the System Editor, open a library component.
2 From the Tree View, navigate to the user block to update.
3 Edit the user block using the Summary View or the Property Editor.

GEH-6700C ToolboxST Chapter 3 Software • 3-5


4 Save and close the library.
5 From the System Editor, open a library or controller component.
6 From the Tree View, right-click the user block to be updated, then select the
Instance command from the shortcut menu.

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, or Program.

User block definitions are the origin 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 two constructs 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.

3-6 • Chapter 3 Software GEH-6700C ToolboxST


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-6700C 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, which in turn contain user block
definitions. A user block definition is a collection of function blocks and user blocks
with input and output pins. 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 The Finder is used to
compatibility, data types, and equations. 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 The Summary View is used for editing the
information about the currently selected user block selected in the Tree View.
tab.

3-8 • Chapter 3 Software GEH-6700C 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 the new name


and select the Type of
library. Click Next to
display the Product
Version page.

GEH-6700C ToolboxST Chapter 3 Software • 3-9


Select the Version and then
check the Optional Libraries
to include. Click Finish to
create the 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-6700C ToolboxST


To upgrade a Library Container
1 From the Tree View, select any Library Container item.
2 From the File menu, select Upgrade to display the Upgrade Wizard.
3 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.

Library Container Editor/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.

To add a new library to a library container


1 From the Tree View, right-click the Libraries item, then select Add Library
to display the Add New Library dialog box.

GEH-6700C ToolboxST Chapter 3 Software • 3-11


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

2 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-6700C 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 properties control the right to View, Modify Data, or Modify Design
of this library. Refer to the section, Security.

Library Summary View

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

GEH-6700C ToolboxST Chapter 3 Software • 3-13


Property Editor

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.

3-14 • Chapter 3 Software GEH-6700C ToolboxST


Exporting a Table Definition
To export a table definition (.csv)
1 From the Component Editor, click the Software tab.
2 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 Select the .csv table definition file (.csv) from the browser window and click
Save.

GEH-6700C ToolboxST Chapter 3 Software • 3-15


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.

Change the value


and click Send &
Close.

The Data Grid displays the differences.

This feature allows you to tune up the table data values in the controller. Once the

table data values are correct, click at the bottom of the Editor
to capture the values in the ToolboxST configuration.

3-16 • Chapter 3 Software GEH-6700C ToolboxST


Using Table Definitions in Software Application
Code
To add a 2D (Univariant) Linear Interpolator block
The following table definition is used:

1 Connect the Table2D pin to the Table\T_ESPBSJ table.


2 Set the XInput to 40.
3 Build and download the application code. The output of the block is as follows.

To Add a 3D (Bivariant) Linear Interpolator block


The following table definition is used:

1 Connect the Table3D pin to the Table\T_DSPNAJ table.


2 Set the XInput to –30.

GEH-6700C ToolboxST Chapter 3 Software • 3-17


3 Set the Yinput to 4.
4 Build and download the application code. The output of the block is as follows:

Adding a User Block Definition


Each library can contain many user block definitions.
To add a user block definition to a system
1 From the Tree View, right-click the library item and select User Block
Definition to display the Add New User Block Definition dialog box.

2 Enter a new name for the library. Click OK.

3-18 • Chapter 3 Software GEH-6700C 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 right-
clicked 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-6700C ToolboxST Chapter 3 Software • 3-19


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
1 From the Tree View, right-click the User Block Definition and select Add
User Attribute to display the Add User Attribute dialog box.

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

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

3-20 • Chapter 3 Software GEH-6700C 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 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.

Property Editor

GEH-6700C ToolboxST Chapter 3 Software • 3-21


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.

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 the section, Block Diagram Editor.

3-22 • Chapter 3 Software GEH-6700C ToolboxST


Summary Tab

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-6700C ToolboxST Chapter 3 Software • 3-23


Block Diagram Editor
Application software in the controller consists of blocks that perform control logic
functions. The controller run time 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.

The Library View is


divided into multiple
categories, each
containing one or more
Click for a Click for shape- Click to zoom Click to display
blocks that perform similar
wiring tool. drawing tools. in and out. Detached View. 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. (Refer to the
section, User Blocks) If the user block is protected, you are prompted to enter the
appropriate password.

3-24 • Chapter 3 Software GEH-6700C ToolboxST


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.

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.

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

GEH-6700C ToolboxST Chapter 3 Software • 3-25


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 Edit View. The block displays on the Block Diagram.
Or,
Press the Insert key to display the Pick Block to Insert dialog box. Select the
desired block and click OK to add it to the Block Diagram.

To edit the properties of a block


Click a block in the Edit View. 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:

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.

Selected Pin displays the pin currently highlighted in the Edit View.

Block Type displays the name of the library block that this block was created from
read-only.

Block Data Type displays the name data type for variant pins on the currently
selected block.

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

Instance Script are scripts that runs when the block is instanced.

Description is text describing the selected block.

Show Description, when set to True, displays the description text for this block on
the diagram.

3-26 • Chapter 3 Software GEH-6700C ToolboxST


Top displays the location of the top of the block in the diagram.

Left displays the location of the left of the block in the diagram.

Height displays the height of the block in the diagram.

Width displays the width of the block in the diagram.

Version displays the version number of the source for this block instance read-only.

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 pin’s Connection property is set to the block that was the source of the
drag-and-drop operation. You can also use the Wiring Tool to form pin
connections, which forms connections to both normal blocks and to blocks with a
configurable number of inputs (called Rubber Pins).

Source of the Wiring Destination, a new


Tool drag-and-drop Rubber pin
operation.

GEH-6700C ToolboxST Chapter 3 Software • 3-27


Block Shape Shortcut Menu
When you right-click a block, a shortcut menu displays:

Block Help shows reference documentation on the selected block type in a help
window.

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.

Add Pin Group adds the next group of pins in a block with a configurable number
of inputs. For example, on a rung block, this would add the next available pin unless
all 16 are in use.

Remove Empty Pin Groups removes empty pins from the end of a rubber block.
This command does not remove empty pin groups in the middle of the block (for
example, pins A through D cannot be removed if Pin E is used).

Show Boolean Logic as Rung toggles the display of a rung block between a
rung diagram alone and a block containing a rung graphic.

Edit Ladder Logic displays the Rung Editor for a rung block.

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

3-28 • Chapter 3 Software GEH-6700C ToolboxST


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 Click to access local


showing the variables variables and
connected to the selected pin. 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 Option buttons


display the Variable specify the type of
Browser. connection.
To connect multiple pins
Double-click a block in the Block Diagram Editor. The Edit Block
Connections dialog box displays.

Click a pin to
select it for editing.

This box displays


the currently
selected pin. Type the name of a
variable or an
intermediate value to
connect to the selected
pin.
Browse buttons
display the
Variable Browser.

GEH-6700C ToolboxST Chapter 3 Software • 3-29


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

In the Edit Block Connection dialog box, a prefix letter and a colon indicate the type
of connection. These prefixes allow the connection type to be specified just like the
option buttons on the Connect Pin dialog box, except prefixes can be typed quickly
and pasted from the clipboard. The following are valid prefixes:
Prefix Type
N: Number or Boolean value
E: Enumeration value
L: Local variable
G: Global variable

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.
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 as described below:

Note When the controller is in Locked mode , double-clicking on a variable value


would bring up the following message.

3-30 • Chapter 3 Software GEH-6700C ToolboxST


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 Click here to invert the current
Value to the controller and value and immediately send it
close the dialog box. to the controller without closing
the dialog box.

Numerical Values

Displays the
current value of
the variable.

Enter a new value


for the variable.

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

Check this box to


prevent programs
from overwriting
your selected
value.

Click to increase or Click here to send the Click here to send the Next
decrease the variable by the Next Value to the Value to the controller without
delta value and send the controller and close the closing the dialog box.
result to the controller. dialog box.

GEH-6700C ToolboxST Chapter 3 Software • 3-31


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 customization of 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 Edit View
toolbar.

The Variable Tool is only useful in Manual Layout mode as a way to clarify a
variable connection. It inserts a variable reference that can be wired to a block pin
and moved around freely. It is useful for creating diagrams that conform to specific
design standards. For example, all input and output variables could be drawn on the
left and right side of the diagram sheet, clarifying data flow for the user block. The
shape created by the variable tool has the following properties:

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.

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.

3-32 • Chapter 3 Software GEH-6700C 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.

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

GEH-6700C ToolboxST Chapter 3 Software • 3-33


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.

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.

3-34 • Chapter 3 Software GEH-6700C 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 devoted to the Edit view 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
dragging 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

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.

GEH-6700C ToolboxST Chapter 3 Software • 3-35


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.

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


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

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 Default to parent setting or a gray check box indicates that you have
no preference at the current level. The diagram will use the settings from the next
level down in the hierarchy.

3-36 • Chapter 3 Software GEH-6700C ToolboxST


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.
In a Relay Ladder Diagram, 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.

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 relay ladder diagram 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 Drag separators to add or Click OK to save or cancel


remove columns. to discard changes .

Drag separators to Displays the current


add or remove rows . equation or error message .

GEH-6700C ToolboxST Chapter 3 Software • 3-37


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

1 Select the contact tool that matches the type of contact you want

to add. The mouse cursor changes to reflect the selected contact type.
2 Click a cell to add a new contact.
3 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 A bad wire

3-38 • Chapter 3 Software GEH-6700C ToolboxST


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

GEH-6700C ToolboxST Chapter 3 Software • 3-39


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 Print Settings tab allows Print Profile tab manages
to change the paper size, you to change the saved print settings. It stores all
margins, and orientation. destination printer and its the settings from both the
associated settings. Options and Page Option tabs.

Prints a summary of Page Numbering


configuration settings options control page
for the component. number assignment.
Linear pages number
sequentially start with
page one.
Includes a list of
Hierarchical page
sections and page numbers are same as
numbers. linear pages but also
numbers each section
Includes a symbol and sub-sections, such
quick reference as 1., 1.1, 1.2.1 and so
guide. on.

Prints all software


programs in the
component.
Prints a reference to Displays a Print Preview Click this button to
all variables in the window with the document print the document.
component. exactly as it will appear on
paper.

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 describe how to:

• Add a user block definition to a library


• Insert a linked user block in a controller
• Add a device attribute
• Exclude a block from a user block with an instance script
• Substitute text into a user block with an attribute

3-40 • Chapter 3 Software GEH-6700C ToolboxST


To add a user block definition to a library
1 Open ToolboxST. From the File menu, select New System to display the
New System dialog box.
2 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-6700C ToolboxST Chapter 3 Software • 3-41


The Library Container Creation Wizard opens.

Enter Libraries in the


Name box and click Next.

3 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 double-
clicking the Libraries
item in the Tree View.

3-42 • Chapter 3 Software GEH-6700C ToolboxST


Right-click the User Block
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-6700C ToolboxST Chapter 3 Software • 3-43


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.

5 With the Lib1Usb1 item highlighted in the Tree View, click the Edit button on
the Block Diagram Editor toolbar. The Block Diagram Editor switches to
Edit mode and Libraries tab displays on the right side of the block diagram.

From the Libraries


tab, scroll to select
the Memory Move
category.

3-44 • Chapter 3 Software GEH-6700C ToolboxST


6 Drag a MOVE block from the Memory Move category to the Block
Diagram Editor to add it to the user block. Repeat this process two more times
until three MOVE blocks display on the block diagram.

7 Save the library container by clicking the Save Configuration button on


the toolbar and close the editor by clicking the Close button in the upper
right corner.

GEH-6700C ToolboxST Chapter 3 Software • 3-45


To insert a linked user block in a controller
1 Open the System Editor for the test system created in the previous procedure.
2 From the Tree View, right-click the system item to display the system
shortcut menu.

From the shortcut


menu, click Insert
New.

Then click Controller, and


Mark VIe Controller.
The Mark VIe Creation Wizard
opens.

Enter a name for


the new controller.

Click Next to
continue.

3-46 • Chapter 3 Software GEH-6700C 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.

Open the controller Component


Editor by double-clicking it in the
Tree View or Summary View.

GEH-6700C ToolboxST Chapter 3 Software • 3-47


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

3-48 • Chapter 3 Software GEH-6700C ToolboxST


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

Click OK to accept
the default name.

5 Right-click the Prog1 item in the Tree View to display the Program shortcut
menu.

Click Add Task to display


the Add Taskdialog box.

GEH-6700C ToolboxST Chapter 3 Software • 3-49


Click the User Block
category. The Lib1Usb1
user block will
automatically be
selected, as it is the first
block in the library.

Select the Select


Library Blockcheck
box

Click OK to accept the


default name. The user
block Lib1Usb1 is added
to Prog1 and displays on
both theTree View and
the Summary View.

6 Save the changes by clicking the Save Configuration button on the


toolbar and close the editor by clicking the Exit button .

3-50 • Chapter 3 Software GEH-6700C ToolboxST


To add a device attribute
1 Open the System Editor for the test system created in the previous examples.
2 From the System Editor, open the Controller Component Editor by
double-clicking the controller in either the Tree View or the Summary View.

From the Component


Editor , click the
General tab. Click the
Attributes item on the
Tree View to display
the attribute data grid
in the Summary View .

GEH-6700C ToolboxST Chapter 3 Software • 3-51


Click the Name cell on
the append row
(indicated by an
asterisk *) and type
Attr1 to name the new
attribute.

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

3-52 • Chapter 3 Software GEH-6700C ToolboxST


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

5 Save the changes by clicking the Save Configuration button on the


toolbar, then close the editor by clicking the Exit button .

GEH-6700C ToolboxST Chapter 3 Software • 3-53


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.
2 From the System Editor, open the Library Container Editor by double-
clicking the Libraries item in the Tree View.

Click the plus symbol to


expand the items Lib1
and Lib1Usb1 and
display a list of blocks.

Right-click the MOVE_2


block item to display the
block shortcut menu and
select Add Instance
Script. The block icon
changes to display a blue
S, indicating that a script
has been added.

3 Repeat these steps for the MOVE_3 block item.


4 In the Block Diagram Editor, click the Edit button to switch to Edit mode,
then 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
script Edit Text dialog box displays with the default Instance Script:
Block.Include = Device.Attribute("Attr1").BoolValue
5 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

6 Save the library container by clicking the Save Configuration button on


the toolbar, then close the editor by clicking the Exit button .
7 Open the controller component by double-clicking it in the system editor.
8 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.
9 Change the value to True using the drop-down box,then click OK.
10 Click the Software tab. From the Tree View, locate the Prog1 item. If it is
collapsed, click the plus symbol to expand it.

3-54 • Chapter 3 Software GEH-6700C ToolboxST


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.
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,
click the Value cell in the Attr1 row, then click the ellipsis button. In the
Modify Value dialog box, set the attribute value to False and click OK.
13 Return to the Software tab. Right-click the Lib1Usb1 user block 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 will
cause 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 Configuration button on the


toolbar, then close the editor by clicking the Exit button .

To substitute text into a user block with an attribute

1 Open the System Editor for the test system created in the previous examples.
2 From the System Editor, open the Library Container Editor by double-
clicking the Libraries item in the Tree View.
3 From the Tree View, expand Lib1 and right-click the user block Lib1Usb1 to
display the shortcut menu.

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

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


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

GEH-6700C ToolboxST Chapter 3 Software • 3-55


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

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

8 Change the PromptForInput cell of Attr1_u to True. (You may have to scroll
right in the Summary View to locate the PromptForInput column.)
9 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.

3-56 • Chapter 3 Software GEH-6700C ToolboxST


12 Click the Edit toggle button in the Summary View, then double-click the
enable pin of the MOVE_1 block. The Connect Pin dialog box displays.

13 Click the Local Variable option button. 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 Configuration button on


the toolbar, then close the editor by clicking the Exit button .
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 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 will be
added to the Tree View.
18 From the Tree View, click the Attributes item. The Attr1_u attribute 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.

GEH-6700C ToolboxST Chapter 3 Software • 3-57


20 From the Tree View, right-click the Lib1Usb1 item, then select Instance. The
value entered for Attr1_u will be 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 Lib1Usb1. The ABCDEFG_thing variable will display in the
Summary View.

22 Save the component by clicking the Save Configuration button on the


toolbar, then close the editor by clicking the Exit button .

3-58 • Chapter 3 Software GEH-6700C ToolboxST


CHAPTER 4

Chapter 4 Mark VIe Component


Editor

To open a Mark VIe Component Editor
From the Tree View, double-click a component.

The Summary View provides an


overview of the item selected in the
Tree View. It can be used to monitor or
edit an item.
Tabbed pages organize
the different elements of
the component’s
configuration.

The Tree View 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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-1


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

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

The Min-Max button


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

To edit a property in the Property Editor


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

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

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

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

4-2 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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

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

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

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

Status tab displays operating state and equality information about the 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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-3


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

The three different kinds of protection available are called Access Rights.

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

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

The title bar indicates which access right is protected.

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

Enter the password, then


click OK.

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

4-4 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


To change an existing password
1 From the Property Editor, expand the Protection item.
2 Select the desired access right, such as Modify Design, and then click the
Ellipsis button. If there is already a password on that access right and it has
not yet been entered, you are first asked for the password before being allowed
to change it. The Change Modify Design Password dialog opens.

The title bar indicates


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

Enter the new


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

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

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-5


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

From the Property


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

To view the design


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

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

4-6 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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

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

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

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

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

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-7


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

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

Drag borders to Column


Click to select Sort indicator headers
resize columns
entire grid.

Row
headers

Currently
selected row

Append
row

Selected cell

Editing Data
To... Do this:

Edit a text or numeric value


Left-click inside the cell to be
modified. The cell changes into a text box. Edit the contents of
the cell as desired, and then press Enter to save your
changes.
Edit an enumerated value
Left-click inside the cell to be
modified. The cell changes into a drop-down list. Click the
down arrow and select the desired value for the cell.
Edit a complex value
Left-click inside the cell to be
modified. The cell changes into a text box with an ellipsis
button, indicating that a dialog box is available to change the
cell contents. To display the dialog box, click the ellipsis
button.
Quickly set a property to the Left-click the row header for the first row to be edited. Then,
same value for multiple rows 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.)

4-8 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Organizing Columns
The columns of a data grid can be customized. You can select the columns that
display, their order from left to right, their width and the sort criteria.
To... Do this:
Resize a column Drag the vertical bar on the right of the column header to a
new location.
Quickly remove a single column Right-click the column header and select Hide Column.
Move a column to a different location Drag the column header to a new location.
Sort by a column Click a column header. The column will sort in ascending
order. To sort in descending order, click the column header
again.
Reset columns to the original configuration Right-click any column header and select Default Column
Organization.
Add or remove columns Right-click any column header and select Organize
Columns to display the Organize Columns dialog box.

Add all
available
columns to
the data grid.

Add selected
column to the Move the selected
data grid. column up or down
in the column order.

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-9


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

Add a variable to a block diagram, Arrange windows on screen so both the source grid and a
Trender window or Watch Window destination block diagram, Trender window or watch window are
from a data grid 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.

4-10 • Chapter 4 Mark VIe Component Editor GEH-6700C 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.

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
provides a consistent
way to edit the item
currently selected in the
Tree View .

Component InfoView
displays feedback
information about the
currently selected item.

Summary View provides an


overview of the controller.

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

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

Frame Period determines the frame period in milliseconds. A frame is the basis for
MarkVI 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.

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 change 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 must be changed from the System
Editor.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-11


NTP Configuration Mode determines how the Network Time Protocol client
synchronizes the controller time. Valid options are:

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

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. This feature
is not yet implemented.

Protection provides the following two access rights:

Modify Data permits modification of data values and the forcing of variables.

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.

4-12 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Attributes
Attributes are device-level values that affect how the configuration is generated.
When the Attributes item is selected in the Tree View, a grid displays in the
Summary View to view and edit controller attributes.

The following columns are available:

Name is a unique identifier for the attribute.

Description stores added comments about the attribute.

Type sets the data type of the attribute.

Value displays and modifies the current attribute value.

Array Length determines the number of elements in the array the attribute
represents if set to a number greater than zero. (A value of zero indicates that the
attribute is not an array.)

Prompt determines if the user is asked for values when the attribute is used in
instance scripts.

Additionally, when the Attributes item is selected in the Tree View, the property
editor displays the protection passwords for the attributes. The following protection
options are available:

Modify Data permits the modification of the values of device attributes.

Modify Design permits the modification, addition and removal of device


attributes.

View Design permits the user to view the device attributes.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-13


Attribute Value Editor
The Attribute Value Editor provides a way 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.

Name of the attribute


being edited.
If the attribute uses
Value of the attribute. an enumeration,
use this drop-down
box to select a
predefined value.

Added boxes are used


when an attribute is an
array.

If checked, attribute Sets the data


values are restricted type of the
to an enumeration (a attribute.
predefined set of
allowable values.)
The values
currently in the
To add a value to the
enumeration.
enumeration, fill in the
Name, Value and
(optionally) Description
boxes, and then click the
Add button.

4-14 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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 controller’s 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.

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

Enabled disables the selected network adapter if set to False. (This property is
usually unavailable.)

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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-15


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.

4-16 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-17


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 Insert Module Wizard.

Select an I/O pack


redundancy type

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 will not display.

4-18 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Click the view information
about the currently selected
module version.

Use the drop-down list to select a


module version. Listed module
versions depend on the available
compatibility codes.
If this check box is selected, the
module must be present and
functioning for the controller to
go online.

Click Next.

The Cabinet and


TB Location display
in these fields.

Select the hardware


from the drop-down list
in the HW Form field.

Select the terminal board


type from the drop-down list
in the Type field.

To add auxillary terminal


boards, click in the Phys
Pos field. A drop-down list
display if more than one is
available.

Click Next .

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-19


Review the configuration summary,
and then click Finish to add the
new module.

4-20 • Chapter 4 Mark VIe Component Editor GEH-6700C 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 from the menu. Type a name and a description for the group.
Also select the type and icon for the group and then 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 symbol, release the mouse button to move
the module.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-21


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

Special Modules
Calibrating PSVO Valve Circuits

PSVO valve calibration allows you to configure the valve circuits of the PSVO
module I/O pack. The Calibrate Valve dialog box provides an automated sequence
as well as a verification mechanism to configure and maintain PSVO values for each
valve circuit.

Note Only one valve can be calibrated at one time.

To open the Calibrate Valve dialog box


1 From the Component Editor, click the Hardware tab.
2 From the Tree View, select the desired PSVO module.
3 From the Summary View, select the Module Variables tab, and then click
the On/offline button on the taskbar to go online.

4-22 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


4 In the Summary View, scroll to CalibEnab1, and then double-click it in the
row header.

Note Only enabled regulators can be calibrated.

5 From the Summary View, click the Regulators tab.


6 From the Regulators drop-down list, select the desired regulator.
7 Click the Calibrate button. The Calibrate Valve dialog box displays.

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

9 To exit calibration mode, click the Calibration Mode button again.

Auto Calibrate Commands

Auto Calibrate commands occur in the following sequence:

1 Click Minimum End to stroke the actuator to the minimum end position.
2 Click Fix Minimum End to read the voltage at the minimum end position.
3 Click Maximum End to stroke the actuator to the maximum end position.
4 Click Fix Maximum End to read the voltage at the maximum end position.
5 Click Calibrate to use the calculated values.
6 Click Save to save the calculated values.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-23


Note Only one command state can be active at any one time.

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

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.

Configuring a HART I/O Device

To add HART I/O devices to a component configuration, a PHRA module must be


added in a cabinet group.

To configure PHRA module for HART Devices


1 From the Component Editor, click the Hardware tab.
2 From the Tree View, select the PHRA I/O module.
3 From the Summary View, click the Parameters to configure PHRA module
for an Asset Management System (AMS), if applicable.
4 From the Summary View, click the Inputs and Outputs tabs. Enable and
configure each input and/or output needed for the HART devices.

4-24 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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.
2 From the Tree View, select the PHRA I/O module.
3 Right-click module and click Upload Hart IDs.

PROFIBUS

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-25


To add a PPRF module
1 From the Component Editor, click the Hardware tab.
2 From the Tree View, right-click the Distributed I/O item and select Add
Module. The Insert Module Wizard dialog box displays.

Select an I/O pack


redundancy type.

Select the
module type.

Click Next .

4-26 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Click to view
information about
the currently selected
module version.

Click Next.

Click Finish to add


the new module.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-27


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.

2 Select a file(s), then click the Add File button.

4-28 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


3 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

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-29


Note Any changes made in the PROFIBUS Network tab cannot be undone through
the ToolboxST Undo option under Edit.

The slave device opens with the Modules view displayed.

From the Available


Modules list, select the
Click the pushpin desired module. Then
icon to expand and either double-click the
collapse the module name or click
Tree View. 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 must be restarted after the controller and pack are downloaded.

4-30 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


The Station Address,
which is read-only
Click the General from this view, displays
item to display the the device address.
General View.

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 fail-
safe mode. The default
time interval is 200 ms.

Click theOK
button to return
to the Hardware
tab.

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-31


6 From the Tree View, click the Groups item to add the slave device to an I/O
group.

Click the OK button to


return to the Hardware
tab.

For detailed information


about groups, click the
Help button.

4-32 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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

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

Click the OK
button to return to
the Hardware tab.

For detailed
information, click
the Help button.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-33


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

4-34 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-35


To enable the slave device
From the Tree View, click Station Table to display the window below.

Click Activate to enable


the slave device on the
PROFIBUS network,
then click OK.

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.

4-36 • Chapter 4 Mark VIe Component Editor GEH-6700C 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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-37


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.

VarDataType 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 Mark VIe Variable


Data Type Data Type Scaling
Boolean Boolean
Integer16 Integer
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 events is similar to an SOE, but has a 10ms resolution.

4-38 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


HotBackUp Redundancy

When HotBackup is selected as the redundancy type,


the PROFI_BACKUP_PPRF_R and the
PROFI_BACKUP_PPRF_S variables indicate the
active and backup pack. The variable set to False
is the active pack; the variable set to True
is the backup.

PROFIBUS Diagnostics
To display diagnostics

From the Hardware tab, Tree View, click the


PPRF, then click the PROFIBUS Diagnostics tab.

If any PROFIBUS device causes a diagnostic, the ProfibusDiag variable will have
a value of True. For applications that require diagnostic support, attach a defined
variable to the ProfibusDiag.
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.

The Advanced Diagnostics window below displays no diagnostics.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-39


The Advanced Diagnostics window below displays an example of a PROFIBUS
diagnostic.

4-40 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Viewing Modules
Group Layout

Click the folder


icon to select
group layout.

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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-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 Advanced and are hidden
by default. To display Advanced parameters, click the Show/Hide Advanced
button on the toolbar.

4-42 • Chapter 4 Mark VIe Component Editor GEH-6700C 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.

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)

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-43


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

4-44 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Reporting Module Data
Reporting

The ToolboxST application can generate different types of reports. The I/O related
reports are:

• I/O pack Fault Report


• I/O pack Revision Report
• I/O pack Communication Report
Each report contains configuration or diagnostic details about the I/O hardware in a
component.
To view or print an I/O report
From the Hardware tab Tree View, right-click Distributed I/O and select
Create I/O Report.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-45


The I/O report for the component displays.

4-46 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Upgrading Modules
Modules can be upgraded to a different compatibility code set if one is available.
To upgrade a module
From the Hardware tab Tree View, right-click the module to be upgraded and
select Upgrade Module. The Upgrade Wizard displays.
For the example module shown below, there are two module versions available: a
PEFV with compatibility code set 2,1 and a PEFV with compatibility code set 3,1.

Click a new module


version to upgrade
the module.

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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-47


Comparing Parameters

While making changes to a module’s 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 packs, 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.

4-48 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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

Click this button to


display detailed
diagnostic information
in the Summary tab.

The following are Tree View Symbols:


Error (ex.link unhealthy)

Warning (ex. active alarm)

Informational (ex. inactive alarm)

Normal

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-49


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.

4-50 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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 General from the context menu to display the viewer.

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-51


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.

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.

Programs Item
The Programs item 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. Refer to the section, Adding a Program.

4-52 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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
1 From the Component Editor window, select the Software tab.
2 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.
3 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 top-
level check box. If all the
blocks of a Library
Container are included,
select the check box for an
item at the third level.

To reference a function block library


1 From the Component Editor window, select the Software tab.
2 From the Tree View, right-click the Programs item, then select Library
References. The Library References dialog displays all available user
block libraries.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-53


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

4-54 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Property Editor

The Programs Property Editor has two properties that control how instancing works:

Preserve control constant initial values, if set to True, allows the Initial Value
property of a variable that is a control constant to be modified at the instance and not
overwritten when re-instanced.

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

Use the drop-down list


to select.

Adding a Program
The Programs item allows you to add programs to a controller.
To add a program
1 From the Component Editor window, select the Software tab.
2 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.

Select Add program or


Add Existing Program
from the shortcut menu.

3 Enter the new program name or select an existing .xml file from the Select
Existing Program dialog box.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-55


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

Click the Select Library


Blocks check box to
insert a linked block.
Then select a category
and a user block from
that category. Enter a
name for the linked
block.

Click All to display all of


the categories and
Blocks. Click None to
de-select all Categories .

4-56 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Adding a User Block
To add a user block

From theTree 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 will be used.

A user block can either be linked from a user block library, or embedded, acting as a
container for function and user blocks.

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:

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-57


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 two-
dimensional 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.
To add a table definition
1 From the Software tab, select a Program in the Tree View.
2 Right-click the program name and select Import Table.csv file from the
shortcut menu to display the Table Definition dialog box.
3 Select the desired table definition file and click Open. The Table Definition file
is inserted into the program.

4-58 • Chapter 4 Mark VIe Component Editor GEH-6700C 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.

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

Property Editor

The Property Editor allows you to edit the name, description, and execution order of
the program selected in the Tree View.

Description allows you to describe the program. Click Description and then click
to enter text.

Name allows you to name the program.

Execution Order sets the order of execution of this program in the controller.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-59


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:

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.

Execution Order sets the order of execution in the program.

User Block Name is the name of this user block.

Period, in milliseconds, is the period at which this user block runs. Calculated by
multiplying the frame multiplier by the controller’s 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 for the user block row to be changed and
select from the drop-down list box.

4-60 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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.

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

User Block Variable

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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-61


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 Programs item to display the Variables
item.

Right-click the Variables item


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

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

4-62 • Chapter 4 Mark VIe Component Editor GEH-6700C 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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-63


Summary View

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.

4-64 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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:

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-65


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.

Click a program or user block


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.

Alarm, if set to True, enables the variable as an alarm. Alarms are used for problems
that require the operator’s 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


Alarm=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, to enable 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.

4-66 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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 time stamped 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 attribute is not specified, the Format Spec Engineering Max will be
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 display
low attribute 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 entry
high attribute 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 entry
low attribute 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.

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 description of the variable.

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 name of the variable.

Nonvolatile indicates that the variable should be saved in non-volatile RAM.

Type is the data type of the variable.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-67


Long Term Deadband allows this variable to be long-term data-collected. Sent
as DeadBand to a Legacy SDB.

Short Term Deadband allows this variable to be short-term data-collected.

Access is used primarily for EGD.

ReadOnly variable can be read on EGD.

ReadWrite variable can be written to through EGD.

NoAccess variable cannot be changed with the ToolboxST application.

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.

EGD Page is used to assign the variable to an Ethernet Global Data Page. Enter the
name of the EGD page to which this variable belongs.

Global Name Prefix is the variable's global name prefix type (None, Full, Block,
Program). 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 program
CORE would display depending on the Global Name Prefix as:

None IGVA

Program CORE. IGVA

User Block VG_Health.IGVA

Full CORE.VG_Health.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.

4-68 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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

Select the DDR that


you want to
configure.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-69


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 item in the
right column to edit.
See below for
descriptions of each item.

Appearance

Name is the user-defined description for this DDR, which is used for the filename.

DataRecorder Setup

Auto Enable, if set automatically, enables the capture buffer, then re-enables it 60
seconds after 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 will be collected until Enable
transitions False or the collection fills the buffer.

4-70 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Frame Period Multiplier extends the sampling period by this multiple. The base
sampling period is the frame period.

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.

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 default EGD page.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-71


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.

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 Variable Browser dialog box displays.

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

4-72 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Updating DDR
DDRs are updated separately from the application code download.
To update a DDR
1 From the Component Editor, select the Dynamic Data Recorders tab and
click the desired DDR.
2 Click the Build button.
3 From the Device menu, select Download, and then select Update Dynamic
Data Recorder. Or, click the Update Dynamic Data Recorder

button .

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

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

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-73


Note If the .xml file being imported contains the formatting flags %n, it will be
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


1 From the list of DDRs, select the DDR to be exported.
2 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.
3 Select the desired file and click Save.

DDR Setup
This procedure explains how to set up a DDR to capture two variables.

1 Add a Program to the Software tab.


2 Add a variable DDREnable (Boolean), which is used to enable the DDR.
3 Add a variable DDRTrigger (Real), which is used to trigger the DDR.
4 Add two variables TriangleOut and SineOut, which are connected to the
output of the function blocks. These are the variables that will be added to the
DDR variable collection.

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

6 Set up the DDR as shown below.

4-74 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


7 Add the two variables SineOut and TriangleOut to the DDR. Set the Frame
Period Multiplier to 3, which means a sample will be 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.
8 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.

9 Build and download the application code.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-75


10 Go Online to the controller. From Prog 1, select the Variables item. Double-
click the green live data for the DDREnable variable. Set to True and send to
the controller.

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.

11 Set the value of the DDRTrigger variable equal to or greater than 5 and send to
the controller.

4-76 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


When the capture is complete, the status indicates Complete, and the DDR can be
uploaded.

12 The Trender is used to upload the capture buffer. From the View menu, select
Trenders to add a new trend. The Trender window displays.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-77


13 Select + and the Trender wizard displays. Select Capture Buffer to select the
DDR to upload. The uploaded DDR variables are shown below.

Ethernet Global Data (EGD) Tab


The Ethernet Global Data (EGD) protocol allows you to share information globally
between controller components (sometimes known as nodes) in a networked
environment. EGD allows one controller component, referred to as the producer of
the data, to simultaneously send information to any number of peer controller
components (consumers) at a fixed periodic rate. This network supports a large
number of controller components capable of both producing and consuming
information.

4-78 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


EGD Configuration
To configure EGD for a controller
1 From the System Editor, double-click on a Mark VIe component to display
the Component Editor.
2 From the Component Editor, select the EGD tab.
3 In the Tree View, select Ethernet Global Data. The Ethernet Global Data
properties display in the Property Editor.

The following properties display in the Property Editor when Ethernet Global Data is
selected in the Tree View:

Collection controls the Collection to which this EGD component belongs when
viewed in the EGD management tool (EMT). 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
1 From the Tree right-click the Produced Pages item, and then select Add
Page.
2 Enter a unique name for the new page in the Page Name dialog box and select
OK.

Note When the first Produced Page is created, it automatically becomes the Default
page.

To select the default Produced Page for the standard signals


1 From the EGD tab, select Produced Pages in the Tree View.
2 Select the Default Page Property from the Property Editor, and then select
the desired page from the drop-down list.

Tip Any variable defined with $Default as the EGD page name will automatically
be 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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-79


Editing Produced Pages
To configure a Produced Page
From the EGD tab Tree View, expand Ethernet Global Data.

Under Produced
Pages, select the
desired page.

The page properties


display in the Property
Editor.

The following properties are available for configuration when a Produced Page is
selected in the Tree View:

Ethernet 0, if selected, 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.

Destination IP Address, when set to Unicast, controls the IP address that receives
the exchanges.

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.

4-80 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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 exchange’s skew
by exactly this value. For example, if you have three exchanges in a page and a skew
value of 2, the first exchange’s skew is two, the second exchange’s skew is four and
the third exchange’s skew is six. (The skew property is measured in nanoseconds.)

Starting Exchange ID is used for the first exchange on this page. Each additional
exchange will be incremented from this number. When this property is changed, all
exchanges are renumbered.

Page Compression
When a page compression is performed, the variables are located in increasing size
order, starting with Booleans, then Words, Double Words, and finally all other
variables.
To compress a single page
From the Tree View, right-click the page to compress, and then select
Compress.

To compress all Produced Pages in a component


From the Tree View, right-click Produced Pages, and then select
Compress All.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-81


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

Select one or more


variables from the
Variable Browser,
then click OK.

The Summary View updates to display


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

Tip If the variable to be added to the EGD page is already in use on the 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.

4-82 • Chapter 4 Mark VIe Component Editor GEH-6700C 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 Comma Separated Value (csv) format.

Editing Exchange Signatures and Configuration


Time
Normally, the exchange signature is managed automatically. The major signature
must be incremented when the exchange content changes in any way other than
additions to the end. If you are using the EGD Device Editor to configure EGD for a
device and the device signature changes only when the manufacturer updates the
configuration, you may need to manually set the signature.

Note To edit exchange signatures and configuration time, set Layout Mode to
Manual.

To edit exchange signatures and configuration time


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

3 Review the warning about manual Exchange Signature editing, then click
OK.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-83


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

4-84 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


EGD Diagnostics
The EGD protocol includes a Command Message Protocol (CMP) to obtain the
status of a Class 2 or higher EGD device. MarkVIe is a Class 3 EGD device. When
any EGD tree node other than a referenced device is selected, the EGD Statistics
from [Device] tab will display the statistics from the open component. When a
Referenced Devices tree node 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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-85


Status columns include the following:

Exchange is the Exchange identifier <device name>.<exchange number>

Configuration Time is the time that the exchange was configured

Due Time is the time that a consumer data packet must be received for an exchange
to remain valid

Status is the health of the exchange

Length is the value for a produced exchange. This length may be the highest
variable offset in the exchange or the highest offset of a variable, which may have
been removed. For a consumed exchange, the value may be the highest variable
offset used or the length of the produced exchange, depending on the bind algorithm
of the individual tool.

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.

4-86 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


EGD Configuration Server Tab
The EGD Configuration Server tab allows you to view and delete EGD nodes
currently residing in the configuration server. The configuration server used is the
one defined in the System Editor under the root tree node. If the server is enabled,
this tab displays information from that server.

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

G1
G2

EGD Configuration Server Contents Sample

The tab control contains a toolbar with two buttons:

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

The Delete button deletes the selected node or nodes. If the nodes were saved
as part of the configuration, they can be added again.

The EGD configuration server uses the producer ID to store all the documents for an
EGD node. If you open two systems, then point to the same configuration server and
save a device of the same name with two different producer IDs to that server, you
can end up with two producer ID nodes with the same device name.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-87


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

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


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

The Referenced Devices item on the EGD tab also has a Compare command that
compares the consumed variable information for the open component against the
EGD configuration server’s content.

Referenced Devices
The EGD variables defined in other components can be added to the current
component’s variable list by adding a reference. References can only be created to
EGD-capable devices that are producers of pages.
To select referenced devices
From the Tree View, right-click the Referenced Devices item, and then
select Select Devices to display the Select Devices dialog box.

Select or clear the


check boxes next to
each component
name, then click OK.

4-88 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


The EGD configuration for the selected devices are loaded and the variables display
in the Summary View.

Grayed Exchanges
are not available to
this component.

When EGD configurations are edited in remote devices, you must refresh the
configuration to ensure that the latest variable information is used.
To refresh the configuration of a referenced device
In the Tree View, right-click the device to be refreshed, and select Refresh.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-89


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

4-90 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Configuring Modbus Slave
To configure Modbus slave for a device
From a Component Editor, click the Modbus Slave tab.

Select the Modbus


Slave option in the
Tree View.
Configuration
properties display in
the Property Editor .

Ethernet
Connection Timeout specifies the time in minutes that the slave will remain
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 VIe gateway Modbus

None indicates that the slave feature is not available.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-91


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

Additional Settings
This section applies 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.

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
If set to False 32-bit example: 0x01234567 would be transmitted as 0x01 0x23 0x45
0x67
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 VIe gateway Modbus and the target
processor.

4-92 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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 (read-
only or read/write) and the type of data (a Boolean or a 16-bit word) as follows:

Data Types

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

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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-93


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

For Modbus protocol, go to: http://www.modicon.com/techpubs/toc7.html

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.

Variable Report

There are two types of variable reports:

• The Variable Global report provides a list of all global variables in the
controller. For every variable, the report lists the variable name, description, data
type, alarm/hold/event status, initial value, and units.
• The Variable Configuration report provides a list of all signals and their
configuration.

Block Pin Report

The Block Pin report provides a list of all block pins in the controller software. For
every variable, the report lists the block pin name, block description, block execution
number, connected variable name, data type of the block pin, the program in which
block resides, pin description, user (macro) block name, block name, Program
running number, and the pin usage description.

Note For linked user blocks, internal block pins are not listed.

I/O Report

There are two types of I/O reports:

• I/O Variable report


• I/O Configuration report
The I/O Variable report provides a list of all hardware inputs and outputs points for
the controller. For every I/O point, the following columns are available:

IO Variable is the name of the point.

4-94 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Description is the description of the I/O point.

Device Tag is the ID of the device attached to the screw.

Screw Name is the name of the screw on the terminal board.

Screw Number is the number of the screw on the terminal board.

Cable Number is the ID of the cable attached to the screw.

Wire Number is the ID of the wire attached to the screw.

Interposing TB is the ID of the terminal board junction, if any, between the Mark
VIe and the actual I/O.

Wire Jumpers is the external wire jumper.

Screw Note provides additional information about the screw on the terminal board.

Jumpers provides a list of the module jumpers.

Jumper Value is the position to which to set the module jumpers.

Sense is used for relay and solenoid circuits only. Sense of relay is connected.

TB Name is the name of the terminal board.

TB Hardware Form is the module terminal board hardware form

Group Name is the group name in the location where the module resides.

TB Location is the module position inside the cabinet.

Module Name is the name of the module.

Bar Code is the terminal board barcode.

Connected Variable is the name of the variable attached to the point.

The I/O Configuration report provides a list of all IO points and their configuration.

Alarm Report

The Alarm report creates a spreadsheet displaying all the variables marked as alarms.
For every variable, the report lists the variable name, description, alarm class,
display screen, and a status if it alarms on a zero condition. Variables are marked as
alarms in the variable Property Editor.

Hold Report

The Hold report creates a spreadsheet displaying all the variables marked as hold
variables. This report lists the variable name, description, and the hold ID for each
variable. Variables are marked as holds in the variable Property Editor.

Event Report

The Event report creates a spreadsheet displaying all the variables marked as events.
This report lists the variable name, description, and the event ID for each variable.
Variables are marked as events in the variable Property Editor.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-95


NovRam Report

The NovRam report creates a spreadsheet displaying all the variables marked as non-
volatile. This report lists the variable name and description for each variable.
Variables are marked as NovRam in the variable Property Editor.

IONet EGD Report

The IONet EGD report provides network communication status values of all IONet
communication viewed from the current connected controller. Some values included
are the number produced exchanges, consumed exchanges, produced messages,
consumed messages, missed messages, and late messages.

I/O Diagnostic Report

There are three types of I/O diagnostic reports:

• The I/O Diagnostic Faults report provides a list of all alarms pertaining to the
I/O.
• The I/O Diagnostic Revision report provides a list of I/O firmware revisions and
expected ToolboxST revisions for quick compatibility comparison.
• The I/O Diagnostic Network report provides a list of the I/O network
communication status values pertaining to each I/O module.

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.

4-96 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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.

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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-97


To sort a column
From the Report window, click any column heading to apply a sort to the
associated column. The first click will sort the column ascending; a second click
will switch the column to a descending sort.
To change report columns
From the Report menu, select Change Columns to display the Select IO
Report Columns dialog box.

Note Because the columns in blue are required, they cannot be moved or selected.

4-98 • Chapter 4 Mark VIe Component Editor GEH-6700C 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
Lists available Boolean operators.
columns. (Double-click (Double-click an
a column to add it to operator to add it to
the equation) the equation)

Click to add
parentheses
to your equation.

Enter the filter


equation to be
used in this box.
Erases the current
filter equation.
Click to accept the
filter equation as
shown.
Cancels without changing
the current filtering 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-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-99


In addition, the following rules apply:

• When using the LIKE operator, you must include a wildcard * at the beginning
and/or end of the right-hand value. For example, [Day Name] LIKE ‘T*’
would select Tuesday and Thursday.
• You can use as many groups of parentheses as necessary to define an
expression.
• Any string values must be enclosed in single quotes: 'string'
To remove a report filter
From the Report window, select the Report menu, then click Remove Filter.
The filter will be removed and all available rows will display.

To save a filtered report


From the Report window, select the File menu, then click Save Filtered
Report.

4-100 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


Finding Data

The Find feature allows text searches 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.

Enter the Click to locate and highlight


search text. the next instance of the
search text in the report.

If selected, the
capitalization in the
report and the
search string must
exactly match.

If selected, the find string Determines the direction


must be found as a whole in which the next search
(for example, ‘day’ would not will proceed.
match ‘Monday’)

Importing an I/O Report from a .csv File

The Mark VIe component supports automated importing of data from a previously
generated I/O report.

To avoid potential loss of data, save the Mark VIe


component before attempting any import operation.

To import an I/O report


1 From the Hardware tab Tree View, select Distributed I/O.
2 From the File menu, select Import, then select I/O Report to display the
Open Report dialog box.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-101


3 In the Open Report dialog box, select a report, then click Open to import the
data. Any data that cannot be imported will be highlighted when the imported
report displays.

Forced Variables
Forced variables are variables whose value is permanently overridden with a specific
value. They are managed using the Forced Variables window while connected to a
controller.
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.

4-102 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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.

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 Click the Filter Toggle button to toggle
properties for the currently between displays of modifiable global
selected row in the Data Grid. variables and all 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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-103


Watch Windows
The easiest way to view and organize live variables in a controller is through Watch
Windows. Watch Windows are created and saved in a component. They can be
exported to .xml and .csv files.
To open the Watch Windows dialog box
Open a Mark VIe Component Editor. From the View menu, select Watch
Windows. The Watch Windows dialog box displays the windows that have
been configured for the component.

Click to access the


selected Watch Window.
Double-click a
name in the list to Click to create a new
open an existing Watch Window.
Watch Window.
Click to remove a Watch
Window from the list.

To allow the collection of


variables to be used by other
components, click to save the
window to an .xml or .csv file.

Note If this is the first time the Watch Windows dialog box has been opened for the
selected component, the list will be empty. Create or import a new Watch Window.

Managing Variables

Once a Watch Window is created, variables can be managed with the following
commands.

Right-click anywhere inside the variable


list to display the shortcut menu.

Insert Variable allows you to insert new


variables from the Variable Browser.

Remove Variable deletes the selected


variable.
Go to Definition navigates the Component
Editor to the location where the variable is
defined, such as a program variable grid.

Change Live Value displays the Change Live


Copy Watch as Text copies the contents of a Watch Value dialog box for the selected variable.
Window (including live variables) to the clipboard as
text. This data is in Comma Separated Value (.csv)
format so it can be pasted into spreadsheets, text
editors, and mail clients.

4-104 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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

A Watch Window can be saved to an xml file, which can then be imported into
another components. This allows you to use a previously selected collection of
variables.
To export a Watch Window to an .xml file
1 In the Watch Windows dialog, select the desired Watch Window, then click
the Export button.
2 The Export Watch Windows dialog displays. Select the desired destination,
then click Save.

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.
2 From the Property Editor, locate the Scope property and verify it is set to
Global.
3 From the Property Editor, change the value of the Control Constant
property to True.
4 From the Property Editor, assign an Initial Value and edit to Property
Editor. (Optional)

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-105


Control Constants Window

All control constants in a controller are displayed 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 Click to display the
box. Initial Value is the only column that Modify Value dialog box.
can be modified from the Control
Constants window.

4-106 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


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, but if any fields other than the Value
field have been modified, the control constants will not be updated. 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,,,

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.

GEH-6700C ToolboxST Chapter 4 Mark VIe Component Editor • 4-107


Notes

4-108 • Chapter 4 Mark VIe Component Editor GEH-6700C ToolboxST


CHAPTER 5

Chapter 5 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-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-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 theStatus


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

5-2 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C 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
won’t 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-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-3
If the indicated Control State is not Controlling, the ToolboxST application can
provide additional information as follows:

Move the mouse pointer


over the Control State.

Information about the


current state displays.

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.

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.

5-4 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C 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 is software that 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 is software that 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 is the software that 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 will take 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-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-5
Controller Initial Setup
The Controller Initial 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 using the Controller Initial Setup wizard
1 Connect a serial cable from the main board of the controller to a free serial port
on your computer.
2 Open the Mark VIe Component Editor for the controller to be configured.
3 From the Device menu, select Download, and then Controller Initial
Setup.
4 From the first page of the wizard, click Next to display the second wizard page.

Select the COMM Port to which you


connected the controller in step 1.
(Refer to your computer
manufacturer’s documentation to
identify communication ports.)
Assign the connected board to a
specific redundant controller by
clicking the appropriate option
button. (If the controller is
configured as a simplex or dual
controller, some channels may not
be available.)

Click Finish to connect to the


controller and perform the initial
setup. A progress dialog box
displays the status of the setup
process.

5-6 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C ToolboxST
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 Mark VIe Download
Wizard.
2 If you have changed configuration settings since the last Build operation, a
message box displays indicating that the software is out of date. Click Yes to
build the current configuration. The Mark VIe Download Wizard opens.
3 Click the Next button to advance past the wizard’s introductory page.

Click the Scan button to


examine the system
configuration and locate out-
of-date software. The Scan
operation automatically
selects any software items
that need to be downloaded.
In this example, the G1
controller needs application
code downloaded, but the I/O
module is up to date.

If checked, software
that was identified as
up-to-date by the scan
operation is displayed.

Reboot Required
indicates that an
offline download is
required to update
the application code.

When the appropriate software is


selected for download, click the Next
button. Review the warning that
displays, and then click Next again to
display the Download page displays.

GEH-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-7
Check this box to continue
downloading if errors occur.
(If an error occurs during the
download of a particular
target, no further downloads
are attempted for that target.)

Click to begin the


download process.

Displays the overall


progress of the
download.

Displays the progress


of the current file
download.

Click to stop the


download process
after the current file
completes.

5-8 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C ToolboxST
4 When the download has completed, click Finish to close the wizard. In the
Component InfoView, click the Log tab and review the status messages to
check for potential warnings or errors that may have occurred during the
download.

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 Mark VIe Upload Wizard.
2 Click Next to advance past the introductory page of the Upload 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.

GEH-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-9
(Optional) Enter the name of
a group to hold the newly
uploaded component.

Enter a name for the newly


uploaded component. (It must
be different than the current
component name and be
unique in the system.)

Click here to begin the


upload process.

3 When the upload completes, click Next to display the final page of the wizard.

5-10 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C ToolboxST
Diagnostics Views
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 Diagnostic View for Controller
1 From the Main menu, select View.
2 From the View menu, select Controller Diagnostics.

The Controller Diagnostic dialog box displays.

Click this button to clear Click this button to Select this check box to show
diagnostic messages with the manually retrieve diagnostic messages with status
status of 0. Only these inactive diagnostic messages. of 1 only. Clear this box to show
messages may be reset. 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 status of The human


the message. the message readable description
(0-inactive, of the message.
1- active).

GEH-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-11
I/O Diagnostic View
The I/O diagnostic 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 diagnostic view
1 From the Main menu, select View.
2 From the View menu, select Diagnostics and I/O Diagnostics. The I/O
Diagnostic View displays.

For more information, refer to Chapter 4, the section Diagnostics Tab.

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.

5-12 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C ToolboxST
2 From the Device menu, select Administer Totalizers to open the View/Set
Totalizers dialog box.

The name of the Totalizer The name of the The current value of the Click here to
block pin connected to the variable connected to counter. The values displayed close the dialog
totalizer. (If blank, the Totalizer a configured pin. are retrieved live from the box.
has not been configured.) controller and are updated
once per second as long as the
dialog box is open.

GEH-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-13
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.
2 From the Device menu, select Administer, and then Totalizers to open the
View/Set Totalizers dialog box.
3 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. Once the file has been created, it is opened in
Notepad.

5-14 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C ToolboxST
4 Follow the directions at the top of the file to contact GE Energy with the
information contained in the file. GE will reply with a new Totalizer_ID.txt that
contains a password customized to your installation:

5 Highlight the 28-character password and press CTRL+C to copy the password to
the Windows clipboard, and then return to the View/Set Totalizers dialog box
in ToolboxST.
6 Right-click inside the Password box and select the Paste command to
transfer the 28-character password from the clipboard. If the password is valid, a
new countdown timer displays below the Password box indicating the time
remaining before the password expires. (Totalizer passwords are usually valid
for 24 hours from the time of creation.)

GEH-6700C ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-15
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.

5-16 • Chapter 5 Working Online With a Mark VIe Component GEH-6700C ToolboxST
CHAPTER 6

Chapter 6 Finder

The Finder is a separate window in the toolbox, which contains several useful tools.
It can help you find items, such as text, overrides, differences, and variable usage
from the different types of components.
To open the Finder

From the toolbar, click the Finder button.


-or-
From the Edit menu, select Find.

Enter the text to Selects a type of search to Displays a shortcut


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

When a search is completed, the results display on the Find Results tab of the
Component InfoView. To jump directly to a location, double-click it in the list.

GEH-6700C ToolboxST Chapter 6 Finder • 6-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.

6-2 • Chapter 6 Finder GEH-6700C 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-6700C ToolboxST Chapter 6 Finder • 6-3


Replace Options
Besides performing simple searches, the Finder also supports search-and-replace
operations.
To display the Replace options
In the Finder window, click the Replace button. The window expands to
include new options.

Enter the text to be Replaces the currently Navigate to the


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

Select to keep Finder Replaces all occurrences of


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

6-4 • Chapter 6 Finder GEH-6700C ToolboxST


CHAPTER 7

Chapter 7 Trender

The Trender is a tool used to capture and display trend graphs of variables in the
system. It can collect and display values in real time from controllers and other
sources, and can display data collected by high-speed coherent data collection
systems, such as capture buffers and dynamic data recorders. The Trender also can
display previously captured data from a saved data file.

Accessing a Trender Window


Before you can analyze data trends, you must first open a Trender window in the
Trender. A Trender window is a collection of traces and data that is saved between
uses. You can open a Trender window from inside the ToolboxST application or
separately from the Start menu. If you open a Trender window from inside the
ToolboxST application, the window is stored inside a component or the system, and
you can create as many Trender windows as necessary. If you open the Trender from
the Start menu, files are saved with a .trend file extension.
To create a new Trender window or open an existing Trender
window
1 If the Trender application is not already open, select the Windows Start
button, Programs, GE ControlST, ToolboxST, and then select Trender.
2 From the File menu, select New to create a new Trender window or select
Open and locate an existing trend file.
To create or open a Trender window from the System Editor
1 From ToolboxST, navigate to the System Editor.
2 A list of available components displays in the Tree View. Double-click a
Trender window to open it.
3 To add a new Trender window, right-click a container (either the system item or
a group) and select Insert New, Tool, Trender).
To create or open a Trender window from a Component Editor
1 From ToolboxST, navigate to the Component Editor for the component that
contains the variables you would like to monitor.
2 From the View menu, select Trenders. A list of available Trender windows
displays.
3 Double-click an existing Trender window to open it or click Add, enter a name,
and then click OK to create a new Trender window.

GEH-6700C ToolboxST Chapter 7 Trender • 7-1


To save a Trender window
From the Trender toolbar, select the Save button. If you opened the current
Trender window from within the ToolboxST application, the Trender window
saves automatically. If you opened the Trender window from the Start menu,
the Trender window saves to a file.

Note While Trender windows opened from the Component Editor are associated
with one particular component for storage purposes, they are not restricted to
observing only that component and may be used to monitor any variables.

Trender Window Features


Trender Toolbar
contains commands
for commonly used
tasks in the Trender
window.

Graph View
contains the trend
graphs, which
display the values
represented by
each trace.

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

Data Toolbar
contains commands
that manipulate the
current data.

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

7-2 • Chapter 7 Trender GEH-6700C ToolboxST


Trender Toolbar
Note The Trender toolbar may have fewer buttons if the current Trender window
was opened from the ToolboxST application.

Open existing Save current Undo Redo


Trender window Trender

Create new
Trender Window

Print Print Preview Go Online

Data Toolbar
Note The buttons available on the Data toolbar may vary according to the current
trace source type.

Record data from Add traces Time Axis Reverse


live source & Forward

Pause Remove Zoom In & Auto-range


selected traces Zoom Out selected traces

Working in Trender
Acquiring Data
Before you can analyze data, you must import it into a Trender window. Variables
can be added to the Trender window live, from capture buffers or from static files.
While you may add as many variables as you like to a given Trender window, all of
them must come from the same type of data source. (For example, you cannot
display both live and static file variables simultaneously.)

Adding Traces
The Trender represents each variable with a trace. (The term trace is used since the
Trender works similarly to a digital storage oscilloscope, which displays data by
tracing a line across the screen as values are acquired.) As you add traces to a
Trender window, the new traces display in the Traces Tab. (Refer to the section,
Traces.)

GEH-6700C ToolboxST Chapter 7 Trender • 7-3


Live Trends
When a Trender window contains live trends, it displays the incoming data onscreen
in real time. Live trends are useful for monitoring systems in continuous operation.
To add one or more traces from a live source
1 If the Trender window you would like to add the trace to is not already open,
refer to the section, Accessing a Trender Window.
2 From the Edit menu, select Add Traces. (or click the Add Traces button on
the data toolbar). If there are already traces on the trender, the Variable Browser
for the current data source will display, which you can then use to select the
variables to monitor. If there are no traces on the trender, the Add Trace
wizard displays. If there are traces and you would like to add traces for a
different live data source, you may also invoke the Add Trace wizard by
clicking the drop-down list attached to the Add Traces button.
3 If this is the first trace added to the Trender window, the Add Trace wizard
prompts you for the type of trend to configure. Select Live, then click Next.
4 Select System Component, then click Next.
5 If you did not open the current Trender window from the ToolboxST
application, the Add Trace wizard prompts you for the name of the system file
that contains the source component. Click the Browse button to locate the
system file, then select Next.
6 Select the component from which you wish to trend variables, then click Next.
7 Select the sampling period you wish to use, then click Next. (The sample period
represents the time in milliseconds between samples, so larger numbers result in
fewer samples.) The Select Variables wizard page displays.
8 Click the Add button to display the Variable Browser, then select one or
more variables to monitor. When you are finished, click OK in the Variable
Browser, then click Finish in the wizard. The newly created traces display in
the Trace tab.

Capture Buffer Trends


Many components feature different methods of high-speed synchronous data capture.
While each method addresses different needs, all methods are accessed as capture
buffers in the Trender because they have similar underlying data collection
mechanisms.
To add one or more traces from a capture buffer
1 If the Trender window to contain the new trace is not already open, refer to the
section, Accessing a Trender Window.
2 From the Edit menu, select Add Traces. The Add Trace wizard displays.
3 If this is the first trace added to the Trender window, the Add Trace wizard
prompts you for the type of trend to configure. Select Capture Buffer /
Dynamic Data Recorder, and then click Next.
4 Select the component from which to trend variables, then click Next. A list of
all available capture buffers displays.
5 Select one capture buffer, and then click Finish. All of the variables from the
selected buffer convert into traces and the Trace tab is updated to reflect the
changes.

7-4 • Chapter 7 Trender GEH-6700C ToolboxST


Static File Trends
In addition to acquiring data from a component, the Trender can also display data
from a static file stored on a hard disk. Four formats: Data Collection and Analysis
(.dcaST), Comma Separated Value (.csv), COMTRADE, and GE Control System
Toolbox Trend (.trn) are currently supported as static file sources. While each of
these formats is unique, the procedure to add a trace is identical for all.
To add one or more traces from a static file
1 If the Trender window to contain the new trace is not already open, refer to the
section, Accessing a Trender Window.
2 From the Edit menu, select Add Traces. The Add Trace wizard displays.
3 If this is the first trace added to the Trender window, the Add Trace wizard
prompts you for the type of trend to configure. Select Static, and then click
Next.
4 Select the type of data source to import from and click Next to display an Open
dialog box.
5 Select the desired static file source, then click Open.
6 The Select Variables wizard page displays. Click the Add button to display
the Variable Browser. The ToolboxST application analyzes the selected file
and displays a list of available variables. Select one or more variables to convert
to traces. When you are finished, click OK in the Variable Browser, then
click Finish in the wizard. The newly created traces display on the Trace tab.

GEH-6700C ToolboxST Chapter 7 Trender • 7-5


Obtaining Data
As they depend on the presence of a controller, live and capture buffer traces do not
initially contain any data. (The data from static file traces is automatically imported
and displays as soon as the trace is added.) Once connected to the controller, the
procedure for obtaining data depends on the type of traces present. Data from live
traces is captured in much the same way that a video recorder operates (with record
and pause buttons), while data from a capture buffer is uploaded from the controller
in a single operation.
To connect to the controller

Select the Online button on the Trender toolbar. (If any of the source
controllers are redundant controllers, the Trender prompts you to select a
redundant channel before opening the connection.)
To begin capturing a trend from live traces

On the Data toolbar, select the Record Data button. The Trender
switches to Live mode, and the Graph View continuously scrolls the time axis
to display the latest incoming data while recording.
To freeze the display while capturing a trend from live traces

On the Data toolbar, select the Pause button. Data continues to be


collected but the Trender switches to Replay mode until the Pause button is
selected again.
To stop capturing a trend from live traces

On the Data toolbar, select the Record Data button. The Trender
returns to Replay mode.
To retrieve data from a capture buffer

On the Data toolbar, select the Upload button.

Trender Concepts
Chapters
When working with live, or capture buffer, or some historical sources, the Trender
can record more than one set of data. The basic unit of data capture in the Trender is
a chapter. A chapter represents one acquisition session, which is either a single
upload for a capture buffer source or a single period between clicks of the Record
Data button for a live source. Chapters are organized chronologically, so the first
acquisition session is always the first chapter and the most recent session is always
the last chapter.

A Trender window only displays one chapter of information at a time. Each chapter
maintains its own traces and events. The Events tab only displays events applicable
to the currently displayed data. Similarly, the user data field is unique to each
chapter, so comments about a data set are stored alongside each chapter.
To navigate between Chapters

Click the Previous Chapter or Next Chapter button on the Data


toolbar. (If these options are disabled, there are no other chapters available.)

7-6 • Chapter 7 Trender GEH-6700C ToolboxST


Cursors
In Replay Mode in the Graph View, two cursors individually select values of time
and together select ranges of time. The cursors are used by a number of functions in
the Trender, such as trace statistics, user events, and data export. The time
represented by each cursor is displayed in the status bar at the bottom of the Trender.

Cursor Active cursor

To select a range of time


1 Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired left boundary location.
2 Place the mouse pointer over the diamond at the top of the other cursor and drag
the diamond to the desired right boundary location.
To select a single time
1 Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired value.
2 If the diamond for the cursor that represents the time value you wish to select is
not colored white, click the diamond to select it as the active cursor.

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.

GEH-6700C ToolboxST Chapter 7 Trender • 7-7


Events
During real time monitoring of the controller, certain events may occur such as
alarms and diagnostics. As these events occur, they display in the Trender as a small
triangle on the time axis. All events in the current Chapter appear on the Events tab,
which displays the time and description of each event.

Event Indicator
To jump to an event
From the Event tab, double-click on the description of the desired event.
In addition to events added by the controller, you can add your own User Events. If
added during Live mode, the User Event is placed at the time of the most recently
received sample at the instant the Add User Event command is selected. During
Replay mode, new User Events are added at the time indicated by the active cursor.
(Refer to the section, Cursors.)
To add a user event
1 Select an active cursor.
2 From the Edit menu, select Add User Event. (Or, press the shortcut keys
CTRL+M.)
3 Enter a name for the new event, and select OK.

7-8 • Chapter 7 Trender GEH-6700C 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-6700C ToolboxST Chapter 7 Trender • 7-9


To enable or disable grid lines
1 From the Options menu, select Settings. The System Options dialog box
displays with Trender selected in the Tree View.
2 From the Property Editor, locate the category Grid Lines and set the values
for Horizontal and Vertical to either True or False.
3 Click OK to close the Settings dialog box.

Sample Markers
When exact values at each sample reading are important, the Trender can display
Sample Markers at each sample collection point. By default, Sample Markers display
when the current Graph View contains ten or fewer samples. If desired, you can
change the Sample Marker threshold.

To set the Sample Marker threshold


1 From the Options menu, select Settings. The System Options dialog box
displays with Trender selected in the Tree View.
2 In the Property Editor, under the category General, enter a new value for
Sample Markers.
3 Click OK to close the Settings dialog box.

7-10 • Chapter 7 Trender GEH-6700C 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 button on the Data toolbar.

GEH-6700C ToolboxST Chapter 7 Trender • 7-11


Manual Range Adjustment
When the Auto-Range Trace feature selects an inappropriate range, or if you want
precise control over the range, you can provide a minimum and maximum value for
the Value (vertical) Axis.
To manually adjust the range for a trace
From the Traces tab, select one or more traces, then adjust the Bottom Value
and Top Value properties under Range in the Property Editor.

Trace Colors
The Trender assigns each new trace a color from a set of eight colors stored in the
Settings window. After eight traces are created, these colors are reused. You may
wish to change the color of a trace, especially when multiple traces display on a
single graph.
To change the color assigned to a trace
1 From the Traces tab, select a trace.
2 In the Property Editor, locate the Pen category and select the Color
property.
3 Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
4 Click the square that corresponds to the desired trace color. The trace updates
automatically.
To modify the default trace colors
1 From the Options menu, select Settings.
2 Locate and select the Trender item in the Settings window.
3 In the Property Editor, select the number of the trace (for example, 2nd Trace)
to be changed.
4 Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
5 Click the square that corresponds to the desired trace color.
6 When you have finished changing trace colors, click OK.

Hiding Traces
In some situations, especially with capture buffers, a Trender window contains more
traces than you want to monitor at a particular time. Traces in a Trender window can
be hidden. They still collect data, but they do not display in the Graph View or the
Trace tab.
To hide traces
1 From the Traces tab, select one or more traces.
2 From the Edit menu, select Hide Selected Traces, or right-click on the
selected traces and select Hide Selected from the context menu.
To show or hide a trace
From the Edit menu, select Show Traces. Select and clear the check boxes
next to the trace names as desired, then click OK.

7-12 • Chapter 7 Trender GEH-6700C ToolboxST


Statistical Calculations
The Trender can calculate a set of basic one variable descriptive statistics for
collected data while in the Replay mode. These statistics, which are calculated only
on data in the time range selected by the two cursors, include average, standard
deviation, minimum, maximum, and difference (calculated as final – initial). The
calculated values display as columns on the Trend tab when enabled.

To display statistical calculations


1 From the Options menu, select Settings.
2 Locate and expand the Trender item in the Settings window. Under the
Trender item, select Replay Columns.
3 In the Available list, select one or more columns to enable. (To make multiple
selections, hold down the CTRL key while selecting additional items.)

4 Click the Add button to move the statistics to the Selected list.
5 When you have finished enabling statistics, select OK.

Exchanging Trender Data


Exporting to a File
The Trender can export all traces contained in a Trender window to a file for external
analysis. This file can be imported into third party applications or exchanged with
other users. All traces, including ones, which are currently hidden, are exported.
To export all traces to a file
1 From the File menu, select Export Data.
2 In the Trender Export Data Options box, adjust options as desired to
produce a file compatible with your desired format. The default options produce
a standard .csv file. (See below for a description of each option.)
3 Select OK when you have finished selecting options. A Save dialog box
displays.

GEH-6700C ToolboxST Chapter 7 Trender • 7-13


4 Select a location for the exported file and click OK.

Controls whether the first line of Controls the character


the exported file contains header used to separate values
information for each column. in the exported file.

Controls whether a
column containing Controls the text
timestamps is added exported when no
to the output. data is available
for a trace at a
given point in time.
Controls whether a
column containing
increasing integers is
added to the output. Selects the precision
of the exported
timestamp.
If selected, only the
time range selected
by the cursors is
exported.

Printing Graphs
The Trender can print the currently displayed graph to any printer attached to the
system. Printed graphs reflect the current appearance of the Graph View, including
displayed traces, colors, and axis boundaries.
To preview the results of a print command
From the File menu, select Print Preview.
To print the current Graph View
From the File menu, select Print. Adjust printing options as desired and click
OK.

7-14 • Chapter 7 Trender GEH-6700C ToolboxST


CHAPTER 8

Chapter 8 EGD Editor for External


Devices
®
The EGD Component Editor for external devices allows you to configure Ethernet
Global Data (EGD) for an external or third-party device. The EGD protocol allows
controller components (sometimes known as nodes) to share information in a
networked environment. EGD allows one controller device, referred to as the
producer of the data, to simultaneously send information to any number of peer
controller devices (consumers) at a fixed periodic rate. This network supports a large
number of controller devices capable of both producing and consuming.

Network Adapters
The General tab configures Ethernet adapters for an external EGD-capable device.
One adapter is created by default, and up to four adapters can be added.
To add a network adapter
1 From the System Editor, right-click an external device, then select Edit EGD.
(If Edit EGD is not available, the EGD Editor Enable property of the
component may be set to False. The EGD Component Editor opens.)
2 From the Component Editor, select the General tab.
3 From the Tree View, right-click the Network Adapters item, then select
Add Adapter.
To remove a network adapter
1 From the System Editor, right-click an external device, then select Edit EGD.
(If Edit EGD is not available, the EGD Editor Enable property of the
component may be set to False. The EGD Component Editor opens.)
2 From the Component Editor, select the General tab.
3 From the Tree View, right-click the network adapter to be removed, then select
Delete Adapter.

GEH-6700C ToolboxST Chapter 8 EGD Editor for External Devices • 8-1


The following properties are available for configuration when a Network Adapter is
selected in the Tree View:

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

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

Wire Speed is the speed of the connected network.

Network Name is the name of the connected network.

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

EGD Configuration
To configure EGD for an external device
1 From the System Editor, right-click an external device component and select
Edit EGD. (If Edit EGD is not available, the EGD Editor Enable property of the
component may be set to False. The EGD Component Editor opens.)
2 From the Component Editor, select the EGD tab.
3 In the Tree View, select Ethernet Global Data. The Ethernet Global Data
properties display in the Property Editor.

In the Tree View, select


Ethernet Global Data.

8-2 • Chapter 8 EGD Editor for External Devices GEH-6700C ToolboxST


These properties are available for configuration when Ethernet Global Data is
selected in the Tree View:

Collection controls the Collection to which this EGD component belongs when
viewed in the EMT tool. This information is published to the EGD Configuration
server in the GUI component document, GUIDevice.xml.

Producer ID sets and displays the EGD Producer ID for this component. This is
assigned when the component is created. The Property Editor displays the EGD
Producer ID formatted as an unsigned integer, but dotted and hexadecimal
representations are available by clicking the ellipsis button.

Produced Pages
Produced Pages are data sets configured to be available to other components on the
network.
To add a new Produced Page
1 From the Tree View, right-click the Produced Pages item, then select Add
Page.
2 Enter a unique name for the new page in the Page Name dialog box, then click
OK.
To delete a Produced Page
From the Tree View, right-click the page you wish to delete, then select
Delete.

GEH-6700C ToolboxST Chapter 8 EGD Editor for External Devices • 8-3


Editing Produced Pages
To configure a Produced Page
From the Tree View, select the EGD tab, then expand the Produced Pages.

Under Produced
Pages, select the
desired page.

The page
properties display
in the Property Editor.

The following properties are available for configuration when a Produced Page is
selected in the Tree View:

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

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


supported by the device's EGD implementation profile.

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


after selecting the Build command.

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

Name uses this property to rename the selected page.

Period indicates the transmission period of the page in milliseconds.

Skew is used to prevent exchanges with the same period from being produced at
exactly the same instant. The skew for the first exchange in the page is set to this
value, and each additional exchange skew differs from the previous exchange’s skew
by exactly this value. For example, if you have three exchanges in a page and a skew
value of 2, the first exchange’s skew is two, the second exchange’s skew is four and
the third exchange’s skew is six.

8-4 • Chapter 8 EGD Editor for External Devices GEH-6700C ToolboxST


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

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

Page Compression
When a page compression is performed, the variables are located in increasing size
order, starting with Booleans, then Words, Double Words, and finally all other
variables.
To compress a single page
From the Tree View, right-click the page to compress, and then select
Compress.

To compress all Produced Pages in a component


From the Tree View, right-click Produced Pages, and then select
Compress All.

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.

GEH-6700C ToolboxST Chapter 8 EGD Editor for External Devices • 8-5


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


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

3 Review the warning about manual Exchange Signature editing, then click
OK.

8-6 • Chapter 8 EGD Editor for External Devices GEH-6700C ToolboxST


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

Referenced Devices
The EGD variables defined in other components can be added to the current
component’s variable list by adding a reference. References can only be created to
EGD-capable devices that are consumers of Produced Pages, and as such only EGD-
capable devices are available for referencing.
To select referenced devices
From the Tree View, right-click the Referenced Devices item, and then
select Select Devices to display the Select Devices dialog box.

Select or clear the


check boxes next to
each component
name. Click OK.

The EGD configuration for the selected devices is loaded and the variables display in
the Summary View.

When EGD configurations are edited in remote devices, you must refresh the
configuration periodically to ensure that the latest variable information is used. This
is automatically done during a Bind and Build operation as well as when a
configuration is saved.
To refresh the configuration of a referenced device
In the Tree View, right-click the device to be refreshed, and then select
Refresh.

GEH-6700C ToolboxST Chapter 8 EGD Editor for External Devices • 8-7


Implementation Profile
Each EGD node type has a set of supported EGD features. For example, a device
might have an EGD implementation that only supports broadcast-produced data. The
implementation profile contains details about the EGD implementation of a
particular device.

The following properties are available when editing an Implementation Profile:

Configuration Support configures the operations supported by the device.

Accepts Deletes indicates device support for HTTP deletes.

Multiple Producer IDs indicates device support for multiple producer IDs.

Accepts Puts indicates device support for HTTP Put commands.

Zip Content indicates device support for zipped transfers.

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

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

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

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

8-8 • Chapter 8 EGD Editor for External Devices GEH-6700C ToolboxST


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

Max Coherent Data returns the maximum size in bytes of a variable that still is
guaranteed coherent transfer. If the attribute is not present then all data is guaranteed
coherent transfer regardless of size. It is optional and is initialized to 0.

Max Exchanges returns the maximum number of exchanges supported by the


device. It is optional and is initialized to 0.

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

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

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

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

Device Class is defined in the EGD Protocol Specification:


Class Description
0 Supports only the configuration port.
1 Supports the data port and the Data Production PDU.
2 Supports all class 1 services plus at least acts as a responder for the command port and
the commands associated with that port.
3 Supports all class 2 services plus the configuration port and the required commands
associated with that port. Such devices support responding to configuration requests but
do not dynamically bind their consumed variables.
4 Supports all class 3 services plus dynamically binding consumed variables.

Device Class Name is name of the class of device to which this device belongs.

GEH-6700C ToolboxST Chapter 8 EGD Editor for External Devices • 8-9


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.

8-10 • Chapter 8 EGD Editor for External Devices GEH-6700C ToolboxST


EGD Diagnostics
A CMP can be used to obtain the status of a Class 2 or higher EGD device. When
any EGD tree node other than a Referenced Device is selected, the EGD Statistics
from [Device] tab displays the statistics from the open component. When a
Referenced Device tree node is selected, statistics are obtained from that referenced
device, and the name of the tab page changes accordingly.

Exchange is the Exchange identifier: <device name>.<exchange number>

Configuration Time is the time that the exchange was configured.

Due Time is the time that a consumer data packet must be received for an exchange
to remain valid.

Status is the health of the exchange

Length is the value for a produced exchange. This length may be the highest
variable offset in the exchange or the highest offset of a variable, which may have
been removed. For a consumed exchange, the value may be the highest variable
offset used or the length of the produced exchange, depending on the bind algorithm
of the individual tool.

Message Count is the number of data production packets produced or consumed


since initialization

Missed Count is the number of data production packets missed since initialization.
A missed packet occurs when a data production message is received that has a
request ID greater by more than one than the last message received (accounting for
counter roll-over).

GEH-6700C ToolboxST Chapter 8 EGD Editor for External Devices • 8-11


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 allows you to view and delete EGD nodes
currently residing in the configuration server. The configuration server used is the
one defined in the System Editor under the root tree node. If the server is enabled,
this tab displays information from that server.

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

G1
G2

EGD Configuration Server Contents Sample

8-12 • Chapter 8 EGD Editor for External Devices GEH-6700C ToolboxST


The tab control contains a toolbar with two buttons:

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

The Delete button deletes the selected node or nodes. If the nodes were saved
as part of the configuration, they can be added again.

The EGD configuration server uses the producer ID to store all the documents for an
EGD node. If you open two systems, then point to the same configuration server and
save a device of the same name with two different producer IDs to that server, you
can end up with two producer ID nodes with the same device name.

Menus
File Menu
Save updates the EGD configuration files, refreshes consumed exchanges
and variables, assigns produced variables to exchanges, and, if an EGD
configuration server has been specified, publishes the configuration to the
server.
Import and Export allows you to transfer produced data, consumed data,
symbols, implementation profiles, and GUI device EGD configuration files to
and from a variety of file formats.
Print outputs the summary grid view with the column selection, order, and
width currently visible in the view.
Close closes the currently open device.

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

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

GEH-6700C ToolboxST Chapter 8 EGD Editor for External Devices • 8-13


Device Menu
Bind and Build refreshes the consumed information for all referenced devices,
automatically sets the layout of any unassigned produced variables, and, if no
errors occur, publishes the configuration to the EGD configuration server.
Put Device to SDB command stores the current EGD configuration to the
System Database (SDB). It is only available if the system has an SDB enabled and
configured.
Online sends CMP messages to EGD Class 2 or higher devices to view live
values from the device.

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

8-14 • Chapter 8 EGD Editor for External Devices GEH-6700C ToolboxST


CHAPTER 9

Chapter 9 Configuration
Management System (CMS)

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

• Create, backup, and restore repositories


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

Accessing the CMS Administrator Tool


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

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

To logon to the CMS server


Enter your name and password, then click OK.

Enter a valid user name


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

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-1


The CMS Administrator window displays the selection window shown below.

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

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

9-2 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

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

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-3


Select an existing repository and click Open.

Main menu

User List

Permissions

Repository Menu

Select displays the Select a Repository dialog box.

Create allows a repository to be created.

Delete displays the Delete a Repository dialog box.

Backup allows a repository to be backed up.

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

The user who creates the repository becomes the default administrator.

9-4 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

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

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-5


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

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

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

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

9-6 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

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


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

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

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-7


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

Users Menu

Add displays the Add User dialog box.

Delete allows a user to be deleted.

Edit allows user permissions to be changed.

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

2 Enter the User ID.


3 Select the User can modify systems check box, then click OK.

9-8 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

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

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

3 Click Yes to delete the user.

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

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-9


The following permissions are available:

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


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

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

Click the Start


Server button.

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

Stopping the Server


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

Click the Stop Server


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

Note Stopping the server will disable all repository operations.

9-10 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

2 Select the appropriate user type, then click OK.

If there are any existing repositories with current user types, use this dialog box to
back up all existing repositories in the CMS server.

The list of repositories


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

Specify the backup


location using the
Browse button.

Click OK to back up
the repositories.

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-11


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

CMS Client Interface


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

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

A LogIn window displays:

9-12 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

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

The System View


displays the repository
as an item that contains
systems.

The Device View


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

The Log View displays


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

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-13


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

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

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

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

Setting Working Folder


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

9-14 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

Clearing Status Window


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

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

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

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-15


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

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

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

Click Yes to revert back to the previous version.

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

9-16 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


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

This column displays


the version number of
the system or device.

This column displays


the login name of the
user who made the
change.

This column displays


when the change was
made.

This column displays a


comment entered when the
system or device was
checked in.

GEH-6700C ToolboxST Chapter 9 Configuration Management System (CMS) • 9-17


Notes

9-18 • Chapter 9 Configuration Management System (CMS) GEH-6700C ToolboxST


CHAPTER 10

Chapter 10 Tree File Importer

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.
2 From ToolboxST, 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.)
3 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.
4 From ToolboxST, open the controller and add a reference to the libraries that
were imported in Step 3.
5 Exit ToolboxST 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.

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 ToolboxST, ToolboxST, and
then Tree File Importer to display the Tree File Importer wizard.

GEH-6700C ToolboxST Chapter 10 Tree File Importer • 10-1


2 Click the Browse button. From the Select Workplace window, locate and
select the system .tcw file you created in Step 1, then click Open. Click Next to
continue to Page 2. The ToolboxST application opens the system selected in
Step 1 and displays a list of available controller and library container
components.

3 Select a component to receive the imported configuration, then click Next to


continue to Page 3.

10-2 • Chapter 10 Tree File Importer GEH-6700C ToolboxST


4 Click the Browse button. From the Select Project or Tree File window,
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.

By default, only .prj files


are displayed. Click here
and select Tree Files from
the drop-down list to display
.tre files.
5 Unless you are certain another setting applies, select Straight variable name
conversion, then click OK. The Application Code Conversion Type
dialog box displays.

GEH-6700C ToolboxST Chapter 10 Tree File Importer • 10-3


When the import process is completed, Page 4 of the Tree File Importer 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.

6 After reviewing the log, click Finish to save the updated system and complete the
wizard.

10-4 • Chapter 10 Tree File Importer GEH-6700C ToolboxST


CHAPTER 11

Chapter 11 Reference

Menus
File Menu
Save saves changes to the current component.
Print creates a paper copy of the entire component configuration.
Compare Devices…opens the Pick Items to Compare dialog box.

Upgrade changes the version of the component support software.

Import I/O Report imports an I/O report from a .csv file.


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

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

Cut moves the currently selected item to the clipboard.

Copy places the currently selected item on the clipboard.

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

Delete removes the currently selected item.

Find opens the Finder tool.

Select All selects all available items.


Insert opens the Insert Block dialog box while in the Block Diagram Editor.
Bookmarks provides a mechanism to mark important locations in the
configuration.

GEH-6700C ToolboxST Chapter 11 Reference • 11-1


View Menu
Go Back returns to the view that immediately preceded the current view in the
history.
Go Forward returns to the view that immediately follows the current view in
the history.
Forced Variables opens the Forced Variables dialog box.
Global Variables opens the Global Variables dialog box.
Trenders displays a list of Trender windows associated with the component.
Watch Windows displays a list of Watch Windows associated with the
component.
Reports
Variable creates a report of all global or configuration variables in the
controller.
Block Pin creates a report of all block pins in the controller software.
I/O creates a report of all hardware input and output points.
Alarm creates a report of all variables marked as alarms.
Hold creates a report of all variables marked as hold variables.
Event creates a report of all variables marked as events.
NovRAM creates a report of all variables marked as non-volatile.
IONet EGD provides network communication status values of all IONet
communication displayed in the currently configured controller.
I/O Diagnostics creates a report of all faults, revisions, communications
issues, and hardware issues.
Control Constants opens the Control Constants dialog box.
Diagnostics allows you to view controller diagnostics, Controller advanced
diagnostics, or I/O diagnostics.
EGD Management Tool… opens the EGD Management Tool.
I/O CheckOut opens the IO CheckOut window.
Disagreements allows you to display state exchange voting and output
disagreements for the dual and TMR controllers.

Device Menu
Online connects to or disconnects from a controller.

Build converts the current configuration into binary files that can be
downloaded to a controller.
Download
Controller Initial Setup opens a wizard that performs basic
configuration tasks on the controller.
Controller Flash Boot Loader installs the controller bootloader onto
a CompactFlash card connected to your computer.
Download Wizard downloads base load, firmware and application
code to the controller and Distributed I/O modules.
Update Dynamic Data Recorder allows you to update the DDR.
Update Dynamic Data Recorder exchanges updated information
with the DDRs in the controller.

11-2 • Chapter 11 Reference GEH-6700C ToolboxST


View/Set Time displays a dialog box that controls the controller time.
Upload retrieves configuration information from the controller and uses it to
create a new controller component in the system.
Put Device to SDB stores the component configuration to a System
Database (SDB).
Compress Variables rearranges variables to minimize the amount of space
used.
Administer Totalizers opens the View/Set Totalizers dialog box.
Lock switches the controller into locked mode.
Unlock switches the controller into unlocked mode.
Brand returns the current CRC of the application code files in the
controllers.This is used to verify if the application code loaded into the
controllers and I/O packs is a previously certified version.

Options Menu
Settings displays a dialog box with controller settings.

Help Menu
Release Notes
The ToolboxST application displays up-to-date information about your version.
Mark VIe displays up-to-date information about your version of the Mark VIe support
software.
About displays version and copyright information.

GEH-6700C ToolboxST Chapter 11 Reference • 11-3


Notes

11-4 • Chapter 11 Reference GEH-6700C 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-6700C ToolboxST Glossary of Terms • G-1


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.

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.

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.

G-2 • Glossary of Terms GEH-6700C ToolboxST


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.

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.

GEH-6700C ToolboxST Glossary of Terms • G-3


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.

runtime
See product code.

ToolboxST
A Windows-based software package used to configure controllers.

trend
A time-based plot to show the history of values.

Trender
A subsystem of the ToolboxST application that monitors and graphs signal values
from a controller.

validate
Makes certain that items or devices do not contain errors and verifies that the
configuration is ready to be built into pcode.

variable
The basic unit for variable information. Variables are the placeholders for memory
locations in the toolbox’s different platforms.

word
A unit of information composed of characters, bits, or bytes. It is treated as an entity,
and can be stored in one location. Also, a measurement of memory length, usually 32
bits in length, but can also be 4, 8, or 16 bits long.

G-4 • Glossary of Terms GEH-6700C ToolboxST


Index
attribute value 4-14
A block diagram 3-24
acronyms and abbreviations 1-10 library container 3-8
alarm classes 2-10 rung 3-37
application system information 2-10
documentation 3-40 EGD configuration server reports 4-88
software examples 3-40 Ethernet 4-78, 4-91, 11-6
auto calibrate 4-23 Ethernet Global Data Configuration server
configuring an external EGD device 2-19
C viewing differences 2-18
Ethernet Global Data tab
command
editing Produced Pages 4-80
download 5-5
EGD configuration 4-79
command line arguments 1-5
page compression 4-81
Component Infoview 4-3
produced pages 4-79
components
referenced devices 4-88
grouping 2-4
example setup of DDR 4-74
moving and copying 2-4
configuration F
labeling 9-16
modifying 9-16 File menu
Configuration Management System adding 9-14
administrator tool 9-1 connecting 9-14
client interface 9-12 deleting 9-14
Tools menu 9-10 setting 9-14
User menu 9-8 find methods 6-2
configuring 4-91 forced variables 4-102
Dynamic Data Recorder 4-69 format specifications 2-12
HART I/O device 4-24 function blocks 3-2
Modbus Slave 4-91
G
D General tab 4-11
data grids global variables 4-103
copying 4-10 grid lines 7-9
editing 4-8
H
organizing 4-9
diagnostic views Hardware tab 4-16
controller 5-11 HMI resources 2-14
I/O 5-12
download command 5-5 I
Dynamic Data Recorder tab I/O diagnostic
configuring 4-69, 4-73 report 4-52
updating 4-73 viewer 4-51
implementation profile 8-8
E
installation 1-2
editor
L
library container editor
property editor 3-14
licensing 1-9

GEH-6700C ToolboxST Index • I-1


M S
Measurement systems 2-14 security
Menus passwords 4-4
Device 8-14, 11-2 Viewing Protection Status 4-6
Edit 2-8, 8-13, 11-1 Software tab
File 2-8, 8-13, 9-14 programs item 4-52
Help 2-9, 8-14, 11-3 table definitions 4-57
Options 2-9, 11-3 variable editors 4-66
View 2-9, 8-13, 9-15, 11-2 Source menu
Modbus Slave register pages 4-93 labeling 9-16
Modbus Slave tab modifying 9-16
configuring 4-91 retrieving 9-15
mode special modules 4-22
layout 3-25 Status tab 4-44, 5-2
modifying totalizer values 5-16 summary view 4-2
modules system database 2-15
adding 4-18 system editor
diagnosing 4-49 components 2-3
modifying 4-22 configuration files 2-6
organizing 4-21 opening and creating systems 2-1
reporting 4-45 saving systems 2-5
special 4-22 system information editor
upgrading 4-47 alarm classes 2-10
viewing 4-41 format specifications 2-12
HMI resources 2-14
N measurement systems 2-14
network System Requirements 1-1
adapters 4-15
T
redundancy 4-17
tab
P diagnostics 4-43
page compression 4-81 Dynamic Data Recoder 4-69
Parameters tab 4-42 EGD configuration server 4-87
passwords 4-4 Ethernet Global Data 4-78
pins General 4-11
connecting 3-29 Hardware 4-16
wiring block 3-27 Modbus Slave 4-90
produced pages 4-79, 8-3 Software 4-52
PROFIBUS 4-25 Summary 3-23, 4-42
property editor 4-2 variables 4-43
protected objects 4-7 time axis 7-11
additional 4-91 Tools menu
serial 4-91 adjusting 9-11
starting 9-10
R stopping 9-10
Totalizers
reports
administer 5-12
creating 4-96
passwords 5-14
saving, retrieving and printing 4-97
Tree File Importer
viewing 4-97
running the tree file importer 10-1
Repository menu
backing up 9-7
deleting 9-6
restoring 9-7
selecting 9-5
running the tree file importer 10-1

I-2 • Index GEH-6700C ToolboxST


Trender
adding traces 7-3
capture buffer trends 7-4
concepts 7-6
cursors 7-7
events 7-8
exporting to a file 7-13
hiding traces 7-12
live trends 7-4
obtaining data 7-6
printing graphs 7-14
trace colors 7-12
Trender concepts 7-6
Trender window features
data toolbar 7-3
Trender toolbar 7-3
U
UPD
installing 1-9
reinstalling 1-9
user block
definitions 3-6
libraries 3-3
user block definition
adding 3-18
sorting 3-18
users menu
adding 9-8
deleting 9-9
editing 9-9
V
variable editors 4-66
variables
adding 4-72
forced 4-102
global 4-103
status 4-71
View menu
clearing status window 9-15
refreshing system view 9-15
W
wizard
download 5-7
upload 5-9

GEH-6700C ToolboxST Index • I-3


Notes

I-$ • Index GEH-6700C ToolboxST


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

1 540 387 7000


www.geenergy.com

GEH-6700C
Revised 060920
Issued 040120

You might also like