Geh 6703 PDF

GEH-6703P
ToolboxST* User Guide

for Mark* Controls Platform
Aug 2019
Public Information
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.
Public Information – This document contains non-sensitive information approved for public disclosure.
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.
For further assistance or technical information, contact the nearest GE Sales or Service Office, or an authorized GE Sales
Representative.
Revised: Aug 2019

Issued: June 2014
© 2014 - 2019 General Electric Company.

___________________________________
* Indicates a trademark of General Electric Company and/or its subsidiaries.
All other trademarks are the property of their respective owners.
We would appreciate your feedback about our documentation.

Please send comments or suggestions to controls.doc@ge.com
Public Information
Document Updates
Rev Location Description
Shared IONet Group Updates for enhancements to the Shared IONet feature
Mark VIe, Mark VIeS Diagnostics View Updates to provide the procedure to view Advanced Diagnostics
PCNO I/O Module Configuration Updates to include support for Woodward GS40 and GS50 fuel valves
P
Mark VIe FOUNDATION Fieldbus Interface Linking Removed Attention statement that PFFAs are not capable of online
Devices interaction while the controller is not in the Inputs Enabled or Controlling
Download state. This is no longer applicable as the issue has been resolved.
Control Server Set Templates
New sections
Network Switch Layouts
System Reports Updated to include new Component Versions report
System Component Password Change Updated Attention text for clarification
Updated the following procedures and sections for clarification and
consistency:
• To set up a UCSB / UCSC controller
Mark VIe, Mark VIeS — Working Online
• To set up a UCCA / UCCC / UCSA controller
• To set up a UCCC controller
• Controller Password Change (Attention text only)
N
Updated the Data Grid Variable Properties table as follows:
• Indicated property only applies to libraries: Visibility, Description
• Indicated property only applies to libraries: Inherit Description of
Mark VIe, Mark VIeS Component Editor Program Connected Variable, Usage
Variables • Moved property to Format category: Override Entry Limits, Allow Entry
Limits Override
• Added properties: Keep During Instance, Override Properties, Override
Value, Primary Language, Secondary Language, Is Critical
Mark VIeS Component Menus Added new View menu option PFD Calc to the table
Mark VIeS Safety Controller Operations Updated to describe Branding feature and Locked and Unlocked mode
GEH-6703P User Guide 3

Public Information
Installation Added the table ControlST Installation Options
System Controller Platforms Changed title from System Controller Device Types
Updated to include Rationalization feature for users to provide additional
Diagnostic Translations and Rationalization alarm rationalization information for diagnostic alarms using the ToolboxST
System Information editor
Mark VIe Component Editor Component Menus Updated the Profiler property name to Controller Load Profiler
Added two password protected functions to the table:
Mark VIe Component Editor, Software Tab
• Change Library References
Password Protection
• Change Execution Groups
Mark VIe Component Editor, Software Tab
New section describing multi-core controller Execution Groups
Execution Groups
Mark VIe — Working Online
New section describing the Frame Timeline Profiler
Frame Timeline Profiler
Updated the number of counters from a set of 64 to a set of 64 or 128
Mark VIe — Working Online Totalizers
counters (depending on the controller platform)
Updates include adding Port Status Time Interval property and new sections,
Mark VIe Component Editor
EtherCAT Master Status Variables, EtherCAT Slave Status Variables, and
EtherCAT Tab
EtherCAT Port Disconnect
Mark VIe — Working Online Initial Download to I/O
Added this section (moved from GEH-6721_Vol_II)
Modules
HMI Screens
Define HMI Screen Use Removed the ability to manage HMI screens from each HMI WorkstationST
M
WorkstationST Component Editor Global Component Editor; this is only done from the System Information Editor
Parameters
Added the following properties to the Logging section in the Data Grid
Variable Properties table:
Mark VIe Component Editor Program Variables
• CEL Command Filter
• Data Class
Mark VIe, Mark VIeS Reports Global Variable Added the CEL Command Filter column to the Global Variable Report
Report Columns table
Mark VIe, Mark VIeS Reports Variable Added the CEL Command Filter column to the Variable Configuration Report
Configuration Report Columns table
Mark VIe, Mark VIeS Reports Importable Report Added the CEL Command Filter column to the Global Variable Report table
Data Removed unnecessary ID column from all tables
Updated the following properties in the General Tab Configuration Properties
table
Mark VIe General Tab Configuration Properties • Added Compressed Data Log Protection Settings property to
Compressed Data Log properties
• Added Maintain Component option to the Protection property
Mark VIe Reports Compressed Data Log Report Added Data Class column to the Compressed Data Log Columns table
Updated the DDR Properties table:
• Added the Protection property
Mark VIe Configure DDR
• Updated the Enable property to explain that it must be toggled False
and then True again to re-enable the next capture
4 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

Public Information
New section with information on ToolboxST log files, including History Log,
ToolboxST Log Files
Component Log, Build Log, and Change Log files
Mark VIe General Tab
New Custom Files properties added to the table
Configuration Properties
Removed Note that UCSC does not support controller interoperability; UCSC
System Controller Device Types
does support controller interoperability beginning with ControlST V07.04
L Correction made to the procedure To set the range of unusable node
Commission Fieldbus Devices
addresses to zero, steps 1 through 3.
New section describes the Mark VIe controller interoperability feature, which
Mark VIe Controller Interoperability allows users to replace controllers with supported interoperable controllers in
a redundant set
WorkstationST Component Editor, New section describing the Workstation Features Configuration report, which
Workstation Features Configuration Report displays features configured in each WorkstationST component
Updated the table with support for Windows Server 2016 (Standard Edition)
Computer Recommendations
as both a Recommended and Supported operating system
Mark VIe Component Editor,
Added instructions to configure EtherCAT
EtherCAT Tab
Mark VIe Reports
Replaced the figure Device / Group I/O Revision Report Example
I/O Diagnostics (Module) Revision Report
K
Mark VIe FOUNDATION Fieldbus Interface,
Added this section to describe the Compatibility Revision feature
Configuration, Compatibility Revision
WorkstationST Component Editor, Replaced the figure showing how to Add Collection in the procedure
Recorder Tab To add a collection
WorkstationST Component Editor, New section to provide details for the Recorder Maintenance Log collection
Recorder Tab, Maintenance Log type
Added Attention statement that users application may not be licensed to
J Application Overview
access full system capability and I/O types described in this document
Updated the table with support for Windows 7 Ultimate or Professional as
Computer Recommendations both a Recommended and Supported operating system
Added an Attention for ToolboxST Windows 10 Display Issues
Updated the figure ControlST Installation Options to include the ControlST
Installation Supplement Package installation option, which installs Mark VIeS Safety
Controller V05.03, as well as the associated Distributed Safety I/O packs.
Updated the figure System Settings Window to remove the Display Variable
System Settings Aliases instead of Variable Names setting, which has been moved to the
WorkstationST Preferences menu
Moved the Display Variable Aliases instead of Variable Names setting to the
Variable Names and Aliases WorkstationST Preferences menu, and added the figure WorkstationST
H
Preferences Menu
Updated the description for Enable Alias Prefix in the table General Tab
Mark VIe, Mark VIeS, WorkstationST General Tab
Properties
Added two properties to the WorkstationST General Properties table
WorkstationST General Tab • Crash Dump Location
• Number of Crash Dumps to Retain
Removed the Display Variable Aliases instead of Variable Names setting
from the Alias description and refer to the section Variable Names and
Mark VIe and Mark VIeS Program Variables Aliases
Added the available visibility option descriptions in the table Data Grid
Variable Properties

Public Information
Users and Roles Added procedure to define users and roles in ToolboxST
Added the diagnostic alarm message that displays in the Status tab when the
System Component Password Change
factory default controller password has not been changed
Added the diagnostic alarm message that displays in the Status tab when the
Mark VIe and Mark VIeS Controller Password factory default controller password has not been changed
Change Added the procedure to synchronize controller passwords when a controller
in a redundant set is replaced
Added FOUNDATION Fieldbus Alarm Confirm Time property to the Settings
Properties table and updated the Controller Settings Window figure, which
Controller Settings
was removed from the PFFA Hardware tab Property Editor and moved to
Controller Settings.
Updated the screenshot of the Property Editor and the Fieldbus Device
Properties table in the procedure To instance a fieldbus device placeholder
Instance (Add) a Fieldbus Device Placeholder
to remove the FOUNDATION Fieldbus Alarm Confirm Time property from the
PFFA Hardware tab Property Editor and moved it to Controller Settings
Updated the screenshots showing the Property Editor in the procedure To
Fieldbus Device Alerts enable H1 device alerts and To add alerts to a FOUNDATION fieldbus task to
remove the FOUNDATION Fieldbus Alarm Confirm Time property
Download Fieldbus Devices Added a reference to the section Controller Settings
Added UCSC to Mark VIeS Safety Control list of supported controller device
H System Controller Device Types
types
Control Constants Import and Export Updated this section with newer formatting
Mark VIe, Mark VIeS, and WorkstationST,
Restructured this section for each product for consistency
Download to Controller
Added an Attention note to notify users using PPRF and PCSA in a dual
network configuration requires an offline load if the output map changes, as
Mark VIe Download to Controller
well as instructions to not add or remove Mark VI VME boards during an
online download
Added this section to provide a reference to the instructions to restore the
UCSC for the Mark VIeS Safety control provided in the Mark VIe and Mark
Mark VIeS UCSC Restore
VIes Control Systems Volume II: General-purpose Applications System
Manual (GEH-6721_Vol_II), the section UCSC Restore
Added a Note to inform users that new UCSCs shipped from the factory do
not include the software that supports communication from the PHY PRES
Mark VIe and Mark VIe UCSC Restore
button to the EFA. Users must download to the controller at least once to
enable this functionality.
Mark VIe and Mark VIeS Advanced I/O Functions, Added this section to provide details for Universal I/O Shared IONet
Universal I/O Shared IONet Configuration configuration
Added this section with the procedure to configure a Modbus Slave for the
Mark VIeS Modbus Slave Tab
Mark VIeS Safety controller

Public Information
Related Documents
Document Title Document #
Mark VIe and Mark VIeS Control Systems Volume I: System Guide GEH-6721_Vol_I
Mark VIe and Mark VIeS Control Systems Volume II: System Guide for General-purpose
GEH-6721_Vol_II
Applications
WorkstationST GSM 3.0 User Guide GEH-6757
WorkstationST Application Mark V Feature System Guide GEH-6759
Mark Controllers Shared IONet User Guide GEH-6812
WorkstationST Alarm Viewer Instruction Guide GEI-100620
WorkstationST OPC DA Server Installation Guide GEI-100621
WorkstationST OPC AE Server Instruction Guide GEI-100624
WorkstationST Alarm Server Instruction Guide GEI-100626
WorkstationST Recorder User Guide GEI-100627
WorkstationST Historian Instruction Guide GEI-100628
WorkstationST HMI Configuration User Guide GEI-100629
WorkstationST Web View Instruction Guide GEI-100661
Mark VIe Controller Standard Block Library Instruction Guide GEI-100682
WorkstationST Network Monitor Instruction Guide GEI-100693
WorkstationST Modbus Feature Instruction Guide GEI-100696
WorkstationST / CIMPLICITY Advanced Viewer Integration GEI-100697
WorkstationST Device Manager Gateway Instruction Guide GEI-100757
Trender Instruction Guide GEI-100795
WorkstationST Control System Health Instruction Guide GEI-100834
User Guide GEH-6703P 7

Public Information
Acronyms and Abbreviations
CA Certificate Authority
CDH Control Data Highway
CMS Configuration Management System
CRC Cycle Redundancy Check
CSP Control Sequence Program (application code)
DDR Dynamic Data Recorder
EGD Ethernet Global Data

EU Engineering Units
HMI Human-machine Interface

LDB Least Significant Bit
MSB Most Significant Bit
NVRAM Non-volatile Random Access Memory
NTP Network Time Protocol

PDH Plant Data Highway
SDI System Data Interface
SFC Sequential Function Chart
SOE Sequence of Events
TMR Triple Modular Redundant
UDH Unit Data Highway
XML eXtensible Markup Language

Public Information
Safety Symbol Legend
Indicates a procedure or condition that, if not strictly observed, could result in

personal injury or death.
Warning
Indicates a procedure or condition that, if not strictly observed, could result in damage
to or destruction of equipment.
Caution
Indicates a procedure or condition that should be strictly followed to improve these

applications.
Attention

Public Information
Control System Warnings
To prevent personal injury or damage to equipment, follow all equipment safety

procedures, Lockout Tagout (LOTO), and site safety procedures as indicated by
Employee Health and Safety (EHS) guidelines.
Warning
This equipment contains a potential hazard of electric shock, burn, or death. Only
personnel who are adequately trained and thoroughly familiar with the equipment
and the instructions should install, operate, or maintain this equipment.
Warning
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

Warning 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.
Warning
Always ensure that applicable standards and regulations are followed and only
properly certified equipment is used as a critical component of a safety system. Never
assume that the Human-machine Interface (HMI) or the operator will close a safety
critical control loop.
Warning

Public Information
Contents
1 Application Overview .................................................................................................................... 17
1.1 Computer Recommendations ................................................................................................................... 18
1.2 Command Line Arguments...................................................................................................................... 20
2 Installation........................................................................................................................................ 23
2.1 ControlST Versions ................................................................................................................................ 27
2.2 ControlST Documentation....................................................................................................................... 28
2.3 Licensing ............................................................................................................................................. 30
3 System Configuration ................................................................................................................... 33
3.1 System Editor ....................................................................................................................................... 33
3.2 External Device Configuration ................................................................................................................. 83
3.3 Network Switch Configuration ................................................................................................................. 84
3.4 Save Systems ........................................................................................................................................ 87
3.5 Change Log .......................................................................................................................................... 88
3.6 Networks ............................................................................................................................................. 89
3.7 Configuration Files ................................................................................................................................ 94
3.8 System Editor Menus ............................................................................................................................100
3.9 System Information Editor......................................................................................................................103
3.10 System Database (SDB) .........................................................................................................................145
3.11 EGD Configuration Server .....................................................................................................................147
3.12 System Reports ....................................................................................................................................154
3.13 System Configuration Files.....................................................................................................................155
3.14 Access Privileges..................................................................................................................................156
3.15 Shared IONet Group..............................................................................................................................164
3.16 System Controller Platforms ...................................................................................................................169
4 Software ..........................................................................................................................................171
4.1 Software Configuration Hierarchy............................................................................................................171
4.2 Library Container Editor ........................................................................................................................175
4.3 Application Documentation ....................................................................................................................196
4.4 System Design Procedures......................................................................................................................197
4.5 Intrinsic Variables for Application Software...............................................................................................206
5 Block Diagram Editor ..................................................................................................................223
5.1 Diagram Commands..............................................................................................................................224
5.2 Rename Sheets.....................................................................................................................................225
5.3 Customize Sheet Borders .......................................................................................................................226
5.4 Variables and Blocks .............................................................................................................................230
5.5 Layout Modes ......................................................................................................................................235
5.6 Manage Blocks ....................................................................................................................................236
5.7 Wire Block Pins ...................................................................................................................................238
5.8 Block Shape Shortcut Menu....................................................................................................................240
5.9 Pin Connection.....................................................................................................................................241
5.10 Toggle Live Data Layers ........................................................................................................................243
5.11 Modify Live Values...............................................................................................................................245
5.12 Shape Drawing Tools ............................................................................................................................247
5.13 Additional Toolbar Buttons.....................................................................................................................254

Public Information
5.14 Diagram Settings ..................................................................................................................................255
5.15 Rung Editor .........................................................................................................................................257
5.16 Combinational Logic Editor....................................................................................................................260
6 Mark VIe Component Editor.......................................................................................................265
6.1 Creation Wizard ...................................................................................................................................265
6.2 Component Editor.................................................................................................................................267
6.3 Tree View ...........................................................................................................................................268
6.4 Summary View ....................................................................................................................................268
6.5 Property Editor.....................................................................................................................................268
6.6 Component InfoView ............................................................................................................................269
6.7 Data Grids...........................................................................................................................................271
6.8 Controller Settings ................................................................................................................................275
6.9 Security ..............................................................................................................................................276
6.10 Send Problem Report.............................................................................................................................280
6.11 Upgrade Components and I/O Modules.....................................................................................................282
6.12 Upgrade I/O Pack Firmware Throughout System ........................................................................................284
6.13 Replace I/O Module ..............................................................................................................................287
6.14 Compare to Controller ...........................................................................................................................287
6.15 Compare Devices..................................................................................................................................288
6.16 Mark VIe Component Menus ..................................................................................................................289
6.17 General Tab .........................................................................................................................................292
6.18 Hardware Tab ......................................................................................................................................306
6.19 Software Tab .......................................................................................................................................326
6.20 Dynamic Data Recorder (DDR) Tab .........................................................................................................352
6.21 Ethernet Global Data (EGD) Tab .............................................................................................................361
6.22 Modbus Slave Tab ................................................................................................................................370
6.23 EtherCAT Tab ......................................................................................................................................384
6.24 Mark VIe Reports .................................................................................................................................395
6.25 Forced Variables...................................................................................................................................489
6.26 Global Variables ...................................................................................................................................490
6.27 Alarm Rationalization............................................................................................................................491
6.28 Watch Window.....................................................................................................................................495
6.29 LiveView ............................................................................................................................................500
6.30 Constants ............................................................................................................................................512
6.31 I/O CheckOut.......................................................................................................................................518
7 Mark VIe — Working Online .......................................................................................................519
7.1 Connect to Controller ............................................................................................................................519
7.2 Controller Status...................................................................................................................................520
7.3 Secure State.........................................................................................................................................524
7.4 Download Controller Configuration .........................................................................................................528
7.5 Upload Controller Configuration .............................................................................................................552
7.6 Backup/Restore Controller Configuration ..................................................................................................554
7.7 Command Event History ........................................................................................................................555
7.8 Diagnostics View..................................................................................................................................557
7.9 Frame Timeline Profiler .........................................................................................................................559
7.10 Totalizers ............................................................................................................................................560

Public Information
8 Mark VIe Sequential Function Chart (SFC) Editor................................................................563
8.1 SFC Operations ....................................................................................................................................563
8.2 Online Operations.................................................................................................................................580
8.3 Publish SFC on EGD Page .....................................................................................................................582
9 Mark VIe FOUNDATION Fieldbus™ Interface ........................................................................585
9.1 Overview ............................................................................................................................................585
9.2 Configuration.......................................................................................................................................586
9.3 Online View and Interaction ...................................................................................................................665
9.4 Other Functions and Features ..................................................................................................................687
10 Mark VIe and Mark VIeS Advanced I/O Functions..............................................................691
10.1 PSVO, PCAA, PSVP, and PMVE Valve Circuit Calibration ..........................................................................691
10.2 HART Device Configuration...................................................................................................................694
10.3 PPRF PROFIBUS Communications Configuration......................................................................................700
10.4 PCNO I/O Module Configuration ............................................................................................................719
10.5 PSCA I/O Module Configuration .............................................................................................................725
10.6 PIOA I/O Module Configuration for ARCNET Support ...............................................................................727
10.7 PUAA/YUAA I/O Configuration .............................................................................................................729
10.8 Universal I/O Shared IONet Configuration ................................................................................................733
11 Mark VIeS Component Editor ..................................................................................................735
11.1 Creation Wizard ...................................................................................................................................735
11.3 Tree View ...........................................................................................................................................737
11.4 Summary View ....................................................................................................................................737
11.5 Property Editor.....................................................................................................................................737
11.7 Data Grids...........................................................................................................................................740
11.8 Controller Settings ................................................................................................................................743
11.9 Security ..............................................................................................................................................744
11.10Send Problem Report............................................................................................................................748
11.11Upgrade Component and I/O Modules .....................................................................................................749
11.12Compare to Controller ..........................................................................................................................751
11.13Compare Devices.................................................................................................................................752
11.14Mark VIeS Component Menus ...............................................................................................................753
11.15General Tab ........................................................................................................................................756
11.16Hardware Tab .....................................................................................................................................760
11.17Software Tab.......................................................................................................................................779
11.18Ethernet Global Data (EGD) Tab ............................................................................................................796
11.19Modbus Slave Tab ...............................................................................................................................803
11.20Mark VIeS Reports ..............................................................................................................................812
11.21Watch Window....................................................................................................................................882
11.22LiveView ...........................................................................................................................................886
11.23Constants ...........................................................................................................................................899
11.24I/O CheckOut......................................................................................................................................905
12 Mark VIeS — Working Online ..................................................................................................907
12.1 Connect to Controller ............................................................................................................................907

Public Information
12.2 Safety Controller Operations...................................................................................................................908
12.3 Controller Status...................................................................................................................................910
12.4 Secure State.........................................................................................................................................913
12.5 Download Controller Configuration .........................................................................................................917
12.6 Upload Controller Configuration .............................................................................................................931
12.7 Backup/Restore Controller Configuration ..................................................................................................933
12.8 Diagnostic View ..................................................................................................................................934
12.9 Disagreements Diagnostic View ..............................................................................................................936
13 Mark VIeS Black Channel Safety Communication.............................................................937
14 Mark VIeS Cause and Effect Matrix........................................................................................939
14.1 Overview ............................................................................................................................................939
14.2 Add Cause and Effect Matrix ..................................................................................................................940
14.3 Block Columns ....................................................................................................................................943
14.4 Property Editor.....................................................................................................................................944
14.5 Intersection of Cause and Effects .............................................................................................................947
14.6 Tool Bar Operations ..............................................................................................................................949
14.7 Configuration.......................................................................................................................................954
15 WorkstationST Component Editor.........................................................................................973
15.1 Creation Wizard ...................................................................................................................................973
15.3 Tree View ...........................................................................................................................................976
15.4 Summary View ....................................................................................................................................976
15.5 Property Editor.....................................................................................................................................976
15.7 Data Grids...........................................................................................................................................979
15.8 Security ..............................................................................................................................................982
15.9 Send Problem Report.............................................................................................................................988
15.10WorkstationST Status Monitor ...............................................................................................................989
15.11WorkstationST Component Menus ..........................................................................................................999
15.12General Tab ...................................................................................................................................... 1001
15.13Acoustic Monitoring (AM) Gateway ..................................................................................................... 1012
15.14On Site Monitor ................................................................................................................................ 1013
15.15Network Monitor Tab ......................................................................................................................... 1014
15.16Alarm Tab ........................................................................................................................................ 1017
15.17HMI Config Tab ................................................................................................................................ 1035
15.18OPC DA Server Tab........................................................................................................................... 1039
15.19OPC UA Server Tab........................................................................................................................... 1056
15.20Variables Tab .................................................................................................................................... 1065
15.21OPC AE Server Tab ........................................................................................................................... 1069
15.22Recorder Tab .................................................................................................................................... 1074
15.23Modbus Tab...................................................................................................................................... 1080
15.24Historian Tab .................................................................................................................................... 1080
15.25GSM Tab ......................................................................................................................................... 1080
15.26Mark V Tab ...................................................................................................................................... 1080
15.27Device Manager Gateway Tab.............................................................................................................. 1080
15.28Control System Health Tab .................................................................................................................. 1081

Public Information
15.29Ethernet Global Data (EGD)Tab ........................................................................................................... 1082
15.30WorkstationST Reports ....................................................................................................................... 1093
15.31Alarm Rationalization......................................................................................................................... 1117
15.32Watch Window.................................................................................................................................. 1120
15.33CommandLineST .............................................................................................................................. 1124
16 WorkstationST — Working Online .......................................................................................1135
16.1 Connect to WorkstationST Computer...................................................................................................... 1135
16.2 WorkstationST Status .......................................................................................................................... 1136
16.3 Download to WorkstationST Application................................................................................................. 1138
17 Finder ..........................................................................................................................................1141
18 EGD Editor for External Devices ..........................................................................................1145
18.1 Network Adapters............................................................................................................................... 1145
18.2 EGD Configuration ............................................................................................................................. 1147
18.3 Produced Pages .................................................................................................................................. 1148
18.4 Page Compression .............................................................................................................................. 1150
18.5 Edit Exchange Signatures and Configuration Time .................................................................................... 1150
18.6 Referenced Devices............................................................................................................................. 1151
18.7 Implementation Profile ........................................................................................................................ 1151
18.8 View Live Data Values ........................................................................................................................ 1152
18.9 EGD Diagnostics ................................................................................................................................ 1153
18.10EGD Configuration Server Tab............................................................................................................. 1154
18.11External Device Menus ....................................................................................................................... 1155
19 Configuration Management System (CMS) .......................................................................1157
19.1 Overview .......................................................................................................................................... 1157
19.2 CMS Server....................................................................................................................................... 1157
19.3 CMS Client (ToolboxST) ..................................................................................................................... 1170
19.4 Upgrade from CMS to CMS – SVN ....................................................................................................... 1208
Glossary of Terms ............................................................................................................................1209
Index.....................................................................................................................................................1213

Public Information
Notes

Public Information
1 Application Overview
The ToolboxST* application provides configuration and diagnostics tools for Integrated Control Systems (ICS). The
ToolboxST application and support packages for various components are included on the ControlST* Software Suite DVD.
Before installing the ToolboxST software, consider the following:
• Close all Windows® programs.

• All software products are installed in a common folder on your hard disk. You can define this location the first time you
install the DVD, but any subsequent releases will be installed to the previously defined location.
• A license key is not required to install the products, but to use the ToolboxST and WorkstationST* applications after
installation, a valid license key (hardware or software) is required. Refer to the section Licensing.
The information in this document applies to the overall Mark* VIe control system or
Mark VIeS Functional Safety System control products; however, your application may
not be licensed to access full system capability and I/O packs as described in this
document. For example, the Mark VIeS Functional Safety System for General
Markets only utilizes the following I/O packs:
• Analog I/O (YAIC)
• Universal Analog (YUAA)
• Vibration Input Monitor (YVIB)
• Relay Output (YDOA)

Attention
• Discrete Contact Input (YDIA)
• Power Distribution System Diagnostics (PPDA)
• Serial Modbus Communication (PSCA)
• Mark VIeS Safety Controller (UCSCS2x)
• Mark VIe Controller for Gateway (UCSCH1x)
Application Overview GEH-6703P User Guide 17

Public Information
1.1 Computer Recommendations
Recommended
Windows Server 2016 (Standard Edition)
OS Windows 7 Ultimate or Professional, 64-bit
Windows Server 2012 R2, single-user configuration, Service Pack 1 and latest Microsoft®updates
CPU Dual core or better
Memory 4 GB RAM (or more)
HD 120 GB (or more)
Monitor 1280 x 1024 x Truecolor (24 million or better)
Drive DVD
Network Ethernet 10/100 MB
USB Two available USB ports
Supported
Windows Server 2016 (Standard Edition)
Windows 10 Professional, 64-bit
Windows 7 Ultimate or Professional, 64-bit
OS Windows Server 2012 R2, single-user configuration
Some issues have been identified with certain features when using the Windows Server 2012 R2 OS.
Refer to ControlST Release Notes (GEI-100746) for details.
Windows Server 2008 R2, single-user configuration, Service Pack 1 and latest Microsoft® updates
Note For the requirements for ToolboxST to run on the HMI, refer to ControlST Software Suite Upgrade Guide (GEI–
100694) the section, HMI Compatibility.

Public Information
Large ToolboxST System Windows OS Issue
An issue in the Windows OS handling of 32-bit application addresses has been

identified in large (~2 GB) ToolboxST system configurations on two platforms:
• Windows 7 64-bit
• Windows Server 2008 R2 64-bit
This results in the following Ethernet connection failures:
• Loss of online connection between ToolboxST and the controller

Attention • Loss of connection in the middle of a configuration download from ToolboxST to the
controller
Microsoft has resolved the issue with a Hotfix (KB2588507) for both operating
systems. GE is not able obtain redistribution rights for this Microsoft Hotfix. Users
with large memory ToolboxST system configurations (such as FOUNDATION Fieldbus)
using Windows 7 and Windows Server 2008 R2 should download and install the
Microsoft Hot Fix.
Note The ControlST Software Suite no longer supports Windows 2000 and Windows XP, and does not support using
CIMPLICITY V8.2 and V9.0 with Windows Server 2012 R2.
ToolboxST Windows 10 OS Display Issues
ToolboxST users with Dell© Precision 5510 mobile workstations with GE Core Load
with a 4K display (Hi DPI) resolution running on Windows 10 64-bit OS will
experience several display issues. To resolve this, upgrade Windows 10 using the
following URL: https://www.microsoft.com/en-us/software-download/windows10. Click
Update Now to download the Windows10Upgrade9252.exe file. (This upgrade will
take approximately 6 hours, followed by 3 or 4 reboots.) After the upgrade, right-click
Attention the ToolboxST icon from the desktop, and select Properties, click the Compatibility
tab, select (check) Override high DPI scaling behavior, then select System
Enhanced. This applies to all supported versions of ControlST running on Windows
10.
Note Contact the nearest GE Sales or Service office, or an authorized GE sales representative for assistance.

Public Information
1.2 Command Line Arguments
The ToolboxST application supports the following command line arguments:
• Go To Variable
• Go To Hardware Diagnostic
• Go To Locator
• -NoSplash
• Archive a ToolboxST System
Note If the ToolboxST application is already opened, starting it again with the /variable option sends a message to the
already running ToolboxST application to cause it to navigate to the appropriate location.
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.
Open the ToolboxST Application

If the first command line argument is a valid path to a *.tcw system file, that system file is used for the variable search.
Otherwise, the first file in the most recently started ToolboxST application is opened.
Open a ToolboxST Component and Navigate 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 to control the device that is searched (refer to
Example 3). A message displays if nothing is found in the component.

Public Information
Example 1
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 system file, that system file is used for the variable search.
Otherwise, the first file in the most recently started ToolboxST system is opened.
Example 2
/HardwareDiagnostic:Marky
This causes the last opened system to be opened, the Mark 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 Mark 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 system 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.
-NoSplash
If the text -NoSplash is contained in an argument, the splash screen does not display when the ToolboxST application starts.

Public Information
Archive a ToolboxST System
This argument opens the most recent ToolboxST system, creates a system archive, then exits the system. Archiving the most
recent ToolboxST system can be overridden by using the first argument to specify the path to the desired system.
The target file name is optional. If not specified, the file name is the ToolboxST system name plus the creation date and time.
If the target file name is a directory, the archive file is placed in that directory with the file name of the ToolboxST system
name plus the creation date and time.
Example 3
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 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 working folder.
ToolboxST c:\MySystem.tcw
/archive:c:\MyArchiveFolder\MySystemArchive.zip
The system c:\MySystem.tcw is opened. An archive.zip file, with the specified archive name, is created.
ToolboxST c:\MySystem.tcw /archive:c:\MyArchiveFolder
The system c:\MySystem.tcw is opened. An archive.zip file, with the opened system name and date/time, is created. The
archive is placed in the specified folder.

Public Information
2 Installation
➢ To install the ControlST Software Suite
This DVD cannot be installed on Windows XP and below.
Attention
Always install new versions of the ToolboxST application before removing older
versions to preserve your personal settings.
Attention
Do not install ControlST component releases (individual .msi files) without first
installing a full ControlST release. Then, component releases can be installed. You
must install the ControlST Software Suite to properly install the ToolboxST
component.
Attention
1. Place the ControlST Software Suite DVD in the DVD-ROM drive.
2. The ControlST Software Suite Setup Notes dialog box displays. Click Continue.
Note If the installation does not begin automatically, navigate to the DVD-ROM drive and run the installation file setup.
exe.
3. The Setup - ControlST Software Suite dialog box displays the installation options. Select the applicable installation
options and click Install.
Installation GEH-6703P User Guide 23

Public Information
ControlST Installation Options
Install Description
Installs the ToolboxST application for configuration of the various controller types that it supports. The
Configuration Tools Package Configuration Tools Package is required to be installed on each HMI that will be involved in the site
configuration; it is typically installed on all HMIs.
Installs the runtime portion of the HMI or Historian, which communicates with controllers to collect
real-time data and alarm information for the HMI. It includes the EGD Configuration Server which is the
WorkstationST
real-time server of the configuration information. The WorkstationST application must be installed on
each HMI and Historian.
Installs the Configuration Management Server (CMS). This package should only be installed on one
CMS-SVN Server
HMI, the one designated as the site's CMS Server (if used) [S-CMS = Server].
Historian Reports Installs a Historian Reports package that is only installed on site Historians, not on HMIs
Beginning with ControlST V07.02, this option installs older versions of runtime for hardware platforms
that are no longer supported by the current version. For example, Mark VIeS V06.00.00C and later do
ControlST Supplement Package
not support the UCCC hardware platform. The last Mark VIeS runtime version that supports UCCC
(V05.03.03C) is installed with this package.
CMS-SVN Server and GE HART® Message Server options are typically only installed
on one computer per site. If either of these options is selected, a message displays
asking you to confirm that you want to install the option.
Attention

Public Information
Note The installation associates .tcw files on a single machine with the ToolboxST Version Selector. This helps determine
the correct version that should be used to open the .tcw file. However, if the most recently installed version is prior to
ControlST V03.03.xx, all .tcw system files are associated with that specific ToolboxST version.
4. When the Welcome window displays, click Next.

5. When the License Agreement window displays, select the I accept check box and click Next.
6. The Destination Folder window displays the installation location. If this is the first installation of the ToolboxST
application on this computer, click Change to change the default installation location (C:\Program Files (x86)
\GE Energy\). If this is a subsequent installation, this window displays the installation location for this version of the
product. Click Next.
Note The Configuration Tools Package option installs the ToolboxST application on your machine.
7. From the Custom Setup window, select the features to install or not install. All components are installed by default.
To not install a component,

expand the component name
and select the Red X.
8. Click Next.
9. Click Install.
10. After installation is complete, click Finish.
11. If any other options were selected (such as WorkstationST), a Setup dialog box displays asking if you want to install the
next selected option. Click Yes and repeat the installation procedure for each selected option.
12. When all selected installation options are complete, click Yes to exit setup.
Note Icons for installed applications are automatically placed on your desktop.

Public Information
Note If the Proficy License Client does not automatically install during ControlST installation, the following Security
Warning dialog box displays. You must exit setup and manually run ProficyClientInstaller.exe from the DVD _files directory
to install it.Without the Proficy License Client installed, you will not be able to open the installed ControlST applications.
Note You can install multiple versions of the ToolboxST application. If a new version is included, the desktop icons and
Start menu update to reflect the most recently installed version.
Note The Alarm Viewer is installed with the WorkstationST application. It can also be installed separately on a remote
computer.
➢ To open installed applications: double-click the icon on your deskop.

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 If you installed the Configuration Tools Documentation option, the ControlST Documentation application can be
opened from the Start menu.
➢ To uninstall or modify the ToolboxST application: from the Start menu, select Settings, Control Panel, and
Add/Remove Programs, right-click the ToolboxST application version and click Uninstall.

Public Information
2.1 ControlST Versions
The Versions feature allows you to view which ControlST Software Suite versions are installed.
➢ To display ControlST versions: from the Start menu, select All Programs, GE ControlST, and Versions to
display a complete list.
The ControlST Versions dialog box contains the following tabs:
• Tree View displays all installed products, their versions, the setup used for installation, and the installation date.
• Form View displays complete information for all installed products in a table format that can be copied and pasted into a
spreadsheet.
• DVD Tree View displays a list of products installed from the DVD.
ControlST Versions

Public Information
2.2 ControlST Documentation
The ControlST Documentation application enables the user to search for and view ControlST documentation. Using the
Search functionality, the user can search for a document number or a keyword or phrase to display links to documents with
that document number or that contain the searched keyword or phrase within the document title. Links to GE documentation
websites are also provided with the search results so the user can search for other related documents or product information
(the links provided depend on if the user is an internal or external GE user). Additionally, the user can enable full text search
(indexing the ControlST documentation folder) to display results for a searched keyword or phrase found within the
documentation text.
Note The ControlST Documentation application can be installed with the ControlST Software Suite. Refer to the section
Installation for further details.
➢ To search and view ControlST documentation

1. Open the ControlST Documentation application.
From the Start menu , select

GE ControlST and ControlST
Documentation, then select the
ControlST Documentation icon.
2. From the Search field, enter a document number or a keyword or phrase for which to search and press Enter.
The Search Enhancement dialog box displays a notification that the search capability can be improved by enabling full text
search. Click Yes or No to continue.
From the Search Enhancement dialog box, click Yes to display the
document How to Enable the Adobe PDF Full Text Search for ControlST
Documentation (GHT-200030). Perform the procedures in that document
to enable full text search.
To view this document at any time, click ControlST Documentation Global Search.
Note: To prevent the Search Enhancementdialog box from displaying every time you
perform a search , check the option Do not show again .

Public Information
The ControlST Documentation application displays the results of your search criteria as follows:
• Internal GE search:
− Link to document(s) containing the document number, keyword, or phrase entered in the Search field
− Link to Mark Controller Solutions Support Site
− Link to GE Power Technical Downloads
• External GE search:
− Link to document(s) containing the document number, keyword, or phrase entered in the Search field
− Link to GE Power Technical Downloads
3. Click the document link to view the document.
4. Click the website link to open the website and search for additional documentation or information.
Search Results Example

Public Information
2.3 Licensing
To use the ControlST Software Suite, a license key must be purchased. License keys are programmed at the factory to control
access to GE applications and software products. The ToolboxST and WorkstationST applications will only function if your
license key is programmed to allow access to those applications. If you have more than one product, your license key must be
programmed for each product. Multiple license keys can be installed on a single computer but the licensing manager will only
recognize one GE hardware key per computer.
A license key can be one of the following:
• Hardware key for Legacy ControlST versions prior to V03.06.09, and from V03.06.09 to V04.07.xx (green or blue USB
Protection Device (UPD) known as a dongle)
• Hardware key for ControlST V05.00 and higher (white M4)
• Software activation key, Project Advantage license, that is typically assigned to a computer, but can also be assigned to a
USB key
Note The hardware key is CE, RoHS, and WEEE-compliant.
Hardware and software license keys can be viewed using the License Viewer/Manager. The Legacy ControlST license key
cannot be viewed.

Public Information
2.3.1 Terminal Services Client License
A Terminal Services Client connection license may be purchased to enable more than two sessions of the ToolboxST, Trender,
and Alarm Viewer applications. A user can launch multiple instances of an application within one login session. The initial
number of sessions (user account login) provided with a ControlST license is limited to two sessions (for example, 1 local
connection and 1 remote connection); however, users can purchase additional Terminal Service client licenses for more
connections (up to 255 available connections).
For the Control Server product, the Terminal Services Client license is used with Microsoft Remote Desktop Services (RDS),
and CIMPLICITY Terminal Services to allow multiple user connections to operate a workstation (Control Server Virtual
Machine) over a network connection.
Users can view their Terminal Services license information using License Viewer/Manager.
License Viewer/Manager Displaying Number of Terminal Services Clients Licenses
If a user logs in and tries to open the ToolboxST, Trender, and Alarm Viewer application and the number of allowed sessions
is exceeded, the following error message is displayed. Additional sessions can be added by purchasing additional Terminal
Server Connection licenses.
Terminal Services License Connection Error Message

Public Information
2.3.2 Hardware License Installation
Before you insert the key, install the ToolboxST and/or WorkstationST application. If
you insert the hardware key before installing these applications, the key may appear
to be installed but it is not associated with the correct drivers. This will correct itself
after the application is installed.
Attention
Note The most current licensing installation is available at the following location: http://support.ge-ip.com/licensing.
➢ To install the hardware key: insert the hardware key into an empty USB port on your computer.
Note Only one hardware key of the same type (Keylok, M4) can be installed at a time.
2.3.3 Software License Installation and Activation

Project Advantage licenses can be installed and activated online or offline using either the GE License Server or a local
license server.
➢ To install and activate the Project Advantage license: enter your activation code (provided by email) in the
Product Lifecycle Management (PLM) Activate License window.
PLM connects to the License Server and performs various checks run by the License Server (valid activation code, license
already assigned, and so forth).
2.3.4 License Client (Viewer/Manager)

Various options are installed with the ControlST Software Suite and the license key enables or disables these options. Use the
License Client (or Manager, or Viewer, depending on version) to display and manage enabled and disabled options.
➢ To open the License Client (Manager/Viewer): from the Start menu, select All Programs, Proficy Common,
and License Client (Manager/Viewer).
License Client/Viewer/Manager

Public Information
3 System Configuration
ToolboxST systems contain components that represent controllers or applications. A system is stored in a folder that contains
both a .tcw configuration file and a collection of supporting files and folders representing the system components.
3.1 System Editor

Create a new ToolboxST system or open an existing system.
➢ To create a new system
From the File menu , select New System

to display the New System window.
Enter a name for the new system. Some characters are prohibited ; if you enter a valid
character, a small red exclamation mark displays .
Specify the working directory to contain the ToolboxST system. Either enter a Location
path or click Browse to navigate to a file location.
Note: If you enter a path that does not exist, the ToolboxST application creates it for you.
Click OK to create the new system.
System Configuration GEH-6703P User Guide 33

Public Information
Newly Created System Editor
Note Refer to the section System Configuration Files for more information.
➢ To open an existing system
From your desktop , double-click

the ToolboxST application icon
to display the System Editor.
From the File menu , select

Open System…
Select the system .tcw file and

click Open to display the
system configuration .

Public Information
3.1.1 ToolboxST System Windows
When a ToolboxST system is opened, the System Editor provides an overview of all configured components in the following
areas:
• Tree View
• Property Editor
• Summary View
• Component InfoView
Summary View provides a

graphical display of all components
and tools in the system
Tree View lists

all components
and tools in the
system.
Property Editor
allows you to
configure all
system
properties when
the system is
selected in the
Tree View.
UDH (and other

network)
properties are
also configured
from the
Property Editor.
Component
properties are
configured in the
specific
Component
Editor
Component InfoView
displays specific system
feedback information
ToolboxST System with Configured Components

Public Information
3.1.2 Alarm Help
When the ControlST Software Suite is installed, two folders are created to provide for Alarm Help in the following location:
<InstallDirectory>\ToolboxST\<Version>\AlarmHelp.
When a new system is created, the ToolboxST application creates a directory within the system folder called
AlarmHelpTemplates. Two .htm Alarm Help files are copied from the installation directory.
The Alarm Help files include:
AlarmHelpTemplate.en.htm help template is used when a variable is in the alarmed state.
AlarmHelpTemplateNormal.en.htm help template is used when an analog alarm variable is in the normal state (not
alarmed).
The .htm files in the AlarmHelpTemplate folder are organized as follows:
AlarmHelpTemplate\<language name in English>\AlarmHelpTemplate.XX.htm
AlarmHelpTemplate\<language name in English>\AlarmHelpTemplateNormal.XX.htm
where XX is the two-letter ISO code for the language.
➢ To configure Alarm Help files

1. From the System Property Editor, set the Publish Alarm Help property to True. This allows the Alarm Help files to
be created.
2. Designate and enter the path for the Master WorkstationST component.
➢ To view Alarm Help: from the Alarm Viewer, right-click an alarm and select Alarm Help to display the Operator
Guidance window. For more information, refer to the WorkstationST Alarm Viewer Instruction Guide (GEI-100620).
Sample Help File for Variables not Alarmed
Sample Help File for Alarmed Variables
Note Alarm help files are published when the device containing the alarm changes is saved. The Log tab in ToolboxST
indicates when publishing is complete.

Public Information
3.1.3 System Password Protection
As a security measure, password protection can be set to restrict access to the controller. The system level functions listed in
the following can be configured to require a password entry before they can be performed.
Password Protected Functionality

System Level Function Specific Function
Controller External Device
Group Library Container
Insert new Network Printer
Tool WorkstationST
Network Time Server Network Switch
Customer Information EGD Config Server
Languages Master Location
System Properties
Redundant Alarm Server System Database
Time Synchronization
➢ To set password protection at system level
From the Property

Editor, expand
Protection and
select Modify Design
to set the password

Public Information
Note After password protection has been set, the first time a user attempts to perform a password-protected function, the
Enter Password – Modify Design window displays. All protected functions performed during the remainder of the current
ToolboxST session will not require re-entering the password.
Password protection can also be set for individual components to restrict certain functions and property modifications. For
further details, refer to the section Password Protection for your component.
To change the password, refer to the section System Component Password Change.
3.1.4 Components and Tools

Systems consist of multiple components that display in both the Tree View and the Summary View of the System Editor. The
System Editor serves as a navigation tool to open more detailed Component Editors for editing or viewing. Double-click
system components in either the Tree View or the Summary View to make changes.
➢ To edit system components: from either the Tree View or Summary View, double-click the system component to
open the Component Editor.
Note You can add components to the root component of a system or group. Some components display a wizard or window
that prompts you for additional information when you add them to the system.
ToolboxST Tree View Icons

Icon Description
Versions (ControlST Software Suite)
System
Group of Components
Mark VIe control
Mark VIeS Safety control
WorkstationST application
Configuration Management System (CMS)
Printer

Public Information
ToolboxST Tree View Icons (continued)
Icon Description
Library Container
Network
Trender
Watch Window
LiveView
External Device (not associated with an application)
Tree File Importer
CMS Administrator
ControlST Documentation
Mark Control Network Switch
Network Time Server
Mark V component
Batch Command Tool

Public Information
3.1.4.1 Group Components
The ToolboxST application provides a component called Group to help 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 you want, including division by physical component location and a variety of logical
divisions. Use the drag-and drop feature to move controllers into Groups.
Note 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.
3.1.4.2 Move and Copy Components

Use the drag-and drop feature to move components within a ToolboxST application. Moving components is the default
drag-and-drop operation for most components.
Some components also 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 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 two exceptions:
• When a group is copied, a new Group is created. The contents of the previous Group remain in place and are not copied
to the new Group.
• The drag-and-drop feature is not 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 the drag-and-drop feature. (To import from the file system, drag the Device.xml or Library.xml
file that represents the component.)

Public Information
3.1.5 System Properties
The Property Editor enables the user to view and configure system properties.
➢ To display system properties: from the Tree View, select a system item to display the system properties in the
Property Editor.
System Properties

Public Information
Property Editor System Properties
Property Description
Acknowledge
If set to True, prompts the operator to enter a comment when they acknowledge an Alarm
Comments
Alarm Out of Service Enables or disables the capability to take Alarms out of service
If set to True, creates an Alarm hierarchy in the WorkstationST Alarm Viewer for all variables defined
as Alarms. Parent and child Alarms are configured in the Component Editor Software tab.
When a parent alarm is defined in the system, if the parent alarm occurs then a child alarm is a
Alarm Parent Child
side-effect of the parent alarm (only the parent alarm can be configured). For further details, refer to
the section Alarm Parent Child, and the WorkstationST Alarm Viewer Instruction Guide
(GEI-100620), the section Alarm Parent Child.
Alarm Shelving Enables or disables the capability to shelve Alarms
Publish Alarm Help If set to True, enables the publishing of Alarm help files when a Save is performed
Reset Comments If set to True, prompts the operator to enter a comment when they reset an Alarm
Defines the primary WorkstationST computer used to monitor the health of various system
Control System Health
components on the UDH, the PDH, and IONet
Customer Name Customer name can be entered
Site Site information
When set to True, communicates with the EGD configuration server
EGD Config Server
For further details, refer to the section, EGD Configuration Server.
Maintain Backward
When set to True, prevents future ToolboxST versions from upgrading the current system file
Compatibility
Name System name
Protection Provides access rights
Modify Design Enables the user to modify the controller design
Working Directory Path to the directory where system files are stored
Primary: Primary language of the system
Language
Secondary: Optional second language (if nothing is entered, a second language is not published)
Master WorkstationST Master location for Human-machine Interface (HMI) screen files, sound files, and such
Path Path to the Master WorkstationST computer
Redundant Alarm Primary Alarm Server: WorkstationST computer that hosts the primary Alarm Server
Server Secondary Alarm Server: WorkstationST computer that hosts the secondary Alarm Server
CA Server Full Name: includes the domain and computer names
CA Server IP Address: provides the controller with the CA Server location for certificate requests
Security Server CA Server Thumb Print: provides the security Thumb print for the CA Server location certificate
RSystem Log Server IP Address: provides the controller with the location to log security-related
messages
When set to True, connects to an SDB. The SDB Host Name and SDB Host Path properties display
SDB Enable
(not applicable for Mark VIeS Safety control systems)
Configured System Time Reference Acquisition Method designates the following:
• Native Time Reference is system time supplied by either local network time servers or the
internal clocks of designated WorkstationST computers.
• Native Time Reference, PC Time Card Option is system time supplied by the internal time
Time Synchronization cards of designated WorkstationST computers.
• Site Broadcast Time Reference is system time supplied by customer-maintained timeserver
broadcasting time to designated WorkstationST computers.
• Site Unicast Time Reference is system time supplied by customer-maintained timeserver
uni-casting time to designated WorkstationST computers
Designated Primary
Designates the WorkstationST computer to be configured as the highest priority time server
Time Source

Public Information
Property Editor System Properties (continued)
Designated Secondary Designates the lowest-priority WorkstationST time server. The designated secondary WorkstationST
Time Source (optional) must be connected to both the PDH and UDH networks.
Disable Time Source If set to True, disables Network Time Protocol (NTP) broadcasts from the WorkstationST computer(s)
NTP Broadcasts designated as the primary (and secondary) time source(s).
If set to Disabled, sets the method for acquiring time by all native devices, and all WorkstationST
NTP Client Mode
computers that are not configured as either a primary or secondary time source
Includes:
Theme File, which is selected by clicking the ellipsis button and contains display attributes for the
Visualization
operator-facing tools, including WorkstationST Alarm Viewer, WorkstationST Status Monitor, and
Trender.

Public Information
3.1.6 CA Server Thumb Print
Note This property only applies to Mark VIe and Mark VIeS secure systems.
Beginning with ControlST V06.00, the CA Server Thumb Print property is required to be provided at the system level for all
systems that use Security servers. Enter the Thumb Print from the CA Server that signed the download certificate in the
System Properties.
CA Server Thumb Print System Property
➢ To enter the CA Server thumb print in the System Property Editor

1. From the Start menu, open a command prompt.
2. Type certmgr.msc and press Enter to display the UI for the certificates on the computer.
3. Open the Download certificate.
Double-click the certificate and navigate to the CA Server root certificate.
Bob
Bob
Bob
Click View Certificate.

Public Information
4. Copy the Thumb Print to the System Properties.
From the Details tab, select the Thumb Print

and copy and paste it in the Property Editor
CA Server Thumb Print field.
CA Server Thumb Print in Property Editor

Public Information
3.1.7 Theme Visualization
Note Refer to the chapter, WorkstationST — Working Online, the section, WorkstationST Status Monitor, WorkstationST
Alarm Viewer Instruction Guide (GEI-100620), and Trender for the ToolboxST Application Instruction Guide (GEI-100795).
Predefined theme files are provided in the installation directory (Program Files\GEEnergy\ThemeFiles).
The ToolboxST application supports theme files for all operator-facing tools. These include:
• Trender
• WorkstationST Alarm Viewer
• WorkstationST Status Monitor
➢ To select a display theme

1. From the System Editor Tree View, select the system item.
2. From the Property Editor, select Theme File and click the ellipsis button.
3. From the Open window, select the desired theme file and click Open. The selected theme displays in the Property
Editor.
4. Click Save. It will take up to two minutes for the changes to be implemented.
Note The EGD Configuration Server must be enabled.
Examples of the operator-facing tools enabled with the selected theme GE GrayScale are provided in the following table. To
use a standard Windows display style, leave the Theme File property empty.

Public Information
Operator-facing Tool Display Themes
Tool Standard Windows Display Style GEGrayScale Style
Trender
WorkstationST
Alarm Viewer
WorkstationST
Status Monitor

Public Information
3.1.8 Batch Commands
This feature is not available for Mark VIeS Safety Control systems.
Attention
The ToolboxST system provides a Batch command to allow you to select multiple controllers and perform the Instance All or
Build commands.
➢ To perform the batch command function
Right-click the
system item and
select Insert New,
Tool , and Batch
Commands

Public Information
If the selected controller is
Save (the From the drop- password-protected and a
configuration down list, select password is not entered, that
displayed) Start Stop the operation. message displays in the log view.
From the
Component
drop-down list,
select the
component and
click to enable.
From the On
Error drop-down
list, select the
action to take
(Stop, Continue
(skip to), or Next
Component))
when the first
error occurs.
To save the log

view information,
right-click, select
all, copy, and
paste to Notepad
or other file.

Public Information
3.1.9 System Editor Status
When a system is online, the status for all active components in that system displays next to the component icon in the
Summary View.
Status Icons
Icon Status Indicates
Component Diagnostics – No
NTP Diagnostics – No
EGD Diagnostics – No
I/O Diagnostics – No
Healthy
Number of Forced Variables – 0
DDR Equality – Equal
Configuration Equality - Equal
Network Status Monitor - Healthy
NTP Diagnostics – No
EGD Diagnostics – No
I/O Diagnostics – No
Unhealthy Number of Forced Variables – 0
DDR Equality – Equal
Configuration Equality – Major difference
Network Status Monitor - UDH has errors
NTP Diagnostics – Yes

EGD Diagnostics – Yes
I/O Diagnostics – Yes
Warning Number of Forced Variables – 1
DDR Equality – Not equal
Configuration Equality – Not equal
Network Status Monitor - UDH has warnings
Component was added after the system went online

No data is being consumed
System and component not communicating
Network Status Monitor - No data OR not consumed
Logic forcing procedures can result in personal injury or death, if not strictly
followed. Only adequately trained personnel should modify any programmable
machine. Forcing of control logic for an operating process is strongly discouraged.
Forcing of protective functions is never permissible for an operating unit. All safety
Warning measures should be strictly enforced in conjunction with this procedure.

Public Information
3.1.10 System Download and Scan
Download the controller(s) component configuration and perform a scan to obtain each component’s version status of the base
load, the firmware, and the application code and parameters.
Note It is possible to scan and perform configuration downloads to multiple controllers simultaneously.
➢ To perform a system download

1. From the System menu, select Download.
2. Select the components for download and click Next.
3. A progress dialog box indicates when each selected controller has been build. Verify that there are no validation errors.

Public Information
If a Build has not been performed on all selected controllers, the following window displays.
After a Build has been performed on all components, the scan takes place. The scan allows the ToolboxST application to
obtain each component’s version status of the base load, the firmware, and the application code and parameters.
The application displays a message if any components selected for download have any conditions (for example, issues with
firmware or application code) that could cause them to be in an inappropriate download state.
4. When the scan is complete and you are prompted to generate a scan report, click Yes. The scan report displays any
controllers that are Not Equal.

Public Information
➢ To save the scan report: from the report File menu, select Save Report.
➢ To start the scan download: from the wizard window, click Next.
Note If all controllers are equal, a download is not required.
Download Completed

Public Information
3.1.11 System Component Password Change
If the controller password is still set to the factory default password, a controller diagnostic alarm message, Default user
password detected, displays in the Status tab to prompt the user to change the password.
Controller Factory Default Password Diagnostic Alarm Message
To maintain a strong security posture GE recommends the user must change the
factory default controller password for a device. The maximum number of characters
for the new password is limited to 8 characters. The new password cannot be the
factory default password. The factory default password is ge.
Attention
➢ To change the component's controller(s) password
From the System menu, select

Change Component Password…
Select the system or individual component (s) for

which to change the password.
Enter the current password, new password, and

re -enter (confirm) the new password.
Note: The password must have a minimum of

seven (7) characters, and meet at least three of the
following requirements:
- Contain at least one uppercase character (A-Z)

- Contain at least one lowercase character (a-z)
- Contain at least one numeral (0-9)
- Contain special character(s) (such as !, #, $, _, %)
Click OK to change the password.

Public Information
Additional windows may display to notify the user that the component is password-protected. For further details, refer to the
section Password Protection for your component.
The Log tab displays password change success or error messages as they occur.
Note For a component configured with redundant controllers, the password applies to all controllers in that component.
Note This password is required to configure the network address during controller setup.
3.1.12 Control Constants Import and Export

The ToolboxST application allows you to perform system-wide import and export of control constants and parameters (.csv
files).
➢ To import control constants and parameters

1. From the System Editor System menu, select Control Constants and Parameters, then select Import.
2. A message displays asking you to confirm that you fully understand the effects of the changes to the control constants
values in the controller(s) to the controller(s). Click OK to proceed.
3. Click Browse… and select the .csv file to import. Use the following .csv file format:
4. Click one of the import options:
• Import to Device Values modifies the values in the device only, which results in a faster load.

Public Information
• Import to Config Values modifies only the initial value in the configuration if it is different. (The variables must be
marked as Control Constants.)
• Import to Both modifies the values in the device and the initial value in the configuration if it is different.
5. A message indicates when the import is finished in the lower left corner of the window and a report log is available to
view. Click View Log to view a report of the import details.

Public Information
Example Import Report Log
Example Import to Device Values Report Log
Example Import to Config Values Report Log
Example Import to Both Report Log

Public Information
➢ To export control constants
1. From the System Editor System menu, select Control Constants and Parameters, then select Export.
2. Select the device(s) to export the associated control constants and parameters.
3. Click Browse... to select the location for the export file.
4. Click Begin Export to export the control constants and parameters of the selected device(s).
5. When the export is complete, click View Log to review the results.

Public Information
A sample .csv file is as follows:
#Version:V04.07.00A
#System Path:C:\T3\T3.tcw
Device Name, Constant Name, Constant Value, Constant Units, Entry High, Entry Low
G1,ControlConstant1,(Not Used),,,
G1,ControlConstant2,30,,50,10
G1,ControlConstant3,True,,,
G1,ControlConstant4,13,,20,8
G1, NonVolatile1,12.5,,23.5,9.6
G1, NonVolatile2,31,,52,12
G1,arr_ControlConstant[0],0,,20,0
Note The Entry High Limit and Entry Low Limit values are imported and exported with the live values for control constants
and parameters.

Public Information
3.1.13 Component Upgrade
The user can upgrade any or all controllers and libraries at the system level.
Note If all configured components have been upgraded to the latest installed version, the System Upgrade Wizard window
displays the message No components require upgrade.
➢ To perform a system upgrade
All component editors must be closed to perform an upgrade from the system.
It is recommended that users back up the ToolboxST .tcw file prior to upgrading the
system.
Attention
1. Check for available upgrades.
From the System menu ,

select Upgrade Components.
Select the component(s) to upgrade and click Next.

Public Information
The System Upgrade Wizard dialog box displays all available upgrades for the selected components, including configured I/O
modules with available upgrades.
Note The latest version for components is displayed by default and the I/O module versions default to the latest compatible
hardware.
2. Select the components for upgrade. By default, components are listed by Component Name but you have the option to
list by component hardware type as well.
The New Version column displays the version to which the component will be upgraded.
Select Upgrade for the appropriate component(s), then click Next to proceed.
a. Select Component Name to list the components by component name.

If an incompatible version (it requires a hardware upgrade) is selected as the New Version, a caution icon is displayed.
This indicates that the selected upgrade version does not support the present I/O module hardware.
Upgrading the component to the new incompatible version will require replacing
existing I/O modules with supported hardware.
Attention
Place your cursor on the Caution icon to display a Tool Tip indicating that the selected
upgrade version does not support the existing I/O module hardware and if you proceed
with the upgrade you will have to replace the existing hardware.

Public Information
If any I/O modules are selected for upgrade to a firmware version that does not support the hardware, an Upgrade
Warning dialog box warns the user that if they proceed with the upgrade it will require replacing existing I/O module
hardware with supported hardware that is compatible with the new version.
Click Yes to proceed and upgrade the selected I/O modules,

or
click No and unselect upgrade for the selected component.
Note Selecting No does not cancel the upgrade. You must unselect the incompatible component(s) if you want to
proceed with the upgrade for other compatible components.

Public Information
b. Select Hardware Type to list components by hardware type with I/O modules.
All modules of the selected particular hardware type will be upgraded at the same time.
Tip � Place your cursor on the component name to display a Tool Tip listing all controllers that contain the I/O module
selected for upgrade.
Components Listed by Hardware Type with Compatible I/O Module Hardware
If Hardware Type was selected and any I/O modules cannot be upgraded due incompatible hardware, the Hardware
Mismatch dialog box displays notifying the user that the incompatible I/O module hardware cannot be listed by Hardware
Type.
Click OK and select Component Name to proceed.

Public Information
3. Click Next to upgrade the selected component(s).
Note Configured libraries are upgraded first.
To cancel the upgrade, click Abort.

Note: The system will complete the upgrade for the component
in progress before canceling the remaining upgrades.

Public Information
3.1.14 Instance Components
Performing an instance for a device updates the software in the device that was referenced from a library. You can select
multiple components to be instanced. After the instancing is complete, an automatic Validate command is performed.
➢ To instance components
From the
System menu,
select Instance
Components to
display the
Select Devices
dialog box
Select
individual
components
or click
Select All
and OK
Information
and progress
for both the
Instance and
Build
commands
display

Public Information
3.1.15 System Replication
The ToolboxST application allows you to create a template component, and replicate it using the Replication Wizard. The
wizard can perform two types of replication:
• Simple Replicate — the name and IP addresses for the duplicate components are automatically assigned in linear order
from a base value
• Replicate using Properties from CSV — the name, IP addresses, and group for the duplicate components are read from a
Comma Separated Value (.csv) file. Since the name and IP address of each component can be specified, this command is
more flexible than the Simple Replicate.
Note The Replication Wizard cannot replicate a component with validation errors. If a validation error message displays
when Simple Replicate is selected, perform the Build command.
➢ To perform a Simple Replicate

1. From the Tree View, right-click a component and select Replicate Component and Simple Replicate. When the
welcome page displays, click Next.
2. From the wizard page, enter the component name. From the drop-down lists, select the first number for the duplicate and
the number of copies, and click Next.
Note Any component name or IP address conflicts display in red in the Status column.
➢ To perform a Replicate using Properties from CSV
Note If the component cannot be replicated, the replicate commands are unavailable.
1. From the Tree View, right-click a component and select Export Component Properties from CSV.
2. Select a name for the .csv file.
3. Using Notepad or Microsoft Excel®, edit the .csv file.
Each line represents one component to create during replication, and each column defines a component property:
• Device Type (must match the template component)

• Device Name (must be unique in the system and .csv file)
• IP Address (must be unique in the system and .csv file)
• Associated IONet Device Name, if the template device has one
• System View Group (location of new component)
The .csv file created by the Export Component Properties to CSV command contains the template device (default). Duplicate
and modify this line for each desired duplicate component and remove the line for the template component.

Public Information
The following example illustrates the creation of two copies of component T1 and its associated components. The new
components will be added to the system temp group.
#Version:V04.01.00A
#System Path:MPCTest_V41.tcw
#Replicate Properties:T1
Device Type, Device Name, IP Address, IoNet Device (ie DFIGe Device
name), Group
MarkVIe,T2,172.20.101.196,PC2,Temp
MarkVIe,T3,172.20.101.197,PC3,Temp
4. Select the edited .csv file.

5. Click Next to display the Replication Wizard.
Note All existing Trenders and Watch Windows in system components are replicated, as well.

Public Information
3.1.16 Archive System
The Archive System allows you to select all or a combination of components to save to an archive.
➢ To select components to archive
From the Archive

System dialog box,
select all or a
combination of
components to
archive and clickOK
A Save As window allows you to save the archive as a zipped file.

Public Information
3.1.17 Create System From...
Attention
The Create System Wizard allows you to create a new system from selected components of an EGD configuration server or
SDB server. If a selected component supports uploading the configuration, an attempt is made to perform the upload. If
Upload is not supported or the upload fails, a component of the correct type is created in the system based on the information
in the EGD configuration server.
Note The new system will not be an exact copy of the original. Not all information required to create a system is available
from the EGD configuration server or SDB, including libraries. The new system will have the default NTP settings; however,
this may not reflect what is configured in the original system.
➢ To create a system using the Create System Wizard
From the File menu, select

Create System From...
to display the Create System Wizard.
When the introduction page displays, click Next.
Note If the system is already open, it will be closed before the wizard starts.

Public Information
Enter a name for the system and click Click Browse to
Next. If that system name already exists, select a location for
you are prompted to overwrite it. the new system.
Select the system

source and click Next.

Public Information
Enter the computer name or IP address of the
WorkstationST computer running the EGD Configuration
Server and click Next to load all available components.
Select the
check boxes
for the desired
components
and click OK.

Public Information
The selected component
displays. Click Next.
If SDB was selected as the system Enter the Host Path on

source, enter the host name or IP the host machine where
address for the server running the SDB. the SDB is located.

Public Information
The following component types can be selected for upload from the EGD configuration server:
• GenericEgd
• Mark VI Control
• Mark VIe Control
• Mark VIeS Safety Control
• External device
• WorkstationST application
Select Create a limited-access WorkstationST

component and enter a name. Click Next to up
load all selected components and display the
system creation output wizard page.

Public Information
Click Finish to close the wizard
and open the new System Editor.
3.1.18 Alarm Shelving and Out-of-Service
Attention
Alarm Shelving allows the operator to temporarily suppress Alarms from the Alarm Viewer live Alarm data display, and from
HMI screens that display Alarms. The Out-of-Service feature allows the operator to place an Alarm in the out-of-service state
or to return the Alarm back to in-service. The Alarm Shelving property is enabled in the System Editor. Alarm Shelving and
the Out-of-service feature apply to Process Alarms only.
Note Alarms must be enabled for shelving on an individual basis.
For further information, refer to the WorkstationST Alarm Viewer Instruction Guide (GEI-100620).

Public Information
3.1.19 Condition-based Unshelving
Attention
In conjunction with the Alarm \Shelving feature and the ANALOG_ALARM and BOOLEAN_ALARM blocks,
Condition-based Unshelving allows you to create the Unshelve sub-variable.
➢ To create the Unshelve sub-variable
Select the
analog variable.
From the Property

Editor , enable the alarm,
then enable the Alarm
Shelving property.
Shelved variable
attached as input pin
The Unshelve sub-variable
also displays in the Block
Diagram Editor.
Sub-variables Properties
display

Public Information
Shelved variable
attached as input pin.
Boolean Alarms can also be
unshelved using the new
BOOLEAN_ALARM block.
Unshelved sub-variable
Alarm
properties
3.1.20 Copy I/O
Attention
It is possible to copy all parameters and connections for I/O packs in a controller to other controllers at the system level.
➢ To copy I/O packs
From either the

Tree View or the
Summary View,
right-click the
controller and
select Copy IO
Wizard.
When the
welcome page
displays, click
Next.

Public Information
Select parameters and/or
connections and clickNext.

Public Information
Select individual I/O packs or click
Select All, then click Next.

Public Information
Select the components to
copy to and click Next.
When the copy process is

complete, click Finish.

Public Information
The progress page displays.

Public Information
3.1.21 Find Unlinked Blocks
The Find Unlinked Blocks report displays a list of unlinked blocks in all configured components.
➢ To generate an unlinked blocks report
From the View menu,

select Reports and
Find Unlinked Blocks
Select individual components

or click Select All and OK

Public Information
Any unlinked programs and blocks display
From the File menu, you can save or print the report
The View and Report menus offer additional options

Public Information
3.2 External Device Configuration
When you add an External Device to the system, 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 and the
component is double-clicked in the ToolboxST application, the external application opens the configuration device.
If the configuration for the external device is stored in a file with a special extension, the user can specify the path to the
configuration file and omit the path to the external application. The ToolboxST application automatically opens the
application associated with the configuration file. In all other cases, specify the exact application to 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
indicated with a question mark.)
2. In the Property Editor, select App Path and click the ellipsis button.
3. Locate the application executable file used to configure the device and click Open. The App Path property displays the
new path.
4. (Optional) If the External Device requires a specific configuration file, select Doc Path and provide the file location.
5. (Optional) 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.
6. (Optional) If the external device application requires a specific working directory (the folder assumed when no path is
specified), configure the Start Directory property.
7. (Optional) If the external device supports Ethernet Global Data (EGD), set the Enable EGD Editor property to True.
8. (Optional) If the external component does not have a configuration file associated with a particular application, select
App Path and click the ellipsis button.

Public Information
3.3 Network Switch Configuration
After networks have been added, create network switches to enable and define component network connections as each
component is added to the system.
3.3.1 Create Network Switch

The Creation Wizard guides the user through the process of creating a network switch.
➢ To create a network switch

1. From the Tree View, right-click the system name, select Insert New.
2. Select Network Switch and follow the Network Switch Device Creation Wizard to create the network switch.
Enter a name for

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

Public Information
Configure the
network switch in
the Property Editor
Network Switch System Properties

Connected Network Network to which the switch is connected (UDH or CDH)
Description Description of the switch
GE Part Number GE-specific part number (optional)
Host Name Host name of the switch
IP Address IP address of the switch
Number of ports on the switch. Enter the total combined number of ports if the switch
Number of Ports
device represents a group of switches in a stacked arrangement
Protection Access rights for the component
SNMP Community Name of the Simple Network Management Protocol (SNMP) community
Switch Type Switch manufacturer
Vendor Configuration Tool Link Provides a link to the switch vendor’s configuration tool

Public Information
3.3.2 Configure Switch Port
Note Ports configured with the connection type Default_Native Device Connection or not used can have a network
component connection.
➢ To add a network component connection to a port: from either the Data Grid or the Property Editor, click the
ellipsis button next to the Network Component property.
Select a
component
and click OK

Public Information
➢ To add a second network to the port for a WorkstationST component: select the Network_2 property and
click the ellipsis button.
Switch Port System Properties

Defines the port connection type
The default is no connection or a single Native Device connection. A Trunk Port specifies
that the port is connected to another switch or is connected to multiple devices through a
network router or hub. The Third-party Critical Device connection indicates a connection to
Port Connection
a device not defined in the system but is expected to be available at all times (an Alarm is
generated if this port is disabled or down). A Peripheral Device indicates a connection to a
non-critical device, such as a printer, that might not always be online. An Alarm is
generated only if the port is disabled.
Port Description Port connection description
Port Number Number of the port selected in the Tree View
Port Type Port connection type, for example, HundredBaseT
Network Component Component or controller within a controller set
Network_1 Name of the connected network
Network_1 IP Address IP address of the network adapter connected to this port
Network_2 Second network name that can be used for WorkstationST components only
Network_2 IP Address IP address of the network adapter connected to this port
WorkstationST component configured with a single network port servicing two networks,
Primary Network one primary and one backup. If set to True, it is the primary network.
Available for WorkstationST components only.
3.4 Save Systems

In the ToolboxST application, Save commands only affect 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.

Public Information
3.5 Change Log
Attention
When changes to the system or an individual component are saved, a Change Log is created in the component folder that
users can access to review the changes.
➢ To view the Change Log

1. Make the necessary system changes in ToolboxST, then click Save.
2. When the following dialog box displays, click View Log to review the Change Log.
Example Change Log

Public Information
3.6 Networks
Attention
The optional Control Data Highway (CDH) is a second Unit Data Highway (UDH) that allows two separate controllers to
communicate with each other. There are two ways to configure a CDH. In a standard network configuration, the CDH is
configured in the same manner as a UDH. Each controller core in the two controller sets is connected directly to a network
switch. EGD exchanges are transmitted by whichever controller is designated as the CDH communicator.
In a direct connect network configuration, the CDH is configured with a single wire connection between the two R, S, and T
controller cores. This method is only possible if the following criteria is met:
• Exactly two controller sets are communicating.

• The redundancy on each of the two controller sets is identical (either dual or Triple Modular Redundant [TMR] or
simplex).
• All EGD exchanges on the CDH are transmitted at exactly frame rate.
If exchanges are transmitted at slower than frame rate, exchange packets from R to R can be transmitted in a different frame
than exchange packets transmitted from S to S.
To avoid voter mismatches, the ToolboxST application issues a Build warning for dual
or TMR redundancies when it detects EGD exchanges on the CDH being transmitted
at a rate other than frame rate unless it determines that network switches have been
configured for the CDH.
Warning

Public Information
➢ To configure a CDH
From the Tree View, right-click the system

item and select Insert New and Network to
display the New Network dialog box

Public Information
From the Property
Editor:
For Scope, select

PeerToPeer
For Media, select

Ethernet
For Transport,
select IP
From the Tree View,

double-click a Mark
VIe component to
display the
Component Editor

Public Information
From the Tree View, select
Network Adapter 1
From the Property Editor:
For Enabled, select True
Enter an IP Address that is

consistent with the Subnet
Mask configured in the
System Editor
For Network, select CDH
From the EGD tab

Tree View, right-click
Produced Pages
and select Add Page
Enter a page
name and
click OK

Public Information
From the Tree View,
select the new page.
From the Property Editor,

set Ethernet 1 to True.
Note: Ethernet 0 transmits

the page on UDH.
Ethernet 1 transmits on
CDH.
The EGD Page cannot be configured to transmit on more than one Ethernet network
(UDH and CDH) on this component. Only one Ethernet platform should be enabled
(True). If both are enabled, ToolboxST displays an error message.
Attention
➢ To add variables
From the Tree

View, right-click
the new page
and select Add
Variable

Public Information
3.7 Configuration Files
3.7.1 Folder Structure
Each system is saved in its own folder. Within this folder is a set of sub-folders and configuration files. The folder structure
depends on the components that are in the currently opened ToolboxST system. The folder structure includes the following
folders:
• System folder is the top-level folder that contains all other folders and files. The folder name is the same name as the
system. The files located within the system folder include:
− SystemX.tcw contains top-level information for each component.
− FormatSpecifications.xml contains format specifications that define units and scaling information for data display.
− SystemDiagram.xml contains information about the system block diagram, including both the basic diagram structure
and additional drawing shapes.
• Component folders contain configuration files for each component in the system. The exact structure of each folder
varies with the component type, but all folders have a Device.xml file that contains basic component information.
• Tools folder contains definitions for all tool components in a system. A folder for each type of tool is located within the
Tools folder, and within the folders for each tool type are additional folders for each instance of the tool.
• Library Container folders exist for each Library Container in the system. The files and folders located within the
these folders include:
− Library.xml contains attributes of the Library Container and a listing of all libraries.
− _Mylibname.xml is a file created for each library in the Container (where Mylibname is the name of the library).
− Block Diagrams is a folder containing the diagrams for the user blocks defined in each library.
3.7.2 File Formats

All configuration data for the ToolboxST application is stored in eXtensible Markup Language (.xml) format.
The .xml files used by the ToolboxST application should NEVER be modified by ANY
other application.
Caution
Configuration files can be both compressed and encrypted. 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.

Public Information
3.7.3 File Compatibility
Each .xml configuration file contains a version number that defines the versions of the ToolboxST application that can open
the file. Typically, when a system or component is saved, the configuration files use the ToolboxST version number that saved
the files.
Note The ToolboxST application cannot open a configuration file saved in a newer ToolboxST version.
Multiple ToolboxST versions can be used on a system (for example, during an upgrade), and upgrading the configuration files
is undesirable. To help prevent accidental upgrades to configuration files, you are warned if saving the file will prevent older
ToolboxST versions from opening the file.
When you are saving a system that causes a version upgrade, you are asked if you wish to continue (a backup of the original
system is created, as well).
ToolboxST Version Warning
ToolboxST Version Upgrade Warning

Public Information
3.7.4 Backward Compatibility
It can be useful to use different versions of the ToolboxST application on the same system (for example, you can add a
component in a newer ToolboxST version and still use the older ToolboxST version with the existing components). In certain
instances, it is possible to maintain backwards compatibility.
Note This feature is enabled from the System Property Editor. For further details, refer to the section System Properties.
When opening a system in a newer ToolboxST version, the following prompt may display. Click Yes for the .tcw file to be
written in a format compatible with the ToolboxST version that last saved the system. Individual components will continue to
be saved in the newer version.
Backward Compatibility Save Window
Restrictions on backward compatibility include:
• Systems saved by ToolboxST versions prior to V04.04.11C cannot enable the Maintain Backward Compatibility property
• Certain features added to the system may require the newer file format. If you attempt to use one of these features, a
message displays to ask if you wish to proceed.
Click Cancel to cancel the change. Click OK to save the change and upgrade the system to the current ToolboxST version.

Public Information
3.7.5 Master WorkstationST Computer Configuration
From the Property

Editor, select Master
WorkstationST and
from the drop-down list,
select the component to
be the master. Enter
the Path to the files
An example is RootPath\Help\Diagnostics\PAIC\PAICDiags.sp.chm, where RootPath is the path configured in the System

Property Editor.
Note Refer to WorkstationST Alarm Viewer Instruction Guide (GEI-100620) for more information about viewing language
options.

Public Information
3.7.6 System Settings
The ToolboxST application provides a variety of settings that affect system operation and feature functionality. Users can
view and configure System settings for all components in a system display when the Settings window is opened from the
System Editor. Users can also configure component settings from within each component.
➢ To view system options: from the Options menu, select Settings to display the Settings window.
System Settings Window
System Settings Properties

Appearance
Main Font Font used for most application text
Confirmations
Build When set to True, prompts for confirmation before each build
General
Auto Backup When set to True, creates backup copies of configuration files during the Save command
When set to True, automatically loads the previously loaded system when the application
Load Last System
starts
Maximum Build Errors Maximum number of errors to occur before exiting a Build (for unlimited errors, set to zero)
Send User Experience When set to True, sends anonymous user experience information to GE used for application
Information improvements
Misc
ALM System Application Life-cycle Manager type

Public Information
3.7.7 ToolboxST Log Files
The ToolboxST application produces log files that users can access to review actions and messages from devices and tools.
The log files are text (.txt) files created within the TooboxST component folders (refer to the section Folder Structure). The
following sections describe the available log files:
• History Log
• Component Log
• Build Log
• Change Log
3.7.7.1 History Log

In each component folder, the text file ComponentName History Log.txt contains a log of each save, build, and download
performed for the component. Communications errors from downloads are also recorded in this file. A date and time stamp
for the event and the user name of the user logged in at the time of each event is provided in the History Log.
Example History Log
3.7.7.2 Component Log

The Component Log is a set of text files created in a component folder containing all events that are written to the Log View
in the ToolboxST application. These files are useful in cases where the Log View was cleared and the user needs to view
previous messages.
Because the Component Log can be a very large file, a new log file is generated when a component is first opened. The date is
contained in the filename of the text file, ComponentName log DateTime.txt. Old Component Log files are not deleted.
Example Component Log

Public Information
3.7.7.3 Build Log
Log View events for the previous build are written to a file named build.log and saved in the component folder.
3.7.7.4 Change Log

Change Log files are created in the Logs folder located within each component folder (if the component supports this feature).
For further details, refer to the section Change Log.
3.8 System Editor Menus

The following table provides the available System Editor menu items and functionality.
Menu Command Used

New System Create a new system
Open System Open an existing system
Close System Close the current system
Save system-level changes to the current system (does not save component-level
Save System
changes)
File
Save System As Save the current system with a new name or to a new location
Archive System Select system components to be archived
Create System From Open the Create System Wizard
Recent Files List the eight most currently accessed systems
Exit Close the ToolboxST application and all associated component editors
Delete Remove the item(s) currently selected in the Tree View, including any non-empty groups
Add a new component to the current system, including:
Controller
External Device
Group
Shared IONet
Library Container
Insert New Network
Printer
Tool
WorkstationST
Network Time Server
Edit Network Switch
Communication Gateway
Add an existing component from a folder, including:
Device
Library Container
Insert Existing
Trender
Watch Window
LiveView
Cut Cut the selected item in the Tree View
Copy Copy the selected item in the Tree View
Paste Paste the copied item in the Tree View into the Summary View
System Information Display the System Information Editor
Selected component Display the Component Editor for the item currently selected in the Tree View
Public Information
Menu Command Used
By Type Automatically organize the Tree View by component type
By Group Organize the Tree View by components
Track Synchronize Tree View selections with Summary View selections
Memory Usage Display the currently allocated memory
Access the following EGD diagnostic tools:
View Online Statistics displays EGD exchange status from the selected component.
Only EGD Class 2 or higher components that respond to EGD Command Message
Protocol (CMP) have this diagnostic window.
WorkstationST Capture Live UDP Packets provides an EGD window only enabled in
EGD Diagnostics
a WorkstationST component with an OPC DA server configured. This allows the
WorkstationST runtime to capture up to 10,000 EGD UDP messages, then upload
them for display, printing, and exporting to .csv format.
EGD Network Load Calculation provides network load calculation to determine
memory usage.
Perform one of the following:
View EGD configuration
View Differences opens a configuration view window.
server
Work Offline allows you to work offline.
Network Status
Display defined networks in the system
Viewer
Generate the following reports:
Force Lists displays all forced system variables.
I/O displays all I/O variables
Alarm displays Alarms from all configured components
Reports Hold displays Holds from all configured components
Event displays Events from all configured components
Find Unlinked Blocks displays unlinked blocks from all configured components
Firmware Versions allows you to select devices and display a report of the installed
firmware versions for each
FOUNDATION Fieldbus Display the device definition window (Refer to the chapter Mark VIe Control FOUNDATION
DD Manager Fieldbus Interface.)
Online Work online
Download Select components to scan for downloading
Control Constants
Import or export system-level control constants and parameters
and Parameters
Upgrade Components Upgrade any or all configured components at the system level
Instance Components Instance any or all configured components at the system level
System Restore Password Restore any password protection that was unlocked for the component or clear the Undo
Protection history
Allows the user to configure the Wind Turbine Control for Wind Farm Management for
multiple devices at one time.
Set Wind Turbine
This menu item is only visible if the V300 Advanced Options system setting for the Mark
Control Configuration
VIe controller is enabled. From the Options menu, select Settings, Mark VIe Controller,
and set V300 Advanced Options to True.
Options Settings Configure system settings
Cascade Arrange open Component Editors in a layered style
Window Tile Arrange open Component Editors in a grid style
Close All Close all open Component Editors
CMS Refer to the section CMS Menu Items.

Public Information
Menu Command Used
Displays available help files, such as ToolboxST System Editor and Mark VIe Component
Contents
Editor
Displays current information about your ToolboxST software version in the Release Notes
Release Notes
Viewer window
Displays the document ControlST Software Suite How-to Guides (GEH-6808) (if
How to Guides
Help available)
Send Problem Report Send a problem or suggestion to the ToolboxST development team
Create
Retrieve logs and other troubleshooting information from all system devices, and combine
Troubleshooting
them into a single report
Report
About Open the About screen with version and platform information
Public Information
3.9 System Information Editor
The System Information Editor enables the user to modify and configure system information including alarm system settings,
format specifications, users and roles, and other items that apply to all system components.
Note 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 Edit menu, select System Information to
display the System Information Editor Tree View.
System Information Editor Tree View

Public Information
3.9.1 Alarm System
The following sections provide instructions to configure the alarm system.
System Information Editor Alarm System Tree View Items
3.9.1.1 Alarm Block Templates
Attention
Alarm Block Templates are used in conjunction with the ANALOG_ALARM block in certain controller configurations. The
ANALOG_ALARM block provides Analog Alarm documentation defined in application code; it also allows automatic
configuration of the Alias properties of each Alarm associated with the Analog Alarm.
Note For further details on these blocks, refer to the Mark VIe Controller Standard Block Library Instruction Guide
(GEI-100682).
Public Information
➢ To add an Alarm Block Template
1. From the System Information Editor Tree View, right-click Alarm Block Templates.
2. From the shortcut menu, select Add Alarm Block Template.
Enter a name
for the template
and click OK
➢ To configure automatic Alias names for a template

1. Add Alias names. From the Data Grid, enter an Alias name for each SubVariable.
System Information Editor Alarm Block Templates Alias Names
2. From the Tree View, select the Alarm Block Template.

3. From the Tree View, expand the template and select Attributes.
4. Define any attributes needed for the Alias properties. Typically, these attributes will have Prompt For Input set to
True.

Public Information
3.9.1.2 Alarm Classes
Alarm Classes are groups or collections of related alarms that share a common priority and color scheme.
➢ To edit Alarm Classes: from the System Information Editor Tree View, select Classes.
A Data Grid with the existing Alarm Classes displays in the Summary View.
Note When colors are selected, unnamed colors may display in the Data Grid as RGB codes.
Public Information
Alarm Class Properties
Ack Background Color Displays the background color for an alarm in the Acknowledged state
Ack Foreground Color Displays the foreground color for an alarm in the Acknowledged state
Ack Inner Border Color Displays the inner border color for an alarm in the Acknowledged state
Ack Outer Border Color Displays the outer border color for an alarm in the Acknowledged state
Alarm Background Color Displays the background color for an alarm in the Alarm state
Alarm Foreground Color Displays the foreground color for an alarm in the Alarm state
Alarm Inner Border Color Displays the inner border color for an alarm in the Alarm state
Alarm Outer Border Color Displays the outer border color for an alarm in the Alarm state
Blink Background Color Displays the background color for the blink state of an active unacknowledged alarm
Blink Enabled If set to True, enables blinking ability
Blink Foreground Color Displays the foreground color for the blink state of an active unacknowledged alarm
Blink Inner Border Color Displays the inner border color for the blink state of an active unacknowledged alarm
Blink Outer Border Color Displays the outer border color for the blink state of an active unacknowledged alarm
Normal Background Color Displays the background color for an alarm in the Normal state
Normal Foreground Color Displays the foreground color for an alarm in the Normal state
Normal Inner Border Color Displays the inner border color for an alarm in the Normal state
Normal Outer Border Color Displays the outer border color for an alarm in the Normal state
Specifies which image to use when an alarm is in the Acknowledged state.
Acknowledge Image An Alarm Symbol must be assigned to the Alarm Class and the Symbol selection must be Custom
before the image can be imported.
Specifies which image to use when an alarm is in the Active state.
Active Image An Alarm Symbol must be assigned to the Alarm Class and the Symbol selection must be Custom
Specifies the alternate image to use when Blink is True and the alarm is in the Active state.
Blink Image An Alarm Symbol must be assigned to the Alarm Class and the Symbol selection must be Custom
Specifies the image to use when an alarm is in the Normal state.
Normal Image An Alarm Symbol must be assigned to the Alarm Class and the Symbol selection must be Custom
Description Displays the description in the primary language (English)
Display Priority In Symbol If set to True, displays the Priority in the alarm symbol in the WorkstationST Alarm Viewer
Displays the name of the Alarm Class
Name
Limited to five characters if using an SDB.
Priority Alarm Class priority (1 to 99, where 1 is the highest priority)
Sound Reference Sound definition to select when an active Alarm displays in the Alarm Viewer
Symbol displayed for a particular Alarm Class (Read-only)
Symbol
An Alarm symbol can be associated with an Alarm Class.

Public Information
3.9.1.3 Alarm Definitions
Alarm Definitions provide a template of the Analog Alarm parameters and their properties. When an Analog Alarm is created
in a component, these values are used to configure Analog Alarm parameters.
➢ To add an Alarm Definition
Public Information
➢ To edit Alarm Definitions: from the Tree View, expand Definitions and select the Alarm definition.
Note $Desc (and $2ndDesc) may be used for the Alarm Description and Second Language Description for the Analog
Alarm when the Alarm Parameter is created in the component.
Alarm Definitions Columns

Column Description
Alarm Parameter Name of the Alarm (read-only)
Alarm State Parameter state, the property configured in the Alarm State Definition (read-only)
Alarm state for the second language, configured in the Alarm State Definitions
Second Alarm State
(read-only)
Alarm Description Parameter description for this Alarm
Second Language Alarm Description Second language parameter description for this Alarm

Public Information
3.9.1.4 Alarm Inhibit Groups
The Alarm Inhibit Groups feature uses standard blockware to suppress the generation of alarms in the controller. It also
removes the suppressed alarm from the alarm queue (if present), and from all alarm displays in the control system, including
the WorkstationST Alarm Viewer.
➢ To configure alarm inhibit groups
From the Data Grid, add

one or more variables
From the System

Information Editor
Tree View, expand
Inhibit Groups and
select a controller
From the Component Editor Software tab,

locate the defined alarm in theData Grid
If InhibitLossOfPressure is set to True, the corresponding

variable, FeedWaterPumpA_LossOfPressure, will not
generate an alarm when it transitions to True. It will also be
removed from all alarm displays
Public Information
A signal driven in the application code
enables the Alarm Inhibit group and
inhibits the alarm in the Alarm Viewer.
3.9.1.5 Alarm Sounds

Use the System Information Editor to define options that annunciate certain sounds within the Alarm Viewer. A specific
sound definition is assigned to an alarm class.
➢ To edit sounds
1. From the Tree View, select Sounds to edit the configured sounds in the Summary View.
2. In the Data Grid, enter a Sound Name (such as chimes for this example).
3. From the Sound Type column, select a sound type from the drop-down list (such as Wave File for this example).
4. From the Wave File column, click the Ellipsis (...) button, then navigate to select the file type.

Public Information
The following table lists the available properties when a Sound is selected in the Data Grid.
Sound Properties
Time lapse between sounds (from 100 to 10,000 ms). The Repeat Quantity property must be 1 or
Delay
more.
Duration Sound’s duration (from 100 to 10,000 ms)
Frequency Sound’s frequency (range is 100 to 500 Hz)
Name Sound’s name
Repeat Quantity Number of times the sound is repeated
Sound Type Type of sound annunciated; options are Tone, Wave File, and Text to Speech
If selected as the Sound Type, displays the name of the Wave File. When the system information is
Wave File
saved, the wave files are published to the Master WorkstationST computer
3.9.1.6 Alarm State Definitions

Alarm state definitions are user-defined descriptions for analog Alarm parameters.
➢ To edit alarm state definitions: from the System Information Editor Tree View, expand Alarm System and select
State Definitions to display the parameters in the Data Grid.
Alarm State Definitions Columns

Column Description
Alarm Parameter Available Alarm state condition for the Alarm state values being entered
Alarm State Primary language Alarm state description that displays in the Alarm Viewer
Second Alarm State Second language Alarm state description that displays in the Alarm Viewer
Public Information
3.9.1.7 Alarm Symbols
Alarm symbols can be associated with an Alarm Class and feature. The associated symbol uses the same alarm color and
Priority configuration and displays in the Alarm Viewer and on CIMPLICITY screens. Only one symbol can be associated
with an Alarm Class; however, the same symbol can be used by multiple Alarm Classes.
➢ To edit Alarm symbols

1. From the System Information Editor Tree View, expand Alarm System and select Symbols to display the alarm
parameters in the Data Grid.
2. From the Symbol column for an alarm, select a symbol from the drop-down list.
3. From the Alarm Classes column, click the Ellipsis (...) button and select an alarm class for the symbol.

Public Information
➢ To configure sort method for alarm symbols
1. From the Tree View, select Symbols.
2. From the Property Editor, select either Option 1 or Option 2.
Option 1 (Alarm State, Priority, Acknowledgement State) includes:
• Priority 1 Active Unacknowledged

• Priority 1 Active Acknowledged
• Priority 1 Normal Unacknowledged
• Priority 1 Normal Acknowledged
Option 2 (Acknowledgement State, Alarm State, Priority) includes:

Public Information
3.9.2 Control Server Set Templates
The Control Server Set Templates item is used to create custom templates for use in configuring a High Availability (HA) or
Simplex Control Server set. Default HA and Simplex templates are selected when a Control Server component is initially
created in the system to provide a starting point for a typical Control Server configuration, then custom templates may be
created using the System Information Editor Control Server Set Templates item.
Note For further details, refer to the WorkstationST Control System Health Instruction Guide (GEI-100834).
➢ To create a custom HA or Simplex template

1. From the System Information Editor Tree View, select Control Server Set Templates.
2. Select either HighAvailability or Simplex from the Tree View to display the configuration properties in the Data Grid.
3. From the Data Grid, edit the properties to create a custom configuration template.
High Availability Control Server Set Template Properties

Device Properties
Cluster Name Cluster name
High Availability Set to True if the server set has multiple Virtualization Servers configured for High Availability
Name Device name
Hypervisor
Hypervisor Type Type of hypervisor hosted by the servers in the server set. Control Server setting is ESXi.
Username of the read-only hypervisor account used by the Control System Health (CSH) feature for
Password
collecting status data
SNMP community name
Some Allied Telesis switch models do not accept special characters such as the @ symbol, so these
SNMP Community Name switches cannot use the standard GeS@lem9ro SNMP community name. This is a common configuration
error where all of the switches are configured with the default community name, while certain switches are
using a different community name.
Password configured for the read-only hypervisor account used by the CSH feature for collecting status
Username
data from the servers
VSphere
vCenter Host Host name or IP Address of the vCenter Server VM (typically named HC1) that is managing the server set

Public Information
High Availability Control Server Set Template Properties (continued)
Username of the read-only vSphere account used by the CSH feature for collecting status data from
vCenter Username
vCenter
Password configured for the read-only vSphere account used by the CSH feature for collecting status data
vCenter Password
from vCenter
Simplex Control Server Set Template Properties

Device Properties
High Availability Set to True if the server set has multiple Virtualization Servers configured for High Availability
Name Device name
Hypervisor
Hypervisor Type Type of hypervisor hosted by the servers in the server set. Control Server setting is ESXi.
Password Username of the read-only hypervisor account used by the CSH feature for collecting status data
SNMP community name
Some Allied Telesis switch models do not accept special characters such as the @ symbol, so these
SNMP Community Name switches cannot use the standard GeS@lem9ro SNMP community name. This is a common configuration
error where all of the switches are configured with the default community name, while certain switches are
using a different community name.
Password configured for the read-only hypervisor account used by the CSH feature for collecting status
Username
data from the servers
Note Refer to GEI-100834 for a full description of all configuration properties.
Public Information
3.9.3 Diagnostic Translations and Rationalization
The Diagnostic Translations and Rationalization feature provides two options:
• Allows second language display of the product diagnostic messages from controllers, I/O modules, and WorkstationST
devices
A second language must be selected from the Component Property Editor before using
this feature or it will not function properly.
Attention
• Allows configuration of diagnostic alarm information to support alarm help features in the WorkstationST Alarm Viewer
Note Additional alarm rationalization properties can be edited for each diagnostic message. (In the Tree View, the
WorkstationMessages node provides descriptions that may be translated but are not associated with diagnostic
messages. These descriptions do not allow for configuration of the alarm rationalization properties).
Example Diagnostic Alarm Rationalization Properties

Public Information
Diagnostic Translations and Rationalization Properties
Alarms and Events
Alarm Class Selected system configured Alarm Class
Enable or disable the ability for an operator to shelve an alarm. A shelved
Alarm Shelving alarm will be temporarily removed from the alarm display, keeping nuisance
alarms from cluttering the Alarm Viewer.
Alarm Shelving Max Duration Maximum time in minutes that an alarm can be shelved
Enable or disable the Return to Normal (RTN), Unacknowledged alarm
state. The returned to normal unacknowledged alarm state is reached when
Auto Reset
the process returns within normal limits and the alarm clears automatically
before an operator has acknowledged the alarm condition.
Child Alarms Name of the child alarms (comma-separated list of variables)
Consequence of Inaction Consequence of inaction
Consequence of inaction if the operator does not address this alarm in the
Second Language Consequence of Inaction
second language
Operator Action Action the operator should take to avoid the defined consequences
Action the operator should take to avoid the defined consequences in the
Second Language Operator Action
second language
Indicates how urgent it is to perform corrective actions to avoid defined
Operator Urgency
consequences
Indicates how urgent it is to perform corrective actions to avoid defined
Second Language Operator Urgency
consequences in the second language
Potential Causes Potential causes of the alarm
Second Language Potential Causes Potential causes of the alarm in the second language
Plant area used to group variables into logical groupings based on plant
Plant Area
layout for display in the WorkstationST Alarm Viewer
General
Message Id that corresponds to a given diagnostic message
Message Id Refer to the following figure for an example view of a diagnostic message in
the WorkstationST Alarm Viewer.
Languages
English Message Text Diagnostic message in English, as read from the product .dlls
Primary Language Message Text Diagnostic message translated in primary language
Second Language Message Text Diagnostic message translated in the second language
Public Information
➢ To view diagnostic alarm message help (corresponds to the Message Id property) in Alarm Viewer:
right-click the alarm message (Message ID 547 for this example) and select Alarm Help.
The Alarm Viewer Help dialog box displays the alarm help for that diagnostic alarm. When the user preferences are set to use
a second language, the second language property values are displayed in the alarm help in the translated second language.

Public Information
➢ To export all diagnostics to a .csv file
1. From the Component Property Editor, verify that a second language has been configured.
2. From the System Editor Tree View, double-click the system item to display the System Information Editor.
3. From the System Information Editor Tree View, right-click Diagnostic Translations and Rationalization and
select Export Product Diagnostics....
Note The Export Product Diagnostics option creates an All_Product_Diagnostic Translations.csv file that contains
diagnostics for all I/O packs installed on this computer. It may be opened using Notepad or an .xml spreadsheet.
4. From the Tree View, right-click Diagnostic Translations and Rationalization and select Import Diagnostics.
5. Select the All_Product_Diagnostic Translations.csv file.
6. Expand the Diagnostic Translations and Rationalization item to display each individual system component,
including diagnostics grouped as Common. Diagnostics text can be translated in either the .csv file or the System
Information Editor.
Note Translations for common diagnostics need only be entered once.
7. Select a component to display the message text containing the Second Language column with empty text.
8. It is the user’s decision as to whether they will send the complete list or individual products to a translation company. To
create an individual .csv file for a particular component, right-click a component and select Export these
Diagnostics.
Note Selecting the Diagnostic Translations item exports all I/O pack items within to a single .csv file. However, if an
individual I/O pack is selected, the diagnostics for that I/O pack only are exported.
Public Information
9. Open the .csv file to read the instructions for translation.
➢ To import translated diagnostic messages

1. From the HMI that runs the ToolboxST application, verify that the .csv file contains the new column with translated
messages.
2. From the System Editor Tree View, double-click the system item.
3. From the System Information Editor, if all messages were translated, select Import Diagnostics and navigate to
the All_Product_Diagnostic Translations.csv file.
4. For an individual product, from the Tree View expand the Diagnostic Translations and Rationalization item to
display the individual product. Right-click, select Import Diagnostics and select that .csv file.
If you select that product name, the message text displays with the second language column containing the translated text.
5. Open the Component Editor for each device in the system with translated diagnostics and click Save. This adds the
second language descriptions to the controllers/devices in a running system.

Public Information
3.9.3.1 Validate Diagnostics
If you are using the Configuration Management System (CMS), perform a Get Latest command for all controllers on your
computer. The Validate Diagnostics command verifies the I/O packs attached to a particular system, then confirms that a
translation has been entered for each I/O pack in the list of required packs.
Note Any errors or warnings that occur during validation display in the Component InfoView. Double-click an error or
warning to be connected to that diagnostic.
The Validation command applies to all translations entered into a system. Even if you have Common selected when you start
to validate, all translations are validated. Warnings and errors do not prevent controllers from running the Build and
Download commands, but rather ensure that all Second Language diagnostic text displays correctly at runtime.
Note The text displays in English if there is no Second Language translation for a particular diagnostic.
3.9.3.2 Delete Diagnostics

Only I/O packs used on your job need to have translations entered. Unused I/O packs can be selected from the Tree View and
deleted. You have the opportunity to cancel the Delete command before it’s performed. However, once a Delete command is
performed, it cannot be undone.
Note This command only deletes the selected translation records. If a diagnostic occurs and its translation record was
deleted, it still displays in English.
➢ To add a missing translation to a running system

1. From the Tree View, select an I/O pack, add the translated text in the Second Language Message Text column, and
click Save.
2. Open all controllers that use the I/O pack with the missing translation and perform a Save command.
Note If the configuration in the ToolboxST application is equal to the configuration running on the controller, the new
information is published to the EGD configuration server. The next time the diagnostic occurs, the translated text displays. If
the configuration and the running controller are not equal, the controller must be downloaded for the changes to take effect.
Public Information
3.9.3.3 Display Second Language Diagnostics
Displaying Second Language diagnostics can be selected from two different locations.
➢ To display Second Language diagnostics
From the
WorkstationST
component
General tab,
select General
From the Property

Editor, select Use
Second Language .
If you want all users

of this component to
be able to display a
second language,
set to True
Or
From the WorkstationST Status Monitor

tray icon, right-click and select Regional
Settings and Use Second Language
Note When you select Use Second Language from Regional Settings, that becomes your permanent default setting,
regardless of what is configured in the ToolboxST application.
The Alarm Viewer provides a means to override this setting.

The option Select Active Measurement System allows you to specify either English or metric measurements.

Public Information
3.9.4 Format Specifications
Format specifications control how variables are presented in an HMI. They are grouped into sets that 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 minimum and maximum 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:
Using this formula, a conversion from Celsius to Fahrenheit would be calculated by the HMI as follows:
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.
Public Information
➢ To create a Format Specification Set
1. From the System Editor Edit menu, select System Information.
2. From the Tree View, right-click Format Specification Sets 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 Information Editor Tree View, select Format Specification Sets.
A Data Grid containing format specifications displays in the Summary View.
2. From the Name column, enter a Name for the new Format Specification, or right-click a Format Specification Set and
select Add Format Specification Set.

Public Information
The following table lists the available properties that can be modified to configure the Format Specifications Sets.
Note When a Measurement System is selected, HMI applications scale the display limits accordingly.
Format Specifications Sets Properties

Display Low Limit Default lower limit for HMI displays (bar graphs, trending, and such)
Display High Limit Default upper limit for HMI displays (bar graphs, trending, and such)
Engineering Max Maximum value of the range used for unit conversions
Engineering Min Minimum value of the range used for unit conversions
Can be assigned to a format specification. When a variable is attached to a format specification
Enumerations with enumerations, those enumerations are used, unless they are overridden by enumerations
locally defined on the variable.
Number of digits to display to the right of the decimal point (for example, a precision of two
Precision
displays the fraction 1/3 as .33)
Units Text that identifies the format specification unit
Description Variable description
Format Spec Set Selected format specification
Group Optional name that can be used to sort and organize format specifications
Measurement System Measurement system (Metric or U.S.) to which the unit belongs
Unique name for the format specification. If the system data is Put to an SDB, a limit of 12
Name
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, from the drop-down list, select a
measurement system.
Public Information
3.9.5 HMI Resources
An HMI allows you to organize and customize access to Alarms and live data. Variables have an HMI resource property that
can be set to one of the HMI resources defined here. Each resource has a name and an optional description.
➢ To add device names and descriptions: from the Tree View, select HMI Resources.
3.9.6 HMI Screens

HMI screen files are downloaded to the HMI WorkstationST components. The HMI screen files are managed from the System
Editor, which includes the following actions:
• Adding and deleting screen files from the System Information Editor
• Defining the use of screen files by HMI WorkstationST components
• Modifying screen files from the system .tcw file location or the Master location if CMS is not enabled
• Downloading screen files from the Master location to the HMI WorkstationST components
Note It is recommended that HMI screen files be managed from the System Information Editor, although they can also be
managed from the WorkstationST components.
3.9.6.1 HMI Screen File Locations

There are typically three HMI screen file locations:
• The Master location is the path defined at the system level. This location is displayed in the System Editor Property
Editor.
• The System File location is the HMIScreens folder (in the same location as the .tcw file).
• The HMI WorkstationST location is the path defined in the HMI Config tab in the WorkstationST application.
Master
location
path
Master Location

Public Information
3.9.6.2 View HMI Screen Files
The HMI screen files are accessed from the System Information Editor.
➢ To view the HMI screen files

1. From the System Editor Edit menu, select System Information.
OR
From the System Editor Tree View, double-click the system item.
2. From the Tree View, expand HMI Screens to display the HMI WorkstationST components and HMI screen files in the
Summary View.
3.9.6.3 Add and Delete HMI Screen Files

➢ To add an HMI screen file to the system
Note When CMS is enabled, the system must be checked out to add screens.
1. From the System Information Editor Tree View, right-click HMI Screens (or any item under it or in the
Summary View) and select Add HMI screen file to display a Select a Folder dialog box.
2. (Optional) Enter the Folder Name in which the HMI screen files will be stored. (This folder will be located within the
HMIScreens folder at the system .tcw location.)
3. Click OK to add the screen file to the HMIScreens root folder.
4. Browse to and select the screen file or files you want to add and click Open. The screen file is added to the system file
location.
Public Information
➢ To delete an HMI screen file from the system
1. From the Summary View, select the screen file to be deleted.
2. Right-click the screen file and select Delete, or, from the toolbar, click the Delete icon, or from the Edit menu, select
Delete. The screen file(s) should be deleted from the HMIScreens folder in the .tcw location.
3.9.6.4 Define HMI Screen Use

A particular HMI WorkstationST component may not require all screen files in the system. The use of specific screens for
each component is defined from the System Information Editor. When a screen is added to the system, all HMI
WorkstationST components defined for HMI Screen Files in the System Information Editor have access to that screen by
default.
➢ To define the use of HMI screens for a WorkstationST component

1. From the System Information Editor Tree View, expand HMI Screens and select HMI WorkstationSTs.
2. From the Summary View, select a screen.

3. From the column for the selected WorkstationST component, select True to enable that component to use that screen or
select False to disable use.
Note When a particular WorkstationST component is selected in the Tree View, the Use property can also be changed from
both the Summary View and the Property Editor.

Public Information
3.9.6.5 Download HMI Screen Files
The HMI screen files are downloaded from the Master location to the WorkstationST component location. Screen files can be
downloaded either automatically (through a configuration property set for the WorkstationST component) or manually.
Note If a WorkstationST component is configured for automatic download, a manual download cannot be performed.
When pre-configured for automatic download, the WorkstationST application periodically compares the date of the file in the
Master location to the date of the file in the WorkstationST location. When an HMI screen file is saved to the Master location,
its date changes. The component detects the change and automatically copies the new file to the WorkstationST HMI screens
folder. HMI screen files can be downloaded to an HMI WorkstationST component without checking out the system or
individual HMI screens from the Configuration Management System (CMS).
➢ To manually download HMI screen files from the Master location to the designated HMI WorkstationST
components
1. From the System Information Editor Tree View, select HMI Screens or HMI WorkstationSTs.
2. From the Summary View, select one or more HMI screen files.
3. From the Summary View, right-click to select Download selected HMI screens.
Note Any screens selected for download that are not configured to be used on the WorkstationST component will not be
downloaded.
When not pre-configured for automatic download, the WorkstationST application compares the local HMI screen dates with
the Master during a build of the WorkstationST component. An option to download the mismatched screens is then presented
to the user when the WorkstationST component is downloaded.
Public Information
3.9.6.6 Display HMI Screen File Status
The System Information Editor displays the status of HMI screen files, comparing the date and size of the master HMI screen
file in the Master location with the date and size of the HMI screen file in the WorkstationST location. The Status column
reflects whether the HMI WorkstationST screen file is current with the Master file.
➢ To update HMI screen file status

1. From the Tree View, select HMI Screens or an HMI WorkstationST on a WorkstationST component.
2. From either the Tree View or the Summary View, right-click to select Refresh HMI screen data.
The Summary View Status column displays either Up to Date or Out of Date for the HMI WorkstationST component using
those files. Locally Modified may also display if a change was made at the HMI WorkstationST location.
The size and date of both the Master and the WorkstationST HMI screen file display in the Property Editor.
3.9.6.7 Edit HMI Screen File

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

1. From the System Information Editor Tree View, select HMI Screens.
2. From the Summary View, select an HMI screen file and right-click to select Edit selected HMI screen.
Edit an HMI Screen File with CMS Enabled

When CMS is used, the CMS Repository is the source of the HMI screen files. The file edited is the one in the System .tcw
location. When editing is completed, the screen file is checked back into the CMS Repository, then published, at the user’s
discretion, to the Master location so it can be used by all the HMI WorkstationST components that are configured to use it.
Note The process of editing an HMI screen file is different, depending on whether CMS is enabled.
• From the System Information Editor, right-click the file to be edited and check it out by selecting CMS and
CheckOut. The checked-out status displays.
• Right-click the screen file again and select Edit. The file opens in CimEdit for editing.
• Save the edits and close the file.
• Right-click the file and check it in by selecting CMS and CheckIn to update the file in the System .tcw location.
• A message displays asking if you wish to publish the changes to the Master. Typically, you will click OK. This updates
the screen file in the Master location.

Public Information
Edit an HMI Screen File without CMS Enabled
Note The edit window displayed depends on the state of both the Master file and your system file.
The source of these HMI screen files is the System .tcw location. When CMS is disabled, the Check Out function copies the
file from the System .tcw location to the computer where the editing is taking place. The file is then checked back in to the
System .tcw location.
There are three possible states, as follows:
• System HMI screen file is not locked for editing

• System HMI screen file is locked by another user
• System HMI screen file is locked by you from a previous edit session
3.9.6.8 Archive Files

A project (or system) can be archived into a zip file from the System Editor. However, the archive does not retrieve the HMI
screen files stored in either the Master or the WorkstationST location. It archives the HMI screen files in the System .tcw
location.
Note To ensure that the latest screens from the Master are included in the archive, perform the Copy Master to Local
function before the archive function.
When an archive is unzipped, the HMI screen files are located in a subdirectory relative to the location of the system’s .tcw
file. For example, if the system is called abcSystem, and is stored in C:\Site, the .tcw file is located at C:\site\abcSystem
\abcSystem.tcw. The HMI screen files are located at C:\site\abcSystem\HMIScreens. This is the System .tcw location of the
HMI screen Files.
3.9.6.9 Copy HMI System Files

➢ To copy files from the System .tcw Location to the Master location or from the Master location to the
System .tcw location
1. From the System Information Editor Edit menu, select a screen, then select System.
2. To copy a screen file from the System .tcw location to the Master location, select Copy Local to Master.
3. To copy a screen file from the Master location to the System .tcw location, select Copy Master to Local.
Note If files already exist in the Master location when copying from the system, a warning dialog displays to ask if you wish
to overwrite the existing files.
Note The Copy Local to Master is not typically required except when setting up a system or the Master WorkstationST
component for the first time. The Copy Master to Local is required prior to performing a system archive to ensure that the
latest screens from the Master have been copied to the System .tcw location before creating the archive.
Public Information
3.9.7 Network Switch Layouts
Beginning with ControlST V07.05.01C, Network Switch Layouts provide enhanced network switch management features.
Network Switch Layouts provide the mapping between the internal switch interfaces and the physical switch ports, which
enables the Network Monitor or CSH feature to read the switch data over SNMP and display the data with the correct
physical port location.
Two types of Network Switch layouts are supported:
• GE standard switch layout definitions: standard switch layout definitions that are provided as part of the ControlST
product. The standard switch layout files correspond to the standard switch types qualified for NetworkST. GE standard
layouts cannot be modified.
• Custom switch layout definitions: custom switch layouts can be created to support non-standard switch types.
The use of switch layouts has been designed to provide the following improvements:
• Support for newly qualified switch types independent of ControlST releases: in previous ControlST versions, the
network switch layouts were hard coded in the release. Support for newly qualified switches was only available as part of
the next ControlST release and required, at a minimum, an update of ToolboxST and WorkstationST. ControlST
V07.05.01C and later versions moved the switch-specific code to a switch layout file. The switch layout file is updated as
new switches are qualified, and this file can be sent to existing sites that need to support the new switch type
independently of the ControlST release cycle and without the need to upgrade to a newer version of ControlST.
• Minimize the impact of switch operating system changes: network switch vendors periodically update the switch
operating systems, and in some cases these changes have required ControlST updates to support new behaviors that were
introduced as part of the operating system update. The switch layout files have been designed to minimize the impact of
internal switch layout changes. In the event that internal switch changes cannot be supported by the existing switch
layout, a new switch layout will be created that will be included in the next ControlST release and distributed to affected
sites.
• Support for unqualified (custom) switch types: GE standard switch layouts are provided for all NetworkST standard
switch configurations. Support for non-standard switch types can be added by creating custom layout files.

Public Information
3.9.7.1 Configure Switch Layouts for New Sites
When configuring a new system with ControlST V07.05.01C or later, only the GE standard switch layouts are available by
default. The GE standard switch layouts correspond to the standard switch types supported by NetworkST. The following
figure displays the switch device Switch Layout Type property with the list of available switch layout types.
Note Layouts for GE standard NetworkST switch types always begin with GE, followed by the switch manufacturer, model
number, and any model-specific options (GE_<Manufacturer>_<Model>_<Options>).
The GE standard switch layouts support any NetworkST qualified Cisco® switch. Switches from other manufacturers have
been supported on a legacy basis but it is not anticipated that these switches will be used often in new systems. If support for a
legacy switch type is required on a new system, legacy switch support can be enabled using the following procedure.
Public Information
➢ To enable legacy switch support on a new system
1. From the System Information Editor Tree View, select Network Switch Layouts to display the supported switch
layouts.
2. From the Property Editor, set the Enable Legacy Switch Support property to True to display the legacy switch
layouts.

Public Information
Public Information
When this setting is enabled (True), the legacy switch types are available for selection when modifying the network switch
configuration, as shown in the following figure.
Note Always use the GE standard switch layouts when available. For example, always use the GE_CISCO_2960_24Port
layout but never use the legacy Cisco_Catalyst_2960 layout. In the case where a supported legacy switch such as the
Enterasys_N1 is required, the legacy layout must be used because there are no GE standard layouts defined for Enterasys
switches.
Refer to section Custom Network Switch Layout Configuration for the procedure to create custom switch layouts. For
example, the GE standard switch layouts only support 24 port versions of the Cisco 2960 switch. Support for a 48 port Cisco
2960 switch is not available with the GE standard layouts, but a custom switch layout can be created to allow monitoring of
this non-standard switch type.
Note The custom layout is used for qualifying new switch types and cannot be used for normal operation. The switch is not
monitored when the custom layout is selected.

Public Information
3.9.7.2 Manage Switch Layouts when Upgrading Existing Sites
When a system that was created by an older version of ControlST is opened in ToolboxST V07.05.01C or later, the legacy
switch support is enabled by default, and the existing switch configurations remain valid without opening or building the
existing switch configurations. Although it is not necessary to upgrade the switch configurations, the best practice is to
upgrade any Cisco switches to the GE qualified layout if one is available. For example, a switch configured for the legacy
Cisco_Catalyst_2960 layout should be updated to use the GE_CISCO_2960_24Port layout. Updating the switches to the GE
qualified switch layouts will insulate the site against future switch operating system changes that are most likely to occur if a
switch fails and is replaced with a newer version.
Whenever a GE standard switch layout is selected for a switch type that supports
stacking, stacking is enabled by default and the number of switches in the stack is
initialized to the maximum stack size defined by the switch layout type. Do not forget
to modify these properties to match the actual layout of the switch being configured.
Attention
Public Information
3.9.7.3 Add Support for Newly Qualified NetworkST Standard Switch Types
New GE standard switch layouts are created as new switch types are qualified for NetworkST. The new standard switch
layouts are added to the GeSwitchLayouts.xml file, which is then used to update older versions of ControlST with the latest
standard switch layouts. Any ControlST version that supports the GE standard switch layouts (V07.05.01C and later) can be
updated to support the latest GE standard switch layouts by updating the GeSwitchLayouts.xml file. Simply copy the latest
GeSwitchLayouts.xml file to the top level of the ToolboxST project directory (the directory where the .tcw file is located),
then close ToolboxST and re-open the project to make the new GE standard switch layouts available.
Note For systems under CMS source control, first check out the system configuration (check out from the root tree node of
the system overview), then copy the new GeSwitchLayouts.xml file in place of the existing one. Open the System Information
Editor by double clicking on the system overview root tree node. Make some change to something in the editor and change it
back so the document requires saving. Save the editor and close it. Check the system back into CMS.
3.9.7.4 Custom Network Switch Layout Configuration

The Network Switch Layouts in ToolboxST provide the mapping between the internal switch interfaces and the physical
switch ports, which enables the Network Monitor or CSH feature to read the switch data over SNMP and display the data
with the correct physical port location.
ToolboxST provides GE standard switch layouts that correspond to all supported NetworkST standard switch types. Support
for non-standard switch types can be configured by creating custom Network Switch Layouts, which are used to enable the to
monitor non-standard switch types.
Note The use of a non-standard switch implies that the user assumes responsibility for all aspects of the switch configuration
and its interaction with and impact on the network. Switch configuration is beyond the scope of this document. SNMP V1 or
SNMP V3 must be enabled and properly configured in the switch to enable monitoring of the switch values.
Network Switch Layouts allow users to enter unique physical port-to-port faceplate and interface name mapping. The
Network Switch Layouts include a set of legacy switch layout types that were supported before the ability to add custom
switch layouts existed. These legacy switch layout types cannot be edited, but are presented for completeness and to allow
easy version upgrade. There is also a set of GE standard switch layout definitions that cannot be modified but are included as
validated switch layouts.

Public Information
➢ To add a custom Network Switch Layout
1. From the System Information Editor, expand the Network Switch Layouts.
2. From the Tree View of layouts, right click a port, select Add Switch Layout, and enter a unique name for the layout.
(As an alternative, you may copy an existing one.)
3. From the Property Editor, modify the properties to configure the switch layout.
Public Information
Network Switch Layout Configuration Properties
General
Is a legacy layout Legacy layouts; cannot be modified (False)
Is Stackable Switch is a stackable switch (default is True)
Maximum number of stacked switches allowed. This setting limits the Stacked Switch Group Size
Maximum Stack Size
setting in the Network Switch component editor.
Sets the number of ports on each switch. For a stacked switch this number controls how many
Number of ports on each ports are defined as the Stacked Switch Group Size is set. For a non-stacked switch this controls
switch the total number of ports. For the switch layout, all ports are shown per the Maximum Stack Size
and Ports Per Switch setting.
Standard GE switch configurations are part of the product. This switch layout is a standard
Standard Layout
configuration; cannot be modified (False).
Name of the type of switch. There are some pre-defined legacy switch types that were used by
Switch Layout Type
previous ToolboxST / WorkstationST versions, which are included but cannot be modified.
Manufacturer of the network switch. There are some manufacturers that require special SNMP
Switch Manufacturer
behavior by the WorkstationST Network Monitor.
In the Data Grid View, each non-legacy switch allows modification to port information.

Public Information
Switch Layout Data Grid Column Details
Column Description
Port Location Read only indication of the stack and face plate port number
Port number on the switch nameplate. This number is the same on all individual switch ports for a
Faceplate Port Number
stacked switch, but the Stack Number will be different.
Faceplate port name. This is used in the port location which is displayed in the network status
Faceplate Port Name
viewer.
Port Number Port number returned from SNMP queries and shown using the switch command line interface
Faceplate Post Port Text Text is appended after the port number into the Port Location field
Interface name that can be viewed through the switch command line interface (for example,
Interface Name
FastEthernet1/4)
Stack Number Stack number for a stackable switch (1 for a switch that does not support stacking)
3.9.8 Plant Areas

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

Users and roles for ToolboxST are configured from the System Information Editor. Each user is assigned a role with
privileges and an optional set of resources. User names correspond to Windows users (work groups or domain users).
➢ To define Users and Roles

1. Open the ToolboxST system .tcw file.
2. From the System Editor menu, select Edit, then select System Information.
3. From the System Information Editor Tree View, select Users and Roles and add user roles to the data grid.
Note Although User names must match Windows logon names, Role names do not have to match.
The following table lists the User and Roles properties available in the Property Editor.
Public Information
Users and Roles Settings

Item Description
Time, in minutes, after which a user who has temporarily logged on over the existing user, is
automatically logged off. If set to 0, automatic log off does not occur. When the temporary user
Auto LogOff Timeout is logged off, the previous user is again active.
Auto LogOff Timeout and Block Modify if User has no Force Privilege display in the Property
Editor when Users and Roles is selected.
Block Modify if user has no
Enables you to block a user from modifying a variable in the forced state
Force Privilege
Enable Service Accounts Allows GE Service Account users to log into the system
When False, HMI Resource protection on variables is disabled when there are no Users defined
in the ControlST system configuration.
Enforce HMI Resource
This is the default value, which allows libraries to be single-sourced with HMI Resources
Strictly
assigned to variables. Some applications require HMI Resource enforcement even with no
users in the system, in which case users should set this property to True.
Allows User and Role configuration to be protected independently of the overall system
Protection
configuration
Comma separated list of HMI Resources that will be added to any GE Service Account users
Service Account HMI
that log into the system. This is in addition to whatever special HMI Resources those users are
Resources
granted intrinsically.
User Settings
Defines the User
In Windows Domains, the name can be the Domain\UserName.
A Group name can also be specified here, by prepending the name with an at @ sign. Groups
Name can either be locally defined on the PC or come from a domain. Some limitations apply, such as
local groups that reference domain groups cannot be used. However, local groups can contain
domain users. For example, a group name of @SITEDOMAIN\Operators will allow all users in
that Domain group to log on and be granted the Role and HMI Resources assigned to that entry
in the User list.
Role Defines the user’s access privileges
Associated with a User
Users are configured in the System Information Editor and can be assigned to variables. Users
who have a resource that matches a variable’s resource can write to live data for that variable if
HMI Resources the privilege is assigned. If a variable does not have a resource, it defaults to allow the user to
modify the data if the user’s role supports that privilege. Users with an empty list of resources
are only allowed to modify variables without an Human-machine Interface (HMI) resource
defined. Refer to the section HMI Resources.
Role Settings
Role Name User name and privileges
Alarm Privilege Allows you to acknowledge and reset Alarms in the Alarm Viewer
Alarm Service Privilege Allows you to place Alarms as out-of-service from the Alarm Viewer
Allows you to shelve or unshelve one or more Alarms in the Alarm Viewer. Refer to the section
Alarm Shelving Privilege
Alarm Shelving.
Download Privilege Allows you to download to a controller

Public Information
Users and Roles Settings (continued)
Go To Definition From HMI Allows you to right-click within an HMI graphics window and go to the definition in the ToolboxST
Graphics Privilege controller logic
Live Data Force Privilege Allows you to force live values
Allows you to modify live values
The Live Data Modify Privilege must be set to True for the Live Data Force Privilege to be
Live Data Modify Privilege
enabled, and to remain enabled. If the Live Data Modify Privilege is changed to False, the Live
Data Force Privilege will automatically default to False.
Tag Out Privilege Allows you to lock out control functions on the HMI
Allows you to use the WorkstationST Status Monitor to start and/or stop WorkstationST
Start/Stop WorkstationST
features. This privilege also allows you to start or stop features from the Status tab when the
Features
component in online.
Public Information
3.10 System Database (SDB)
Attention
The ToolboxST application can interface with a System Database (SDB) from the System Editor.
Second Language must be selected

before diagnostic text can be translated
in System Information Editor
SDB Enable property must be set to True

before other SDB properties can be configured
SDB Host Name is the location of the SDB
SDB location path

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

1. Open the System Information Editor. From the System menu, select Put System to SDB. (Refer to the section,
System Information Editor.) A window displays to confirm the destination SDB Host and Path.
2. Click OK. When the process is complete, the results display on the Log tab of the InfoView.
Files that are used by multiple WorkstationST runtimes are stored in a defined Master location. These files include HMI
screen files, sound files, and Alarm help files.
Public Information
3.11 EGD Configuration Server
The EGD configuration server is a repository for EGD device and system configurations. Like the SDB, the EGD
configuration server allows configuration information to be available to multiple tools or runtime platforms.
The EGD configuration server maintains a group of .xml documents for each EGD device. The EGD configuration server also
maintains a MasterSymbolTable.xml file that contains format specifications, Alarm Classes, and other system-level
information.
Note The ToolboxST application uses the EGD configuration server if it has been enabled in the System Editor.
The protocol used to get and put these .xml documents to and from the EGD configuration server is a published HTTP
protocol. This protocol is available for other tools, and is currently used by the GE CIMPLICITY ME.

Public Information
EGD Configuration Server Properties
Item Description
URL on the EGD configuration server where EGD documents are
Base Path
located
If set to True, enables communication with 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
The URL/EGD should not be devices is obtained from the EGD configuration server if the
changed unless the system configuration time is newer in the server than in the ToolboxST
administrator has installed a custom Enable application's local directory for that referenced device. For example,
EGD configuration server. if the *.tcw file 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 time stamp than the configuration at C:\MySystem\Dev1.
Otherwise the local c:\MySystem\Dev1 configuration would be used.
Host Name or IP address of the host running the EGD configuration
Host Name
server
The Port value should not be Port Server port value (default is 7938)
changed unless the system Timeout Server connection timeout in ms
administrator has installed a custom Selects the Internet Explorer proxy settings, if set to True. The
Use IE Proxy
EGD configuration server. default is False. It is recommended to not use a proxy
Public Information
3.11.1 Work Online with EGD Configuration Server
Work Online with the EGD configuration server is the default in the ToolboxST application to open, build, or save
components. You can select Work Offline from the View menu or from the Status bar shortcut menu.
When the EGD configuration server is enabled, a status bar indicates the Online/Offline status. Right-click the status bar to
display a shortcut menu, which allows you to toggle between the two modes. If Work Offline is selected, the server is
bypassed when components are opened, built, or saved. This means that any component saved results in a difference between
the EGD configuration server and the ToolboxST application.
An issue in the Windows operating system handling of 32-bit application addresses has
been identified in large (~2 GB) ToolboxST system configurations on two platforms:
• 64-bit Windows 7
• Windows Server 2008 R2 (64-bit)
This results in the following Ethernet connection failures:
• Loss of online connection between ToolboxST and the controller
• Loss of connection in the middle of a configuration download from ToolboxST to the

Attention controller
Microsoft has resolved the issue with a Hotfix (KB2588507) for both operating
systems. GE is not able obtain redistribution rights for this Microsoft Hotfix. Users
with large memory ToolboxST system configurations (such as Foundation Fieldbus)
using Windows 7 and Windows Server 2008 R2 should download and install the
Microsoft Hot Fix.
3.11.2 ToolboxST/EGD Configuration Server Interaction

When the ToolboxST application is online, and the EGD configuration server is enabled, the application reads any new EGD
configuration server data. It then saves or builds to the EGD configuration server.
When a component is opened, the configuration of any EGD referenced device is read from the local file location (in that
referenced device’s ToolboxST device folder for the opened system). It is then requested from the server if the server has a
newer version.
When a component is saved, the EGD configuration is saved to the EGD configuration server. If communication with the
EGD configuration server fails during an Open, Build, or Save command, a window to select Work Offline or Retry displays.

Public Information
3.11.3 View Differences
The View Differences feature is used to compare the EGD configuration files in the ToolboxST system to the last files that
were published EGD configuration server and identify the differences.
➢ To compare the local EGD configuration to the server configuration: from the System Editor View menu,
select EGD Configuration Server, then select View Differences.
OR right-click the status bar shortcut menu and select View Differences.
The Local Configuration Compare to Server Configuration window displays the comparison results between the local EGD
configuration files and the EGD configuration server files.
Note Publishes to the EGD Configuration server occur when a component is saved. If a component in a .tcw file is not the
latest configuration (for example, if the most current configuration is on another computer), publishing the local EGD
configuration sends the old configuration to the server.
The following features are provides to help identify differences:
• The Search text box allows the user to filter the display for the entered criteria.
• Color coding represents differences and missing documents:
− Salmon color indicates documents that are missing from the configuration server
− Green/gray color indicates rows containing differences
• The toolbar above the grid provides two icons:
− Select the Toggle icon to only display the documents that do not match in the table.
− Select the Help icon to display a diagram that illustrates the dataflow of configuration documents between tools
(Configuration Server and WorkstationST).
Public Information
Toggle Search Text Box
Help
Missing
Different
Local Configuration Comparison to Server Configuration
Note The CMS Status column displays information only if the user is currently logged into CMS and the ToolboxST system
is under CMS control.

Public Information
Help Configuration Dataflow
EGD Configuration Commands

Command Description
Displays a difference report for any consumed or produced data file that exists in both the
View Differences
server and the local system
View Server Document Views the server version of a selected document
View Local Document Views the local version of a selected document
Equalize Server to Match all
Makes equal any document that is marked Not Equal by publishing the local configuration to the
Local System Documents to
EGD configuration server
the Server
Empty Server, and then
Sends all local documents and causes all EGD configuration server content to be removed
send all Local Documents to
before the local documents are published
the Server
Send Selected Local Sends a local copy of a selected document(s) to the EGD configuration server. If the device’s
Document(s) to the Server tree node is selected, all documents under the device are sent to the server
Deletes selected device(s) in the server. A device typically has more than one document. When
Delete selected Device(s)
any document for a device is selected, all documents are deleted. A confirmation dialog box
from the Server
displays prior to delete and lists the device names that will be deleted.
Refresh Display Compares the local system to the EGD configuration server and updates the display
Public Information
3.11.4 Configure External EGD Device
Note Refer to the section, System Database (SDB)
The EGD configuration for a device in the SDB can be retrieved for use in a ToolboxST system. However, before you can
reference an external device in the SDB, the SDB Enable property must be set to True.
➢ To retrieve 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.
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. From the Tree View, right-click the external device and select Get EGD from SDB. A window displays 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 Component InfoView.
Note If the EGD configuration server is enabled for the system, the EGD configuration will also be put to the EGD
configuration server.

Public Information
3.12 System Reports
System reports provide system information in a viewable format. Generated reports display in a separate window and may be
printed or saved for later use. The following report can be generated for configured components:
• Force Lists
• I/O / Variable
• Alarm Parent Child Relationships
• Alarm
• Hold
• Event
• Find Unlinked Blocks
• Firmware Versions
• Workstation Consumed Device Information
• Workstation Feature Configuration
• System IP Address Information
• Component Versions
➢ To generate a system report: from the System Editor View menu, select Reports, then select the report.
Public Information
3.13 System Configuration Files
Each system configuration has a .tcw file associated with a particular ToolboxST version. When an existing system .tcw file is
opened, a window may prompt you to select a ToolboxST version to use when opening the file. In most cases, when there is
only one ToolboxST version of the installed (ToolboxST.exe), the .tcw file opens without displaying a window. When multiple
ToolboxST versions are installed, a window displays with all versions that are equal to, or a higher version than, the selected .
tcw file.
In the following example, the fivetwoC.tcw system file opens using the selected version. If the selected version is higher than
the system in which it was saved, you must upgrade the ToolboxST version.
ToolboxST Version to Open Configuration File

Public Information
3.14 Access Privileges
The Privileges feature defines system access rights. System users and their roles are configured using the System Information
Editor. Each user is assigned a role and an optional set of resources. User names correspond to Windows users (work groups
or domain users). The following sections describe Privilege feature functionality:
• Display current user

• Log on
• Log off
• Set user access roles
Note The Privileges features is accessible from the WorkstationST application or WorkstationST Status Monitor icon in the
taskbar notification area.
The following figure illustrates how the ToolboxST application, CimView, and CimEdit authenticate system access using the
Privileges feature.
Public Information

!

+

!
+

!

" #$ %#&
'"( ) )' "'

./0

%)'$$)'&
#*
)'$

$'

)+
)''
"

))+
),-
+
+ ./0

)
)')

./0

)
1/' "'

'

! "#$ %
&'
(
(
! "# $ %
) *+ (, ,
'
( - "

',!.

Public Information
3.14.1 Display Current User
Note Privileges can only be modified from the System Information Editor.
➢ To display the current user
From the taskbar

notification area, right-
click the WorkstationST
icon and select Show
Current Privileges User.
The current user and

assigned privileges display.
Public Information
3.14.2 Log On
From the Privileges User Logon Manager, you can:
• Log on and replace the current user

• Log on and temporarily override the current user
Note An event message indicating the logged-on user (and role) is generated in the Alarm Viewer.
➢ To replace the current user: right-click the WorkstationST Status Monitor icon and select Privileges Log On.
From the User drop-down

list, select the user, enter
the password, and click OK.
The user selected (with defined privileges) replaces the current user.

Public Information
➢ To temporarily override the current user
Select Temporary Log

On to change the current
user to the sub-user
The user maint is now logged on over the current user (now sub-user). The previously defined user privileges for maint take
effect.
Public Information
3.14.3 Log Off
The feature Auto LogOff Timeout is activated when one user is logged on over another user. This feature is enabled in the
Property Editor when the Users and Roles item is selected from the Tree View.
Note An event message indicating that the user logged off is generated in the Alarm Viewer.
➢ To set the Auto LogOff Timeout: from the System Editor Tree View, double-click the system item to display the
System Information Editor.
From the Tree

View, select
Users and
Roles.
From the
Property Editor,
enter the Auto
Logoff Timeout
in minutes.
If the temporary user remains inactive through the timeout period, that user is logged off and message displays that the user
administrator is again active.
➢ To log off the Current User: right-click the WorkstationST Status Monitor icon and select Privileges Log Off.
The current user is now logged off. If the current user was the temporary user, the sub-user now becomes the current user and
previously defined user privileges now apply.

Public Information
3.14.4 Access Roles
The Access Roles property in the Component Property Editor allows you to set access rights for modifying data or design
according to user names and roles pre-defined in the System Information Editor.
Note Only users with roles assigned to a protected object can access that object.
➢ To set access roles
From the General

tab Property
Editor, select
Access Roles and
click ellipsis button.
Public Information
From the drop-down list, select an Access
Right and the Role Name to be assigned.
By default, when a role is assigned to an access right, only users with that role can access the protected object (programs,
tasks, and such). Permissions are also inherited from parent objects. For example, if a component has the Modify Design role
assigned to Operator, all objects in that component require the Operator role before allowing design changes. However, each
Role name can optionally be applied with the Grant keyword. This reverses the normal behavior so that users with the Grant
keyword have access to the object regardless of any parent objects. As an example, the Modify Design access could be
restricted for an entire component to users with the Maintenance role, but one particular program could be modifiable by
users with the Operator role.
Modify Design Grant Admin Access

Public Information
3.15 Shared IONet Group
Beginning with ControlST* V04.06, sharing data between two controller sets on a single Ethernet input/output network
(Shared IONet) is available for some Mark* controllers. Beginning with ControlST V07.06, some Shared IONet Groups may
contain up to four controller sets (in accordance with supported controller combinations). With Shared IONet, an owner
controller configures its owned I/O modules, Writes outputs, Reads Sequence of Events (SOE), and provides diagnostic
information. Owned I/O modules are attached to the owner controller that can configure and Write outputs to them, and they
obtain IP addresses from their owner controller. Only the owner controller can Write outputs for an I/O module it owns.
Note A controller set is a group of controllers (based on redundancy) with a set of owned I/O modules. In the ToolboxST*
System Editor Summary View, a controller set displays as a single controller.
A shared I/O module sends field device inputs to both its owner controller and to all consumer controllers. A consumer
controller receives the field device inputs from the shared I/O modules that are owned by the other owner controller. The
exception to this is a Mark VIeS Safety controller. The Mark VIeS only receives inputs from its own safety-certified I/O
modules. The ToolboxST application is used to configure the controller sets. The computer with ToolboxST communicates
with the I/O devices through a software gateway function residing in the controllers.
Only the following controller combinations are supported by Shared IONet:
• One Mark VIeS Safety controller and up to three Mark VIe controllers
• One MarkStat controller and one Mark VIe controller
• Up to four Mark VIe controllers
Note The UCPA controller platform should not be used in a Shared IONet system.
Public Information
3.15.1 Insert New Shared IONet Group
➢ To add a Shared IONet Group
1. Open a ToolboxST system *.tcw file to display the System Editor.
2. Create a Shared IONet Group.
From the System

Editor Tree View,
right click the
system and select
Insert New and
SharedIONet
From the New

Shared IONet
Group dialog box,
enter a name and
a description
(optional) and
click OK.
3. If inserting a new controller, from the Tree View, right-click the Shared IONet Group and select Insert New,
Controller, and Mark [VIe, VIeS, or Stat] Controller.
a. Complete the Creation Wizard pages to add the controller.
b. If inserting a new second controller, repeat these steps.

Public Information
4. If adding an existing controller, from the Tree View, drag the controller into the Shared IONet Group. If the Must
Rebuild/Download message displays, click OK.
a. If the controller is not at least version 4.06, perform an upgrade.
b. If there are I/O modules that are not at least version 4.06 firmware, perform an upgrade.
c. If adding a second controller to the Shared IONet Group that already exists on the system, repeat step 4 a and b.
5. Save the system.
Shared controller display

in the Summary View
6. Double-click each controller to open both Component Editors.

7. From each Component Editor, add and configure the I/O modules.
Public Information
3.15.2 Delete or Remove Shared IONet Groups
➢ To remove a shared IONet Group
1. From the System Editor Tree View, expand the Shared IONet Group and either:
a. Drag the controllers from inside to outside the group.
Or
b. Delete the controllers from inside the group.
2. Select and delete the group folder.
3. Restart the WorkstationST* OPC DA server to refresh the I/O diagnostics as displayed from the system-level controller.
If the server is not restarted, active diagnostics may not display from the system level.
When attempting to delete the Shared IONet Group without first removing the controllers, the following message displays.

Public Information
3.15.3 Download Shared IONet
➢ To download a Shared IONet group
1. Verify that the Component Editors have been saved and closed.
From the System

Editor System menu,
select Download
SharedIONet
2. A Download Shared IONet System wizard displays. Notice that the check boxes for the individual controllers
cannot be cleared.
3. Complete the wizard screens to build and download to the Shared IONet Group.
Note For further details, refer to Mark VIe and Mark VIeS Controllers Shared IONet Instruction Guide (GEH-6812).
Public Information
3.16 System Controller Platforms
There are several available controllers that can be instanced in a ToolboxST system. The available controller platforms depend
on the user’s control system. The following tables list the controllers that are available for each control system, and identifies
the supported and unsupported features the controllers offer for that control system. For further information on each
controller, including backup/restore procedures, refer to the Mark VIe and Mark VIeS Control Systems Volume II: System
Guide for General-purpose Applications (GEH-6721_Vol_II), the chapter Controllers.
Mark VIe General-purpose Controllers

Supported Feature?
Method for
Controller IONet FOUNDATION
Redundancy OPC UA Backup/ Shared IONet Modbus TCP
Redundancy Fieldbus
Restore
Master
UCPA No No No No Simplex only No (PSCA),
Slave
Simplex, Master
UCSA Yes Yes No Yes Dual, Yes (PSCA),
TMR Slave
Simplex, Master
UCSB Yes Yes Yes Yes Dual, Yes (PSCA),
TMR Slave
Simplex, Master
Yes
UCSC Yes Yes Yes Dual, Yes (PSCA),
Restore only
TMR Slave

Public Information
Mark VIeS Controllers
Supported Feature?
Method for
Controller IONet FOUNDATION
Redundancy OPC UA Backup/ Shared IONet Modbus TCP
Redundancy Fieldbus
Restore
Simplex,
Slave
UCSB Yes No Yes Yes Dual, No
(Read Only)
TMR
Simplex,
Yes Slave
UCSC Yes No Yes Dual, No
Restore only (Read Only)
TMR
Public Information
4 Software
This feature is not available for the WorkstationST component.
Attention
There are two system components for creating downloadable application software, controllers, and Library Containers.
Controller components contain the 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 software consists of function blocks that perform logical and mathematical operations on the block variables. This
network of blocks and connected variables controls a particular machine through physical inputs and outputs.
Function blocks arranged and connected within a software element are called tasks. Tasks are grouped into other software
elements called programs. For more information, refer to the section Software Tab.
User-defined blocks called user blocks are created using existing function blocks, as well as other user blocks. User blocks
can be used in a task in the same manner as function blocks.
4.1 Software Configuration Hierarchy
Programs and tasks are

required elements of
software configuration,
resulting in at least two
levels of hierarchy.
Program groups can be used

to add a level above
programs. Combined with
user blocks, the levels of
hierarchy can be four or
more.
Software GEH-6703P User Guide 171

Public Information
4.1.1 Variables
Variables can be defined within programs, tasks, and user blocks. Task and user block variables can be Global, Member, or
Local variables. Program variables can be either Global or Member variables. A variable must be Global to be connected to a
turbine I/O or 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.
Member variables are a special type of local variable that can be accessed by any task or block within the variable’s parent
program. For example, if you define a Member variable on a program, any task or user block within that program can see and
connect to the Member, but blocks in other programs cannot see it. This is useful for implementing object-oriented patterns
like encapsulation.
Intrinsic variables are pre-defined controller variables primarily used by the ToolboxST application. These variables are
product-specific, meaning that intrinsic variables for one controller may differ from those of other products.
4.1.2 Variable Names and Aliases

When developing application software in ToolboxST, libraries of re-usable code are frequently created to reduce mistakes and
enable productivity. One of the challenges in code re-use is the wide variety of variable naming conventions between different
industries, businesses, and teams.
In ToolboxST, each variable has a Name and an Alias property. The variable Name is used when writing the original library,
while an Alias can be used for the end-user’s preferred naming convention. ToolboxST can display either Name or Alias
depending on if the value Display Variable Aliases instead of Variable Names is selected from the WorkstationST User
Preferences menu. When selected (enabled), ToolboxST is placed in Alias mode and the Alias of a variable is displayed
instead of the variable’s Name. Alias mode applies to most places in ToolboxST where a variable name is displayed, including
logic diagrams, connection properties, where used, browse dialogs, and validation errors.
In addition to displaying Aliases, ToolboxST allows the entry of either the variable Name or the Alias for a connection
property. Internally, ToolboxST translates the Alias into the variable Name to maintain consistent configuration. However,
Name and Alias are not completely interchangeable—there are still places where variable Name is always used, such as in the
generation of files to be downloaded to the controller itself.
WorkstationST User Preferences Menu
Note A variable Alias report can be generated for a list of all variables with aliases.
Public Information
4.1.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 Library Container Editor Tree View, right-click Libraries and select Add Library.
2. In the Add New Library dialog box, type a name and click OK.
3. Right-click the library and select Add User Block Definition.
4. Save the library.
5. If the new library does not display in the Summary View, right-click Programs in the Component Editor Tree
View and select Library References.
Select the new

library check box
and click OK.
The new library
displays in the
Summary View
6. From the Component Editor, select the Software tab.

7. From the Software tab Tree View, right-click a program item and select Add Task.
8. In the Add Task dialog box, select the Select Library Block checkbox to display library blocks.
9. Insert a linked user block by selecting the user block definition from the dialog that displays.

Public Information
Note An alternative method is to 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, locate the user block to update.
3. From the Summary View or the Property Editor, edit the user block.
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 and select Instance.
4.1.4 User Block Definitions

User block definitions consist primarily of function blocks, user blocks, and variables. The user block definition variables,
which can be either local or global, act as the parameters. User block definitions with global variables can only be used once
in a given controller unless the variable name contains a text substitution or the variable's Global Name Prefix property is set
to Full, Block, Task, or Program.
User block definitions are the source of both linked and unlinked user blocks. Each user block has a version and description to
help manage reusable software.
Instance scripts and text substitution allow user blocks to use a set of code in multiple situations. These work with the
ToolboxST automation interface and the user attributes that belong to either the user block or the controller component.
User attributes 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.
Device attributes are similar to user attributes in that they that allow you to specialize user block definitions. 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 software within the device. Device attributes do not have a PromptforInput
property. (Refer to the section Software Examples.)
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.
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.
Public Information
4.2 Library Container Editor
The Library Container Editor is used to create reusable software that can be included in multiple controller components.
Library Containers are added to a system as a separate component. Double-click the component icon in the Tree View to
display the editor as a separate window. Each Library Container can contain one or more libraries. Each of these can contain
user block definitions, program definitions, or task definitions.
A User Block Definition is a collection of function blocks and user blocks with input and output pins.
A Program Definition is a collection of tasks that can be used in a controller device.
A Task Definition is a collection of function blocks and user blocks that can be used in a program.
Validate checks the configuration Summary View is used Library View contains
for errors, connection compatibility, to edit the user block categories of blocks that
data types, and equations selected in the Tree View perform various functions
Tree View
displays all
items in the
editor. Add or
delete libraries
here
Property
Editor displays
properties for
the item
selected in the
Tree View
Component
InfoView
displays
information
whenever an
action occurs

Public Information
➢ To add a Library Container to a system: from the Tree View, right-click the system name and select Insert New
and Library Container.
Enter a Name (up to 32

alphanumeric characters), select
the controller type, and click Next
It is highly discouraged that systems contain multiple libraries or objects with the
same name for the following reasons:
• Duplicate named libraries – Even though a system can contain multiple libraries
with the same name, a Library Container or device can only reference one of these
libraries. Therefore, if the libraries have a different subset of objects the system will
not be able to access all of the objects in both libraries.
• Duplicate named objects – Even though a system can contain multiple objects with
Caution the same name, an unexpected instancing operation can occur if a device or Library
Container references more than one of these objects. This could also lead to confusion
for future users who may not be intimately involved in the system design. If a user
designs a system in this manner it is their responsibility to test and understand the
instancing operation and convey that information to all system users.
Public Information
From the drop-down lists, select the ControlST Version
and the Application type, then click Finish.
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.)
➢ To upgrade a Library Container

1. From the Tree View, select any Library Container item.
2. From the File menu, select Upgrade.
3. When the welcome page displays, click Next.
4. Select the desired version and click Finish.

Public Information
4.2.1 Add a Library
Multiple libraries can be added to a Library Container to organize the software into separate pieces. These can be referenced
individually in the controller component. Each library is contained in an .xml file, and can be imported into other Library
Containers.
➢ To add a new or existing library to a Library Container
From the System Editor Tree View, double-click the Library Container.
From the Libraries menu , select Add Library or Add Existing Library.
Public Information
Enter a name for a new library or select
the desired existing library and click OK.
Tip � The Summary View Libraries item displays names and locations of all function blocks and user block libraries defined
in the Library Container. The function block library version used by the Library Container can be determined by looking at
the Directory field and observing the path to the library.
4.2.2 Library References

Libraries can reference other libraries across Library Containers. This allows users to have standard user blocks defined in
one library, which can then be referenced in other libraries and updated as needed without having to copy the user block
library into the other libraries that use it. For example, if a user modifies a user block and any libraries reference (use) that
block, the user can perform an Update all uses on the block and all libraries containing that block will update automatically.
Library containers and devices should have a reference to all top-level and nested
linked objects. Failure to do this may cause the Instancing and Update All Uses
features to generate errors due to not being able to update all selected objects. This
results in the following error message displayed in the Log window: The block [user
Attention block 1] is not found in block library assembly.
Note The Go to Definition and Compare to Definition features will not work for any object that does not contain a reference
to the source object.

Public Information
➢ To view User Block Library references across Library Containers
From the Tree View, right-click a Library

Container and select Library References.
From the User block Libraries tab,

select the libraries to view and click OK.
Devices and Library Containers must have library references to the source code of all
linked objects for the Go to Definition and Compare to Definition features to operate. If
no library reference exists for an object these functions will not be displayed in the
right-click menu.
Attention
Note If the user performs an Instance All operation the system updates all nested link contents from their source code if they
are defined within the Library Container. However, nested links that were defined in referenced libraries are updated here
with an exact copy as they exist in that reference library. The reference library content is not updated by the Instance All
operation.
Instancing behaves differently from Instance All in that if the user performs an Instance operation the system updates all
nested link contents from their source even is the source is referenced from another library.
Public Information
4.2.3 Find All Library Uses
➢ To locate all uses of a User Block Library: refer to the procedure Find All Uses.
4.2.4 Library Property Editor

When a library is selected, the following properties are included.
Description Description for this library
Name Unique name for this library
Access Roles are assigned to users to protect each access right for the object.
Modify Data allows you to modify data values and forcing of variables.
Protection
Modify Design allows you to modify the design of defined blocks in this library.
View Design allows you to view details of defined blocks in this library.
4.2.5 Library Summary View

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

Public Information
4.2.6 Library Help Files
The ToolboxST application supports the following help file types to document a library of user blocks. All three file types
have the same name as the block (Block1.mht), and are located in the HelpFiles subdirectory in the Library Container. This
format, which can be created by Microsoft Word, allows images and text to be combined on a page.
Help File Type Description

Contains individual HTML pages compressed together into a single file. This .chm file,
which is used to document an entire library of user blocks, has the same name as the
Compressed HTML (.chm) library (Lib1.chm). It is located in the same directory as the library .xml file that it
documents. The individual HTML pages within the .chm file must have the same name
as the block they document.
MHtml files (.mht) Document individual blocks in a library
HTML files (.htm) Document individual blocks in a library
Text files (.txt) Document individual blocks in a library
The Library Container contains:
• Lib1.xml (contains Block1 and Block2)

• Lib1.chm (contains the help for Block1 and Block2)
• Lib2.xml (contains Block3 and Block4)
Helpfiles contain:
• Block3.mht
• Block4.htm
The ToolboxST application first searches for a .chm file that corresponds to the Library name. If this is not found, it searches
in the HelpFiles directory for a help file that matches the block name. The search order is:
• .mht
• .htm
• .txt
Public Information
4.2.7 Password Protection
The first time you attempt to perform a password-protected function, the Enter Password dialog box displays. All protected
functions performed during the remainder of the current ToolboxST session do not require re-entering the password.
Note If passwords were set in the Property Editor for this library, the following functions require a password.
Library Container Editor Password Protected Functions

Function Modify Data Modify Design
Add Special Task √ √
Add User Block Definition √
Add Program Definition √
Add Task Definition √
Change Name (property) √
4.2.8 Table Definition Property Editor

Table Definition Properties
Name Name of the Table Definition
Determines whether the table's Z values and limits can be adjusted both in configurations and online.
Adjust The Adjust flag is read when imported; if it is False, the table data cannot be changed without another
import.
Description Description of the Table Definition
Identification Identification text for the Table Definition
Revision Revision text for the Table Definition
Maximum Z value Maximum Z value used to limit the values that can be entered in the live or initial values
Minimum Z value Minimum Z value used to limit the values that can be entered in the live or initial values
Engineering Y Units Description of the engineering Y unit
Engineering X Unit Description of the engineering X unit
Engineering Z Units Description of the engineering Z unit
4.2.9 Export Table Definition

➢ To export a table definition (.csv file)
1. From the Component Editor Software tab, expand Table Definitions and select the table definition to export.
2. Right-click the table definition and select Export Table.CSV File.
3. From the Open window, select the .csv file and click Open.

Public Information
4.2.10 Online Table Definition Data Value 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.
The Data Grid displays the differences and allows you to edit the table data values in the controller. Once the table data values
are correct, click the Save to Initial Values button to capture the values in the ToolboxST configuration.
Differences Displayed in Data Grid
Public Information
4.2.11 Table Definitions in Software Code
➢ To add a 2D (uni-variant) Linear Interpolator block
1. Connect the Table2D pin to the Table\T_ESPBSJ table.
2. Set XInput to 40.

3. Perform a Build and download the application code to display the block output.
Example of 2D Pin Block Output

Public Information
➢ To add a 3D (bi-variant) Linear Interpolator block
1. Connect the Table3D pin to the Table\T_DSPNAJ table.
2. Set XInput to –30.

3. Set Yinput to 4.
4. Perform a Build and download the application code to display the block output.
Example of 3D Pin Block Output
Public Information
4.2.12 Add User Block Definition
A user block definition is a collection of function blocks and user blocks with input and output pins.
➢ To add a user block definition
From the System Editor Tree View, double-click the Library Container.
Right-click the Library item and select

Add User Block Definition.

Public Information
Enter a name for the library and click OK.
User block definitions can be sorted alphabetically. If additional user block definitions are added, repeat the sort.
➢ To sort user block definitions: from the Tree View, right-click the library item and select Sort Definitions.
4.2.13 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 Data Grid.
• 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 ones that have been referenced in a User Block Definition but have
not yet been defined as part of user block variables or user block.
Public Information
4.2.14 Work with User Blocks
User attributes are named values that specialize user block definitions. They consist of a name, a data type, a description, a
value, and a PromptforInput property. The PromptforInput property 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. (Refer to
the section, Software Examples.)
➢ 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.
2. Enter a name for the new attribute and click OK.
3. Select the Attributes item in the Tree View to display modifiable properties in the Data Grid.
4.2.14.1 Instance Script

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.
➢ To add an Instance Script: from the Tree View, right-click the user block definition and select Add Instance
Script.
4.2.14.2 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 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.
4.2.14.3 Validate
This command checks the selected user block definition for errors. Validate also 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 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.
4.2.14.4 Update All Uses

Changes in user block definitions (as well as in task and program definitions) can be instanced directly (pushed) from a
library to other libraries and to the controllers as opposed to changes being pulled from the library from individual libraries or
controllers.

Public Information
Note Changes in user block definitions (as well as in task and program definitions) can be pushed (update all uses) directly
from one library to other libraries and to the controllers as opposed to changes being pulled (Instanced) from the library from
individual libraries or controllers.
➢ To update user block definitions
From the Tree View, right-click

the user block definition and
select Update All Uses.
Note The Enter Password dialog box displays if this action is password-protected.
Click Yes .
Note When Update All Uses is selected, you are prompted to save changes if changes have not been saved. Once changes
are saved, the Controllers and Libraries to Update dialog box displays.
The Controllers and Libraries to Update dialog box displays the search results. Each Library Container or controller
containing the user block being pushed is listed, as well as indication if it is OK to update (push) the instance, the number of
instances within the Library Container or controller, and the status that corresponds to the number of instances within the
Library Container or controller. The following table describes the possible status of the instances within the Library Container
or controller that qualify it as OK or not OK to push. Library Containers can contain multiple libraries, therefore the status
field can contain more than one status because different libraries within the same container can have a different status.
Public Information
Select the appropriate Library Container or controllers and click Update.

Public Information
Update Status Descriptions
Status Description
OK At least one instance in the Library Container/controller can be updated
Read Only At least one instance in the Library Container/controller is Read Only and cannot be updated
At least one instance in the Library Container/controller contains a user block with a duplicate
Duplicate Definition definition. This means there is a user block defined in this library that uses the exact same name as
the user block being updated.
Controller is currently opened in ToolboxST and must be closed before the controller can be selected
Open (only applies to to be updated.
controllers) Once the controller is closed the status will not update. However, the user will be able to select the
controller to be updated.
Unlinked User block is unlinked and cannot be updated
Note A Library Container/controller with an OK status is the only one that can be updated. Users can only select a Library
Container when the OK to Push To status is OK.
The following Warning dialog box displays to remind users that any open Library Containers or controllers will not be
updated.
Click OK to close the Warning dialog box and

make sure all controllers and libraries are closed .
Public Information
The Block Updating Results dialog box displays the update results. Click Close to close out the window.
Block Updating Results
Screen Name Update Results

Status Description
Updated Blocks Number of blocks that were updated
Read Only Blocks Number of blocks that are Read Only and could not be updated
Unlinked Blocks Number of blocks that are unlinked and could not be updated
Number of blocks that failed to update due to the Library references in the Library Container/controller not
being pointed to the library that contains the user block.
Failed Blocks
This result in the following error message displayed in the Log window: The block [user block 1] is not found in
block library assembly.

Public Information
4.2.14.5 Find All Uses
➢ To display all uses of a user block: from the Tree View, right-click the user block definition and select Find all
Uses.
Click Yes .
The search results display in the Find Results tab of the Component InfoView.
Find All Uses Search Results
The system notifies the user in the search results of unlinked objects and duplicate names.
Find All Uses Search Results — Unlinked Object
Find All Uses Search Results — Duplicate Name
Public Information
4.2.14.6 User Block Property Editor
A user block definition is created by using the Block Diagram Editor to insert different types of blocks and connect them to
perform a function.
User Block Property Editor Properties

Block Type Name of the user block definition in the library where this user block was created
Description Description of this user block
Name Unique name of this user block

Instance Script Runs when the block is instanced
Detached Summary File Path to a summary diagram for the user block
Enable When set to True, enables the user block
Protection Properties control the Access Roles, Modify Data, Modify Design, and View Design permissions for
the library
Version User-defined version of a user block
4.2.15 Import Alarm Rationalization Report

An alarm rationalization report generated from a controller for external editing can be imported into the library container.
Refer to the section Export and Import Reports.

Public Information
4.3 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

1. Open the Component Editor.
2. From the File menu, select Print to display the Print Options dialog box.
Page Options tab allows Print Settings tab allows you

you to change paper size, to change the destination Print Profile tab stores
margins, and orientation printer and associated settings saved print settings
Prints a
summary of Page Numbering
configuration controls page
settings number
assignment
Includes a list
of sections Linear pages
with page number
numbers sequentially
Includes a starting with page 1
quick
reference Hierarchical
symbol guide pages include
sections and
Prints all subsections (1, 1.1,
component and such)
programs
Prints a reference to all Displays a

component variables print preview
Public Information
4.4 System Design Procedures
This section provides five procedures to create a system. These procedures build on each other so you must complete them in
the following order:
1. Add a user block definition to a library.
2. Insert a linked user block in a controller.
3. Add a device attribute.
4. Exclude a function block from a user block with an instance script.
5. Substitute text into a user block with an attribute.
4.4.1 User Block Definition

➢ To add a user block definition to a library
1. Open the ToolboxST application. From the File menu, select New System.
2. Enter a name and click OK.
3. From the Tree View, right-click the system item and select Insert New and Library Container.
4. Follow the wizard pages to create a Library Container. (Refer to the section Library Container Editor.)
5. From the Tree View, double-click the Libraries item to open the Library Editor.
6. From the Tree View, right-click the Libraries item and select Add Library.

Public Information
Right-click the
new library and
select Add User
Block Definition
Enter a name or click OK to

accept the default name.
Public Information
7. With the Lib1Usb1 item highlighted in the Tree View, the All Categories drop-down list displays on the right side of
the block diagram.
From the All

Categories drop-
down list, select
Type Conversion
8. Drag a MOVE block from the Type Conversion category to the Block Diagram Editor to add it to the user block.
Repeat this process once more until two MOVE blocks display on the block diagram.
9. Save the Library Container.

Public Information
4.4.2 Linked User Block
➢ To insert a linked user block in a controller
1. From the System Editor Tree View, right-click the system item and select Insert New, Controller, and Mark VIe
Controller.
2. Complete the creation wizard and open the Component Editor.
3. From the Software tab, right-click Programs and select Library References.
Select the new library

check box and click OK.
The new library displays
in the Summary View
4. Right-click Programs again and select Add Program. Complete the Add Program dialog box and click OK.
5. From the Tree View, right-click Prog1 and select Add Task. Complete the Add Task dialog box and click OK.
6. Save the changes and close the editor.
Public Information
4.4.3 Device Attribute
➢ To add a device attribute
1. Open the test System Editor and double-click to open the component.
2. From the Tree View, select Attributes.
3. Enter the Name for the new device attribute as attr1.
Click the Name cell on the

append row (indicated by an
asterisk*) and enter attr1
4. Click in the Value cell for attr1, then click the ellipsis button (...) to display the Modify Value dialog box.

Public Information
5. Set the Enumeration and Data Type for the attribute.
Name of the
attribute
being
modified
If selected, the
attribute values
are restricted to
an enumeration
(a predefined
set of allowable
values).
To add a value to the Data type of

enumeration, enter the Name, the attribute
Value, and (optionally)
Description and click OK.
6. Save the changes and close the Component Editor.
Public Information
4.4.4 Block Exclusion with Instance Script
➢ To exclude a function block from a user block with an instance script
1. Open the test System Editor and double-click the Library Container Editor.
Right-click the
MOVE_2 block
and select Add
Instance Script
The block icon

displays a blue S
to indicate that a
script was added
2. Repeat these steps for the MOVE_3 block item.

3. From the Tree View, select the MOVE_3 block item. In the Property Editor, select the Instance Script field and
click the ellipsis button. The Edit Text dialog box displays with the default Instance Script: Block.Include =
Device.Attribute("Attr1").BoolValue
4. 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
5. Save and close the Library Container.
6. From the System Editor, open the Component Editor.
7. From the General tab Tree View, select Attributes. From the Data Grid, click the Value cell of the Attr1 row and
click the ellipsis button.
8. From the Modify Value dialog box, change the value to True and click OK.
9. From the Software tab Tree View, expand the Prog1 item.
10. Right-click Lib1Usb1 and select Instance. The user block contents display in the Summary View with MOVE_1
and MOVE_2 blocks. The block MOVE_3 was excluded by the instance script created in step 8 because Attr1 is set to
True.
11. From the General tab Tree View, select Attributes. Click the Value cell in the Attr1 row, click the ellipsis button,
change the value to False, and click OK.
12. From the Software tab Tree View, right-click Lib1Usb1 and select Instance. Since Attr1 is now set to False, the
instance script causes the block MOVE_2 to stop displaying and the block MOVE_3 to display instead.

Public Information
13. Save and close the component.
4.4.5 Text Substitution with Attribute

➢ To substitute text into a user block with an attribute
1. Open the test System Editor.
2. From the Tree View, double-click the Library Container Editor.
3. From the Tree View, expand Lib1, right-click the Lib1Usb1 user block, and select Add User Attribute
4. Change the attribute name to Attr1_u and click OK. A new Attributes item displays in the Tree View under the user
block definition Lib1Usb1.
5. From the Tree View, select Attributes.
6. From the Data Grid, change the Attr1_u data type to STRING by clicking the Type cell (which currently contains
UNDEFINED), and selecting STRING from the drop-down list.
7. Change the PromptForInput cell of Attr1_u to True. (You may have to scroll right in the Data Grid to locate the
PromptForInput column.)
8. Now that the attribute has been created, create a user block variable with text substitution in its name. From the Tree
View, click Variables.
9. From the Data Grid, click the Name cell in the Append row (indicated by an asterisk *) and {Attr1_u}_thing. Leave
the data type set to the default value, BOOL.
10. 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.
11. In the Summary View, double-click the enable pin of the block MOVE_1.
Public Information
12. Click to select Local Variable. Then, enter the variable name {Attr1_u}_thing in the text box and click OK. The block
diagram updates to reflect the new connection.
13. Save the Library Container and close the editor.

14. To see the text substitution in action, open the Component Editor.
15. From the Software tab Tree View, expand the Prog1 item.
16. From the Tree View, right-click Lib1Usb1 and select Instance. An Attributes item is added to the Tree View.
17. From the Tree View, click the Attributes item. The attribute Attr1_u created in step 5 displays in the Data Grid.
18. Click the Initial Value cell of the Attr1_u row. Click the Ellipsis button and enter the text ABCDEFG to be
substituted. Click OK.
19. From the Tree View, right-click the Lib1Usb1 user block and select Instance. The value entered for Attr1_u is
substituted into the variable {Attr1_u}_thing and into the MOVE_1 ENABLE pin connection, creating a variable
named ABCDEFG_thing.

Public Information
20. To verify that the variable name substitution has occurred, click the Variables item under the user block Lib1Usb1.
The ABCDEFG_thing variable displays in the Summary View.
21. Save the component and save the editor.
4.5 Intrinsic Variables for Application Software

The ToolboxST application uses global intrinsic variables to display the status of various components and functions. They can
also be used as referenced variables in controller application logic. All intrinsic variables are read-only unless otherwise
specified.
Public Information
Mark VIe Intrinsic Variables
Data Engineering Min
Global Intrinsic Variables Description Max Limit
Type Unit Limit
When this variable is set to True, a command is generated for
Alarm.Ack acknowledging all alarms in the Alarm or Hold queue not previously BOOL TRUE/FALSE 1 0
acknowledged (read/write).
Output variable that contains the number of alarms in the alarm
Alarm.AckCount UINT Number 65535 0
queue that have been acknowledged
Output variable that contains the number of alarms currently in the
Alarm.ActiveCount UINT Number 65535 0
alarm queue
Output variable that is set to True every time a new alarm occurs. It
can be reset either by toggling the Alarm Horn Silence variable or
Alarm.Horn BOOL TRUE/FALSE 1 0
by sending the Silence Horn SDI command. The alarm horn is also
silenced when all alarms are removed from the queue.
When this variable is True, a command is generated to silence the
Alarm.HornSilence BOOL TRUE/FALSE 1 0
horn (read/write)
Output variable that is set to True when the alarm queue contains
Alarm.Indicator BOOL TRUE/FALSE 1 0
one or more active alarms.
When this variable is set to True, a command resets all alarms after
checking if reset is allowed for those alarms. A reset command is
Alarm.Reset allowed for an alarm if it is in the queue but is not alarmed, and the BOOL TRUE/FALSE 1 0
alarm has already been acknowledged. Once an alarm is reset, it is
removed from the alarm queue (read/write).
Used to determine the current status of Alarm.Ack, Alarm.Reset,
AlarmSpecialToken and Alarm.HornSilence. This value should not be used by the UINT Do not use N/A N/A
application.
Alarm.UnackCount UINT Number 65535 0
queue that have not been acknowledged.
Bit-masked value indicating if a restart is allowed, if a download is
allowed, or if the processor is currently downloading. The meaning
AppStatus_X UINT Do not use N/A N/A
of this intrinsic is subject to change, so this value should not be
used.
Contains the revision number of the auto reconfiguration for
Seconds since
AutoReconfigRevision_X processor X. This value is used to check for equality between the UDINT 4294967295 0
01/01/1970
controller and the ToolboxST application.

Public Information
Mark VIe Intrinsic Variables (continued)
Type Unit Limit
Value indicates whether or not processor X is a CDH
communicator. A value of 1 means that processor X is a CDH
communicator. The designated controller is always a CDH
CDHCommunicator_X UINT Enumeration 1 0
communicator. A second processor may also be a CDH
communicator if it loses communications with the designated
controller on the CDH network.
Value contains the processor ID, and is different within a redundant
set. A value of 1 corresponds to the R processor, a value of 2
ControllerID UINT Number 3=T 1=R
corresponds to the S processor, and a value of 3 corresponds to
the T processor.
Heartbeat value coming from processor X. This value should
ControllerStateHeartbeat_X UDINT Number 4294967295 0
always be changing.
Contains the UTC time as known by processor X as the number of
ControllerTimeNanoSeconds_X nanoseconds within the current second. This is used in conjunction UDINT Nanoseconds 4294967295 0
with ControllerTimeSeconds_X.
Contains the UTC time as known by processor X as the number of
Seconds since
ControllerTimeSeconds_X seconds since January 1, 1970. This is used in conjunction with UDINT 4294967295 0
01/01/1970
ControllerTimeNanoSeconds_X.
Indicates the current state of processor X. The values with the
corresponding state are as follows:
0x00: POWERUP
0xD0: MASTER_INITIALIZATION
0xD1: DC_DETERMINATION
0xD2: DATA_INITIALIZATION
0xD3: INPUTS_ENABLED
0xD5: EXCHANGE_INITIALIZATION
ControlState_X UINT Enumeration 0xFF 0x00
0xD6: EXCHANGING
0xD7: SEQUENCING
0xD8: STANDBY
0xDA: CONTROLLING
0xDB: LOADING
0xDC: LOAD_DONE
0xDF: FAILURE
0xFF: NOT_APPLICABLE
Public Information
Type Unit Limit
Used prior to the processor reaching the Controlling state to
indicate why the processor is paused in that state. A value of 0
means that the processor has reached the Controlling state. The
other values in the following list are permissives and indicate what
the processor is currently waiting for. These values are subject to
change in future releases.
20: CONTROLLER_ID_DETERMINED
21: SYS_ONLINE
22: DC_DETERMINED
24: NVRAM_DATA_INIT_COMPLETE
25: APP_DATA_INIT_COMPLETE
28: INPUTS_RECEIVED
29: FRAME_SYNCHRONIZED
30: INPUTS_VOTED
31: STATES_INITIALIZED
32: STATES_EXCHANGED
ControllerReasonCode_X DINT Enumeration 46 –1
33: BLOCKWARE_RUNNING
34: LOAD_COMMAND_RECEIVED
35: ONLINE_LOAD_COMPLETE
36: APPLICATION_EQUALITY
37: APPLICATION_EQUALITY_STANDBY
38: OUTPUTS_RECEIVED
39: APP_MANAGER_DRIVERS_LOADED
40: ACFG_CONFIG_RELEASED
41: FF_DEVICES_PRESENT
42: IOAPP_INITIALIZED
43:IOAPP_CONFIG_COMPLETE
44: IOAPP_PROCESS_RUNNING
45: IOAPP_STANDBY_COMPLETE
46. VALID_PROCESSES_FOUND
Additionally, a value of -1 means that the FAILURE state has been
entered, although this is not actually a permissive.
Indicates the X processor revision of the Dynamic Data Recorder.
Seconds since
DdrRevision_X This value is used to check for equality between the controller and UDINT 4294967295 0
01/01/1970
the ToolboxST application.
Contains configurable internal information not intended for
DebugFloat_X REAL Do not use N/A N/A
application use.

Public Information
Type Unit Limit
All process alarms are placed in the Default Inhibit Group unless
otherwise configured for a specific inhibit group. When the
DefaultGrpInhibit DefaultGrpInhibit intrinsic is set to True, all process alarms in the BOOL TRUE/FALSE 1 0
default group are inhibited. This intrinsic should be used with
extreme caution.
Identifies the designated controller as known to processor X. A
value of 0 corresponds to unknown, 1 corresponds to the R 0=
DesignatedController_X UINT Number 3=T
processor, 2 corresponds to the S processor, and 3 corresponds to Unknown
the T processor.
Indicates the CRC of the device backup file for processor X. This
DeviceBackupCrc_X value is used to check for equality between the controller and the UDINT Number 4294967295 0
ToolboxST application.
Indicates whether the X processor has a backup file on flash. This
value is True if the device backup file exists, and False if the device
DeviceBackupExists_X BOOL TRUE/FALSE 1 0
backup file does not exist. Downloading the device backup file is
selectable in the controller download wizard.
Indicates the revision of the FOUNDATION Fieldbus live list. This value
starts at 1 and increments as the device configuration changes or if
FFLiveListRev_X the device loses and regains connection to the processor X. This UDINT Number 4294967295 1
value is used for internal communication coherency, and is not
intended for application use.
Value indicates the number of forced variables known to the X
processor. A variable's value may be forced in the ToolboxST
Forces_X UINT Number of forces 65535 0
application, which overrides the value produced by the application
code. Forced variables are stored in NVRAM.
Corresponds to the sequence number for forcing on the X
ForcesSeqNum_X processor. This value is used for internal communication UDINT Do not use N/A N/A
coherency and is not intended for application use.
Indicates what percentage of the frame is not used for frame-critical
operation (inputs, outputs, application code), and is available for
FrameIdleTime_X REAL % 100 0
lower priority operations (ToolboxST communications, online loads,
and such).
True if a hardware diagnostic is raised for processor X. The
HardwareAlarm_X BOOL TRUE/FALSE 1 0
HardwareAlarmReason_X explains the cause of the diagnostic.
Bit-encoded variable that provides the reason why the
HardwareAlarmReason_X HardwareAlarm_X is set for processor X. The CTRLR_MON block UDINT bit encoded N/A N/A
is used to interpret the reason code.
Public Information
Type Unit Limit
When the controller is a UDH communicator, if the alarm manager
finds any active holds that are not overridden it sets this variable.
Otherwise this variable will be false. If there are four active holds in
Hold.Permissive BOOL TRUE/FALSE 1 0
the queue and all four are overridden, Hold Permissive will be set
to false. If override is removed from any one of the four holds, Hold
Permissive is again set.
Indicates what percentage of the overall CPU time is not executing
IdleTime_X code for processor X. This value is not the same as FrameIdle_X. REAL % 100 0
This is also known as the system idle time.
Value indicates whether or not the X processor is frame
Is_Synced_X synchronized. This value should be true once the processor has BOOL TRUE/FALSE 1 0
passed the DC_DETERMINATION state.
Indicates whether the auto-reconfiguration server is currently
IsAutoReconfigDownloading_X downloading an I/O module. Controllers and I/O modules should BOOL TRUE/FALSE 1 0
not be powered off or downloaded when this value is true.
Value is True when the X processor has auto-reconfiguration
IsAutoReconfigEnabled_X BOOL TRUE/FALSE 1 0
enabled.
Indicates whether all consumed CDH EGD exchanges are healthy
IsCdhEgdHealthy_X on the X processor. A False indication means that there is at least BOOL TRUE/FALSE 1 0
one unhealthy consumed exchange.
Indicates whether there is currently a dynamic bind in progress on
IsDynamicBindActive_X BOOL TRUE/FALSE 1 0
processor X. This value indicates that a download is not allowed.
Declares whether processor X has its UTC clock synchronized to
IsNtpSynced_X an NTP source. A value of True indicates that the clock is BOOL TRUE/FALSE 1 0
synchronized.
Indicates whether all consumed UDH EGD exchanges are healthy
IsUdhEgdHealthy_X on the X processor. A False indication means that there is at least BOOL TRUE/FALSE 1 0
one unhealthy consumed exchange.
Indicates whether there is an active or an inactive diagnostic in the
diagnostic queue for processor X. If this value is true, there is at
least one diagnostic. To view and/or clear diagnostics, from the
L3Diag_X BOOL TRUE/FALSE 1 0
ToolboxST System Editor, double-click the controller to display the
Component Editor, and from the View menu, select Diagnostics
and Controller Diagnostics.

Public Information
Type Unit Limit
Indicates the major revision for the application on processor X. This
value is used to check for equality between the processor and the
Seconds since
MajorRevision_X ToolboxST application. A difference in the major revision between UDINT 4294967295 0
01/01/1970
the processor and the ToolboxST application means that on a
download, a processor restart is required.
Indicates the minor revision for the application on processor X. This
value is used to check for equality between the processor and the
Seconds since
MinorRevision_X ToolboxST application. A difference in the minor revision between UDINT 4294967295 0
01/01/1970
the processor and the ToolboxST application means that on a
download, a processor restart may or may not be required.
The overall system CRC. For internal use only. This value should
OverallConfigCrc_X UINT Do not use N/A N/A
not be used by the application.
Indicates the build number for the controller product
ProductRevision_Build Example: V01.02.03C Build 456, with build number indicated in UDINT Number 4294967295 0
bold
Indicates the major revision for the controller product
ProductRevision _Major Example: V01.02.03C Build 456, with major revision number UINT Number 99 1
indicated in bold
Indicates the minor revision for the controller product
ProductRevision_Minor Example: V01.02.03C Build 456, with minor revision number UINT Number 99 0
indicated in bold
Indicates the patch revision for the controller product
ProductRevision_Patch Example: V01.02.03C Build 456, with patch revision number UINT Number 99 0
indicated in bold
Indicates the build status (Alpha, Beta, Charlie) for the controller A=1
ProductRevision_Status product UINT Enumeration B=2 N/A
Example: V01.02.03C Build 456, with build letter indicated in bold C=3
Value indicates the redundancy of the controller set: 0=
Redundancy UINT Enumeration 3=TMR
Values: 1=Simplex, 2=Dual, and 3=TMR Unknown
Public Information
Type Unit Limit
Enumerated value for the current security state of processor X. The
different states are:
0: OPEN
1: NEGOTIATE
2: GETTING_CA_CERTIFICATE
SecurityState_X UINT Enumeration 6 1
3: ENROLLING
4: GETTING_CA_CERTIFICATE_REVOCATION_LIST
5: AUTHENTICATED
6: SECURED
Any other value indicates an invalid state.
Time synchronization error relative to the limits. The
synchronization regulator must be within the limits to reach frame
synchronization. The meaning of this intrinsic is subject to change,
Sync_Err_Sigma_X LREAL Do not use N/A N/A
so this value should not be used. If a user wishes to see if the
processor is time synchronized, the Is_Synced_X intrinsic should
be used.
Time synchronization regulator error. This value is the relative error
from the master to the slave. The meaning of this intrinsic is subject
Sync_Est_Error_X to change, so this value should not be used. If a user wishes to see LREAL Do not use N/A N/A
if the processor is time synchronized, the Is_Synced_X intrinsic
should be used.
Value indicates whether or not processor X is a UDH
communicator. A value of 1 means that processor X is a UDH
communicator. The designated controller is always a UDH
UDHCommunicator_X UINT Enumeration 1 0
communicator. A second processor may also be a UDH
communicator if it loses communications with the designated
controller on the UDH network.

Public Information
Mark VIeS Intrinsic Variables
Data Engineering Max Min
Alarm Name Description
Type Unit Limit Limit
When this variable is set to True, a command is generated for
Alarm.Ack acknowledging all alarms in the Alarm or Hold queue not BOOL TRUE/FALSE 1 0
previously acknowledged (read/write).
Alarm.AckCount UINT Number 65535 0
queue that have been acknowledged.
Output variable that contains the number of alarms currently in
Alarm.ActiveCount UINT Number 65535 0
the alarm queue
Output variable that is set to True every time a new alarm
occurs. It can be reset either by toggling the Alarm Horn
Alarm.Horn Silence variable or by sending the Silence Horn SDI command. BOOL TRUE/FALSE 1 0
The alarm horn is also silenced when all alarms are removed
from the queue.
When this variable is True, a command is generated to silence
Alarm.HornSilence BOOL TRUE/FALSE 1 0
the horn. (read/write).
Output variable that is set to True when the alarm queue
Alarm.Indicator BOOL TRUE/FALSE 1 0
contains one or more active alarms.
When this variable is set to True, a command resets all alarms
after checking if reset is allowed for those alarms. A reset
command is allowed for an alarm if it is in the queue but is not
Alarm.Reset BOOL TRUE/FALSE 1 0
alarmed, and the alarm has already been acknowledged. Once
an alarm is reset, it is removed from the alarm queue
(read/write).
Used to determine the current status of Alarm.Ack, Alarm.
AlarmSpecialToken Reset, and Alarm.HornSilence. This value should not be used UINT Do not use N/A N/A
by the application.
Alarm.UnackCount UINT Number 65535 0
queue that have not been acknowledged.
AppStatus _X is a bit-masked value indicating if a restart is
allowed, if a download is allowed, or if the processor is currently
AppStatus_X UINT Do not use N/A N/A
downloading. The meaning of this intrinsic is subject to change,
so this value should not be used.
The AutoReconfigRevision _X contains the revision number of
the auto reconfiguration for processor X. This value is used to Seconds since
AutoReconfigRevision_X UDINT 4294967295 0
check for equality between the controller and the ToolboxST 01/01/1970
application.
Public Information
Mark VIeS Intrinsic Variables (continued)
The CDHCommunicator_X value indicates whether or not
processor X is a CDH communicator. A value of 1 means that
processor X is a CDH communicator. The designated controller
CDHCommunicator_X UINT Enumeration 1 0
is always a CDH communicator. A second processor may also
be a CDH communicator if it loses communications with the
designated controller on the CDH network.
The ControllerID value contains the processor ID, and is
different within a redundant set. A value of 1 corresponds to the
ControllerID UINT Number 3=T 1=R
R processor, a value of 2 corresponds to the S processor, and a
value of 3 corresponds to the T processor.
The ControllerStateHeartbeat_X is the heartbeat value coming
ControllerStateHeartbeat_X UDINT Number 4294967295 0
from processor X. This value should always be changing.
The ControllerTimeNanoSeconds_X contains the UTC time as
known by processor X as the number of nanoseconds within
ControllerTimeNanoSeconds_X UDINT Nanoseconds 4294967295 0
the current second. This is used in conjunction
withControllerTimeSeconds_X.
The ControllerTimeSeconds_X contains the UTC time as
known by processor X as the number of seconds since January Seconds since
ControllerTimeSeconds_X UDINT 4294967295 0
1, 1970. This is used in conjunction 01/01/1970
withControllerTimeNanoSeconds_X.

Public Information
The ControllerReasonCode_X is used prior to the processor
reaching the Controlling state to indicate why the processor is
paused in that state. A value of 0 means that the processor has
reached the Controlling state. The other values in the following
list are permissives and indicate what the processor is currently
waiting for. These values are subject to change in future
releases.
20: CONTROLLER_ID_DETERMINED
21: SYS_ONLINE
22: DC_DETERMINED
24: NVRAM_DATA_INIT_COMPLETE
25: APP_DATA_INIT_COMPLETE
28: INPUTS_RECEIVED
29: FRAME_SYNCHRONIZED
30: INPUTS_VOTED
31: STATES_INITIALIZED
ControllerReasonCode_X 32: STATES_EXCHANGED DINT Enumeration 46 –1
33: BLOCKWARE_RUNNING
34: LOAD_COMMAND_RECEIVED
35: ONLINE_LOAD_COMPLETE
36: APPLICATION_EQUALITY
37: APPLICATION_EQUALITY_STANDBY
38: OUTPUTS_RECEIVED
39: APP_MANAGER_DRIVERS_LOADED
40: ACFG_CONFIG_RELEASED
41: FF_DEVICES_PRESENT
42: IOAPP_INITIALIZED
43:IOAPP_CONFIG_COMPLETE
44: IOAPP_PROCESS_RUNNING
45: IOAPP_STANDBY_COMPLETE
46. VALID_PROCESSES_FOUND
Additionally, a value of -1 means that the FAILURE state has
been entered, although this is not actually a permissive.
Public Information
The ControlState_X value indicates the current state of
processor X. The values with the corresponding state are as
follows:
0x00: POWERUP
0xD0: MASTER_INITIALIZATION
0xD1: DC_DETERMINATION
0xD2: DATA_INITIALIZATION
0xD3: INPUTS_ENABLED
ControlState_X 0xD5: EXCHANGE_INITIALIZATION UINT Enumeration 0xFF 0x00
0xD6: EXCHANGING
0xD7: SEQUENCING
0xD8: STANDBY
0xDA: CONTROLLING
0xDB: LOADING
0xDC: LOAD_DONE
0xDF: FAILURE
0xFF: NOT_APPLICABLE
The DdrRevision_X indicates the X processor revision of the
Seconds since
DdrRevision_X Dynamic Data Recorder. This value is used to check for UDINT 4294967295 0
01/01/1970
equality between the controller and the ToolboxST application.
The DebugFloat_X contains configurable internal information
DebugFloat_X REAL Do not use N/A N/A
not intended for application use.
All process alarms are placed in the Default Inhibit Group
unless otherwise configured for a specific inhibit group. When
DefaultGrpInhibit the DefaultGrpInhibit intrinsic is set to True, all process alarms BOOL TRUE/FALSE 1 0
in the default group are inhibited. This intrinsic should be used
with extreme caution.
The DesignatedController_X identifies the designated controller
as known to processor X. A value of 0 corresponds to unknown, 0=
DesignatedController_X UINT Number 3=T
1 corresponds to the R processor, 2 corresponds to the S Unknown
processor, and 3 corresponds to the T processor.
The DeviceBackupCrc_X indicates the CRC of the device
DeviceBackupCrc_X backup file for processor X. This value is used to check for UDINT Number 4294967295 0
equality between the controller and the ToolboxST application.

Public Information
The DeviceBackupExists_X indicates whether the X processor
has a backup file on flash. This value is True if the device
DeviceBackupExists_X backup file exists, and False if the device backup file does not BOOL TRUE/FALSE 1 0
exist. Downloading the device backup file is selectable in the
controller download wizard.
The FFLiveListRev_X indicates the revision of the FOUNDATION
Fieldbus live list. This value starts at 1 and increments as the
device configuration changes or if the device loses and regains
FFLiveListRev_X UDINT Number 4294967295 1
connection to the processor X. This value is used for internal
communication coherency, and is not intended for application
use.
The Forces_X value indicates the number of forced variables
known to the X processor. A variable's value may be forced in
Forces_X UINT Number of forces 65535 0
the ToolboxST application, which overrides the value produced
by the application code. Forced variables are stored in NVRAM.
The ForcesSeqNum_X corresponds to the sequence number
for forcing on the X processor. This value is used for internal
ForcesSeqNum_X UDINT Do not use N/A N/A
communication coherency and is not intended for application
use.
The FrameIdleTime_X indicates what percentage of the frame
is not used for frame-critical operation (inputs, outputs,
FrameIdleTime_X REAL % 100 0
application code), and is available for lower priority operations
(ToolboxST communications, online loads, and such).
The HardwareAlarm_X is True if a hardware diagnostic is
raised for processor X. The HardwareAlarmReason_X explains
HardwareAlarm_X the cause of the diagnostic. BOOL TRUE/FALSE 1 0
The HardwareAlarmReason_X value is a bit-encoded variable

that gives the reason why the HardwareAlarm_X is set for
HardwareAlarmReason_X UDINT bit encoded N/A N/A
processor X. The CTRLR_MON block is used to interpret the
reason code.
When the controller is a UDH communicator, if the alarm
manager finds any active holds that are not overridden it sets
this variable. Otherwise this variable will be false. If there are
Hold.Permissive BOOL TRUE/FALSE 1 0
four active holds in the queue and all four are overridden, Hold
Permissive will be set to false. If override is removed from any
one of the four holds, Hold Permissive is again set.
Public Information
The IdleTime _X indicates what percentage of the overall CPU
time is not executing code for processor X. This value is not the
IdleTime_X REAL % 100 0
same as FrameIdle_X. This is also known as the system idle
time.
The Is_Synced _X value indicates whether or not the X
processor is frame synchronized. This value should be true
Is_Synced_X BOOL TRUE/FALSE 1 0
once the processor has passed the DC_DETERMINATION
state.
The IsAutoReconfigDownloading_X indicates whether the
auto-reconfiguration server is currently downloading an I/O
IsAutoReconfigDownloading_X BOOL TRUE/FALSE 1 0
module. Controllers and I/O modules should not be powered off
or downloaded when this value is true.
The IsAutoReconfigEnabled_X value is True when the X
IsAutoReconfigEnabled_X BOOL TRUE/FALSE 1 0
processor has auto-reconfiguration enabled.
IsCdhEgdHealthy_X indicates whether all consumed CDH
EGD exchanges are healthy on the X processor. A False
IsCdhEgdHealthy_X BOOL TRUE/FALSE 1 0
indication means that there is at least one unhealthy consumed
exchange.
IsDynamicBindActive_X indicates whether there is currently a
IsDynamicBindActive_X dynamic bind in progress on processor X. This value indicates BOOL TRUE/FALSE 1 0
that a download is not allowed.
IsNtpSynced_X declares whether processor X has its UTC
IsNtpSynced_X clock synchronized to an NTP source. A value of True indicates BOOL TRUE/FALSE 1 0
that the clock is synchronized.
IsUdhEgdHealthy_X indicates whether all consumed UDH
EGD exchanges are healthy on the X processor. A False
IsUdhEgdHealthy_X BOOL TRUE/FALSE 1 0
indication means that there is at least one unhealthy consumed
exchange.
L3Diag_X indicates whether there is an active or an inactive
diagnostic in the diagnostic queue for processor X. If this value
is true, there is at least one diagnostic. To view and/or clear
L3Diag_X BOOL TRUE/FALSE 1 0
diagnostics, from the ToolboxST System Editor, double-click
the controller to display the Component Editor, and from the
View menu, select Diagnostics and Controller Diagnostics.

Public Information
MajorRevision_X indicates the major revision for the application
on processor X. This value is used to check for equality
between the processor and the ToolboxST application. A Seconds since
MajorRevision_X UDINT 4294967295 0
difference in the major revision between the processor and the 01/01/1970
ToolboxST application means that on a download, a processor
restart is required.
MinorRevision_X indicates the minor revision for the application
on processor X. This value is used to check for equality
between the processor and the ToolboxST application. A Seconds since
MinorRevision_X UDINT 4294967295 0
difference in the minor revision between the processor and the 01/01/1970
ToolboxST application means that on a download, a processor
restart may or may not be required.
The overall system CRC. For internal use only. This value
OverallConfigCrc_X UINT Do not use N/A N/A
should not be used by the application.
The Redundancy value indicates the redundancy of the 0=
Redundancy UINT Enumeration 3=TMR
controller set. A value of 1=Simplex, 2=Dual, and 3=TMR. Unknown
The SecurityState_X is the enumerated value for the current
security state of processor X. The different states are:
0: OPEN
1: NEGOTIATE
2: GETTING_CA_CERTIFICATE
SecurityState_X UINT Enumeration 6 1
3: ENROLLING
4: GETTING_CA_CERTIFICATE_REVOCATION_LIST
5: AUTHENTICATED
6: SECURED
Any other value indicates an invalid state.
Sync_Err_Sigma_X is the time synchronization error relative to
the limits. The synchronization regulator must be within the
limits to reach frame synchronization. The meaning of this
Sync_Err_Sigma_X LREAL Do not use N/A N/A
intrinsic is subject to change, so this value should not be used.
If a user wishes to see if the processor is time synchronized,
the Is_Synced_X intrinsic should be used.
Public Information
The Sync_Est_Error_X is the time synchronization regulator
error. This value is the relative error from the master to the
slave. The meaning of this intrinsic is subject to change, so this
Sync_Est_Error_X LREAL Do not use N/A N/A
value should not be used. If a user wishes to see if the
processor is time synchronized, the Is_Synced_X intrinsic
should be used.
The UDHCommunicator_X value indicates whether or not
processor X is a UDH communicator. A value of 1 means that
processor X is a UDH communicator. The designated controller
UDHCommunicator_X UINT Enumeration 1 0
is always a UDH communicator. A second processor may also
be a UDH communicator if it loses communications with the
designated controller on the UDH network.

Public Information
Notes
Public Information
5 Block Diagram Editor
This feature is not available for the WorkstationST component.
Attention
Software in the controller consists of blocks that perform control logic functions. The controller runtime provides a library of
standard blocks that can be combined to form user blocks. The Block Diagram Editor allows you to create and edit user
blocks using a visual interface and drag-and-drop tools. The Block Diagram Editor displays in the Summary View when a
user block is selected in the Tree View.
From the Tree View, Library View contains

Shape- Zoom Full- categories of blocks
select a user block to
Wiring drawing in and screen Detached
display the editor in that perform various
tool tools out view view functions
the Summary View
Additional editing tools display on the toolbar, and a sidebar called the Library View displays on the right side of the
Summary View to allow you to make changes to a user block.
Note If the user block is read-only or linked, an error message displays. If the user block is protected, you are prompted to
enter the appropriate password.
Block Diagram Editor GEH-6703P User Guide 223

Public Information
5.1 Diagram Commands
When you right-click an empty portion of the diagram, the Diagram shortcut menu includes the following items.
Auto-Layout Mode Controls how the blocks on the diagram are arranged. Refer to the section Layout Modes.
Diagram Settings Displays the Diagram Settings
Append Sheet Adds a new drawing sheet at the end of the drawing
Insert Sheet Inserts a sheet immediately before the current sheet in manual mode
Delete Sheet Deletes the current sheet in manual mode
Rename Sheet Opens the Rename Sheets dialog box
Edit Sheet Border Opens the Sheet Border Editor
Print Sheet Prints the current sheet
Zoom Adjusts the zoom level to either a preset zoom level or a custom value
View Settings Allows you to toggle the rulers, library view, and print border
Paste Inserts the contents of the clipboard at the selected location
Public Information
5.2 Rename Sheets
Individual sheets can be renamed to follow any standard naming convention needed for a particular system. The sheet names
are used in page numbering and cross references, and must be unique within a particular device.
➢ To rename sheets: from the Tree View, right-click Programs or right-click anywhere in the empty portion of the
diagram.
Software path Enter sheet name and click

and sheet number Rename (cannot be undone)
Note For a particular sheet, you can enter a complete sheet name or use certain substitution characters to automatically
number or letter the sheets within a particular diagram.
Sheet Names
Substitution
Represents Example
Character
# Sheet number
One of the 26 uppercase ASCII letters (A-Z)
@ Sheet letter
{AttributeName} Attribute

Public Information
5.3 Customize Sheet Borders
By default, each sheet in a block diagram has a border that consists of a rectangle with grid coordinates and a footer that
contains information about the diagram. The footer information is selected to be as universal as possible, but additional
information is often required. Both the border and the footer can be customized for a particular system.
➢ To customize the sheet border: from anywhere in the Block diagram: right-click and select Edit Sheet Border.
Select Border or
Footer options.
Preview
selected
options.
Edit footer,
then select
either Export
or Import for
border re-use.
Public Information
5.3.1 Border Options
Border Option Description
Border Name Text field to name the border
Border Description Text fields to describe the border
Coordinates When selected, draws the grid of letters and numbers on the border
Outer Line When selected, draws a rectangle around the outer edge of the border
Inner Line When selected, draws a rectangle around the inner edge of the border
When selected, draws the footer. When unchecked, the Footer Options and Footer Block section of
Footer
the dialog box is grayed out.
Footer Height Total vertical space allocated to the footer
Number of rows in the footer; each row is allocated vertical space equal to the footer height divided
Footer Rows
by the number of rows
Number of columns in the footer; each column is allocated horizontal space equal to the border
Footer Columns
width (which is paper size-dependent) divided by the number of columns
5.3.2 Preview
The Preview section displays how the border looks with the selected options. Additional preview features include the
following:
• Scroll the preview and zoom in and out

• Footer cell being edited in the Footer Block section is highlighted in the preview and the user can left-click a footer block
to select it for editing
• Press and hold the left mouse button and drag a footer block to move it around the footer

Public Information
5.3.3 Footer Block
The currently selected cell in the footer can be modified in the Footer Block section.
Cell Description
Next Cell Selects the next cell in the footer (list is sorted in Z order back to front)
Previous Cell Selects the previous cell in the footer (list is sorted in Z order back to front)
Delete Cell Removes the current cell from the footer. The button is only visible if a cell is selected.
Adds a new cell to the footer at the current Row and Column. The button is only visible if no cell is
Create Cell currently selected. Clicking an empty spot on the footer in the Preview makes the Create Cell visible
and presets the Row and Column fields to where you clicked in the preview.
Top-most Footer row for the current cell. It does not need to be within the footer boundaries, which
Row
allows special effects like non-rectangular footers.
Column Left-most Footer row for the current cell
Height Number of rows taken up by the current cell
Width Number of columns taken up by the current cell
Empty When selected, causes the cell to display no content
Text Allows you to enter custom text into the cell
Sheet Information Displays a pre-defined cell
Image Display an image in the cell
Export Saves the current border from the editor to a specific .xml file
Import Loads a specific border .xml file into the editor
Cancel Closes the editor without saving changes

Saves the editor to the .xml file for the current device. The border .xml file is always named
OK
SheetBorder.border.xml, and is saved in the same location as the device .xml file.
5.3.4 Custom Text

Select the Custom Text option to customize the following text:
• Caption is text displayed in a smaller font on the first line of the cell.
• Text is text displayed in a larger font on the second line of the cell.
Note You can also define attributes at the device level.
For both fields, the text is clipped to the size of the cell (no wrapping) and both support Attribute substitutions. For example,
if the custom text for a border cell is custom Text with {Attr1} substitution, the {Attr1} is replaced with the current value of the
user attribute Attr1 in whatever context the border is drawn. If Attr1 is not defined, it is removed from the text. These attribute
substitutions allow the user to customize footer contents for specific programs, tasks, or user blocks.
Public Information
5.3.5 Sheet Information
Information Type provides a drop-down list of different pre-defined cells.
Requisition information from the system and device includes:
• Customer Site
• Customer Name
• Drawing Number
• Engineer
• Requisition Number
• Process Application
• Shop Order Number
• DM Number
• Serial Number
• Machine Size
Automatically-generated configuration data includes:
• User Block Revision

• Build Major Revision
• Build Minor Revision
• Last Modified
• Print Date
• ToolboxST Version
• Component Name
• Software Path
• Sheet Number
• Next Sheet Number
There is also a special automatically-generated cell called Title. The Title cell displays the description text associated with the
user block or task. If description is blank, Title looks for the first block contained in the user block or task with a description
that is not blank. If no block description is found, Title looks for the first text shape drawn in the user block or task.
Certain user blocks and library blocks are designed to be dragged from the Component Editor Software tab to the
CIMPLICITY application. This screen-building software enables you to create graphical objects to represent a block, as well
as automatically configure the graphical objects to use block-defined global variables.

Public Information
5.4 Variables and Blocks
Many blocks in the ToolboxST Standard Block libraries support a special type of variable that contains both a value and an
enumerated status. The value can be any of the Analog data types, while the status is a UINT with pre-defined enumeration
values.
5.4.1 Blocks with Status

Many blocks have pins that generate status. For some blocks, status is optional. For example, there is both a status and a
non-status version of most Math blocks (Add, Mult, and such).
Blocks with Status

Certain blocks, such as the Analog Input (AI) block always use status. Pins with status contain a small slash that indicates
more than one value is represented by the line. Status pins can be connected to each other or connected to non-status pins or
immediate values. If a non-status variable or immediate value is connected to a status input pin, the pin always has the default
status value.
AI Block with Status
Public Information
Status Combine and Status Split Blocks
It is sometimes necessary to create a status variable from a normal analog value and a particular status value. Analog and
status values can be split into separate variables using the STATUS_COMBINE and STATUS_SPLIT blocks (illustrated in the
following figure).
Analog value Live value (in

parentheses)
Status value Combines is an

AnalogWithStatus
Variables Split using STATUS_COMBINE and STATUS_SPLIT Blocks

Public Information
5.4.2 Block Shapes and Lines
Block shapes are used to enhance readability of block diagrams. They are defined in the Standard Block Library and other
optional libraries.
Block lines provide visual representation of status and connection. For example, Boolean blocks have dashed lines to indicate
they are Boolean values. Analog blocks have solid lines to indicate they have Analog values. Block lines are certain colors to
indicate online status.
Block Lines
Block Type Line Type Line Color Status
Black Normal
Online Analog Solid
Magenta Bad Quality
Red True
Grey False
Online Digital Dashed
Orange Forced True
Blue Forced False
Example of Block Shapes and Lines
Public Information
5.4.3 Variable Input Blocks
Certain blocks (such as Add and And) referred to as Rubber blocks have a variable number of pins and are drawn differently.
Example of Rubber Blocks
Some complex blocks have functional groups of input and output pins.
Grouped
input pins
Example of Grouped Input Pins

Public Information
Certain blocks automatically hide pins that do not apply to the configured mode of operation.
MODE_OPT
set to NONE
MODE_OPT
set to AUTO Auto
displays Auto mode
mode pins pins
Example of Hidden Pins
Note Pins hidden by animations always display if they are connected to a variable.
Public Information
Variables attached to blocks display the configured redundancy next to the block pin.
Example of Configured Redundancy
5.5 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 Toolbox Classic Layout mode, meaning blocks are arranged in order with a focus on optimal
use of space.
Layout Modes
Layout Mode Description

Toolbox Classic Automatically places wires and creates new sheets as necessary, making it appropriate for
Layout small-to-medium sized diagrams
Arranges blocks in execution order in one column, with inputs and outputs lined up on the edges of
List Layout the sheet. All Rung blocks display as Rung diagrams rather than blocks. This mode is ideally suited
for sequencing, and can be used to simplify very large diagrams where wiring becomes confusing.
Does not arrange blocks or wires, but leaves all layout tasks to the user. It is ideal for users familiar
Manual Layout with a sheet-oriented approach to design or for applications where very specific documentation
standards must be met.

Public Information
5.6 Manage Blocks
Managing blocks includes adding blocks and editing block properties.
➢ To add a block
1. From the Library View, select a category and the desired block, then use the drag-and-drop operation to move the block
to the Block Diagram Editor.
Or
From the Tree View, right-click a task, a user block, or a block and select Add Block.
2. Select the desired block and click OK.
Block Selected to Add
Public Information
➢ To edit the properties of a block: click a block in the Block Diagram Editor and modify as needed.
Block Properties
Block Type Name of the library block from which this block was created
Description Text describing the selected block
Unique identifier that allows the block (as well as its attributes and pins) to be referenced
Instance Name
from other places in the ToolboxST application
Instance Script Script that runs when the block is instanced
Height Height of the block in the diagram
Left Location of the left of the block in the diagram
Selected Pin Pin currently selected in the block highlighted in the diagram
Show Description When set to True, displays the description text for this block on the diagram
Top Location of the top of the block in the diagram
Width Width of the block in the diagram
Detached Summary File Backsheet for the selected block
Version Read-only the version number of the source for this block instance
Determines when the block is run. Setting this property automatically renumbers other blocks
Execution Order
in this user block. The blocks are run in sequential order

Public Information
5.7 Wire Block Pins
Block pins are wired together to direct the flow of data through the software. Form a connection 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 for pin connections , which forms connections to both normal blocks and to
blocks with a configurable number of inputs (rubber pins).
Source of the wiring tool Destination

drag-and-drop operation (new rubber pin)
Wire Block Pins
5.7.1 Wire Styles and Colors

Block-connecting wires are represented in a variety of styles and colors to indicate connection values and quality. For
example, wires are solid to represent Analog variables (any Numeric data type) and they are dashed to represent Booleans.
When the ToolboxST application is online with the controller, the wires are different colors to indicate values and quality. The
wires are black when the ToolboxST is offline.
Type and Style Quality Color

Normal Black
Online Analog, solid
Poor Magenta
True Red
False Gray
Online Boolean, dashed
Forced True Orange
Forced False Blue
Forcing of control logic for an operating process is strongly discouraged. Logic forcing
procedures can result in personal injury or death if not strictly followed. Only
adequately trained personnel should modify any programmable machine.
Public Information
5.7.2 Zoom and Pan Tools
➢ To pan the block diagram: from anywhere in the diagram, press and hold the right-mouse button. The cursor displays
as a hand to allow you to pan in any direction.
➢ To use zoom in the block diagram
Select the zoom tool Highlight the area to zoom to
Note While using the Zoom tool, the diagram hyperlinks are active.

Public Information
5.8 Block Shape Shortcut Menu
➢ To display the shortcut menu items: right-click a block.
Menu Items
Item Description
Block Help Displays a help window for the selected block
Opens the New Trender dialog box. Once you enter a name, Trender opens with the block
Add To Trend automatically added.
Refer to the Trender Instruction Guide (GEI-100795).
Opens the new Watch Window dialog box. Once you enter a name, Watch Window opens
Add to Watch
with the block automatically added.
Toggles the display of description text for the block. This text is the most effective way to
Show Description on Diagram
document a block, as the text stays attached to the block when the diagram is rearranged.
Edit Block Pins Displays the Edit Block Pin Connections dialog box.
Unhide all Pins Causes the pins to display
Use Status When enabled, uses the status of each input to calculate the status of each output
Add Pin Group If selected, adds additional inputs
Remove Empty Pin Groups Removes empty inputs
Show boolean logic as Rung (RUNG blocks) displays Boolean logic for the block
Displays the RLD Editor
Edit Ladder Logic
Refer to the section Rung Editor.
Copy Copy a block
Paste Paste the copy to the diagram
Cut Cut a block from the diagram
Delete Delete a block from the diagram
Bring to Front Reorder blocks, causing them to display above or below all other blocks and shapes on
Send to Back the diagram when overlap occurs.
Insert whatever is on the clipboard but sets the run order of the blocks to occur
Paste After
immediately after the right-clicked block.
Public Information
5.9 Pin Connection
Pins represent block inputs and outputs. Parameters are always inputs and are usually constant values that control block
operation. Most parameters are drawn on the block diagram beneath the block; Typically, they do not display if they are set to
the initial default value.
➢ To connect a single pin: from the Block Diagram Editor, double-click a pin.

Public Information
➢ To connect multiple pins: double-click a block in the Block Diagram Editor.
➢ To edit a pin connection

1. From the Connection or Value column, select the cell for the desired pin.
2. Enter a new value or click the down arrow and select a value.
Note Press Enter while entering text to select the next pin on the block, allowing rapid entry of connections.
3. Select the Connection column to display a drop-down list that includes Browse Globals and Browse Locals. Any
enumerated values that are legal for the selected pin also display in the drop-down list. Select an option to display the
Select a Variable dialog box.
All block pin connection changes take effect immediately. (The Edit Block Pin Connections dialog box does not contain an
OK nor a Cancel button.)
➢ To reverse any changes: from the Component Editor Edit menu, select Undo.
Public Information
5.10 Toggle Live Data Layers
To reduce information clutter in the online block diagram you can toggle live data or variable names on and off using various
toolbar buttons.
➢ To toggle between live variables and values: from the diagram Layer toolbar, click the down arrow and select the
desired action.
Diagram Layer Toolbar Menu
Diagram Layer Toolbar Button Functionality

Mode Button Display
Live value only:
Value Only (VAL)
Variable only:
Variable Only (VAR)

Public Information
Mode Button Display
Variable name and live value
Value Over Variable displays the live value larger than the variable:
Variable Over Value displays the variable name larger than the live
value:
Value and Variable (VAL/VAR)
Variable Inline with Value both display larger and may overlap other
shapes in the diagram:
Public Information
5.11 Modify Live Values
If you are online with a controller and the controller is not in Lock mode, you can change the current value stored in a
variable. Optionally, you can also force the new value to prevent programs defined in block diagrams from overwriting your
choices.
Forcing of control logic for an operating process is strongly discouraged. Logic forcing
procedures can result in personal injury or death, if not strictly followed. Only
adequately trained personnel should modify any programmable machine.
➢ To change the value of a variable: from the Software tab (any place variables are used), double-click a variable
value to display the Send Value dialog box and change it as needed.
Boolean Values

Public Information
Displays the
current value
of the variable
Click Send &

Close to send
the Next Value
Enter a to the controller
new value. and close the
dialog box.
Click Send to
send the New
Value to the
Enter a value to
be added to or controller.
subtracted from
the variable. Click to increase
or decrease the
variable by the
Select Force delta value and
Value to prevent send to the
selected value controller.
from being
overwritten.
Numerical Values
Array Values
Public Information
5.12 Shape Drawing Tools
Drawing tools allow you to customize a block diagram. The drawing tools create shapes, which are elements of graphics or
text that provide additional visual information on a drawing sheet. They are accessed from the Block Diagram Editor toolbar.
5.12.1 Variable Rail Tool
The Variable Rail Tool arranges inputs along the left side of a sheet and outputs along the right side to improve
readability. It inserts a variable reference that can be wired to a block pin and moved around freely.
Inputs Outputs
Properties
Item Description
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
On a variable rail display with symbols and cross references that indicate the role of the variable in the
Variables
system
Note The Variable Rail tool is only used in Manual Layout mode. (Refer to the section Layout Modes.) When you select the
Variable Rail tool, a message displays that enables you to switch to this mode.

Public Information
Note For each variable on the rail, cross references to other variable usages display.
Local input
Global variable
Undefined variable
EGD variable
Pin callout
I/O
Variable Rail Symbols
Note The text in the I/O symbol indicates the redundancy for an input.
Connected I/O can be:
• Simplex Input with 1 IONET (S1)
• Simplex Input with 2 IONET (S2)
• Dual Input (D)
• TMR Input (T)
• HotBackup Input (H)
Public Information
Add Variable Rail
➢ To add a variable rail
1. From the Block Diagram Editor, select the Variable Rail drawing tool.
2. Press and hold the left-mouse button on the block diagram sheet, then drag the mouse until the size and location of the
new variable rail displays.
To define a rectangular
area for the rail, click
and drag the cursor.
Tip � Clicking in the right or left two inches of the sheet docks the rail to the sheet’s edge.
5.12.2 Add Variables to a Rail

➢ To add a variable to a rail: click to select a desired variable, then drag the variable from the rail and drop it onto a
block pin to form a wired connection.

Public Information
From anywhere inside
the rail, double-click
then select from the
drop-down list
Note Variables from other windows (Watch Windows, Trenders, and such) can be dragged and dropped into a variable rail.
Public Information
5.12.3 Manage Variables on a Rail
Variables attached to a rail can be manipulated in different ways.
➢ To connect variables on a rail to a block pin: drag a variable from the rail and drop it into a block pin to form a
wired connection.
➢ To move variables on a rail: select and drag the variable from the rail to the desired location.
5.12.4 Work with Variables

➢ To work with variables: right-click anywhere in the Variable Rail to display the commands in the following table.
Variable Commands
Command Description
Displays a list of all places that the selected variable is used (hardware I/O, EGD page, and
Go To Where Used
such)
Add To Trend Adds the selected variable to a defined Trender
Add To Watch Adds the selected variable to a defined Watch Window.
Navigates to the location where the variable is defined. It automatically selects the Where Used
Go To Definition
tab in the Component InfoView.
Change Live Value Displays the Change Live Value dialog box (you must be online).
Add To EGD Set the EGD page for the selected variable

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

1. Click at the desired upper left corner of the text field, drag to the desired lower right corner and release the mouse button.
2. Enter the text in the dialog box that displays and click OK. The new shape is added to the drawing.
Text Tool Properties

Properties Description
Text Displays the text
Text Font Displays the font
Foreground Color Displays the color
Filled If set to True, causes the text shape to use the Fill Color as a background color
Fill Color Displays the background color behind the text if Filled is set to True
Top Displays the top location
Left Displays the left location
Height Displays the height
Width Displays the width
Public Information
5.12.6 Rectangle/Ellipse Tools
The Rectangle and Ellipse tools draw simple geometric shapes with configurable line and fill colors.
➢ To add Rectangle or Ellipse: click the desired upper left corner of the shape, drag to the desired lower right corner
and release the mouse button.
Rectangle / Ellipse Tool 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
5.12.7 Image Tool

The Image tool inserts a Windows Metafile (.wmf) or Enhanced Metafile (.emf) into the diagram.
Note The image file is not embedded in the diagram. All images must be distributed separately from the .xml files for the
diagram.
➢ To use the Image tool

1. Click the desired upper left corner of the shape, drag-and-drop in the desired lower right corner, and release the mouse
button.
2. In the Browse for Image dialog box, provide the path to the .wmf or .emf file that contains the image and click OK.
Image Tool Properties

Metafile Path Displays the path to the .wmf or .emf file containing the image that is displayed
Width Displays the width
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.

Public Information
5.13 Additional Toolbar Buttons
Toolbar Buttons
Button Use
Toggles the Library View, Component InfoView, Property Editor, and Tree View on and off. Full
Full Screen Editing screen mode provides more space for working with large drawings.
You can have multiple detached views for moving pins from one drawing to another drawing.
Displays a new window containing a Block Diagram Editor by itself (without the Tree View or
Detached View Window Component InfoView). The new window displays the same diagram as the main view, but can be
scrolled and zoomed independently.
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). This tool modifies the location, width, or height of each shape to match the
Alignment Tools 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.
Public Information
5.14 Diagram Settings
The Diagram Settings dialog box allows you to 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.
Hierarchy of Diagram Settings
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 displays on legal-size paper while all other diagrams display
on letter-size paper.
➢ To configure diagram settings: from Edit mode, right-click an open area of a diagram and select Diagram
Settings.

Public Information
Diagram Settings
Setting Description
Size Selects the paper size
Landscape When selected, creates a drawing wider than it is tall
Font Sizes Sets the font sizes in the diagram
Hide Unused Pins When selected, hides unconnected pins
Show Block Drawings When selected, graphically displays block operation whenever possible
Show Wired Pin Connection
When not selected, hides the connection text for wired pins to reduce clutter
Text
Tip � Selecting the Default to parent setting or a dimmed check box indicates that you have no preference at the current
level. The diagram uses the settings from the next level down in the hierarchy.
Public Information
5.15 Rung Editor
Boolean logic functions are added to a block diagram inside special blocks called rung blocks. Rung blocks are named after a
component of a Relay Ladder Diagram (RLD). In an RLD, one or more contacts (which function similarly to a mechanical
relay switch) are connected as a control network for a single coil or output. As the diagram is formed with two vertical buses,
one representing power and one representing ground, the completed diagram resembles a ladder, with each coil and associated
contacts resembling a ladder rung. Rung blocks, like the rungs in a relay ladder diagram, control a single output.
The rung block controls variable values using Boolean logic equations. While you can specify a Boolean logic equation
directly by connecting it to the EQN pin of the rung block, a graphical RLD Editor is also available to simplify the process.
➢ To open the RLD Editor: from a Block Diagram, double-click a Rung Block.
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.
Drag separators to add Click OK to save or Cancel

Wiring tools or remove columns to discard changes
Drag
separators
to add or
remove rows
Displays the
current
equation or
error message

Public Information
5.15.1 Contacts
Each contact represents a virtual relay switch 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 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.
5.15.2 Wires
Wires are used to connect contacts to the coil and to each other.
➢ To add a wire: select the Wire tool and click a location on the grid.
Wires can only be drawn vertically or horizontally:
Good Wire Defective Wire
Public Information
5.15.3 Coils
➢ To connect the coil to a variable: double-click the coil to display the RLD Editor.
Note The diagram always has one coil.
5.15.4 Rows and Columns

Up to 16 rows or columns can be added to the grid.
➢ To add or remove rows or columns: drag the boundary between any row or column. Blue text indicates the result of
the action.
5.15.5 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 displays on the status bar to help you resolve the error.
Note When the output equation displays on the status bar, the diagram is correctly drawn and no errors are detected.

Public Information
5.16 Combinational Logic Editor
Some blocks have internal Boolean logic functions represented as combinational logic (for example, AND, OR, and NOT
gates interconnected to calculate an output based on the current input values). For example, the LOGIC_BUILDER block
calculates its OUT_VAL using an equation and up to 32 Boolean inputs. The Combinational Logic Editor allows you to
graphically edit the equation.
➢ To open the Combinational Logic Editor: from the Block Diagram or Tree View, double-click a LOGIC_
BUILDER block or right-click a LOGIC_BUILDER block and select Edit Combinational Logic.
Note The Combinational Logic Editor can remain open while you work in other ToolboxST windows.
Public Information
Edit block pins Diagram View
Pins
list
Status
bar
Additional Buttons Description of Use

Select or cancel the selection of gates, pins, and wires.
Press Ctrl key while clicking for multiple selections.
Zoom in or out on the diagram
Zoom in or out on the diagram
Resize the diagram to fit the current window
Delete selected gates, pins, and wires
Logic gates AND, OR, and NOT can be used in Combinational Logic. If there is an existing equation on the block being
edited, it is automatically converted to a logic diagram. Each + operator becomes an OR gate, each * operator becomes an
AND gate, and each ~ operator becomes a NOT gate. Gates can also be added to the diagram.

Public Information
➢ To add a gate to a diagram
1. Click to select the corresponding Gate Tool.
2. Move the cursor over the diagram and click to connect.
Note The position of the gate will change as interconnections are made with Inputs and other gates.
Combinational logic blocks have up to 32 input pin groups. These are added and removed from the block using the block
diagram or Edit Block Pin Connections dialog box. As soon as inputs are changed, the Input List in the Combinational Logic
Editor is updated. Once a pin displays in the Pin List it can be used to make connections to logic gates.
➢ To make logic gate connections

1. From the Pin List, click a pin.
2. Move the cursor over the diagram to display actions for the input at the current mouse position.
3. From a logic gate, click a pin to set that pin to the input.
or
4. Click a gate to add a new input to the gate.
Note A Tool Tip displays warnings for connections that cannot be made.
The only output for the equation displays in the pin list as OUT. Only one gate can write to the OUT, and OUT cannot be used
as an input.
The drag-and-drop feature can be used to connect pins on gates. Tool Tips provide feedback on permitted connections. Wires
between gates alter the automatic arrangement of the diagram.
If there are errors within the diagram, an equation will not be calculated and the OK and Apply buttons are grayed. Click the
status bar to display errors.
Public Information
Selecting an error causes the corresponding gates, wires, and pins to be highlighted. As errors are corrected, they are
automatically removed from the error list. When all errors are resolved, the error list is hidden and the equation displays on
the status bar.
Errors include:
• Unconnected pins
• Unreachable gates, or gates that have no direct or indirect connection to the OUT variable
• Feedback, where the output of a gate is used as input to the same gate or a gate that feeds into the same gate
• Multiple gate outputs connected to a single gate input
• OUT used as an input
• Inputs used as a gate output

Public Information
Notes
Public Information
6 Mark VIe Component Editor
The Mark VIe Component Editor provides a comprehensive user interface for configuring a Mark VIe controller. The
elements of the configuration are grouped by specific function tabs. Areas of the editor provide various displays, depending
on the currently selected item.
6.1 Creation Wizard

The Creation Wizard guides the user through the process of inserting a controller to create a component.
➢ To create a component: from the System Editor Tree View, right-click the system and select Insert New,
Controller, and Mark VIe Controller.
Enter a Name for the new controller (up to 32 alphanumeric characters )

and select the Application and Version. The default application is
General Purpose. The Version always defaults to the most current .
If you do not have the configuration for a

particular controller , but you know its IP
address, click Upload from Controller
and enter the IP Address.
Click Next to continue.
Mark VIe Component Editor GEH-6703P User Guide 265

Public Information
Click Finish to accept the default Libraries and add the controller to the system .
Public Information
6.2 Component Editor
➢ To open the Mark VIe Component Editor: from the System Editor Tree View, double-click the Mark VIe
component.
Tabbed pages organize

the elements of the Summary View provides a
component configuration graphic overview of the controller.
Tree View
lists the items
that can be
configured.
The list
changes when
a different tab
is selected.
Property
Editor
allows you to
edit the item
currently
selected in
the Tree
View.
Component
InfoView
displays
information
about the
currently
selected item.
➢ To edit the component: select an item in the Tree View. The configuration information displays in the Summary
View and Property Editor.
➢ To import an existing component

1. From the Tree View, right-click either a system or a group and select Insert Existing and select Device.
2. Select the Device .xml file for the component to be imported and click Open.

Public Information
6.3 Tree View
The Tree View displays different information based on the selected tab. An item selected in the Tree View determines the
properties (if any) that display in the Property Editor, and whether data or information displays graphically in the Summary
View or in a Data Grid (table format).
6.4 Summary View

The information displayed in the Summary View depends on the item selected in the Tree View. It can contain everything
from WorkstationST features that can be enabled to EGD statistics where no editing is possible.
6.5 Property Editor

The Property Editor allows you to view and edit the properties of the selected item in the Tree View. The configuration item
displays in the left field and the value displays in the right field.
Alphabetical List allows you

to view the properties arranged
Min-max allows alphabetically by name
you to quickly
reside the Tree Double-click
view and the the double
Property Editor bar to view
within their the Property
shared view Editor in a
detached
List by window
category allows
you to view the
list of properties
organized by
category
➢ To edit a property in the Property Editor: select an item by clicking its value field.
Click the ellipsis button to select a value from a dialog box.
Click the drop-down menu button to select a value from a drop-down list.
Note If no button displays, edit the value directly in the corresponding text box on the right side of the Property Editor.
Public Information
6.6 Component InfoView
The Component InfoView contains multiple tabs that provide controller status information.
Component InfoView Tabs
Component InfoView Tab Descriptions

Tab Description
Displays messages related to user commands or system events issued in the ToolboxST configuration
Log Tip � If there is a build problem, the error is listed on the Log tab. Double-click the error. The input focus goes
to the location in the component configuration where the error occurred.
Status Displays operating state and equality information about the component
Keeps a navigation history for each user session and allows you to return to different places in the
History 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.
Finds all uses of a variable within a Library Container
The write icon at the beginning of some lines indicates that the variable is being written at that location.
Where 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.
Find Results Displays the results of the Finder

Info Displays context-sensitive descriptions for the selected Tree View or Summary View item

Public Information
6.6.1 Log Tab
The Log tab contains three additional tabs: Errors, Warnings, and Messages. Each time a Build command is performed, the
Log tab is updated with errors, warnings, and general information (messages). Concurrently, with each Build command, a file
is generated in the Component folder that reflects the contents of the Log tab. The file (build.log) updates each time a Build
command is performed.
Each time a Build is performed, a message displays that allows you to view the Change log.
When Errors or Warnings are present, the Log tab notifies the user by displaying the current count, as well as a description.
Click each button to hide the corresponding item. For example, click Warning to hide the warnings listed in the Log tab;
Click Warnings again to display the warnings in the Log tab.
Right-click an Error or Warning and select Go To

to open the affected configuration location.
Public Information
6.6.2 Status Tab
The Status tab provides the controller operating state and equality status. When you are online with the controller, the color
displayed on the Status tab indicates the overall state of the controller. Refer to the section Controller Status for further
details.
6.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 available features.

Public Information
6.7.1 Edit 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

drop-down list. Click the down arrow and select the desired value for the cell.
Edit a complex value

text box with an ellipsis button, indicating that a dialog box is available to change the cell
contents. To display the dialog box, click the ellipsis button.
Quickly set a property to the Left-click the row header for the first row to be edited. Then, while pressing the CTRL key,
same value for multiple rows 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.)
6.7.2 Organize Columns

The columns of a Data Grid can be customized. You can select the columns that display, the column order from left to right,
the column width, and the sort criteria.
To... Do this:
Resize a column Drag the vertical bar on the right of the column header to a new location.
Quickly remove a single column Right-click the column header and select Hide Column.
Move a column to a different location Drag the column header to a new location.
Sort by a column Click a column header. The column sorts in ascending order. To sort in descending
order, click the column header again.
Reset columns to the original Right-click any column header and select Default Column Organization.
configuration
Add or remove columns Right-click any column header and select Organize Columns to display the
Organize Columns dialog box.
Public Information
Select a column Click the double arrow
then click the arrow button to add all available
button to add it. columns to the Data Grid.
Select a
column name
and use the up
arrow to move
it to the left-
most side of
the Data Grid.

Public Information
6.7.3 Copy and Move Data
To… Do this:
Copy and paste a single row Right-click the header for the source row and select Copy Selected/Current Rows to
place the source row on the clipboard. Then, right-click the header for the append row
in the destination grid and select Paste Row(s) to insert the row into its new
location.
Copy and paste multiple rows Left-click the row header for the first source row. Then, while pressing the CTRL key,
left-click added row headers. After selecting all desired rows, continue to hold down the
CTRL key and right-click any selected header. From the shortcut menu, select Copy
Selected/Current Rows to place the rows on the clipboard. Then, right-click the header
for the append row in the destination grid and select Paste Row(s) to insert the rows into
their new location.
Copy and paste a range of two or Click the top left cell of the desired range and drag to the bottom right cell. Right-click the
more cells selected region and select Copy Selected/Current Rows to place the cells on the
clipboard. Then, click the top left cell of the destination range and drag to select the
same number of columns and rows that were copied to the clipboard. Right-click inside
the destination region and select Paste Row(s).
Move rows between data grids Arrange windows on screen so both the source and destination grid are visible. (An
entry in a Tree View is acceptable as a destination). Left click the row header for the first
row. Then, while pressing CTRL, click any added row headers to be moved. Release the
CTRL key and drag a row header to the new data grid.
Add a variable to a block diagram, Arrange windows on screen so both the source grid and a destination block diagram,
Trender window or Watch Window Trender window or Watch Window are visible. Then, drag the row header for the variable
from a data grid 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.
Public Information
6.8 Controller Settings
➢ To open the Settings window: from the Component Editor, select the Options menu, then select Settings.
Controller Settings Window
Settings Properties
Download
When set to True, allows you to download application code to redundant controllers in
Controller Parallel Online Download
parallel
Displays the boot loader in the Download Wizard when it does not have to be
Show Boot Loader
downloaded
FOUNDATION Fieldbus
Enable User Configuration of Link When set to True, allows you to configure the link master device on a FOUNDATION
Master Devices Fieldbus segment link
The minimum time between retries of FOUNDATION Fieldbus alert reports. Units are
FOUNDATION Fieldbus Alarm 1/32 ms, (32000 = 1 sec). This applies to the entire device. (Range is 1 to 640000).
Confirm Time Note Setting this value too small may adversely affect the reporting of alerts from
runtime. The recommended value is 640,000.
Linking Device Parameters are
Prevents modifying of linking device parameters
Read-only
I/O Diagnostics
Makes controller I/O diagnostic Alarm events available for automatic Alarm updates in
Enable I/O Diagnostic Alarm Events
the I/O Diagnostic Viewer

Public Information
Settings Properties (continued)
When set to True, displays diagnostic icons in the Tree View and serves as a
Show Diagnostic Icons permissive to show more enhanced diagnostic icons in both the Tree View and the
Summary View
When set to True, displays enhanced diagnostic icons in the Tree View and the
Show More Enhanced Diagnostic
Summary View (Show Diagnostic Icons must be set to True for this option to be
Icons
enabled)
Use Regional Settings for Diagnostic Makes the I/O diagnostic Alarms conform to regional settings (use the Second
Alarms Language option)
PROFIBUS
Show Advanced Importer Screen Displays the advanced importer screen when importing a PROFIBUS configuration
V300
When set to True, allows users to configure the Wind Turbine Control for Wind Farm
Management at the System level using the System menu item Set Wind Turbine
V300 Advanced Options
Control Configuration. For more information, refer to the section System Editor Menus,
listed as a System menu Command item.
6.9 Security
The ToolboxST application provides security based on user-entry passwords. Passwords ensure that only authorized persons
have access rights to view or modify system components. Protected objects can have one or more of these access rights and
each access right can have a different password. Some objects can be password-protected if they are contained in another
parent object, which is protected by its own password(s).
Access Rights
Access Rights Description
Allows you to set Modify Data and Modify Design access rights to pre-defined user roles. Once roles
Access Roles
have been assigned to a protected object, only users with those roles can access the object.
Allows you to make changes to data values associated with an object without changing how it works.
Modify Data 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.
Allows you to change the way a protected object works. For example, this protects block creation and
Modify Design 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.
Public Information
6.9.1 Passwords
Whenever you attempt to perform an operation on a protected object, the Enter Password dialog box displays.
Note Passwords are case-sensitive – secret and Secret are not considered to be the same password.
➢ To change an existing password

1. From the Property Editor, expand Protection.
2. Select the desired access right and click the Ellipsis button. If there is already a password for that access right, you are
first asked for the password before being allowed to change it.

Public Information
6.9.2 Password Caching
The security system caches passwords that were previously entered so that once you enter a unique password, you do not have
to enter that password again. Separate caches are maintained for the system and each major component (such as a Library
Container). A cached password remains until the component is closed.
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.
➢ To clear all passwords and protect the component: from the Device menu, select Restore Password
Protection.
6.9.3 View Protection Status

The protection status for a component displays in the Property Editor.
Protection Properties
Access Roles Allows you to set modifying data and design rights to previously defined user roles
Allows you to modify data values and forcing of variables
Logic forcing procedures can result in personal injury or

death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine.
Modify Data Forcing of control logic for an operating process is strongly
discouraged.
Warning Forcing of protective functions is never permissible for an

operating unit. All safety measures should be strictly enforced
in conjunction with this procedure.
Modify Design Allows you to modify the component design
Public Information
6.9.4 Protected Objects
Specific actions governed by each access right depend on the specific component type.
Examples of Protected Objects

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

Public Information
6.10 Send Problem Report
This feature allows you to report problems with the controller or any configured I/O modules. The report is generated and
attached to an e-mail to the ToolboxST support team.
➢ To send a problem report

1. From the Help menu, select Send Problem Report.
2. Enter information in the Submit Problem Report dialog box and click Send.
Public Information
➢ To send an I/O module report
1. From the Hardware tab Tree View, right-click an I/O module and select Troubleshoot and Send Problem Report.
2. When the Send Problem Report dialog box displays, enter information and click OK.
Sample Problem Report Contents

File Type Provides
Error Log (controller and I/O All time stamped Alarms in the controller. Each alarm message also contains the
.txt
module) code file name and line number
Event Log (controller and I/O All time stamped Events in the controller. Each Event message also contains the
.txt
module) code file name and line number
Diagnostic History (controller
.txt All diagnostic messages sent to the ToolboxST application and other clients
and I/O module)
EGD information/statistics for the controller (for example, number of
EGD Info History (controller) .txt
produced/consumed exchanges, late counts, missed counts)
Boot/base/firmware revision data for I/O packs present in the ToolboxST
Revision Info (I/O module) .xml
configuration and in the I/O pack to confirm revision equality
System topology history Information about the I/O pack configuration (for example, module name,
.xml
(controller) redundancy, parameters)

Public Information
6.11 Upgrade Components and I/O Modules
ControlST supports a variety of control equipment, including updated firmware and configuration tools that are available as
component editors within the ToolboxST application. During installation of a new ControlST version, newer versions of some
components may be installed as well. To use the new versions, you must upgrade each component separately. You may also
upgrade multiple I/O modules for a component at the same time.
➢ To upgrade a component
After a component has been upgraded, you cannot undo the upgrade. You also cannot
upgrade a component to its current or a previous version.
Attention
1. Install the latest version of the ToolboxST application.
2. Open the ToolboxST application, open the system .tcw file, and double-click a component.
3. From the File menu, select Upgrade, then select the component and appropriate I/O module(s) to upgrade.
To select all I/O modules for upgrade, click the top box in Item column box. From the New column drop -down list,
select the new firmware version .
To select one I/O module, select the box next to the I/ O module name.
Click the document icon next to the
To select multiple I/O modules, press and hold the Ctrl or Shift Key and version to display release notes for the
select each I/O module. selected version .
Public Information
Click the double-arrow icon and choose to upgrade all selected
components and I/O modules to the most recent version
or
Upgrade all selected I/O modules to the latest version with the
same (matching) I/O and configuration compatibility codes.
(This option applies only to I/O modules.)
4. Click OK to upgrade the component.

Public Information
6.12 Upgrade I/O Pack Firmware Throughout System
➢ To upgrade I/O pack firmware throughout the system
1. From the System Editor, open the first Mark VIe controller.
2. From the Component Editor File menu, select Upgrade.
3. Select a firmware version for each I/O pack that supports the BPPC.
Component Editor File

menu selection for
upgrading I/O pack/
module firmware
Current version of firmware for Available version of firmware for I/ O

I/O module in configuration file module tied to BPPC Upgrade V05.01
for controller (*.tcw)
Release notes for PDIA

I/O pack; support for
BPPC was introduced
in V04.04.09
Public Information
4. From the Property Editor, set Enable Auto-Reconfiguration to False.
Mark VIe control

Auto-Reconfiguration
feature for I/O packs
5. From the toolbar, perform a Build and Download to the Mark VIe controller.

Public Information
6. From the Property Editor, set Enable Auto-Reconfiguration to True.
7. From the toolbar, perform a Build and Download to the Mark VIe controller.
8. Repeat these steps for each Mark VIe controller in the system.
Public Information
6.13 Replace I/O Module
➢ To replace the I/O module
1. From the Hardware tab Tree View, right-click the I/O module to be replaced and select Help to display the I/O module
help file.
2. From the help file, refer to the section, Replacement.
6.14 Compare to Controller

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

1. From the Mark VIe Component Editor File menu, select Compare To Controller to display the Select Channel
dialog box.
2. Select the desired channel, and click OK.

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

Public Information
6.15 Compare Devices
This feature allows you to compare the configurations of two different devices.
➢ To generate a Compare Devices report
From the File menu,

select Compare
Devices. When the
Select Items to
Compare dialog box
displays, select the
device to be compared.
A Compare Results: window displays differences between the two selected devices.
Public Information
6.16 Mark VIe Component Menus
Menu Command Use to
Save Save changes to the current system
Print Generate a paper copy of the entire component configuration
Upgrade Change the version of the component support software
Compare the ToolboxST configuration for a controller against the actual configuration
Compare to Controller
downloaded to the controller
File Compare Device by Compare individual program(s) in the ToolboxST configuration for a controller against the
Program(s) same programs in the actual configuration downloaded to the controller
Compare Devices… Compare ToolboxST component configurations
Import an I/O Variable or Configuration report, a Global Variable report, a Block Pin report
Import
from a .csv file, or a Variable Alias report, or Second Language report from a .csv or .xml file
Close End the component editing session and return to the System Editor
Undo Remove the item currently selected in the Tree View
Redo Add a new component to the current system
Edit
Delete Delete the item selected in the Tree View
Find Display the Component Editor for the item currently selected in the Tree View
Bookmarks Mark and toggle between items in the Tree View

Public Information
Menu Command Use to
Go Back Return to the view that immediately preceded the current view in the history
Go Forward Return to the view that immediately follows the current view in the history
Forced Variables Display a list of forced variables
Logic forcing procedures can result in personal injury or death, if

not strictly followed. Only adequately trained personnel should
modify any programmable machine. Forcing of control logic for
an operating process is strongly discouraged.
Forcing of protective functions is never permissible for an

Warning operating unit. All safety measures should be strictly enforced in
conjunction with this procedure.
Global Variables Display a list of global variables
Display a list of Trenders for this component
Trenders
Refer to Trender Instruction Guide (GEI-100795)
Watch Windows Display a list of Watch Windows for this component
LiveViews Display live data from the open component
Generate any of the following reports:
Variable generates a report of all global or configuration variables in the component.
You can also generate a Web variable report, a Compressed Data Log variable report, an
EGD variable list report, Alias report, or a Second Language report
Block Pin generates a list of all block pins in the configuration
View I/O generates an I/O variable report or an I/O configuration report.
Alarm generates a list of all variables marked as Alarms
GE Rationalization provides a report of Alarms using the GE Rationalization column
definitions
Hold generates a list of all variables marked as Holds
Event generates a list of all variables marked as Events
NVRAM generates a report of all variables marked as non-volatile
IONet EGD provides network status values of all IONet communication displayed in the
Reports
current component
I/O Diagnostics generates a report of all faults, revisions, communication, and
hardware issues
Coding Practices generates a list of unwritten variables, a list of multiple writes, and
a list of unused I/O variables
Auto-Reconfiguration generates either a Configuration report or a Difference
report
FOUNDATION Fieldbus Configuration generates a FOUNDATION Fieldbus
Configuration report
Create FOUNDATION Fieldbus H1 Field Device Report generates a report for
an H1 field device.
Unlinked Programs/User Blocks generates a list of unlinked programs and user blocks
Constants Generate a list of both control constants and undriven variables
Command Event History Display the diagnostic events and command history for this component
Diagnostics Display regular and advanced controller diagnostics, as well as I/O diagnostics and I/O status
Public Information
Menu Command Use to
Controller Load Profiler Displays the Controller Load Profiler window to monitor controller activities.
I/O CheckOut Verify that Mark VIe I/O points are operational
View the disagreements (for example, exchange vote data and output voting) among
redundant controllers in a TMR or Dual configuration.
Disagreements
Note Disagreements do not exist for simplex systems.

View
Export Alarms for
Compare Alarm criteria in plant Alarm philosophy
Rationalization
Display the device definition dialog box
FOUNDATION Fieldbus DD
Manager Note From the Options menu, the Settings dialog box, the FOUNDATION Fieldbus option must be
set to True to display in the View menu.
Online Connect or disconnect from a controller
Build Convert the current configuration into binary files that can be downloaded to a controller
Perform the following functions:
Controller Setup opens a wizard that allows the user to perform basic configuration
tasks.
Change Controller Password... allows the user to change the controller password for the
device.
Download Download Wizard… downloads base load, firmware, and application code to the
controller and distributed I/O modules.
Update Dynamic Data Recorder exchanges updated information with the DDRs in the
Device
controller.
View/Set Time… displays a dialog box that manages the controller time.
Backup Files to Controller provides file backup.
Retrieve configuration information from the controller and uses it to create a new controller
Upload
component in the system
Put Device to SDB Store the component configuration to a System Database (SDB)
Compress Rearrange variables to minimize the amount of space used
Administer Totalizers Open the View/Set Totalizers dialog box
Restore Clear all passwords and protect the component
Security State Go from the Open state to the Secure state
Options Settings Display a dialog box to select Mark VIe controller settings
Contents Open the Mark VIe editor help file
Controller Help Open the Mark VIe controller help file
Distributed IO Help Display a list of pack help files to open
Display any of the following release notes:
ToolboxST displays current information about your version.
Help Release Notes
Mark VIe displays current information about your version of the Mark VIe support software
Distributed IO allows you a list of pack help files to open.
How To Guides Display ControlST Software Suite How-to Guides (GEH-6808) (if available)
Send Problem Report Display a System Change Request form to report any system issues
About Display version and copyright information

Public Information
6.17 General Tab
The General tab allows the user to configure the properties and attributes of a Mark VIe control.
6.17.1 Configuration Properties

➢ To configure the Mark VIe control: open the Component Editor, select the General tab, and modify the
configuration properties as needed.
General Tab Configuration Properties

Command Event Log stores information concerning alarm and event transitions and variable set commands on the controller file system.
This data can be viewed by an external client through a web interface.
Specifies the maximum size (as a percentage) of both the command and event portions of the Command and
% Command Size
Event log
% Event Size Specifies the maximum size (as a percentage) of the event portions of the Command and Event log
Log to Disk Specifies whether Command events should be logged to the CompactFlash® on the controller
Time Specifies the number of days that the Command and Event log is kept if the allocated space is not exceeded
Compressed Data Log† activates the compressed data log (CDL), which collects selected variables in the controller data log file
% Size† Specifies the maximum size (as a percentage) of the Compressed Data Log (CDL)
Average Interval Time† Specifies the interval in minutes over which the data is averaged and stored
Compressed Data Log Configures the shared secret key used to retrieve data from the CDL secure API, but does not affect the CDL’s
Protection Settings HTTP API. The shared secret must be at least 8 characters long.
When set to True, activates the Compressed Data Log to collect selected variables in the controller data log
Enable Compressed Data
file
Log†
When set to False, a major configuration difference occurs that forces an offline load.
Time† Specifies the number of days the Compressed Data log is kept until the allocated space is exceeded
Controller Web Pages provides controller information. Certain controllers, such as the 1.5 MW wind turbine, use specific web pages that
must be specified for downloading. If web pages are enabled but the Web File Path property does not specify the appropriate location, the
Web Pages tab displays no information.
When set to True, activates the Web server on the controller and displays the Web Page tab
Enable Controller Web Pages
When set to False, a major configuration difference occurs that forces an offline load.
Password Allows users to create or change a password
Web File Path Directory used as the web page source when downloading product web pages to the controller
Custom Files are a set of files defined by the user that will be downloaded to the controller. If the controller supports this feature, the Custom
Files section displays in the General tab.
If enabled, allows the user to specify an additional location for files to be included in the application download
to the controller.
Enabled if the Enable Custom Files Folder Download property is set True. This property is enumerated only
with existing sub-folders of the <SystemFolder>\CustomFiles\ folder. Any files residing in the sub-folder
Custom Files Folder
specified by this property will be included in the application download to the controller, as well as the files
residing in the <SystemFolder>\CustomFiles\Common\ folder.
This setting is optional. If it is left blank, then only the files residing in the <SystemFolder>\CustomFiles
\Common\ folder will be downloaded to the controller.
Enable Custom Files When set to True, any files placed in the <SystemFolder>\CustomFiles\Common\ folder will be included in the
Common Download application download to the controller
Enable Custom Files Folder
When set to True, enables the Custom Files Folder property
Download
General
Application Reflects the application type
Public Information
General Tab Configuration Properties (continued)
Determines how backup files are handled during the Build and Download commands
Includes:
Controller Backup Option • Automatic (Default): creates backup files in a device.zip file during a Build command, and provides an
option in the Download Wizard to download the device.zip file
• Manual mode: does not create a device.zip file so there is no option to download backup files from the
Download Wizard
Description Functional description of the current controller
Enable Alias Prefix When set to False, the device prefix name is not displayed in CIMPLICITY screens (default is False)
Enable Auto-Reconfiguration When set to False, disables the Auto-Reconfiguration feature (default is True)
Time of the Build command performed after the most recent major change. (Major changes require the
Major Revision
controller to be restarted after download.)
Time of the Build command performed after the most recent minor change (minor changes do not require a
Minor Revision
controller restart)
Name of the current controller. It is read-only in the Mark VIe Component Editor, and can only be changed
Name
from the System Editor
Determines how the Network Time Protocol client synchronizes the controller time
Includes:
• Configuration Manual Override: When set to True, displays the Mode property that allows you to
override the system NTP settings and use the local device settings only
NTP Configuration
• Mode options include:
− Disabled: controller does not perform any time synchronization
− Broadcast: client listens for NTP broadcasts on the network
− Unicast: client uses the specified servers to obtain the time
Platform Type of hardware on which the Mark VIe control code is started
Read-only property that reflects the version of the Mark VIe product associated with the selected component.
Product Version
The version number is set when the configuration is first created, and is updated with each product upgrade.
Profiler Enabled Determines if the Controller Profilers are enabled

Public Information
Options are:
• Access Roles: assigned to protect each access right for this component
• Modify Data: allows you to modify data values and force variables
• Modify Design: allows you to modify the controller design
• Maintain Component: allows you to perform certain maintenance operations on the controller. When
Maintain Component is not set, these operations are protected by Modify Data or Modify Design. The
operations enabled by Maintain Component access are:
− Save Component
− Rename Component
− Build
− Download
− Download DDR
− Controller Setup
− Compress Variables
− Compress NOVRAM
Protection − Change Network settings
− Change I/O pack and terminal board Barcode or Hardware Form
Maintain Component is intended work in combination with Modify Design and Modify Data protection to lock
down all changes to the controller except the above list.
Logic forcing procedures can result in personal injury

or death, if not strictly followed. Only adequately
trained personnel should modify any programmable
machine.
Forcing of control logic for an operating process is

strongly discouraged.
Warning
Forcing of protective functions is never permissible
for an operating unit. All safety measures should be
strictly enforced in conjunction with this procedure.
Determines the level of redundancy of the controller:
• Simplex: single non-redundant controller
• Dual: two-controller configuration where one controller provides backup for the other
Redundancy
• TMR: triple module redundant configuration where there are three controllers that vote on decisions for
reliability
A controller configured as Simplex cannot have Dual IONets.
OPC Properties
Defines the OPC AE severity value for a diagnostic Alarm in the active condition. This value displays in Alarm
Active Diagnostics Severity
clients.
Enable OPC UA Server If set to True, enables the OPC UA server in the controller.
Defines the OPC AE severity value for a diagnostic Alarm in the normal condition. This value displays in Alarm
Normal Diagnostics Severity
clients.
Routing
When set to True, allows the Mark VIe controller to accept routed network packets. This property is only
Enable Routing
necessary when the component and the producing component are not on the same physical network.
Scheduling
Background Period Reflects the timeframe, in seconds, of blocks with background methods
Public Information
Determines the frame period in ms. A frame is the basis for Mark VIe scheduling; the frame period determines
Frame Period the fastest scan time, the rate at which first class I/O is scanned, and the fundamental frequency for the
scheduling of all tasks.
Wind Farm Management System†
Enable Wind Farm When set to True, allows a wind turbine to be controlled by the wind farm controller
Management System When set to False, a major configuration difference occurs that forces an offline load.
Primary Wind Farm
Management Server IP Primary IP address of the Wind Farm Management Server
Address
Receive Multicast Address IP address of the multicast group to receive from
Secondary Wind Farm
Management Server IP Secondary IP Address of the Wind Farm Management Server
Address
Wind Control‡
Enable Group Messaging When set to True, enables multicast messaging services
Maximum number of wind turbines for this Wind Control. If this number is reduced after the turbines have
Max Wind Farm Turbines connected, those turbines are disconnected from Wind Control when the timeout parameter set in the Wind
Turbine Timeout (sec) property is reached.
Send Multicast Address IP Address of the multicast group to send to
Wind Farm Master Number Master plant number for this Wind Control
Wind Farm Update Time (ms) Time, in ms, to update all wind turbines
Wind Turbine Timeout (sec) Time, in seconds, at which timeout data is received from the wind turbines
† These properties are only available when the Wind Turbine Control (1.5 MW) application of the Mark VIe controller is running.
‡ These properties are only available when Wind Control application of the Mark VIe controller is running.

Public Information
6.17.2 Requisition Info
The Requisition Information properties are free-form text fields that can be used to document a controller device’s requisition.
The Show Diagrams Tab property controls the display of a Diagrams tab in the Mark VIe Component Editor. When True, the
file referenced by the Diagrams Tab File property is displayed in the Diagrams Tab. Supported file types are Windows
Metafiles and HTML files.
Requisition Info Property Editor
Note These properties are displayed in the footer section of logic sheets. Refer to the section Customize Sheet Borders.
Public Information
If passwords were set for this component, changing the following properties requires a password.
Password Protected General Tab Properties

Property Modify Data Modify Design
Command Event Log properties
(% Command Size; % Event Size; N/A √
Log to Disk; Time)
Enable Controller Web Pages N/A √
Controller Backup Option N/A √
Description N/A √
Enable Auto-Reconfiguration N/A √
NTP Configuration N/A √
Platform N/A √
Profiler Enabled N/A √
Redundancy N/A √
OPC properties (Active Diagnostics Severity; Normal Diagnostics
N/A √
Severity)
Scheduling properties (Background Period (sec); Frame Period (sec) N/A √
Adding modules N/A √
Note The first time you attempt a password-protected function, the Enter Password dialog box displays. All protected
functions performed during the remainder of the ToolboxST session do not require re-entering the password.
6.17.4 Attributes
Attributes are device-level values that affect how the configuration is generated. Select the Attributes item in the General tab
Tree View to edit controller attributes in the Summary View data grid.
Attribute Columns
Column Description
Name Unique identifier for the attribute
Description Stores added comments about the attribute
Value displays and modifies the current attribute value

Public Information
6.17.5 Attribute Value Editor
The Attribute Value Editor allows you to enter values for a wide variety of data types.
➢ To open the Attribute Value Editor: from an attribute Data Grid, select a Value Cell and click the ellipsis button.
Name of the
attribute being
modified
If checked, the
attribute values
are restricted to
an enumeration
(a predefined set
of allowable
values).
To add a value to
the enumeration,
enter the Name,
and a Description
(optional) and click
OK.
Public Information
6.17.6 Network Adapters
The network adapters 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 five 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.
The following table describes the properties displayed in the Property Editor when a Network Adapter item is selected in the
Tree View.
Network Adapter Properties
Adapter Settings
Enabled If set to False, disables the selected network adapter. Set to True to enable the network adapter.
Host Name Internet Protocol (IP) host name for the selected network adapter
IP Address IP Address for the selected network adapter
Wire Speed Speed of the network to which the selected adapter is connected
Network Settings
Sets the network connected to the selected adapter. (Available networks are determined in the System
Network
Editor.)
Controls which portions of the IP address are deemed significant.
Subnet Mask 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.

Public Information
6.17.7 Virtual Network Adapters
The Virtual Network Adapters in the controller display in the Tree View within the General tab. Virtual Network Adapters can
be configured for UCSC controllers with an Embedded Field Agent (EFA). The number of adapters depends on the
controller’s hardware type and configuration. In most applications, controllers will have only one Virtual Network Adapter,
which is used as an internal network between the controller and the EFA running in virtual machines (VMs) on the same
controller. When the controller is initially created, the EFA network is disabled. The default IP address and subnet are defined
in the following figure. By default they are set to work with the standard EFA IP configuration. When the EFA network is
enabled, it facilitates the exchange of data between the controller and the EFA.
Note For more information on EFA, refer to the Mark VIe and Mark VIeS Control Systems Volume II: System Guide for
General-purpose Applications (GEH-6721_Vol_II), the section UCSC Embedded Field Agent (EFA).
For information on the virtual network, refer to GEH-6721_Vol_II, the section Virtual Network.
The following table describes the properties displayed in the Property Editor when a Virtual Network Adapter item is selected
in the Tree View.
Virtual Network Adapter Properties
Adapter Settings
Enabled If set to False, disables the selected Virtual Network Adapter. Set to True to enable the network adapter.
IP Address Default IP address for the selected network adapter (not usually changed from default setting)
Network Settings
Network EFA (typically the only type of network)
Subnet Mask Default subnet mask for the network (not usually changed from default setting)
Public Information
6.17.8 Auto-Reconfiguration
The ToolboxST application provides a feature called Auto-Reconfiguration, which downloads the necessary configuration
files when an I/O pack is replaced. It requires no user interaction once power is restored to the I/O pack after replacement.
The Auto-Reconfiguration feature is enabled from the General tab Property Editor.
From the General

tab Property Editor ,
select Enable Auto-
Reconfiguration
and set to True
Note This feature is available with ControlST V03.05 or higher.
The Auto-Reconfiguration feature applies only to I/O packs; it is not available for controllers or terminal boards.

Public Information
6.17.9 OPC UA
With ControlST V05.01 or later, the Mark VIe controller includes an OPC® UA server that can be optionally enabled. Before
enabling the server, verify that the controller Ethernet connection to the OPC UA client has been set up correctly and that the
desired clients are active.
The OPC UA server currently only supports anonymous connections. If you are
deploying a Mark VIe controller in a secure state, it is recommended that you set all
variables available through OPC UA to Read-only access, using the External Access
property in the ToolboxST application.
Attention
Note This feature is not available for the UCPA or Mark VIeS UCSBS1A controller.
Use of the OPC UA server will reduce controller idle time, which is directly affected by the following:
• Number of clients
• Sampling intervals of the OPC UA client
• Type and number of variables being used
➢ To enable the OPC UA server
From the General

tab Property Editor,
set Enable OCP UA
Server to True
Public Information
Note From the OPC UA client connected to the controller (for example, Trender), enter opc.tcp://192.168.101.111:4841
where 192.168.101.111 is the IP address of the controller and 4841 is the port used for the server.
The OPC UA server makes a subset of variables available to OPC UA clients. Set the variable’s Download Info property to
True to make a variable available through OPC UA.
➢ To select Mark VIe variables for third-party client(s)

1. From the Software tab Tree View, select Variables.
2. From the Summary View, select the desired variables.
3. From the Property Editor Usage category, set Download Info to True. Changes will take effect after the controller
is downloaded.
Note Double variables have a significant effect on idle time usage.
4. Download to the controller and verify that it is online and in the controlling state.
After the OPC UA server has been enabled and the clients are configured and requesting data, the controller idle time should
be observed to ensure adequate performance.
➢ To verify OPC UA performance

1. From the OPC UA client, configure the required data, and verify that it is being received from the Mark VIe controller.
2. From the Component InfoView Status tab, verify that System Idle Time (%) has not dropped too low.
If the OPC UA is using an unacceptable amount of the controller idle time, the following can reduce the idle time used:
• Make fewer variables available through the OPC UA server by setting Download Info property to False for as many
variables as practical.
• From the client, decrease the number of variables requested or increase the sampling interval.
• From the client, disable OPC UA to reduce the total number of clients requesting data from the Mark VIe controller.

Public Information
The following figures display typical performance data without double variables for a UCSA and UCSBH4A forms of the
Mark VIe general-purpose controller.
Typical Idle Time Starting at 95.4 with UCSBH4A Controller and 500 ms fixed sampling interval
Typical Idle Time Starting at 95.4 with UCSBH4A Controller and 250 variables
Public Information
Typical Idle Time Starting at 93.1 with UCSA Controller and 500 ms fixed sampling interval
Typical Idle Time Starting at 93.1 with UCSA Controller and 250 variables

Public Information
6.18 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 an I/O pack. For each
compatibility code set, there are multiple hardware forms used to identify physical characteristics of the I/O pack. Each I/O
module that can be added to a controller is identified by both its hardware form factor and its compatibility codes.

If passwords were set in the General tab Property Editor for this component, the following functions require a password.
Hardware Tab Password Protected Functions

Add Module √ √
Add Group N/A √
Attach Layout Drawing N/A √
Public Information
6.18.2 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 I/O module redundancy.
➢ To change the network redundancy: from the Hardware tab Tree View, select the Distributed I/O item.
From the Tree View,

select Distributed I/ O
From the Network

Redundancy drop-down
list, select either simplex,
dual, or TMR
I/O redundancy depends

on controller redundancy
- if the controller is
simplex, the I/O can be
either simplex or TMR
- if the controller is dual,
the I/O can only be dual
- if the controller is TMR,
the I/O can only be TMR

Public Information
6.18.3 Health Delay
The health delay property determines the number of frame periods for inputs to be in the Uncertain state when packets are
missing from dual and simplex I/O packs. Refer to the Mark VIe Controller Standard Block Library (GEI-100682).
From the Tree View,

From the Property

Editor , select the
Health Delay drop-
down list and the
desired number of
frame rates
Public Information
6.18.4 Add I/O Modules
➢ To add an I/O module: from the Hardware tab Tree View, right-click Distributed I/O and select Add Module.
Select the redundancy

type:
Simplex, if one I/O pack
is present, Dual, if two are
present, and TMR if three
are present.
The HotBackup options
provides dual I/ O packs,
with one active gateway
and one backup.
Select an I/O
module type. The
available types
are based on I/O
pack redundancy.
Click Next.

Public Information
If the Module Required check box is selected ,
the module must be present and functioning for
the controller to go online. Devices attached to
LAN modules (PCNO, PPRF) are not required From the Version drop-down list, select the module version .
to be active for the controller to go online. The listed versions depend on the available compatibility codes.
Click Release Notes

to display additional
information for the
currently selected
module version .
Enter the
Terminal Board
Position.
To mix I/O pack

hardware forms,
right-click the I/O pack
and select Modify.
Click Next to confirm

the configuration,
then click Finish.
Bar Code is the unique hardware bar code for the I/O terminal board.
Position is an identifier consisting of 3 or 4 alphanumeric characters that identifies the location of the I/O terminal board
within the cabinet. This information is on a label next to the I/O terminal board. Note: If the position is left blank, it will
default to the module ID.
Public Information
6.18.5 Shared IONet
Beginning with ControlST* V04.06, sharing data between two controller sets on a single Ethernet input/output network
(Shared IONet) is available for some Mark* controllers. Beginning with ControlST V07.06, some Shared IONet Groups may
contain up to four controller sets (in accordance with supported controller combinations). With Shared IONet, an owner
controller configures its owned I/O modules, Writes outputs, Reads Sequence of Events (SOE), and provides diagnostic
information. Owned I/O modules are attached to the owner controller that can configure and Write outputs to them, and they
obtain IP addresses from their owner controller. Only the owner controller can Write outputs for an I/O module it owns.
Note A controller set is a group of controllers (based on redundancy) with a set of owned I/O modules. In the ToolboxST*
System Editor Summary View, a controller set displays as a single controller.
A shared I/O module sends field device inputs to both its owner controller and to all consumer controllers. A consumer
controller receives the field device inputs from the shared I/O modules that are owned by the other owner controller. The
exception to this is a Mark VIeS Safety controller. The Mark VIeS only receives inputs from its own safety-certified I/O
modules. The ToolboxST application is used to configure the controller sets. The computer with ToolboxST communicates
with the I/O devices through a software gateway function residing in the controllers.
Only the following controller combinations are supported by Shared IONet:
• One Mark VIeS Safety controller and up to three Mark VIe controllers
• One MarkStat controller and one Mark VIe controller
• Up to four Mark VIe controllers
Note The UCPA controller platform should not be used in a Shared IONet system.
In a Shared IONet group containing one Mark VIe controller and one Mark VIeS Safety controller, the Mark VIeS Safety I/O
module inputs can be shared between both controllers. However, the safety controller only receives inputs from its owned
safety-certified I/O modules. The safety controller continues to send outputs using a broadcast addressing scheme.
In a Shared IONet group with either two Mark VIe controllers or one Mark VIe controller, either controller can receive each
other's inputs and send outputs in a peer-to-peer communication. The Mark VIe controller delivers outputs to I/O modules
through a multicast packet that contains a specific section for each output device. Multicast is the delivery of a message or
information to a group of destination IONet devices simultaneously in a single transmission from the source. Mark VIe
controllers use multicast addressing to send outputs to I/O modules unless legacy hardware requires otherwise.
After I/O modules have been added to both owning controllers, inputs can be shared to the other Mark VIe controller. Inputs
from Mark VIe controllers can not be shared to a Mark VIeS Safety controller.

Public Information
➢ To share inputs from an owning controller
1. From the Hardware tab, right-click Distributed I/O and select Add Shared I/O. The Add Shared I/O Modules
dialog box displays.
Select I/O
modules and
click OK.
2. Save the Component Editor to update the system file.

Save and close all Component Editors. Shared IONet downloads are performed from the System Editor.
Public Information
6.18.6 Organize I/O Modules
I/O modules can be organized into Groups. The Add Group menu option displays only when group mode is selected.
➢ To create a Group: from the Hardware tab Tree View, right-click Distributed I/O and select Add Group.
From the drop-down list, select a

Enter a Name (up to eight Type (when General is selected, the
alphanumeric characters). Group icon changes to an I/O folder).
Enter a
Description
(optional).
Select the icon

to display in the
Tree View, then
click OK.
➢ To add I/O modules to a Group

1. From the Hardware tab Tree View, drag an I/O module to the desired group.
2. When the cursor changes to a symbol, release the mouse button to move the module.

Public Information
6.18.7 Modify I/O Modules
➢ To modify an existing module: from the Tree View, right-click the module and select Modify.
6.18.8 View I/O Modules

Modules can be viewed in one of two layouts: group or network. Groups and the option to add a group only display in Group
layout.
The Summary View

displays I/O modules in
either group or network
layout. Click the folder
icon to toggle between
the two views
Public Information
When you select an I/O module from the Tree View, the Summary View provides tabs. The tabs displayed vary according to
the I/O module. The tabs that display for all modules include:
• Summary
• Variables
• Diagnostics
• Status
Note For information about the settings configured by I/O pack-specific tabs, refer to the I/O pack documentation.
The Summary View toolbar provides the following icons:
Expand/ Print the

Collapse Zoom the graphical
this view diagram in view Hide/Show
advanced
columns or rows
Detach this Zoom the

view from diagram out
main view
The Summary tab displays a graphical overview of the selected I/O module.
Example PAIC I/O Module

Public Information
The Parameters tab allows you to configure all I/O module-specific parameters. After a parameter is changed, updated
pseudocode files must be downloaded to the I/O packs. This download operation does not require a restart 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.
Click the icon to

display or hide
advanced
columns or rows
Note For some I/O modules, these tabs are split into more module-specific input/output tabs that better define their function.
The Variables tab displays available variables from the I/O module that have no physical endpoint. These variables exist
only internally in the I/O module, and can be connected to another variable for use in code.
The Extra Circuits tab contains input/output variables found on the I/O module terminal boards, which can be associated
with the application software. For some I/O modules, these tabs are split into more I/O module-specific input/output tabs that
better define their function.
The Input and Output tabs contain input/output variables found on the I/O module terminal boards, which can be
associated with the application software.
The Diagnostics tab allows you to check Alarms and errors on I/O packs. Each I/O pack has a unique set of diagnostic
signals that can be monitored.
Inactive Alarm(s)
Active Alarm(s)
Public Information
The Status tab allows you to check the I/O pack version and network communication status.
Status Tab Properties

Prod ID Unique address of the producing device 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 not equal

Public Information
6.18.9 Connect Variables
It is possible to attach a software variable to an I/O variable.
Note A software item (programs, tasks, and such) must be defined in the Software tab before this feature can be performed.
➢ To attach a software variable to an I/O variable: from the Data Grid, select the Variables tab.
Select a defined variable and clickOK. The

Select a Variable dialog box closes and the
variable displays in the Data GridVariables tab
If the variable is not defined, enter

the variable name and clickOK
Public Information
Click Yes to
assign the
variable to the
software item
You can also attach a variable by entering the variable name in the Connected Variable column and pressing Enter. If the
variable name entered is a defined variable, it continues to display and the cursor moves to the next field. If the variable name
entered is undefined, click Yes when the Undefined Variable dialog box displays.

Public Information
6.18.10 Initial Download to I/O Modules
To download to all I/O modules for the first time, go online and perform the procedures to detect and update the terminal
board barcodes, then perform a Build and Download to the I/O modules.
6.18.10.1 Detect Terminal Board Barcodes

Prior to performing this procedure, make sure the following prerequisites are met.
Prerequisites
• You are successfully online with the associated controller set

• All I/O modules have been added to the ToolboxST system and the panel has been rebooted
• All IONet cables are correctly connected to all I/O modules
• All I/O modules are powered on
• Have a written record of all installed terminal boards on hand for reference.
➢ To detect the terminal board barcodes for initial download

1. Go online with the controller (if not already online). From the Component Editor toolbar, click the Go On/Offline
icon.
2. (Recommended) Enable the I/O modules for configuration as follows:
a. From the Component Editor Hardware tab, select all I/O modules.
b. From the Property Editor, set the Configuration property Required to True.
3. From the Tree View, double-click an I/O module icon to display the Modify dialog box.
4. From the Bar Code text box, click the ellipsis (...) button to display the Select Unassigned Terminal Board dialog box
listing the available terminal boards.
5. Select the correct Bar Code and click OK.
6. Review the displayed Warning message, then click Yes to continue.
7. Click OK.
8. Repeat this procedure for any remaining I/O modules.
9. Verify that all terminal boards have been identified by the ToolboxST application.
6.18.10.2 Download to I/O Modules

➢ To perform an initial download of all I/O modules
1. If using Shared IONet, perform the following steps:
a. Save and close both Component Editors.
b. From the System Editor Tree View, select the Shared IONet Group.
c. Right-click and select Download Shared IONet and following the instructions provided in the Download Wizard.
d. Skip to step 4 to continue.
2. From the Component Editor toolbar, click the Build icon.
3. Click the Download icon and follow the instructions provided in the Download Wizard, leaving the default settings.
4. Cycle power to the panel and wait for all equipment to power on, showing the appropriate status LEDs.
5. From the Component Editor toolbar, click the Go On/Offline icon to go online.
Public Information
6. Wait and reset any alarms, if needed.
7. Perform a Build and Download again, if needed.
8. Wait and reset any alarms, if needed.
9. From the Component InfoView Status tab, review the health and equality status of the controller.
The color of the Status tab indicates overall health and equality status of the controller, including its associated I/O hardware.
A major difference in controller equality means that the configuration in the ToolboxST application is different from the
controller configuration.
• Green indicates that the ToolboxST configuration and the controller configuration are equal.
• Orange indicates the presence of inequalities or diagnostic warnings.
• Red indicates that the configuration in the ToolboxST system, which includes base load, firmware, application code,
and I/O module configuration, is significantly different from the component configuration (a Download will correct
this).
Note Refer to GEH-6721_Vol_I, the chapter Troubleshooting for further assistance. For example, if a particular download
fails, this may be fixed by selecting the pack individually from the download wizard and trying again.
6.18.11 Download 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.
6.18.12 Compare 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.
Module parameters directly affect the operation of the controller and associated I/O
modules. To reduce the risk of improper operation or damage to the unit, always
check the Compare Parameters dialog box before downloading new parameter values
to a component.
Caution
➢ To open the Compare Parameters dialog box: from the Hardware tab Tree View, right-click a module to
compare and select Compare Parameters.
6.18.13 Upgrade I/O Modules

It is possible to perform an upgrade to the firmware of a single I/O module.
➢ To upgrade an I/O module: from the Tree View, right-click the I/O module and select Upgrade.

Public Information
Public Information
6.18.14 Diagnose I/O Modules
When a problem with an I/O module is detected, symbols display in the Summary tab. All symbols provide Tool Tips.
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 for an I/O pack, I/O module, or component level.
Note You must be online to view all diagnostics, with the exception of reports.
Tree View symbols include:
Error (for example, link unhealthy)
Warning (for example, active alarm)
Informational (for example, inactive alarm)
Normal
The Summary tab displays diagnostic information.

Public Information
Summary tab diagnostic symbols include:
Inactive Alarm(s)
Active Alarm(s)
I/O pack version status indeterminate
Link broken
Link error
Link warning
Link information
Note Place the mouse over the icon to display Tool Tips.
6.18.14.1 I/O Diagnostic Viewer

➢ To open the I/O Diagnostic Viewer: from the Summary tab, right-click an I/O pack or terminal board and select
Troubleshoot and Diagnostics.
Public Information
6.18.14.2 Create Module Report
➢ To view or print an I/O module report: from the Hardware tab Tree View, right-click Distributed I/O and select
Create Module Report and the report type. Or, from the Summary View, right-click the I/O pack and select Create
Module Report and the desired report.
I/O-related reports include:
• Alarm
• Revision
• Communication
• Hardware
Each report contains configuration or diagnostic details about the I/O hardware.
Example Communication Report
Note For more information, refer to the section Mark VIe Reports.

Public Information
6.19 Software Tab
The Software tab contains all application software downloaded to that controller. Right-click the Programs item in the Tree
View to display 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.

If passwords were set in the General tab Property Editor, the following functions require a password.
Software Tab Password Protected Functions

Add Program N/A √
Add Program Group N/A √
Add Task N/A √
Add Special Task N/A √
Add Variable N/A √
Change Controller Password N/A √
Change Library References N/A √
Change Execution Groups N/A √
Public Information
6.19.2 Add Program
➢ To add a program, program group, or existing program: from the Tree View, right-click Programs and select
from the shortcut menu.
If adding a
program group,
enter a name
and click OK
Note The Add Existing Program command reads an .xml file from another system or controller into the current controller.

Public Information
6.19.3 Add Task
➢ To add a task: from the Software tab Tree View, right-click on an embedded or unlinked program name and select
Add Task.
6.19.4 Enable and Disable Tasks

Tasks can be enabled or disabled in the configuration to prompt the runtime to execute that task or not.
➢ To enable or disable a task

1. From the Software tab Tree View, expand Programs, expand a task, and right-click Variables to display the task
variables in the Summary View.
2. In the Data Grid, set the variable _EnableInitial Value column value to True or False:
a. To enable the task, select True.
b. To disable the task, select False.
Public Information
OR
When the controller is online, double-click the live value of the variable _Enable for the task, select True to enable the task
or False to disable the task, then click Send & Close.

Public Information
When the controller is online, the task icon in the Tree View indicates the executing state of the task as either enabled or
disabled.
Task Icons in Tree View
Task Icon Executing State

Enabled
Disabled
Public Information
If the task is disabled and selected in the Tree View, the Summary View displays the text Task Disabled.
Task Disabled

Public Information
A controller has two types of libraries:
• Function block libraries describe software that is part of the controller firmware
• User block libraries combine these function blocks into user blocks
➢ To reference a function or a User Block library

1. From the Tree View, right-click Programs and select Library References.
2. From each 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.
From the User Block

Libraries tab, select the
top-level system check
box to include all
libraries.
To include blocks for a

specific library container,
select the library
(second-level check box)
and click OK
From the Optional

Libraries tab, select
the Display legacy
blocks in library view
check box to display
legacy blocks in the
Library View and also
in the Select Block to
Insert dialog box
Public Information
6.19.6 Execution Groups
Execution Groups control how blockware is executed on multi-core controllers. An Execution Group specifies on which core
the tasks in a program are executed and a frame multiplier provides an additional scheduling factor for the tasks in the
Execution Group. The number of allowed Execution Groups depends on the controller platform. The first core (Core 0) on a
multi-core controller has a single, fixed Execution Group called the Primary Execution Group, which runs at controller frame
rate. Additional Execution Groups may be added to any Secondary core.
Note For more information on the frame multiplier, refer to the section Frame Timeline Profiler.
➢ To view, add, remove, or modify Secondary Execution Groups

1. From the Software tab Tree View, right-click Programs and select Execution Groups from the drop-down list to
display the Secondary Execution Groups.
2. From the <Component Name> Execution Groups dialog box, select a Secondary Execution Group from the list, select
the button corresponding to the appropriate action (Add, Remove, Edit), then click OK to perform that action.
Note The Primary Execution Group will always be in Read-only mode because it is a fixed group that cannot be modified or
removed.

Public Information
3. After Execution Groups have been set up, assign programs to an Execution Group on a multi-core controller.
a. From the Software tab Tree View, right-click a Program (Prog2 is selected for this example).
b. For the Property Editor Execution Group property, select a Secondary Execution Group to associate with the
program from the drop-down list (Secondary Group 1 is selected for this example).
6.19.7 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.
Public Information
It is not possible to undo this command.
Attention
6.19.8 Overridable Properties

➢ To select overridable properties: from the Tree View, right-click Programs and select Overridable
Properties.

Public Information
6.19.9 User Blocks
The user blocks of a controller program display in the Tree View within the Programs item under tasks, or other user blocks.
Instancing a user block updates it to the latest version from the user block library. Embedded and unlinked user blocks are
disconnected from the library, so instancing goes through the blocks in that user block and instances the linked user blocks.
➢ To instance a user block: from the Tree View, right-click a user block and select Instance.
6.19.9.1 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 Tree View, expand the User Block item, right-click Variables and select either Add
Variable or Add Undefined Variables.
2. From the Add New Variable dialog box, enter the name 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.
6.19.9.2 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.
Note Refer to the section Work with User Blocks.
Public Information
6.19.9.3 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.
User Block Properties
Unlink Unlinks the user block from the definition
BlockType Name of the user block definition in the library from which this user block started
Name Name of this user block
Protection Expands to show the access rights for this user block definition
Execution Order Sets the order of execution in the program
Frame Multiplier Number of frames at which the user block runs
Schedule Offset Offset from beginning of frame at which the user block runs
6.19.9.4 Add User Block

➢ To add or instance a user block: from the Tree View, right-click the task and select from the shortcut menu.
A user block can either be linked from a user block library or embedded in a container.
The Summary View of a user block displays the block diagram for either the user block selected in the Tree View or its
container.
6.19.10 Unlink Permanently

A program that is linked to a Library Container can be permanently unlinked from the controller. Linked tasks and user blocks
can also be unlinked permanently.
➢ To unlink a program: from the Tree View, right-click a program item and select Unlink Permanently.
The linked icon next to the item in the Tree View changes and the program is unlinked from the library.

Public Information
6.19.11 Property Editor
The Property Editor displays the properties of the item selected in the Tree View.
Tree View Item Properties

Programs
Removes the unused variables for all linked user blocks in this device when the user block is
Remove Unused Variables
instanced
Program
Description Users description of the program
Library Type Name of the library definition that this program came from
Name Allows you to name the program
Properties control the Access Roles, Modify Data, Modify Design, and View Design
Protection
permissions for this program
Execution Order Sets the order of program execution
Task
Block Type Name of the user block definition in the library from which this task started
Description Description of this task
Name Name of this task

Instance Script Runs when the task is instanced
Detached Summary File Path to the summary diagram for the user block definition
Help File Allows you to locate the Help file by clicking the ellipsis button
Help Text Locally defined Help that supersedes the global Help
Protection
permissions for this task
Revision History Allows you to edit the revision history by opening the Edit Text dialog box
Version User-defined version of a task

Configures extended visualization for a task or user block
Visualization • Path to Visualization allows selection of a graphic file (.html or .wmf)

• Visualization Type allows configuration of how graphics are displayed (refer to the
section Visualization Type)
Frame Multiplier Number of frames at which the task runs
Schedule Offset Offset from beginning of frame at which the task runs
User Block
Block Type Name of the library block of which the selected block is an instance
Description Text describing the instance of the block
Unique identifier that allows the block to be referenced from other locations in the ToolboxST
Instance Name
application
Instance Script Causes the script to run when the block is instanced
Height Height of the selected block in the diagram
Left Location of the left of the selected block
Public Information
Tree View Item Properties (continued)
Programs
Selected Pin Pin currently highlighted in the diagram
Show Description When set to True, displays the description of the selected block
Top Location of the top of the selected block
Width Width of the selected block

Block Data Type Data type for variant pins in the selected block instance
Enable When set to True, enables variables for the selected block
Version Version number for the source of the selected block instance
Execution Order Determines when this block is started
6.19.12 Program Variables

Program variables are Global variables associated with a particular program. The variables are displayed in the Tree View
within the Programs item. Undefined variables for a program are Global variables that have been referenced in a controller,
but have not been defined as part of a program or user block. Undefined variables for tasks and user blocks are Local
variables that have been referenced within the task or user block.
➢ To add a variable to a program: from the Software tab, expand the Programs item.
Right-click the Variables

item and select Add
Variable or Add
Undefined Variables
User block and task variables are Local by default, and display within the associated user block item in the Tree View.

Public Information
Variables can be edited in the Data Grid and the Property Editor. The Data Grid is used to view or edit variable definitions,
and can be configured to display a subset of the variable properties. Variables can also be added in the Summary View by
directly editing the last row of the variable grid. When a variable is selected in the Data Grid, the Property Editor displays the
variable properties.
Data Grid Variable Properties

Alarms and Events
Alarm Severity Value assigned to an Alarm in the active state. The valid range is 1 through 1000, where 1 is the least severe.
If set to Alarmed (True), enables the variable as an Alarm. Alarms are used for problems that require the operator’s
Alarm
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 color Alarms.
Alarm Inhibit Group Selects the Alarm inhibit group for the Alarm variable.
If set to True, causes the Alarm to be generated on a 1-to-0 transition. The Alarm property must be set to Alarmed
Alarm On Zero
(True).
Alarm Shelving If enabled, temporarily removes selected Alarms from the Alarm Viewer display
Alarm Shelving Max
Period of time during which the selected Alarm(s) remains removed from the display
Duration
Child Alarms Alarms configured as child to the variable (variable should be an alarm)
If enabled, removes the Alarm from the Alarm Viewer display when the Alarm transitions to the normal state. The
Auto Reset
operator is not required to acknowledge the alarm.
Provides an ellipsis button that opens an Edit Text dialog box to enter consequences.
Consequence of
If a second language is configured, an additional property, Consequence of Inaction in <language name> also
Inaction
displays to enter consequences in that language.
If set to True, enables the variable as an Event. Events are stateless messages that are not queued within the controller.
Event
When an Event occurs, a time-tagged transition message is sent to any HMIs that have signed up for Events.
If set to True, enables the variable as a Hold, which is similar to an alarm. The Hold queue contains a list of time-tagged
Hold
Hold states in the turbine startup sequence.
Normal Severity The value assigned to an Alarm in the normal state. The valid range is 1 through 1000, where 1 is the least severe.
Operator Action If a second language is configured, an additional property, Operator Action in <language name> also displays
to enter consequences in that language.
Operator Urgency Indication to operator how urgent it is to execute corrective actions to avoid defined consequences
Parent Alarms Alarms configured as parent to the variable (variable should be an alarm)
Plant Area Places variables into logical plant groups for display in the Alarm Viewer
Potential Causes If a second language is configured, an additional property, Potential Causes in <language name> also displays
Cannot be modified. It is automatically entered from the hardware library if the hardware point is defined as a Sequence
of Events (SOE). SOE are similar to event messages, but they are associated with I/O transitions rather than
SOE Description
application-variable transitions. They are also typically time stamped to a much finer resolution (1 ms) than Alarms or
Events.
Public Information
Data Grid Variable Properties (continued)
Appearance
Determines when the pin displays on the block diagram:
• Never: Never show the pin on the block diagram, but it shows up in the Block Pin Connections window
Visibility
• Used: Show the pin when connected to something
This property is only
• Always: Always show the pin on the block diagram
applicable for
• Hidden: Never show the pin anywhere. Depreciated in favor of Internal, but has same effect.
Libraries.
• Internal: Never show the pin anywhere. Used for internal states like totalizer counters.
• Parameter: Only show the pin in the block's parameter list (ControlST V03.03 and later)
Format
Default upper limit for displays on the HMI (for example, bar graph or trending displays). If a Format Spec has been
Display High Limit
specified and this display-high property is not specified, the Format Spec Engineering Max is used.
Default lower limit for displays on the HMI (for example, bar-graph or trending displays). If a Format Spec has been
Display Low Limit
specified and this display-low property is not specified, the Format Spec Engineering Min is used.
Display Screen Default HMI screen for this variable
Format Specifications can be assigned to variables. These are system owned format specifications that are unique for
Format Spec
each measurement system and are grouped into sets.
HMI Resource Allows you to configure access and visibility of variable and alarm data
Determines the number of digits to the right of the decimal point.
Precision 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.
Engineering units. If a Format Spec has been specified and Units is not specified, the Format Spec Units is used with
Units
the SDB version of the HMI device. This attribute is not used. Only the format specification's Units string is used.
If set to True, allows the Entry High Limit and Entry Low Limit of a linked numeric variable to be modified
The Override Entry Limits property is only available for numeric variables contained within a linked program,
Override Entry Limits
task, or user block, with the Allow Entry Limits property set to True.
Allow Entry Limits Override must be set True in a Library module for this feature to be available.
Allow Entry Limits If set to True, enables the Override Entry Limits property for the library variable inside a device.
Override The Allow Entry Limits property is only available for numeric global variables inside a Library Container.
General
Variable tag name that can be customized by the user. Aliases are available to the WorkstationST component and the
HMI.
ToolboxST may also be placed in Alias mode so the Alias is displayed instead of the variable name in logic sheets,
Alias
properties, and dialogs. This allows standard application code to be created in one variable naming convention, but
edited and viewed in a second naming convention as needed. (Refer to the section Variable Names and Aliases for
further details.)
Array Number of elements in this array variable
Connection Allows a variable to be connected to another variable
Program variable description in Primary language
Description
This property displays if only one (Primary) language is configured.
Enumerations Values represented in separate CSV records
Fully qualified name of the variable. For example, a variable name gas_fuel_opt in a user block named Config under
Full Name
the Program CORE would have a full name of CORE.Config.gas_fuel_opt.
Inherit Description of
Connected Variable
This property is only If set to True, causes the selected pin to inherit the description of any connected global variable
applicable for
Libraries.

Public Information
Initial Value Allows array length, data type, and enumeration editing
Name Variable name
Nonvolatile Indicates that the variable should be saved in non-volatile RAM
Type Refer to the following table, Variable Data Types
Keep During Instance
When set to True, keeps this variable during instance, even if unused.
applicable for
Libraries.
Override Properties If set to True, identified overridable properties (set for each device) in instanced linked code in a device will not be
This property is only updated with new values from the library when code is re-instanced, but instead will maintain any changes made to
applicable for a that instance.
device. This property is only valid for a linked object.
Override Value Determines if the setting for Value overrides the setting in the library
This property is only This property only displays in the data grid for a library, but it cannot be modified in the library.
applicable for a This property is only valid for a Control Constant in a linked object and hysteresis is the sub-variable for analog
device. alarms.
Description
Primary Language Variable description in primary language
Second Language Variable description in secondary language
Logging
This property is only displayed if the Compressed Data Log property is enabled.
The Compressed Data Log property is only available when the Wind Turbine Control (1.5 MW) application of
the Mark VIe controller is running.
Options are:
• Not Logged
Controller Collected • Average Linear: This is a linear average {1/N * sum(values)}
• Average Linear Angle: This is an average for angle based variables; it takes into account 0 degrees equals/360
degrees wrap-around for angles.
• Average Cosine Phi: This average calculation is for power factor (cos phi). It effectively calculates the average
of the arccosine of each of the data values during the interval. The value returned is the cosine of this average.
• Data Snapshot: This selection is for end-of-interval values. The last value captured during the specified interval
is returned.
This property is only displayed if the Controller Collected property is set to something other than Not Logged.
Selects the type of collection for a Compressed Data Log (CDL) variable. Options are:
• General: Data is recorded at uncompressed one second resolution (SecRes) for up to 24 hours and in
Data Class compressed form for longer periods (MinAna). The data is available through the CDL’s HTTP API.
• Protected: Data is recorded at one second rates and compressed and is available only through the CDL’s
secure API.
• Both: Data is recorded in both the General and Protected logs and is available through the HTTP and protected
APIs.
If set to True, prevents modify-variable commands from being written into the Command and Event Log (CEL) (default
CEL Command Filter
is False)
Public Information
Enables the automatic collection by the Historian when:
Historian Deadband Boolean and set to Logged on Change
Analog and set to 0 or higher
Historian Deadband
Defines the deadband value as either engineering units or percent of range
Definition
Enables the automatic collection by the Recorder when:
Recorder Deadband Boolean and set to Logged Continuous or Logged on Change
Recorder Deadband
Definition
Usage
Allows a variable to be designated as a configuration setting.
When set to False, the variable is not a control constant (default is False). If set to True, the variable is a control
Control Constant
constant and the live value can be modified. When set to ReadOnly, the variable is a control constant but the live
value cannot be modified.
If set to True, downloads extended information to the controller that is used by the web server, as well as other
Download Info processes. For example, to view alarms on the touchscreen, the Download Info parameter must be set to True for
each alarmed variable.
EGD Page Used to assign the variable to an Ethernet Global Data Page
Used primarily for EGD:
ReadOnly variable can be read on EGD
External Access
ReadWrite variable can be written to through EGD
NoAccess variable cannot be changed with the ToolboxST application
The variable's global name prefix type (None, Full, Block, Program, Task).
This controls the form of the global name that displays on the EGD page. For example, the name for variable IGVA in
user block VG_Health in task Task1 in program CORE would display (depending on the Global Name Prefix) as:
None: IGVA
Global Name Prefix
Full: CORE.VG_Health.IGVA
Block: VG_Health.IGVA
Program: Task1.IGVAv
Task: Task1.IGVAv
Scope of the variable (Local, Member, or Global):
Local variables can only be used in the program or user block in which it is created.
Scope Global variables can be used in other programs and user blocks. A variable must be Global to be transmitted over
EGD.
Member variables are similar to Local variables, but differ in that they are visible to child tasks and user blocks.
Defines the behavior of pins on a user block:
Usage
Input pins display on the left side of the user block
Output pins display on the right side of the user block
applicable for
State pins display on the right side of the user block
Libraries.
Constant entry is a number; no live data is provided for this pin
Virtual HMI Point If set to True, imports the variable into the HMI as a virtual point
Entry High Limit Default upper limit for setpoint entry on the HMI
Entry Low Limit Default lower limit for setpoint entry on the HMI
Is Critical When set to True, the variable is marked as critical to safety or operation, and must be driven and driving a block pin.

Public Information
Variable Data Types
Data Type Description
Any (ANY) Any data type
Boolean (BOOL 8–bit Boolean
Integer (INT) 16–bit signed integer
Double Integer (DINT) 32–bit (long) signed integer
Real (REAL) 32–bit floating point
Long Real (LREAL) 64–bit (long) floating point
Unsigned Integer (UINT) 16–bit unsigned integer
Unsigned Double Integer (UDINT) 32–bit (long) unsigned integer
Numeric (ANY_NUM) Any data type except Boolean
Analog or Boolean (Simple) Any simple data type
➢ To select the variable data type
From the
Summary View,
select a variable.
From the Type
drop-down list,
select the
variable type.
Or:
from the
Property
Editor,
select Type
and the
variable type
Public Information
6.19.13 Visualization Type
The Visualization Type property configures the display view for graphic files (HTML or WMF) that represent live variable
data. Users can select the form of graphic display from the selected file directory (Path to Visualization). There are three
options available for graphic display:
• Replace the blockware detail view for the task or user block with a graphic
• Add the graphic as a Sheet tab in the block’s detail view
• Display the graphic in a separate window using the eyeglasses button on the toolbar
➢ To configure Blockware Editor visualization
From the Software tab Property

Editor, select the Visualization Type
from the drop -down list.
Click Browse and select the graphic file (.html or .wmf),

then click Apply to set the Path to Visualization.

Public Information
Blockware Editor Replaced with HTML Document (Graphic View)
Graphic Displayed as Summary Sheet

Graphic Displayed in Separate Window
Note Refer to the section Requisition Info for further details.
Public Information
6.19.14 Alarm Configuration
Alarms report abnormal conditions and trips, with descriptions and high-resolution time tags to identify the origin of the event
for troubleshooting. The operator can see and react to alarms and events from any of the equipment within their jurisdiction.
The WorkstationST Alarm Server gathers alarms from the controllers or other sources and makes them available to alarm
clients, such as the CIMPLICITY and WorkstationST Alarm Viewer. The ToolboxST Controller Diagnostics View displays
errors and warnings that occur in the hardware component that may cause improper functionality or communication issues.
Using the ToolboxST software, variables can be configured to generate an alarm or event when designated thresholds or
inputs are exceeded and indicate issues with control system equipment and operation.
Five alarm types can occur in the Mark VIe control system:
• Diagnostic Alarms
• Process Alarms
• Hold List Alarms
• Events
• Sequence of Events (SOE)
Beginning with ControlST V04.04, controller configurations must not exceed the
following limits. If these limits are exceeded, reduce the number of configured Process
Alarms, Events, and Holds.
• Configured Process Alarms and Holds limit = 4,096 maximum
Attention • Configured Holds limit = 512 maximum
• Configured Events limit = 2,048 maximum
Note For further details, refer to the Mark VIe and Mark VIeS Controls Systems Volume I: System Guide (GEH-6721_Vol_I),
the chapter Alarm Overview, and the Workstation Alarm Server Instruction Guide (GEI-100626).
Alarm Parent Child Property

When the Alarm Parent Child property is enabled in the System Editor, Parent Alarm and Child Alarm columns display in the
Software tab Data Grid when Variables is selected in the Tree View. Variables defined as Alarms can then be configured with
the parent/child hierarchy. When a parent alarm is defined in the system, if the parent alarm occurs then a child alarm is a
side-effect of the parent alarm (only the parent alarm can be configured).
Click the ellipsis button to

display the Process Alarm
Parent Alarm dialog box.

Public Information
Right-click to select
Organize Columns .
Browse All Alarms displays all Browse Only Valid Alarms

global alarms in the device. confirms eligibility criteria on all
After alarms are selected, they global alarms and displays only
are validated for eligibility. those that are validated.
Parent and child Alarms can be exported using Alarm Rationalization. Parent alarms only can be imported from a .csv file.
Corresponding child Alarms are automatically placed in the configuration.
➢ To import parent alarms
From the File

menu, select
Import and GE
Rationalization
Report
Public Information
6.19.15 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, in that both are similarly named and used in instruction
blocks. 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. The format for 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 uni-variant (2D) tables and consist of X and Z linear arrays of the same length. Tables
with two independent arrays are sometimes called bi-variant (3D) tables and consist of X and Y linear arrays and a Z
two-dimensional array.
Table definitions are added to a Program in the Tree View and display in the Summary View. They are normally imported
from a .csv file into ToolboxST by engineering and can be exported to a .csv file, modified, and reimported.
Example Bi–variant (3D) .csv File Format
Example Uni–variant (2D) .csv File Format

Public Information
Summary View of Uni-variant (2D) Table Definition Example
Summary View of Bi-variant (3D) Table Definition Example
Public Information
➢ To import a table definition to .csv file
1. From the Software tab Tree View, right-click a Program and select Import Table .CSV File to display the Table
Definition dialog box.
2. Select the desired table definition file and click Open to insert the Table Definition
.csv file into the program.
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.
Table Definition Columns

Column Description
Task Name Name of this task
Period at which this user block runs (in ms). Calculated by multiplying the frame multiplier
Period
by the controller’s frame period, which is set on the General tab.
➢ To change the frame multiplier or the schedule offset: from the Summary View, click the Frame Multiplier
or Schedule Offset cell and select from the drop-down list.
Note Since the schedule offset depends on the frame multiplier, it is possible to select a frame multiplier for which the
current schedule offset is invalid. This causes a validation error when you build the application.
➢ To export a table definition (.csv file)

1. From the Component Editor Software tab, expand Table Definitions and select the table definition to export.
2. Right-click the table definition and select Export Table.CSV File.
3. From the Open window, select the .csv file and click Open.

Public Information
6.20 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.
6.20.1 Configure DDR

➢ To configure a DDR: from the System Editor, double-click the static starter control. The Component Editor
displays.
Public Information
Public Information
DDR Properties
Name User-defined description for this DDR, which is used for the filename
Description User-defined description for this DDR
If set to True, automatically re-enables the DDR after 60 seconds once it is uploaded.
Auto Enable
If Auto Enable is set to True, all manual enable inputs are ignored.
Controls how and when the data is collected. Options are:
Normal causes the DDR to collect pre-samples before a trigger event, and continues to collect
data until the Enable option transitions to False or the collection fills the buffer.
Circular causes the DDR to collect data indefinitely until the Enable option transitions to False.
Buffer Control
The buffer will be filled with the newest samples. No trigger is used.
Only causes the DDR to evaluate the trigger during each operation, and only collect data when
the trigger condition is satisfied. Data is collected until the Enable option transitions to False or
the collection fills the buffer.
Frame Period Multiplier Extends the sampling period by this value. The base sampling period is the frame period.
Options are:
Manual allows you to manually upload the DDR.
Upload Type
Automatic is an automatic upload by the data collection.
Trip is an automatic upload by the data collection, then added to the trip log.
Setup variable that enables the DDR. If set to True and the Auto Enable property is set to False,
the DDR is enabled for capture. This allows the application code to enable and disable data
Enable
collection. This is an edge-triggered property. Once a DDR has been stopped, the Enable
property must be toggled False and then True again to re-enable the next capture.
Trigger Setup variable that triggers the DDR
Post-trigger Samples Number of samples collected after the trigger, including the trigger sample
Pre-trigger Samples Number of samples collected before the trigger
Options are:
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.
Trigger Comparison Type 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.
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
Trigger Comparison Value
for FALSE. 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.
Trigger condition setting that drives trigger evaluation. Options are:
Trigger Type Edge is triggered on the rising edge of the trigger variable.
Level is triggered on the true condition of the trigger variable.
Public Information
6.20.2 Status Variables
Status variables, which indicate the status of the associated DDR, are used to determine when to upload the data. Status
variables are always integers, and are automatically defined and placed on the EGD status page.
Variables can be added to a DDR. When a trigger occurs, these variables are collected by the buffer and subsequently
uploaded by the Recorder 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 DDR tab Tree View, right-click the DDR and select Add Variable.
2. Select the desired variables and click OK.
DDRs can be updated separately from the application code download.
➢ To update a DDR: from the Device menu, select Download and Update Dynamic Data Recorder.
Note DDRs cannot be downloaded if there is a major difference in the device. In this case, the application code must be
downloaded.
DDRs are imported from and exported to .xml files.
➢ To import or export a DDR: from the DDR tab Tree View, right-click the desired DDR and select Import
Configuration or Export Configuration.
Note If the .xml file being imported contains the formatting flags %n, it is replaced by the 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.

Public Information
6.20.3 DDR Setup
➢ To set up a DDR to capture two variables
1. From the Software tab Tree View, right-click the Prog1 item and select Add Variable. In the Add New Variable
dialog box, enter DDREnable (Boolean), which enables the DDR.
2. From the Add New Variable dialog box, add a variable DDRTrigger (Real), which triggers the DDR.
3. From the Add New Variable dialog box, add the variables TriangleOut and SineOut, which are connected to the
output of the function blocks. These variables are added to the DDR variable collection.
4. Create a User Block in the program, and add two FuncGen blocks from the Data Collection section. Set up the pins
on the two blocks as follows. FuncGen1 is set up as a Sine wave generator and FuncGen2 is set up as a Triangle wave
generator.
5. Add the two variables SineOut and TriangleOut to the DDR. Set the Frame Period Multiplier to 3, which means a
sample is collected every 120 ms. The base frame period is typically 40 ms. Set the PreTrigger samples to 20 and the
PostTrigger samples to 100, so that the entire capture takes 14.4 seconds.
Public Information
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.
6. Perform B and download commands to the application code.

7. Go Online with the controller then build and download the application code. From Prog 1, select Variables.
Double-click the live data for the DDREnable variable and set to True.
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.

Public Information
Public Information
8. Set the value of the DDRTrigger variable equal to or greater than 5 and send to the controller. The status indicates the
Capturing state.

Public Information
When the capture is complete, the status indicates Done, and the DDR can be uploaded.
9. From the View menu, select Trenders to add a new trend and upload the capture buffer.
10. From the Trender window, select Edit and Add Traces to display the Trender - Add Trace Wizard.
11. From the wizard, select Capture Buffer/Dynamic Data Recorder to select the DDR to upload.
Public Information
6.21 Ethernet Global Data (EGD) Tab
The EGD protocol allows you to share information globally between controller components in a networked environment.
EGD allows one controller component, referred to as the producer of the data, to simultaneously send information to any
number of peer controller components (consumers) at a fixed periodic rate. This protocol supports a large number of
controller components capable of both producing and consuming information.
6.21.1 EGD Configuration

➢ To configure EGD for a component
1. From the Component Editor, select the EGD tab.
2. From the Tree View, select Ethernet Global Data.
3. Configure the EGD Producer ID to display the unique address of the EGD producing device for this component when it
is created. The Property Editor displays the EGD Producer ID formatted as an unsigned integer.
From the Property Editor, click the ellipsis button

to display dotted and hexadecimal representations.

Public Information
6.21.2 Produced Pages
Produced Pages are data samples configured to be available to other components on the network.
Note When the first Produced Page is created, it automatically becomes the default page.
➢ To add a Produced Page

1. From the Tree View, right-click the Produced Pages item and select Add Page.
2. From the Page Name dialog box, add a name and click OK. The new page displays in the Tree View.
➢ To display standard variables

1. From the EGD tab Tree View, select Produced Pages.
2. From the Property Editor, select the Default Page Property, then select the desired page from the drop-down list.
Tip � Any variable defined with $Default as the EGD page name is automatically placed on the currently selected default
page.
➢ To delete a page: from the Tree View, right-click the page to delete and select Delete.
Public Information
➢ To configure a Produced Page: from the Tree View, expand Ethernet Global Data.
The following table lists the properties that are available when a Produced Page is selected in the Tree View.
Produced Pages Properties

If selected, causes EGD to be broadcast on Ethernet Adapter 0
Ethernet 0 If more than one Ethernet Adapter has been configured for EGD, additional Ethernet properties
display.
Provides three options:
Broadcast sends the page to all EGD nodes
Unicast sends the page to a single destination
Mode
Multicast sends the page to the specified multicast address
This multicast address cannot conflict with multicast addresses on IONet. An error message is
generated if a conflict exists.
Exchanges Indicates the number of exchanges in the selected page. It is updated after a build.
Can be set to True if the selected page is the Default Page.
Default Page
To change the default page, the section Produced Pages.
If set to Auto, automatically assigns exchange numbers and offsets assigned at build time. If set to
Layout Mode
Manual, exchange numbers and offsets can be entered manually.
Sets the minimum length of the exchanges on this page. Some components look only at the length of
Minimum Length the exchange. This property can be set to a value larger than the current size of the exchange so that
as variables are added, the component continues to receive the exchange.
Name Renames the selected page
Period Indicates the transmission period of the page in ms
Multiplies the value by the Controller frame period to obtain the EGD page period. (The results display
Period Multiplier
in the Period property.)
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
Skew
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.)
The Skew property will not be visible if it is not supported in the implementation profile configuration.
Used for the first exchange on this page. Each additional exchange will be incremented from this
Starting Exchange ID
number. When this property is changed, all exchanges are renumbered.
Status Page Used by the WorkstationST application to provide standard variable information.

Public Information

display.
Mode
Default Page
Layout Mode
Period Indicates the transmission period of the page in ms.
Period Multiplier
Skew
Public Information
6.21.3 Page Compression
When a page compression is performed, the variables are located in increasing size order, starting with Booleans, then Words,
Double Words, and finally all other variables. A page compression causes an exchange major signature. Consumers normally
mark the exchange variables as unhealthy until the consumed configuration can be rebound.
➢ To compress a single page: from the Tree View, right-click the page to compress and select Compress.
➢ To compress all Produced Pages in a component: from the Tree View, right-click Produced Pages and
select Compress All.
➢ To add a variable to an EGD page

1. From the EGD tab Tree View, right-click the desired page and select Add Variable to display the Select a Variable
dialog box.
2. Select variables and click OK.
The Summary View updates to display the new variable(s). 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 set the
EGD Page property using either the Summary View or the Property Editor.
➢ To add a variable to a produced page: from the Tree View, right click a Produced Page and select Add
Variable to display the Select a Variable dialog box.
➢ To delete a variable from an EGD Page: from the Summary View, right-click the variable to delete and 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 select Copy Selection. The data is copied in .csv format.

Public Information
6.21.4 Edit Exchange Signatures and Configuration Time
The exchange signature is typically 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 the Layout Mode property to Manual. The Layout Mode
property displays when a Produced Page is selected in the Tree View.
➢ To edit exchange signatures and configuration time

1. From the EGD tab, select the Configuration tab and select a Produced Page in the Tree View.
2. Right-click an exchange in the Summary View and select Edit Exchange Signatures and Configuration Time.
3. Review the warning about manual Exchange Signature editing and click OK.
4. Make any desired changes to the signatures and configuration time and click OK.
Public Information
6.21.5 EGD Diagnostics
The EGD protocol includes a command mechanism that obtains the status of a Class 2 or higher EGD device. Mark VIe is a
Class 3 EGD device. When any EGD item in the Tree View other than a referenced device is selected, the EGD Statistics
from [Device] tab displays the statistics from the open component. When a Referenced Devices item is selected, the statistics
are obtained from that referenced device, and the name of the tab page changes accordingly.
Note You must be online to view diagnostic information.
EGD Diagnostics Columns

Column Description
Exchange Exchange identifier <device name> <exchange number>
Configuration Time Time that the exchange was configured
Due Time Time that a consumer data packet must be received for an exchange to remain valid
Status Health of the exchange
Value for a produced exchange
This length may be the highest variable offset in the exchange or the highest offset of a variable, which
Length
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 Number of data production packets produced or consumed since initialization
Number of data production packets missed since initialization
Missed Count 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).
Number of times a refreshment fault has occurred
Refresh Errors 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.

Public Information
6.21.6 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. If the server is enabled, this tab displays information
from that server.
Filter Toggle defaults to a filtered state. It displays items that have the same name but have a different Producer ID as
the open component.
Delete deletes the selected item(s). If the item(s) were saved as part of the configuration, they can be added again.
The EGD configuration server uses the producer ID to store all the documents for an EGD node.
Note A system can have one EGD configuration server only.
When a component is saved, the EGD configuration is automatically published to the EGD configuration server. To avoid
unintentional overwriting of data, do not configure more than one .tcw file for a server.
6.21.7 EGD Configuration Server Reports

With the system item selected, the EGD configuration server tab can be enabled on the System Editor Property Editor. When
enabled, the Produced Pages item has two additional context menu items as follows:
• Compare command compares the component's EGD-produced data configuration with the EGD configuration server’s
content.
• UnConsumed Data command generates a report showing variables produced by this component that are not listed in
any other device’s consumed data file.
Note You can select devices to search against. The individual pages, with just variables, perform the same Compare.
The Referenced Devices item on the EGD tab also has a Compare command that compares the consumed variable
information for the open component against the EGD configuration server’s content.
Public Information
6.21.8 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

1. From the Tree View, right-click Referenced Devices and select Select Devices.
2. From the Select Devices dialog box, select or clear the check boxes next to each component name and click OK.
The EGD configuration for the selected devices are loaded and the variables display in the Summary View.
Note When EGD configurations are edited in remote devices, you must refresh the configuration to ensure that the latest
variable information is used. The configuration is automatically refreshed when a component is opened, and when a Build is
performed in the component.
➢ To refresh the configuration of a referenced device: from the Tree View, right-click the device to be refreshed
and select Refresh.
6.21.9 Create Undefined Variables

The Create Undefined Variables option allows you to create variables in a component created from a referenced device. The
list of undefined variables is generated when a Build command is performed. As the variables become available from the
referenced device, they are deleted from the list.
➢ To create undefined variables for a single or multiple referenced device(s): from the Tree View, right-click
either the device or Referenced Devices and select Create Undefined Variables.

Public Information
6.22 Modbus Slave Tab
The Modbus® slave feature allows a Modbus master to read or write data directly from the Mark VIe controller, using the
Modbus protocol over Ethernet.
6.22.1 Configure Modbus Slave

➢ To configure a Modbus Slave
1. From the Component Editor, select the Modbus Slave tab.
2. From the Property Editor, modify properties as needed.
Note Modifying Modbus properties results in a minor difference in the ToolboxST configuration. However, removing all
Modbus points creates a major configuration difference that forces an offline load.
Modbus Properties
Property Description Valid Range
Connection Specifies the time in minutes that the slave remains connected to the master over
1 to 10
Timeout Ethernet when no requests are being received.
Port choices:
Ethernet Port Specifies the Ethernet port to be used for slave-Ethernet communication
502 and 503
Specifies the timeout period expressed as character time X 10. For example, 35
Inter-Character
represents 3.5 character times, or 0.0036 seconds at 9600 baud, 1 start bit, no parity, 1 35 to 1000
Timeout (ICT)
stop bit.
Choices:
None, Odd,
Parity Specifies check character Even,
Mark, and
Space
Response Delay Additional delay time in ms before the slave responds to a master request. 0 to 999
Limits the number of commands processed per second. This is based on commands
Command Limit 0 to 25
that have changed, not commands that are identical to previously received commands.
Data Swapped Changes the transmission order if the data is greater than 16 bits when set to True. True or False
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
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. Possible codes are 4, 6 or None. None is selected only if the Modbus Master needs no reply
when communication fails between the Mark VIe controller and the target processor.
Public Information
6.22.2 Modbus Slave Register Pages
The Modbus Slave tab Summary View contains four tabs 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:
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
Note For Modbus resources, go to http://www.modbus.org.
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 from the Property Editor, select None as the Interface.
When a variable is added, the columns that display are listed in the following table.
Variable Columns
Column Description
Variable that is read or written from the device or the referenced device
Connected Variable
A connected variable must be added before the other columns become active.
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.) All
BOOLs within a word must be set to the same Read or Read/Write direction.
• INT is a signed 16-bit word that takes one register
• UINT is an unsigned 16-bit word that takes one register
Point Data Type • 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
If a Modbus Master talking to a Slave will be writing to Booleans being added to a Holding Register, be
sure that all mapped Booleans are set to Read/Write. If the Master sends a command to change a
Boolean that is Read-only, the Slave will not perform any writes, and will return a Slave Exception.
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. Data types that are 32 bits or more
Address (DINT, UDINT, REAL, and LREAL) should be placed on odd addresses. The valid range for addresses
is 1 to 65534. When specifying an address for a BOOL variable, the bit 0-15 within the 16-bit word is
represented by a decimal. For example, 1.00 selects register address 1 and bit 0, and 10423.7 selects
register address 10423 and bit 7.
Raw Min Convert Modbus Slave variable data into engineering units
Raw Max The Raw Min and Raw Max columns control the minimum and maximum for the raw data. The Eng Min
Eng Min 0 and Eng Max columns control the minimum and maximum engineering units to which the raw data will
Eng Max be scaled. (The BOOL data type cannot be scaled.)
Read-only identifier automatically generated from the register page name, the address, and, if
Name
necessary, an added unique number

Public Information
6.22.3 Data Format
All variables handled by the controller Modbus I/O are transferred to the controller signal space at the start of each task if
they are referenced in the control code. This method allows data type conversions and scaling. The data type conversion is
controlled by the type of Modbus variable and controller signal data type.
Float values are rounded prior to being stored in short or long registers. Short and long registers are clamped to their
minimum and maximum limit if the conversion exceeds their specified range.
Available Controller Data Type Conversions

Modbus Data Type Coil Register Bit 1 Register 2 Registers 4 Registers
BOOL BOOL INT UINT DINT UDINT REAL REAL
Controller BOOL Yes Yes N/A N/A N/A N/A N/A N/A
Signal Data INT N/A N/A Yes Yes Yes Yes Yes Yes
UINT N/A N/A Yes Yes Yes Yes Yes Yes
DINT N/A N/A Yes Yes Yes Yes Yes Yes
UDINT N/A N/A Yes Yes Yes Yes Yes Yes
REAL N/A N/A Yes Yes Yes Yes Yes Yes
LREAL N/A N/A Yes Yes Yes Yes Yes Yes
Public Information
6.22.4 Data Scaling
Data scaling converts the Modbus variable into a signal that represents engineering units. Multiple signals can share one
scaling record.
The Modbus variable assumes a range

of 0 to 4000, while the controller signal is
between -40 and 160 degrees
The gain is defined as:

Gain = EngRange/RawRange
Gain = (Engmax – Engmin)/(Rawmax – Rawmin)
Gain = (160 - (-40))/(4000 – 0) = (160 + 40)/4000
Gain = 200/4000 = 1/20 = 0.05
The offset is defined as:
Offset = Engmin – (Rawmin x Gain)
Offset = -40 - (0 x 0.05) = -40
The formula to convert the Modbus variable to a controller signal is:
Controller signal = Modbus variable x Gain + Offset
Controller signal = Modbus variable x 0.05 + (-40)
Controller signal = Modbus variable x 0.05 - 40
If the Modbus variable’s raw value is 1000, the controller value is (1000 x .05) - 40, or 10 degrees.
Note The range of the Modbus variable is determined by the data type and not by the scaling record. Each integer data type
has an implied range. The raw data range in the scale dialog box is only used to compute the gain and offset of the variable
when converting it to a signal.
The formula to convert the controller signal to a Modbus variable is:

Modbus variable = (Controller signal - Offset)/Gain
Modbus variable = (Controller signal - (-40))/0.05
Modbus variable = (Controller signal + 40)/0.05
If the controller signal is 10, the Modbus variable is (10 + 40)/0.05 or 1000. Modbus variables and controller signals do not
have to be associated with a scale definition, even if a data type conversion is required. A gain of 1 and an offset of 0 are used
in these cases.
An INT variable is a signed 16-bit number. In this mode, the most significant bit is treated as a sign bit where a one is used for
negative values. Controller signals are converted into INT Modbus variables by applying the scaling information, rounding
the values to the nearest integer value, and then clamping the result in the range of −32768 to +32767.
A UINT variable is an unsigned 16-bit number. Controller signals are converted into UINT Modbus variables by applying the
scaling information, rounding the values to the nearest integer value, and then clamping the result in the range of 0 to +65535.
A DINT variable is a signed 32-bit number. The value is transmitted on Modbus as two consecutive 16-bit integers with the
least significant word in Register N and the most significant word in Register N+1. In this mode, the most significant bit is
treated as a sign bit where a one is used for negative values. Controller signals are converted into DINT Modbus variables by
applying the scaling information, rounding the values to the nearest integer value, and then clamping the result in the range of
–2147483648 to +2147482647.

Public Information
A UDINT variable is an unsigned 32-bit number. The value is transmitted on Modbus as two consecutive 16-bit integers with
the least significant word in Register N and the most significant word in Register N+1. Controller signals are converted into
DINT Modbus variables by applying the scaling information, rounding the values to the nearest integer value, and then
clamping the result in the range of 0 to +4294967295.
A REAL variable is a signed 32-bit IEEE® 754 standard number. The value is transmitted on Modbus as two consecutive
16-bit integers with the least significant word in register N and the most significant word in register N+1. In this mode, the
most significant bit is treated as a sign bit and the next eight bits are a biased exponent followed by a 23-bit significant.
Controller signals are converted into FLOAT Modbus variables by applying the scaling information.
Note To ensure data coherency, LONG Modbus variables should always start on an odd register number, and the master
should send both registers to the controller in the same Modbus transaction.
To ensure data coherency, FLOAT Modbus variables should always start on an odd register number, and the master should
send both registers to the controller in the same Modbus transaction.
6.22.5 Command and Response Definition

This section describes the commands and responses supported by the UCCA to implement the Modbus communications and
functions. The UCCA is a Slave station on an RS-232C data link that responds to commands from the Master. Messages are
transmitted and received using the RTU transmission mode where RTU transmits data in 8-bit bytes.
6.22.5.1 Message Format

The Serial RTU transmission mode uses the following format (where follower address, function code, CRC-16 MSB, CRC-16
LSB are all bytes):
Station ID Function Code … Function Specific Data … CRC-16 MSB CRC-16 LSB
Station ID (follower address) is a number from 1 to 255 that specifies the unit with which to communicate.
Function code specifies the purpose and format of the remaining message portion.
CRC-16 are two bytes that complete every serial Modbus message. These bytes check errors and are calculated to ensure that
no transmission error occurred while the message was in transit. The method for calculating the CRC-16 is a public protocol.
Refer to the Gould Modicon Modbus Protocol Reference Guide for information on calculating a correct Cycle Redundancy
Check (CRC).
The same functions are supported over Ethernet and the serial ports. All Modbus messages are received on the specified
Ethernet port. The Ethernet physical layer provides a CRC-32 check on all transmissions so the Modbus CRC-16 is not
included. Modbus over Ethernet adds the following header to the message formats.
Invocation Invocation Protocol Protocol Length Length Station ID Function … Function

ID MSB ID LSB MSB LSB MSB LSB Code Specific Data …
Invocation ID is not used by the controller Modbus. Set to 0.

Protocol ID is not used by the controller Modbus. Set to 0.
Length is the byte count of the remaining part of the message and is used by the Modbus to receive the rest of the message,
which is exactly what is sent and received over the serial connections.
Public Information
6.22.5.2 Message Errors
When a message that cannot be acted upon is received, it is either ignored (and the controller waits for the next message) or
an exception message is generated. Any messages that are misunderstood, incomplete, or altered in some manner (framing,
parity, or CRC-16 error) are always ignored because it is not possible to reliably determine the intention of the message. The
master must detect this timeout condition and resend the message as necessary.
Any time a message receipt is being sent over a serial connection and an interval of time corresponding to 3.5 character times
(based on the baud rate) occurs without receipt of a character, the message receipt in progress is aborted and ignored. Other
message failures are responded to with an exception response if no reception error has occurred, and if the message was not a
broadcast (follower address was zero). The following table displays the exception code responses that are supported when a
normal response is impossible.
Exception Code Responses

Code Name Description
01 Illegal function Message function received is not supported
02 Illegal data address Address referenced in the data field is not in a permissible range
03 Illegal data value Value transmitted in the data field is illegal
04 Device failure Data source is unhealthy
06 Device busy Too many writes to the controller – commands per second limit exceeded
99 Illegal slave address Illegal slave address sent through Ethernet
The exception message reply from the controller is formatted as follows:

Station ID (controller address) must be in the range of 1 to 255.
Function code is always equal to the master’s function code with the MSB set. As an example, an exception response sent
back to a master that sent a message with function code 02 hex, would have a function code of 82 hex (or 130 decimal) in the
exception reply.
Exception codes are as described in the table, Exception Code Responses. Only codes 01 through 03 and 06 are supported.

Public Information
6.22.6 Function Code Descriptions
The nine function codes implemented in the controller are used to read from, and/or write to, the four Modbus table types.
The following table lists the function codes included in the messages sent from the DCS that are supported by the controller.
Each function code and the controller reply are described in this section.
Function Code Descriptions

Code Description
01 Read output coils
02 Read input coils
03 Read holding registers
04 Read input registers
05 Force (write) single output coil
06 Preset (write) single holding register
07 Read exception status
15 Force (write) multiple output coils
16 Preset (write) multiple holding registers
6.22.6.1 Function Code 01: Read Output Coils

Function code 01 is used to read the output coil table. The message sent from the master is formatted as follows:
Function Code (01) Start Coil (MSB) Start Coil (LSB) Number of Coils Number of Coils
(MSB) (LSB)
Starting output coil number is two bytes long, and can be any value less than the highest output coil number available in
the output coil table. The starting output coil number is equal to a number one less than the first output coil returned in the
normal response. For example, to get the first output coil, enter 0 for the starting output coil number. The high-order byte of
the starting output coil number field is sent as the first byte. The low-order byte is sent next.
Number of output coils to return is two bytes long, and must be from 1 to 2000, inclusive. It specifies the number of
output coils returned in the normal response. The sum of the starting output coil value and the number of output coils must be
less than or equal to the highest output coil number available in the output coil table. The high-order byte of the number of
output coils field is sent as the first byte. The low-order byte is sent next.
The normal message reply from the controller is formatted as follows:
Function Code (01) Byte Count Data Bytes 1-n
Byte count is a binary number from 1 to 250. The specified number of data bytes follow.
Data bytes (data field) are the packed output coil status data. Each byte contains eight output coil values. The LSB of the
first byte contains the value of the output coil whose number is equal to the starting output coil number plus one. The value of
the output coils are ordered by number, starting with the LSB of the first byte and ending with the MSB of the last byte. If the
number of output coils is not a multiple of eight, then the last data byte contains zeros in one to seven of its highest order bits.
Public Information
6.22.6.2 Function Code 02: Read Input Coils
Function code 02 is used to read the input coil table. The message sent from the master is formatted as follows:
Function Code (02) Start Coil (MSB) Start Coil (LSB) Number of Coils (MSB) Number of Coils (LSB)
Starting input coil number is two-bytes long and can be any value less than the highest input coil available in the input
coil table. The starting input coil number is equal to one less than the number of the first input coil returned in the normal
response. For example, to get the first input coil, enter zero for the starting input coil number. The high order byte of the
starting input coil field is sent as the first byte. The low order byte is sent next.
Number of input coils to return is two-bytes long and must be from 1 to 2000, inclusive. It specifies the number of input
coils returned in the normal response. The sum of the starting input coil value and the number of input coils must be less than
or equal to the highest input coil available in the input coil table. The high order byte of the number of input coils field is sent
as the first byte. The low order byte is sent next.
Data bytes (data field) are the packed input coil status data. Each byte contains eight input coil values. The LSB of the first
byte contains the value of the input coil whose number is equal to the starting input coil plus one. The value of the inputs are
ordered by number, starting with the LSB of the first byte and ending with the MSB of the last byte. If the number of input
coils is not a multiple of eight, then the last data byte contains zeros in one to seven of its highest order bits.
6.22.6.3 Function Code 03: Read Holding Registers

Function code 03 is used to read holding registers. The message sent from the master is formatted as follows:
Function Code Start Register Start Register Number of Registers Number of Registers
(03) (MSB) (LSB) (MSB) (LSB)
Starting holding register number is two-bytes long and can be any value less than the highest holding register number
available in the holding register table. The starting holding register number is equal to one less than the number of the first
holding register returned in the normal response. For example, to get the first holding register number (holding register
number one) enter zero for the starting holding register number. The high order byte of the starting holding register number
field is sent as the first byte. The low order byte is sent next.
Number of holding registers value is two-bytes long and must be from 1 to 128, inclusive. It specifies the number of
holding registers returned in the normal response. The sum of the starting holding register value and the number of holding
registers must be less than or equal to the highest holding register number available in the holding register table. The high
order byte of the number of holding registers field is sent as the first byte. The low order byte is sent next.
Function Byte Count First Register First Register … Data Registers Last Register (LSB)
Code (03) (MSB) (LSB) Requested …
Byte count is an even binary number from 2 to 254, or 0. If the byte count is 0, then the master assumes 256 data bytes
follow. Otherwise, the specified number of data bytes follow, not including the two CRC-16 bytes (serial mode).
Holding registers are returned in the data field in numerical order, with the lowest number holding register in the first two
bytes and the highest number holding register in the last two bytes. The number of the first holding register is equal to the
starting holding register number plus one. The high order byte is sent before the low order byte of each holding register.

Public Information
6.22.6.4 Function Code 04: Read Input Registers
Function code 04 is used to read input registers. The message sent from the master is formatted as follows:
Function Code (04) Start Register Start Register Number of Registers Number of Registers
(MSB) (LSB) (MSB) (LSB)
Number of input registers value is two-bytes long and must be from 1 to 128, inclusive. It specifies the number of input
registers returned in the normal response. The sum of the starting input register value and the number of input registers must
be less than or equal to the highest input register number available in the input register table. The high order byte of the
number of input registers field is sent as the first byte. The low order byte is sent next.
Function Code Byte Count First First Register … Data Registers Last Register (LSB)
(04) Register (LSB) Requested …
(MSB)
Input registers are returned in the data field in numerical order, with the lowest number input register in the first two bytes
and the highest number input register in the last two bytes of the data field. The number of the first input register in the data
field is equal to the starting input register number plus one. The high order byte is sent before the low order byte.
Public Information
6.22.6.5 Function Code 05: Force Single Output Coil
Function Code (05) Output Coil (MSB) Output Coil (LSB) State (00 or FF) 0
Function code 05 is used to force (or write) a single output coil in the output coil table. The message sent from the master is
formatted as follows:
Output coil number is two-bytes long and can be any value less than the highest output coil number available in the output
coil table. The output coil number is equal to one less than the number of the output coil forced. For example, to change the
first output coil enter 0 for the output coil number. The high order byte of the starting output coil number field is sent as the
first byte. The low order byte is sent next.
State byte is sent by the master with only two possible values. A zero (00h) is sent to turn the specified output coil off (set
false). A value of 255 (FFh) is sent to turn the specified output coil on (set true). The state byte is always followed by a single
byte with value 0.
The format of the normal message reply from the controller is identical to the received message.
6.22.6.6 Function Code 06: Preset Single Holding Register

Function code 06 is used to preset (or write) to a single holding register. The message sent from the master is formatted as
follows:
Function Code Holding Register Holding Register Register Data (MSB) Register Data (LSB)
(06) (MSB) (LSB)
Holding register number is two-bytes long and can be any value less than the highest holding register number available in
the holding register table. The holding register number is equal to one less than the number of the changed holding register.
For example, to change the first holding register enter 0 for the holding register number. The high order byte of the starting
holding register number field is sent as the first byte. The low order byte is sent next.
Holding register data field is two bytes long and contains the value to which the holding register specified by the holding
register number field is preset. The first byte in the data field contains the high order byte of the preset value. The second byte
in the data field contains the low order byte.
The format of the normal message reply from the controller is identical to the received message.

Public Information
6.22.6.7 Function Code 07: Read Exception Status
Function code 07 is used to read the exception status data, defined as the first eight output coils. These can indicate the
controller status or condition of any other state. Function code 07 thus provides a short form of request for reading the first
eight output coils, output coils one through eight. The message sent from the master is formatted as follows:
Function Code (07)
Function Code (07) Data Byte
Data bytes (data field) are the packed output coil status data. The data byte contains eight output coil values. The LSB of
the byte contains the value of output coil number one. The MSB contains the value of output coil number eight.
6.22.6.8 Function Code 15: Force Multiple Output Coils

Function code 15 is used to force (or write) multiple output coils in the output coil table. The message sent from the master is
formatted as follows:
Function Code Starting Coil Starting Coil Coil Count (MSB) Coil Count Data Bytes … Data …
(15) (MSB) (LSB) (LSB)
Starting coil number is two-bytes long and can be any value less than the highest output coil number available in the
output coil table. The output coil number is equal to one less than the number of the forced output coil. For example, to
change the first output coil, enter zero for the output coil number. The high order byte of the starting output coil number field
is sent as the first byte. The low order byte is sent next.
Coil count is two-bytes long. It specifies the number of output coils to set. The sum of the starting output coil value and the
number of output coils must be less than or equal to the highest output coil number in the output coil table. The high order
byte of the number of output coils field is sent as the first byte. The low order byte is sent next.
Byte count is the number of data bytes to follow.
Data bytes (data field) are the packed output coil data. Each byte contains eight output coil values. The LSB of the first
byte contains the value of the output coil whose number is equal to the starting output coil number plus one. The value of the
output coils are ordered by number, starting with the LSB of the first byte and ending with the MSB of the last byte. If the
number of the holding coils is not a multiple of eight, then the last data byte contains unused data in its highest order bits.
Function Code (15) Starting Coil (MSB) Starting Coil (LSB) Coil Count (MSB) Coil Count (LSB)
The field definitions are the same as the request message.
Public Information
6.22.6.9 Function Code 16: Preset Multiple Holding Registers
Function code 16 is used to preset (or write) to multiple holding registers. The message sent from the master is formatted
as follows:
Function Starting Starting Register Register Data Bytes Data Registers

Code (16) Register (MSB) Register (LSB) Count Count (LSB) (MSB:LSB format)
(MSB)
Start register number is two-bytes long and can be any value less than the highest holding register number available in the
holding register table. The holding register number is equal to one less than the number of the changed holding register. For
example, to change the first holding register enter 0 for the holding register number. The high order byte of the starting
holding register number field is sent as the first byte. The low order byte is sent next.
Number of holding registers value is two-bytes long. It specifies the number of holding registers to set. The sum of the
starting holding register value and the number of holding registers must be less than or equal to the highest holding register
number in the holding register table. The high order byte of the number of holding registers field is sent as the first byte. The
low order byte is sent next.
Byte count is the number of data bytes to follow.
Register data field is two-bytes for each holding register to set. The first byte in the data field contains the high order byte
of each preset value. The next byte contains the low order byte.
Function Code (16) Starting Register Starting Register Register Count (MSB) Register Count
(MSB) (LSB) (LSB)
The field definitions are the same as the request message.

Public Information
6.22.7 Advanced Diagnostics
Advanced diagnostic utilities can be used to diagnose issues with Modbus communications. This includes utilities to print the
accumulated Modbus errors from a network and print a log of the most recent Modbus messages.
Note The Modbus diagnostic utility is available with the Mark VIe controller firmware V03.03 or later.
➢ To view diagnostic data from ToolboxST

1. From the Component Editor, click the View menu, Diagnostics, then Controller Advanced Diagnostics.
2. Select the desired diagnostic reports.

3. Select the Auto Clear on Send check box.
4. Click Send Command.
Network Adapter 1 (located in the General tab Tree View) must be enabled, named,
and addressed. Refer to the section Network Adapters.
Attention
Public Information
Modbus Controller Slave Advanced Diagnostics Reports
Report
Displays Modbus slave configuration information.
The beginning of the report displays a summary of the total number of coils/register and the highest
and lowest coil/register configured for each of the four Modbus categories (holding coils, input coils,
Modbus Slave holding registers, and input registers). More extensive details are available using the registers
Configuration command. Below this summary, the report displays more configuration data, including command
rate information, data swapping configuration, configured NAK codes, and serial port selections. To
modify the configuration, close the advanced diagnostic window, and from the property page, select
the Modbus Slave tab, and Modbus Slave.
Modbus Slave Clients Displays the currently established Modbus master connections.
Modbus Slave Displays counters for Modbus write information
Command Summary Function codes 5, 6, 15, and 16 are the only codes that perform a write.
Message Format Displays the message formats used in serial Modbus messages to and from the Modbus slave
Summary Error codes are also displayed.
Errors Displays errors and resets errors
Log Displays message logs and resets logs

Public Information
6.23 EtherCAT Tab
The Mark VIe control provides embedded support for EtherCAT communication using the UCSCH1C controller platform as
the EtherCAT Master. From the ToolboxST EtherCAT tab, the user imports the EtherCAT slave devices by uploading an
EtherCAT Network Information (ENI) file and configures the Slave devices to communicate with the EtherCAT network. The
following figure displays the network port connections on a UCSCH1C controller used for EtherCAT configuration.
EtherCAT Network Port Connections on UCSCH1C Controller
Public Information
6.23.1 Import Slave Devices and Configure EtherCAT Network
Communication
➢ To import the Slave devices (ENI file) and configure EtherCAT network communication
1. From the Mark VIe component Property Editor, change the Platform to IS420UCSCH1C.
2. Set the Platform Option to EtherCAT.
3. From the Component Editor, select the EtherCAT tab.
EtherCAT Tab with EtherCAT Properties

Public Information
4. Import an EtherCAT Network Information (ENI) file to the controller containing the EtherCAT Slave devices to
communicate with the EtherCAT network. From the Tree View, right-click the EtherCAT node and select Import ENI
File.
5. After the ENI file is imported, the Tree View displays each Slave device. With the top (head) EtherCAT node selected,
the Property Editor displays the EtherCAT Master properties. Set the Cable Redundancy, Frame Loss Limit, and
Port Status Time Interval property values as needed. Refer to the following table for a description of these properties.
EtherCAT Master Properties

Cable Redundancy When set to True, enables the use of two Ethernet ports on the UCSC controller to form a ring
Frame Loss Limit Number of EtherCAT communication frames lost per hour to trigger a diagnostic alarm
Port Status Time Interval Time in minutes to update the port status (range is 1 to 60 minutes)
Public Information
6. From the Tree View, select a Slave device node to populate the Data Grid with the points associated with the selected
Slave device. From the Data Grid, configure the connected variables, device tags, and scaling values.
Note When scaling values are changed, the data type of the point automatically becomes REAL.
7. Perform a Build and Download to the controller.

Public Information
6.23.2 Create Cabinet with Multiple Slave Devices
The Tree View allows users to drag and drop multiple Slave devices under a common head unit to create a cabinet.
➢ To move devices under a common head unit to create a cabinet

1. From the Tree View, select all devices you want to move under a common device. Do not include the head node.
Multiple Slave Devices Selected
2. Drag and drop the selection onto the appropriate head device to place the selected elements within a collapsible tree with
the head as the parent element.
Public Information
Multiple Slave Devices Moved Under One Head Device
6.23.3 Slave Device Online Status

Each Slave device has a status variable that reflects the state of that device. When online, the color of the circles next to each
Slave device indicates the state of the device. For a head (top-level) node that was created by moving multiple Slave device
nodes within that head unit in the Tree View, the head node color indicates its children. For example, if a single child device
of the head node is in an Unknown state (red), the head node reflects that status.
Example Slave Device State Colors
Slave Device States

State of Device State Description Color
65519 Unknown State (disconnected or damaged) Red
1 Init Yellow
2 PreOP Yellow
4 SafeOp Yellow
8 OpState Green

Public Information
6.23.4 Import Updated ENI File
If an ENI file has already been imported but requires minor changes to the EtherCAT network, make the changes and import
the updated ENI file the same way you initially imported it. If point names match between the previous ENI file and the new
ENI file, the connected variables, tree structure, and scaling information of those points will be retained. If there is not a
match for a point with a connected variable, an Info message in the log window indicates which point and connected variable
were removed.
➢ To import an updated ENI file:

1. From the Tree View, right-click the EtherCAT node and select Import ENI File.
2. Perform a Build and Download to the controller.
6.23.5 EtherCAT Data Type Expansion

Some EtherCAT point data types are comprised of multiple sub-data types. In most cases, you can determine the sub-data
types from the ENI file. However, there are several sub-data types that cannot be expanded. In this case, those points are
removed and, after you perform a Build, an Info message displays in the Log window indicating the cause.
Example EtherCAT Info Message for Sub-data Types
6.23.6 EtherCAT Supported Data Types

The supported EtherCAT data types and the Mark VIe data types to which they are converted are listed in the following table.
Note Any other EtherCAT data type not listed in this table will not be loaded.
EtherCAT Data Type Mark VIe Data Type

BIT BOOL
BOOL USINT
BOOL32 UDINT
BYTE UINT
WORD UINT
DWORD UDINT
SINT INT
USINT UINT
INT INT
UINT UINT
DINT DINT
UDINT UDINT
REAL REAL
Conn Info 15 UDINT
TIME UDINT
TOD UDINT
TIME OF DAY UDINT
DATE UDINT
DATE AND TIME UDINT
DT UDINT
IPADDR UDINT
Public Information
6.23.7 Change EtherCAT Data Type
If an identified device is not giving you the data type you expect, this can be changed to a compatible data type, as shown in
the following figure.
Changing EtherCAT Data Type in ToolboxST
The compatible EtherCAT data types are:
• SINT, USINT, BYTE

• INT, UINT, WORD
• DINT, UDINT, DWORD, REAL
6.23.8 EtherCAT Master Status Variables

EtherCAT Master status variables are diagnostics that apply to the Master and can have a Connected Variable and a Device
Tag configured.
➢ To display EtherCAT Master status variables: from the EtherCAT tab Tree View, select the EtherCAT head
(top-level) node to display the EtherCAT Master status variables in the Summary View.
Example EtherCAT Master Status Variables
As illustrated in the following table, Master Status Variables Corresponding to Diagnostic Alarm Conditions, when a
diagnostic alarm is active, it sets the status variable indicated (checkmarked) in the table to True. For example, if any one of
the diagnostic alarms 2400, 2407, 2408, 2409, or 2410 are active, then MasterFault is True. In contrast, all five of these
diagnostic alarms must be inactive in order for MasterFault to be False.

Public Information
Master Status Variables Corresponding to Diagnostic Alarm Conditions
Diagnostic Master Status Variable
Diagnostic Condition
Alarm ID MasterFault LinkFault SlaveFault RingOpenFault FrameLossFault PortDisconnectActive
2400 Scan bus error ✔ — — — — —
2401 All Ethernet links disconnected — ✔ — — — —
2402 Line break detected — — — ✔ — —
2404 Limit for lost frames exceeded — — — — ✔ —
2405 Devices disconnected — — ✔ — — —
2406 Device in unexpected state — — ✔ — — —
2407 Master in unexpected state ✔ — — — — —
2408 ENI file not match bus config ✔ — — — — —
2409 Redundant Ethernet links crossed ✔ — — — — —
2410 Config not supported ✔ — — — — —
N/A User disconnects a port — — — — — ✔
Public Information
6.23.9 EtherCAT Slave Status Variables
EtherCAT Slave status variables are diagnostics that apply to an EtherCAT Slave device. There are five EtherCAT Slave
status variables per Slave.
➢ To display EtherCAT Slave status variables: from the EtherCAT tab Tree View, select an EtherCAT Slave
node to display the EtherCAT Slave status variables in the Summary View.
Example EtherCAT Slave Status Variables
OpState is the operational state of the Slave device. This is the same value that drives the status of the Slaves listed in the
Tree View. (Refer to the table Slave Device States for the explanation of the values.)
Device states Port0Status, Port1Status, Port2Status, and Port3Status report the Rx error counters from the devices. The
least significant byte is the CRC error count and the most significant byte is the Rx error count. The update rate is defined in
the EtherCAT Master property Port Status Time Interval (default is 10 minutes). (Refer to the table EtherCAT Master
Properties for a description of this property and other EtherCAT properties.) The counters in the device are cleared upon
every update, which means the Port Status variables are measured in counts since last update. All Rx error counters within the
device are cleared if at least one Port Status on the device has a Connected Variable. Unlike other Slave Points, only Port
Statuses that have a Connected Variable will show live data. If there is not a Connected Variable, the Live Values column
displays the value as Unused. This is done for performance improvements in the runtime.
If you have upgraded from a version of ToolboxST that did not support Port Status
variables, re-import the ENI file to display the Port Status variables in the data grid
for the EtherCAT Slave devices.
Attention

Public Information
6.23.10 EtherCAT Port Disconnect
Before performing a port disconnect, verify the state of the EtherCAT network. A port
disconnect could potentially isolate a portion of devices if the Cable Redundancy
property is not set to True, or if there is already a Line Break in the EtherCAT ring.
Caution
The following limitations apply to port disconnects:
1.) If a RingOpenFault is present as a result of a network break, disconnecting a

different port could potentially cause a portion of the Slave devices to be lost.
2.) If a port disconnect is performed on a device and then that device or another device
on the network is rebooted or if a different network cable is unplugged and
Caution reconnected, this can result in an entire portion of the network to become unavailable
to the Master (with a portion of the Slave devices lost). If this occurs, reboot the
UCSCH1C EtherCAT Master.
➢ To disconnect an EtherCAT port on a Slave device: from the EtherCAT tab Tree View, right-click on an
EtherCAT Slave node and select the appropriate Disconnect Port # from the list.
A window displays indicating if the disconnection was successful.
Note Only one port may be disconnected at one time.
➢ To determine if there is a Port Disconnect: from the EtherCAT tab Tree View, right-click on the EtherCAT
head (top-level) node and select Find Port Disconnect to display window that indicates which port is disconnected or
indicates that there are no disconnected ports.
Public Information
➢ To clear a Port Disconnect: from the EtherCAT tab Tree View, right-click on the EtherCAT head (top-level) node
and select Clear Port Disconnect.
A window displays indicating success in clearing the port disconnect, or indicating that there were no active port disconnects
to clear.
Note An active port disconnect is not retained after a Mark VIe control reboot or power cycle.
6.24 Mark VIe Reports

Mark VIe control reports provide a variety of controller information in a viewable format. Generated reports display in a
separate window and can be printed or saved for later use, as well as exported to a .csv file and opened in Microsoft Excel.
Reports can also be sorted, filtered, and searched to quickly locate information. This chapter describes the following Mark
VIe control available reports and their use, as well as how to create reports, and report features:
• Variable
• Block Pin
• I/O
• Alarm
• GE Rationalization
• Hold
• Event
• NVRAM
• IONet EGD
• I/O Pack Peer-to-Peer
• I/O Diagnostics
• Coding Practices
• FOUNDATION Fieldbus Configuration
• FOUNDATION Fieldbus H1 Field Device
• FOUNDATION Fieldbus Parameter Reconcile
• Auto-Reconfiguration
• Unlinked Programs/User Blocks
6.24.1 Variable Report

The Variable reports enable the user to create reports listing every signal (variable) used in the control code and it used to
collect current data for parameters and specifics for third-party devices.
This section describes the following Mark VIe control variable-related reports:
• Global variables
• Variable configuration
• Web
• Compressed data log
• EGD point list
• Alias
• Second language

Public Information
6.24.1.1 Global Variable Report
The Global Variable report lists all Global variables used in the Mark control application code. Operators can view the
variable definition for variable descriptions and parameter data.
➢ To generate a Global Variable report

1. Create a Global Variables report.
From the View menu,

select Reports, Variable,
and Global.
The progress bar displays while the

report is being created, then the Global
Variable report displays the results.
Global Variable Report Example

2. Review the list of Global Variables.
Public Information
3. View variable definition data.
Double-click a Global
Variable to go to where
the variable is defined
in the application code.
Note Intrinsic variables are not defined in the application code configuration. The Where Used tab displays locations in the
configuration where the intrinsic variables have been used.

Public Information
Global Variable Report Columns
Column Description
Name Global Variable name
Alias Variable tag name that can be customized for use with the WorkstationST application and all HMIs
Second Language Description Description in second language (if configured in System Editor)
Type Variable type (BOOL, REAL, UINT)
Used in Code If True, any connection used in the code
Written Multiple If True, indicates the variable is written more than once in the code
Control Constant If True, indicates the variable is a control constant
EGD Page Configured EGD page
Initial Value Initial value of the variable
Alarm Indicates either alarmed or not alarmed (for Booleans), and provides the definition for Analog alarms
Locator Full variable name, used to find the I/O point in the device
If enabled, causes the Alarm to be cleared before the operator acknowledges the Alarm condition
Auto Reset when the process returns to normal limits.
Refer to the WorkstationST Alarm Viewer Instruction Guide (GEI-100620).
Alarm Shelving If enabled, allows the operator to temporarily remove the alarm from the Alarm Viewer display
Alarm Shelving Max Duration Maximum time, in minutes, that an alarm can remain shelved
Plant Area Defined string that associates a variable to an area or function of a plant
Parent Alarms Alarms configured as parent to the variable (variable should be alarm)
Child Alarms Alarms configured as child to the variable (variable should be alarm)
Consequence of Inaction Consequence if operator does not address the alarm
Operator Urgency Level of urgency it is for operator to address the alarm
Operator Action Action the operator should take to avoid defined consequences
Potential Causes What may have occurred to cause this alarm
Second Language Consequence of
Consequence in second language if operator does not address the alarm
Inaction
Second Language Operator Urgency Level of urgency it is in second language for operator to address the alarm
Second Language Operator Action Action in second language the operator should take to avoid defined consequences
Second Language Potential Causes What may have occurred to cause this alarm in second language
Access Variable access type
Alarm Class Selects a system-configured Alarm Class, which is used by an HMI to classify and color Alarms
Alarm Inhibit Group Alarm Inhibit Group with which this variable is associated
If set to True, causes the Alarm to be generated on a 1–to–0 transition. Alarm property must be set to
Alarm On Zero
Alarmed (True).
Array If set to True, variable is an array
Default upper limit for HMI displays (bar graph, trending, and such). If a Format Spec has been
Display High
specified and this property has no specification, the Format Spec Engineering Max is used.
Display Low Default lower limit for HMI displays
Display Screen Default HMI screen name
Entry High Upper limit for setpoint entry on HMI
Entry Low Lower limit for setpoint entry on HMI
Entry No Row entry number
If set to True, enables the variable as an Event. Events are stateless messages not queued in the
Event controller. When an Event occurs, a time-tagged transition message is sent to all HMIs configured for
Events.
Format Spec Name of the Format specifications used to control the method of presenting variables in an HMI
Global Name Prefix Importable value is a predefined enum; it can be set to None, Full, Program, Block, and Task
If set to True, prevents modify-variable commands from being written into the Command and Event
CEL Command Filter
Log (CEL) (default is False)
Public Information
Global Variable Report Columns (continued)
Historian Deadband
Boolean and set to Logged on Change Analog and set to 0 or higher
Historian Deadband Definition Definition of Historian Deadband value
If set to True, enables the variable as a Hold, which is similar to an Alarm. The Hold queue contains a
Hold
list of time-tagged Hold states in the turbine startup sequence.
I/O True if value is connected to an I/O
Intrinsic True if variable is intrinsic one
NVRAM Indicates that the variable should be saved in non-volatile RAM
Determines the number of digits to the right of the decimal point. This is the default for precision when
Precision the number displays on the HMI. If a Format Spec has been specified and this property has no
specification, the Format Spec Precision is used.
Read Value is Read from the variable in the code, EGD, or I/O
Enables data collection of this variable in the Recorder if the value is changed from Not Logged to a
non-negative number for analog variables, or changed to Logged on Change or Logged Continuous
Recorder Deadband
for Boolean variables. This value represents the amount that the data value must change before it is
stored.
Recorder Deadband Definition Definition of the Recorder Deadband value
SOE True if variable is configured as an SOE
SOE Description Description of SOE
Units Engineering units
Usage Variable definition usage
Written Value is written to variable in the code, EGD, or I/O

Public Information
6.24.1.2 Variable Configuration Report
The Variable Configuration report lists all configured variables used in the Mark VIe control application code. Operators can
view the variable definition for variable descriptions and configuration data.
➢ To create a Variable Configuration report

1. Generate a Variable Configuration report.
From the View menu,

and Configuration.

report is being created, then the Variable
Configuration report displays the results.
I/O Variable Configuration Report Example
2. Review the list of variables.

3. View variable definition and configuration data.
Public Information
Double-click a variable
to go to where the
variable is configured

Public Information
Variable Configuration Report Columns
Column Description
Name Variable name
Type Variable type (for example, BOOL, REAL, UINT)
Enum If set to True, indicates that the variable has an enumeration
Units Indicates engineering units
Precision Indicates the variable precision
Control Constant If set to True, indicates that the variable is a control constant
Used In Code If set to True, is any connection used in the code
Written Multiple If True, indicates that the variable is written more than once in the code
Indicates either alarmed or not alarmed for Booleans, and provides the definition for analog
Alarm
Alarms
Alarm On Zero If set to True, indicates that the Alarm occurs on a 1–to–0 transition
Event If True, indicates that the Alarm is an Event
Hold If True, indicates that the Alarm is a Hold
SOE If True, indicates that the Alarm is an SOE
NVRAM If True, indicates that the Alarm is a NVRAM
Array If True, indicates that the Alarm is an array
Alarm Class Indicates a group of Alarms that share a common priority and color scheme
Display Screen HMI screen name
Display High Default upper limit for HMI screens
Display Low Default lower limit for HMI screens
Entry High Default upper limit for the set-point entry on the HMI
Entry Low Default lower limit for the set-point entry on the HMI
Recorder Deadband Enables data collection of a variable in the Recorder if the value changes
If set to True, prevents modify-variable commands from being written into the Command and
CEL Command Filter
Event Log (CEL) (default is False)
Historian Deadband Enables data collection of a variable in the Historian if the value changes
Variable tag name that can be customized for use with the WorkstationST application and all
Alias
HMIs
Second Language
Second language, if configured in the System Editor
Description
Locator Full name of the variable
If enabled, causes the Alarm to be cleared before the operator acknowledges the Alarm
Auto Reset
condition when the process returns to normal limits
Alarm Shelving If enabled, allows the operator to temporarily remove the Alarm from the Alarm Viewer display
Alarm Shelving Max
Maximum time, in minutes, that an Alarm can remain shelved
Duration
Public Information
6.24.1.3 Web Report
The Web report provides variable name, description, type, alias, second language description, and location in the application
code, as well as where the variable is used and if the variable is written multiple times in the code.
➢ To create a Web report
To generate a Variable Web report, Controller Web Pages must be enabled in the
controller Property Editor and the variables must have the Download Info column set
to True for the web report to display the variables.
Attention
1. Generate a Web report.
From the View menu,

and Web.
The Web report displays

the results.

Public Information
Double-click a variable to go
to where the variable is used
Web Report Columns

Column Description
Name Variable name
Used in Code If set to True, is any connection used in the code
Variable tag name that can be customized for use with the WorkstationST application
Alias
and all HMIs
Second Language
Description in second language (if configured in System Editor)
Description
Public Information
6.24.1.4 Compressed Data Log Report
The Compressed Data Log report provides Wind turbine controller variables being collected on the compressed data log for
the controller. Variable data collected includes description, type, use in code, written multiple, initial value, alias, second
language description, locator, controller collected, display high, display low, entry number, external access, global name
prefix, units, and usage. This report can be used for troubleshooting and informational reference.
➢ To create a Compressed Data Log report
From the View menu, select Reports, Variable, then

select Compressed Data Log.
Example Compressed Data Log Report

Public Information
From the Compressed Data Log report, double-click
a variable to view the configuration details.
Public Information
Compressed Data Log Columns
Column Description
Name Variable name
Type Variable data type
Used in Code Connection used in code
Written Multiple Written more than once in the code
Initial Value Initial value of variable
Variable tag name that can be customized for use with the WorkstationST
Alias
application and all HMIs
Second Language Description in second language (if configured in System Editor)
Controller Collected Variable is collected by the controller (type)
Display High Default upper limit for display on HMI
Display Low Default lower limit for display on HMI
External Access Variable access type
Global Name Prefix Global name prefix
Data Class Selects the type of collection for a Compressed Data Log variable

Public Information
6.24.1.5 EGD Report
The EGD Report provides a list of EGD points that are associated with EGD communication. Users can view the
configuration for each point as well as the settings for troubleshooting, locations (devices), and information reference.
➢ To create an EGD Point List report

1. Generate the EGD report.
From the View menu, select Reports, Variable,

and EGD to generate the EGD points list report.
Example EGD Point List Report
Public Information
2. Select a variable or point and navigate to the EGD configuration.
From the EGD Point List report, double-click a row item

to display the EGD configuration.

Public Information
EGD Point List Report Columns
Column Description
Variable Variable name
Point Name EGD point name
Point Offset EGD point address
Direction Access, either Read-Write or Read-only
Data Type EGD data type (for example, BOOL, REAL, UINT)
CIMPLICITY
HMI screen
Resource
Units Units of the EGD variable
Producer ID Unique address of the producing device
Period (ms) Time frame for the EGD points to be updated
Exchange Name Name of the exchange
Destination Destination IP address
Alias
and all HMIs
Second Language
Description
Path Location path (or the full name of the item)
Format Specification System-owned format specification assigned to a variable
Exchange Length Length of the exchange
Exchange Number Number of the exchange
Exchange Revision Revision of the exchange
Public Information
6.24.1.6 Alias Report
The Variable Alias report provides the variables and variable alias names. Users can export the report to Excel, enter the
alternative variable alias names, then import the report back into the ToolboxST system to display the alias names in the
Alarm Viewer and other areas where the variable names are available.
➢ To create an Alias report

1. Generate the Variable Alias report.
From the View menu, select Variable, then select Alias.

Public Information
The Alias Report displays the variables and
associated alias names.
2. To enter alias names, save the report as a .csv file, enter alias names, then import the data back into the ToolboxST
system.
Alias Report Columns

Column Description
Name Variable name
Alias Variable alias
Public Information
6.24.1.7 Second Language Report
The Variable Second Language report provides the variable name, the second language description, and the variable
description. Users can save the report file, enter the second language descriptions, then import the report back into the
ToolboxST system to display the descriptions in the Alarm Viewer.
➢ To generate a Second Language report
From the View menu, select Reports, Variable, and Second Language
to generate the Second Language report.

Public Information
The Second language report displays the variable name and its associated description in primary and second language. Second
languages are set from the System Property Editor.
Second Language Report Example
Second Language Report Columns

Column Description
Name Variable name
Second Language Desc Variable description in selected second language
Description Variable description in selected primary language
Public Information
6.24.2 Block Pin Report
The Block Pin report lists all block pins for every variable in the controller software and the associated blocks. Operators use
the block pin report as a cross-reference report containing pin descriptions, programs, tasks, and where the pins are used.
➢ To generate a Block Pin report

1. Create a block pin report.
From the View menu, select Reports and Block Pin

to generate the Block Pin report.
Example Block Pin Report
2. Select a block pin and navigate to the pin connections.

Public Information
From the Block Pin report, double-click a pin to display
the pin connection in the block diagram.
The Software tab displays the program, task, and block in which the pin is used.
Double-click the associated pin to display the connections.
Public Information
Block Pin Report Columns
Column Description
Pin Pin name
Pin Description Pin description
Block Block name
Block Description Description of the instanced block
Task Task Name
Program Program name
Locator Full name of the I/O variable
Block Execution Determines the order in which the block executes
Connection Pin variable connection
Data Type Pin data type
Program Execution Determines the order in which the program executes
Usage Usage type (such as input, output, contact, state)
6.24.3 I/O Report

The I/O report provides a cross-reference list of signal names to device names. Using this report, operators can locate a device
to find the logic, link to drawings and logic, and locate replaceable items. The following sections describe each available
Mark VIe control I/O-related report that can be created in detail:
• I/O Variable report

• I/O Configuration report
6.24.3.1 I/O Variable Report

The I/O Variable report provides a list of I/O variables. Using this report, operators can locate a device to find the logic, link
to drawings and logic, and locate replaceable items.
➢ To create an I/O Variable report

1. Generate a variable report.
From the View menu, select I/O, then select

to display the I/O variable report results.

Public Information
Example I/O Variable Report
2. Select a variable and navigate to the configuration.
From the variable report, double-click an I/O Variable to display the configuration.
Public Information
I/O Variable Report Columns
Column Description
I/O Variable I/O variable name
Description I/O variable description
Direction Direction of the I/O variable (input or output)
Device Tag ID of the device attached to the screw
Screw Name Name of the screw on the terminal board
Screw Number Number of the screw on the terminal board
TB Name Terminal board name
TB Hardware Form Hardware form for the module terminal board
TB Location Terminal board location of the module
Jumpers List of jumpers in the module
Jumper Value Position used to set the module jumpers
Group Name Name of the group where the module resides
Module Name Module name
Wire Jumpers IDs of the external wire jumpers
Screw Note Additional information about the screw
Wire Number ID of the wire attached to the screw
Cable Number ID of the cable attached to the screw
ID of the terminal board junction between the Mark
Interposing TB
VIe control and the I/O
Sense of the connected relay (used only for relay
Sense
and solenoid circuits)
Bar Code Terminal board bar code
Connected Variable Name of the variable attached to the I/O variable
Configured redundancy of the I/O pack (simplex,
Pack Redundancy
dual, TMR)
Config Type I/O configuration type
Data Type I/O variable data type
Engr High I/O high value in engineering units
Engr Low I/O low value in engineering units
Port Name Name of module’s port
Raw High Raw I/O high value
Raw Low Raw I/O low value
SeqOfEvents Sequence of Events (SOE)
Signal Invert Signal inversion
Sub-Assembly Name of module’s sub-assembly
If the I/O variable is used by the Control Sequence
Used in Code
Program (CSP), the application code
Mode I/O point configuration mode

Public Information
6.24.3.2 I/O Configuration Report
The I/O Configuration report lists all configured I/O variables in the current configuration. Using this report, operators can
view the configuration of the I/O module for troubleshooting, ordering replacement parts, and informational reference.
➢ To create an I/O Configuration report

1. Generate a configuration report.

to display the I/O Configuration report results.
Example I/O Configuration Report
Public Information
From the I/O Configuration report, double-click

an I/O Variable to display the configuration.
I/O Configuration Report Columns

Column Description
Module Name Name of the module
Config Label Name of the configuration parameter
Config Value Value of the configuration parameter
Category Parameter category (for example, input, outputs)
Category Group Parameter category group name

Public Information
6.24.4 Alarm Report
The Alarm report provides a list of all alarms in the current configuration and the aspects associated with them. Users can
view the module(s) associated with the alarms in the Alarm Viewer for alarm troubleshooting.
Note Variables are marked as Alarms in the Property Editor.
➢ To create an Alarm report

1. Generate an Alarm report.
From the View menu, select Reports, and Alarm to

generate an Alarm report .
Example Alarm Report
Public Information
2. Select an alarm to navigate to the configuration.
From the Alarm report, double-click an alarm

to display the alarm configuration details.
Alarm Report Columns

Column Description
Name Variable name
Alarm Class Group of related alarms that share a common priority and color scheme
Format Spec Configured format specification
Type Variable type (such as BOOL, REAL, UINT)
BQ Enables bad quality for a variable
H Enabled High alarming state for the variable when it is defined as an analog Alarm
HH Enabled High high alarming state for the variable when it is defined as an analog Alarm
High high high alarming state for the variable when it is defined as an analog
HHH Enabled
Alarm
L Enabled low alarming state for the variable when it is defined as an analog Alarm
LL Enabled Low low alarming state for the variable when it is defined as an analog Alarm
LLL Enabled Low low low alarming state for the variable when it is defined as an analog Alarm

Public Information
Alarm Report Columns (continued)
Column Description
RH Enabled Enabled rate of change when the variable is alarmed
Normal Severity Value assigned when the Alarm is in the normal state
Active Severity Value assigned when the Alarm is in the active state
Alias
If enabled, causes the Alarm to be cleared before the operator acknowledges the
Auto Reset
Alarm condition when the process returns to normal limits
If enabled, allows the operator to temporarily remove the Alarm from the Alarm
Alarm Shelving
Viewer display
Alarm Shelving Max
Duration
Second Language
Description
DH Enabled Deviation alarming state for a variable when it is defined as an analog Alarm
Alarm Inhibit Group Name of the Alarm Inhibit group when the variable is defined as an Alarm
Alarm On Zero True if alarm occurs on 1 to 0 transition
Consequences of
Consequence if operator does not address this alarm
Inaction
Operator Urgency Indication of how important it is that the operator addresses this alarm
Potential Causes Possible cause of this alarm
Second Language
Consequences of Consequence in second language if operator does not address this alarm
Inaction
Second Language Indication in second language of how important it is that the operator addresses
Operator Urgency this alarm
Second Language
Possible cause of this alarm in second language
Potential Causes
Second Language Action in second language the operator should take to avoid defined
Operator Action consequences
Public Information
6.24.5 GE Rationalization Report
The GE Rationalization report lists GE Rationalization parameters for the current alarms generated for the variables. Users
can export the report to Excel, enter specific information to manage plant-specific alarms, and then import the updated report
back into ToolboxST to make the values available from Alarm Help in the Alarm Viewer.
Alarm Help files are only generated when the Publish Alarm Help property is set to
True in the system Property Editor.
Attention
➢ To create a GE Rationalization report
From the View menu, select Reports, and GE Rationalization.
Example GE Rationalization Report

Public Information
GE Rationalization Report Columns
Column Description
Variable Name Variable name
Alarm Full Name Variable name, including the program name
Second Language
Description
Alarm Class Group of related Alarms that share a common priority and color scheme
For Boolean alarms, Alarm Type is always Discrete (which indicates a
Alarm Type Boolean alarm). For Analog Alarms it indicates the Analog Alarm type:
HHH, HH, H, L, LL, LLL, Deviation, Rate of Change, Bad Quality.
Amount by which a variable has to change below the defined Limit
value before a new state is declared and the variable is removed from
Hysteresis
the Alarm High state.
This value is applicable to any Analog Alarm types except Bad Quality.
If enabled, allows the operator to temporarily remove the Alarm from
Alarm Shelving
the Alarm Viewer display
Alarm Shelving Max
Duration
Name of the Format specifications used to control the method of
Format Spec
presenting variables in an HMI
On Delay Delay triggered by the Alarm (to minimize excessive noise)
Deviation Deviation alarming state
Enables or disables the Return to Normal (RTN) Unacknowledged
alarm state
Auto Reset This state is reached when the process returns to normal limits, and the
alarm clears automatically before the operator has acknowledged the
alarm condition.
Potential Causes Potential causes of the Alarm
Second Language Potential causes of the Alarm (in the Description in second language if
Potential Causes configured in System Editor)
Second Language Action the operator should take to avoid defined consequences (in the
Operator Action Description in second language if configured in System Editor)
Consequence of
Consequence of inaction
Inaction
Second Language
Consequence of inaction (in the Description in second language if
Consequence of
configured in System Editor)
Inaction
Length of time to perform corrective actions to avoid defined
Operator Urgency
consequences
Second Language
consequences (in the Description in second language if configured in
Operator Urgency
System Editor)
Public Information
6.24.6 Hold Report
The Hold report identifies all steam turbine variables marked as Holds for troubleshooting and information reference.
Note Variables are marked as Holds in the Property Editor.
➢ To create a Hold report
From the View menu, select Reports, then select

to display the report results.
Example Hold Report

Public Information
From the Hold report , double-click a variable
to view the configuration details.
Hold Report Columns

Column Description
Name Variable name
Hold ID Identification number of the Hold
Second Language
Description
Public Information
6.24.7 Event Report
The Event report lists digital signals defined as an Event, and provides an alarm History record when a signal transitions from
a 1 to 0. Event notifications provide the date and time stamp for when the Event occurred. This report can be used for
troubleshooting and informational reference.
Note Variables are marked as Events in the Property Editor.
➢ To create an Event report

Example Event Report

Public Information
From the Event report, double-click a variable to
view the configuration details.
Event Report Columns

Column Description
Name Variable name
Event ID Identification number of the Event
FF Event ID Identification number of a FOUNDATION Fieldbus Event
Second Language
Description
Public Information
6.24.8 NVRAM Report
The NVRAM report lists all configured variables that are downloaded and used in the RAM and marked as non-volatile.
NVRAM variable values are saved so in the event of power loss or if you power down and power up, the controller restores
the last stored values.
Note Variables are marked as Nonvolatile in the Property Editor.
➢ To generate a NVRAM report

1. Create a NVRAM report.
From the View menu, select Reports, then select NovRAM

to generate a NovRAM report.
Example NVRAM Report

Public Information
2. Select a variable and view the configuration values.
From the NovRAM report, double-click a variable to display

the configuration values.
NVRAM Report Columns

Column Description
Name Variable name
IsArray Identifies if the NVRAM is an array
Alias
Second Language
Description
Public Information
6.24.9 IONet EGD Report
The IONet EGD report provides network status values for all IONet communication displayed in the current component and
reflects totals of the controller exchange. EGD communication, configuration, and status specific to EGD communication
(system and controller) can be used for troubleshooting and information reference.
➢ To create an IONet EGD report
From the View menu, select Reports, then select IONet EGD
Example IONet EGD Report

Public Information
IONet EGD Report Columns
Column Description
Total Exchanges Total number of exchanges
Produced Exchanges Total number of produced exchanges
Consumed Exchanges Total number of consumed exchanges
Produced Messages Total number of produced messages
Consumed Messages Total number of consumed messages
Missed Messages Total number of missed messages
Late Messages Total number of late messages
Out of Order Messages Total number of out-of-order messages
Invalid Egd Versions Total number of invalid EGD versions
Too Short Messages Total number of too-short messages
Unknown Exchanges Total number of unknown consumers
Unknown Producers Total number of unknown producers
Public Information
6.24.10 I/O Pack Peer-to-Peer Report
The I/O Pack Peer-to-Peer report provides a list of I/O packs that are configured with a peer-to-peer connection as transmit
and receive modules for I/O functions.
➢ To create an I/O Pack Peer-to-Peer report
From the View menu, select Reports, then select I/O Pack Peer-to-Peer.
I/O Pack Peer-to-Peer
Example I/O Pack Peer-to-Peer Report
I/O Pack Peer-to-Peer Report Columns

Column Description
Function Function of the module
Transmitter Module serving as the transmitter in the Peer-to-Peer configuration
Receiver Module serving as the receiver in the Peer-to-Peer configuration

Public Information
6.24.11 I/O Diagnostics (Module) Report
The I/O Diagnostics reports list all diagnostic alarms for the device that need attention. The following sections describe the
Mark VIe I/O diagnostics-specific reports:
• Alarm
• Revision
• Communication
• Hardware
6.24.11.1 I/O Diagnostics (Module) Alarm Report

The I/O Diagnostics Alarm report generates a list of all diagnostic alarms for a device, Group, or module at the time the report
is created. Users can print the report and open the module(s) in the Diagnostic Viewer to get help for alarm troubleshooting.
➢ To generate an I/O Diagnostics Alarm report

1. Select a device for which to create an Alarm report.
a. For a Device:
From the View menu, select I/O Diagnostics, then select Alarm.
Public Information
b. For a single Group:
From the Tree View, right-click a Group and

select Create Module Report, then select Alarm.
Device / Group Diagnostics Alarm Report Example

Public Information
c. For a single I/O module:
I/O Module Diagnostics Alarm Report Example
2. Locate an alarm and view the details in the Diagnostic Alarm Viewer.
From the Alarm report , double-click a diagnostic alarm

and select the Diagnostics tab to display the alarm
details in the Diagnostics Alarm Viewer.
Public Information
3. View the Diagnostic Alarm Help containing possible causes and solutions for troubleshooting.
Double-click an alarm to open the

alarm help for troubleshooting.
I/O Diagnostic Alarm Report Columns

Column Description
Time Time at which the alarm occurred
Alarm ID Alarm ID number referenced for troubleshooting
Alarm status: TRUE (Yes) if the alarm is currently active, FALSE (No) if the
Active
alarm is not active
Module Associated module name
Jack (Channel) I/O pack or module jack (slot) and channel
Description Alarm description
Location Location of terminal board to which the I/O pack or module is connected

Public Information
6.24.11.2 I/O Diagnostics (Module) Revision Report
The I/O Diagnostics Revision report provides the revisions for the I/O modules at the device, Group, or module level.
Revision values that are used in the I/O module and in the ToolboxST system, including application, firmware, boot, base,
Pcode, and others, are viewed for comparison (configuration to hardware match) or informational reference.
➢ To generate a Revision report

1. Select a device for which to create an Revision report.
a. For a device:
From the View menu, select I/O Diagnostics, then select Revision.
Public Information
b. For a Group:
From the Hardware tab Tree View , right-click a Group and

select Create Module Report, then select Revision.
The Module Revision Report is displayed.
Device / Group I/O Revision Report Example

Public Information
c. For an I/O module:
From the Hardware tab Tree View , right-click an I/O

module and select Create Report, then select Revision.
2. Locate a module in the report and view the details in the Status Viewer.
Public Information
From the Revision report, double-click a module and
select the Status tab to display the status details.
I/O Revision Report Columns

Column Description
Module Module name
Description I/O pack revision type
I/O Pack Value I/O pack revision value
ToolboxST Value ToolboxST system revision value
Equal I/O pack equality status: Yes (Equal) or No (Not Equal)

Public Information
6.24.11.3 I/O Diagnostics (Module) Communication Report
The I/O Diagnostics Communication report provides informational status of the I/O module communication at the device, I/O
module, or Group level that the operator uses to detect and resolve communication issues.
➢ To generate a Communication report

1. Select a device for which to create an Communication report.
a. For a device:
From the View menu, select Reports, I/O Diagnostics, then select Communication.
Public Information
b. For a Group:
From the Hardware tab, right-click the Group, select Create Module Report, then select Communication.
From the Hardware tab, right-click the

module and select Create Report, then
select Communication.

Public Information
2. View the I/O module communication status details in the report.
I/O Module Communication Report Example
I/O Communication Report Columns

Column Description
Module Module name
Pack Logical I/O pack name associated with the module
Required? Module required for controller boot: True or False
Unique address of the producing device of I/O pack IONet
Prod ID
EGD
Exch ID Exchange ID of I/O pack IONet EGD
Health Health state of I/O pack IONet EGD: Healthy or Unhealthy
Period I/O pack IONet EGD period
Size I/O pack IONet EGD data length
Recv Cnt Number of times EGD received the data exchange
Missed Cnt Number of times EGD did not receive the data exchange
Number of times EGD received the exchange later than
Late Cnt
expected
Connection IONet number
Bad Data Time Stamp? Bad data is a time stamp: True or False
Bad Minor Sig? Bad minor signature: True or False
Bad Major Sig? Bad major signature: True or False
Healthy? Data exchange status healthy: True or False
Is Bad Config Time Stamp? Bad configuration is a time stamp: True or False
Long? Data too long: True or False
Never Sent? Data exchange never sent: True or False
On Preferred Sender? Data exchange is sent on the preferred IONet: True or False
Out of Order Cnt Number of address changes that occurred
Producer? Data exchange is produced by this producer: True or False
Stale Data Cnt Number of stale data messages
Stale Data? Exchange data is stale: True or False
Time Out? Exchange has timed out: True or False
Too Long Cnt Number of messages that are too long
Too Short? Exchange data is too short: True or False
Unequal Minor Sig? Unequal module is a minor signature: True or False
Public Information
6.24.11.4 I/O Diagnostics (Module) Hardware Report
The I/O Diagnostics Hardware report lists hardware information for an I/O pack at the device, I/O module, or Group level,
such as firmware ID, serial number, used boards, and bar code. The hardware information in the report can be used for
ordering replacement parts, gathering bar codes, maintenance, troubleshooting, and informational reference.
➢ To generate a Hardware report

1. Select a device for which to create an Hardware report.
a. For a device:
From the View menu, select Reports, I/O Diagnostics, then select Hardware.

Public Information
b. For a Group:
From the Hardware tab, select Create Module Report, then select Hardware.
Device / Group Hardware Report Example
Public Information
From the Hardware tab Tree View , right-click an I/O module

and select Create Report, then select Hardware.
Example I/O Module Hardware Report

Public Information
2. View the I/O module hardware details in the report.
I/O Hardware Report Columns

Column Description
Module Module name
Name of hardware group or rack to which the I/O pack or board
Group
belongs
Catalog Number Board hardware catalog number
Firmware ID Firmware ID of software
Serial Number Serial number of the hardware ID device
Bar Code Board hardware bar code
Index ID index
Label Label associated with the ID
Type Hardware type
Error Code Error code returned when trying to read the hardware ID
Connector name of the terminal board in which the I/O pack is
Connector
plugged
6.24.12 Coding Practices Report

The Coding Practice report allows the user to check the variables in the ToolboxST configuration to review for invalid coding
(configuration). The following four types of coding practices reports can be generated:
• Unwritten variables
• Multiple writes
• Multiple output assigned variables
• Unused I/O
➢ To generate a Coding Practices report

1. Create a Coding Practices report and view the results.
Public Information
From the View menu,
select Reports and
Coding Practices
Leave the default values to display

all options in the report, or select
individual types.
Click View Report to view the results.

Public Information
A list of coding practice report(s) displays at the top of the report.
For quick navigation, click a report link to go to that section of the report.
Example Coding Practices Report
From the Coding Practices report , double-click a variable to display the configuration.
Public Information
Coding Practices Report Columns
Column Description
Unwritten Variables Variables used in blockware logic, but have no assigned values
Variables used in multiple locations, such as blockware logic, EGD, or
Multiple Writes
I/O point configuration
Multiple Output Assigned
All variables attached to more than one output
Variables
Unused I/O Connected I/O values that are not used anywhere
Spares Unconnected and unused I/O values
➢ To save the Coding Practice report as a .csv or .html file
From the Coding Practice report File menu,

select Save As CSV or Save as HTML,
then select the location to save the report.

Public Information
6.24.13 FOUNDATION Fieldbus Configuration Report
The FOUNDATION Fieldbus Configuration report lists all configured FOUNDATION Fieldbus parameters and values. Users can
determine which parameters are configured for blocks, linking devices, H1 field devices, segments, modules, and groups for
information reference, maintenance, and troubleshooting.
➢ To create a FOUNDATION Fieldbus Configuration report

1. Generate a FOUNDATION Fieldbus Configuration report.
From the View menu , select Reports, then select

FOUNDATION Fieldbus Configurationto display the report results .
Public Information
Example FOUNDATION Fieldbus Configuration Report
2. Select a parameter to view the configuration.
From the FOUNDATION Fieldbus Configuration report ,

double-click a parameter to navigate to where the
parameter is defined.

Public Information
FOUNDATION Fieldbus Configuration Report Columns
Column Description
Parameter Parameter name
Sub Parameter Sub-parameter name
Description Parameter description
Value Parameter value
Block FOUNDATION Fieldbus block that owns the parameter
H1 Device PD Tag Physical tag of the H1 device that owns the block
Displays Device Tag entered in Device Tag property for FOUNDATION
Device Tag
Fieldbus function block on H1 device
Segment PD Tag Physical device tag of the segment provided by the user
Segment Link ID Link identifier of the segment
Module Linking device module name
Group Name of the group where the linking device module resides
Connected pin variable created during FOUNDATION Fieldbus block
Controller Variable
assignment
Indicates (True or False) if the parameter is referenced in a No
Download collection
When parameters are added to the device description (DD) file by the
No Download device manufacturer, they are referenced in a No Download collection
and ToolboxST prevents the user from downloading those parameters.
ToolboxST reads and reports the parameters and if they are referenced
(True) in a No Download collection they cannot be downloaded.
Public Information
6.24.14 FOUNDATION Fieldbus H1 Field Device Report
The FOUNDATION Fieldbus H1 Field Device report lists all configured FOUNDATION Fieldbus parameters and values for H1
field devices, as well as device status, linked segment, and associated module. This specific configuration information on each
device can be used for information reference, maintenance, troubleshooting, and parts replacement ordering.
➢ To create a FOUNDATION Fieldbus H1 Field Device report
From the View menu , select Reports, then select

FOUNDATION Fieldbus H1 Field Device to display the report results.
Example FOUNDATION Fieldbus H1 Field Device Report

Public Information
FOUNDATION Fieldbus H1 Field Device Report Columns
Column Description
H1 Device PD Tag Physical tag of the H1 device that owns the parameter
H1 Device State state of the H1 device
H1 Device Name H1 device name
H1 Device ID Identifier of the H1 device
Segment PD Tag Physical device tag of the segment provided by the user
Segment Link ID Link identifier of the segment
Manufacturer ID ID of the manufacturer registered with FOUNDATIONFieldbus
Device Type Type of linking device
Device Revision Revision of the device
DD Revision Device description file revision
Module Name of the linking device module
Group Name of the group where the linking device module resides
Node H1 device node index
CFF Revision Common file format revision
Public Information
6.24.15 FOUNDATION Fieldbus Parameter Reconcile Report
The FOUNDATION Fieldbus Parameter Reconcile report generates a report of unequal parameters. Using this report, users can
view where the FOUNDATION Fieldbus parameters are defined to resolve issues and reconcile parameter equality for blocks,
H1 devices, segments, linking devices, or systems (single parameter or all). The Parameter Reconcile report also provides the
existing ToolboxST report features, such as print, filter, refresh, and sort columns.
Note Refer to the section Report Features for a description of common report features.
➢ To reconcile FOUNDATION Fieldbus parameters

1. From the Hardware tab, select the block, H1 device, linking device, segment, or the Distributed I/O group (system) for
which to reconcile parameters and generate a Reconcile report.
From the Tree View, right-click a

block, H1 device , linking device ,
or segment , and select
Reconcile Parameters to
generate a Reconcile Report.

Public Information
To reconcile all parameters in
the Distributed I/O group, right-
click Distributed I/O and select
Create FOUNDATION Fieldbus
Reconcile Parameters Report.
2. Select which parameters to include in the report.
Select an option and click OK.
Note: Assigned block parameters

are those that are used in the
controller application code .
Public Information
3. The report displays unequal parameters that need to be resolved. Select the value(s) to which you want the ToolboxST
system and device to be set, or select all parameters values.
Note Select All and Clear All works for each parameter in either the Device Value column or the ToolboxST Value column.
Selecting all values in one column will clear any selections in the other column. For example, selecting all Device Values will
clear any selections that have been selected in the ToolboxST Value column.
From the Device Value column or the ToolboxST Value column , select the check box
beside the value(s) to which you want the ToolboxST system and device to be set.
Note: Only one value type can be chosen for each parameter.
To select all values, right-click

the check box beside the value
and select Select All.
4. Reconcile the selected parameters and generate the Reconcile Report.
From the toolbar, click Reconcile to

reconcile the selected parameter(s)
and generate the report,

from the File menu , select
Reconcile Parameters.

Public Information
The Reconcile Report displays the results of the reconcile operation.
The Equality column also displays the equality of the parameters.
5. If there are unresolved parameters, they are indicated as unresolved (unequal) in the report. Refresh the report to display
only the unresolved parameters.
From the toolbar, click Refresh to

remove
resolved parameters .
Note: To troubleshoot failed

reconciliation , double-click any
parameter in the report to
navigate to where the
parameters are defined in the
ToolboxST system configuration .
Public Information
6. Select the values to refresh.
Select ToolboxST and Device values to upload

the device values to the ToolboxST system ,
or
select ToolboxST values to only update the
ToolboxST values .
Click OK to reload the Reconcile Report .
Note Reloading both ToolboxST and FOUNDATION Fieldbus device parameters takes additional time due to the need to
establish communications and read the FOUNDATION Fieldbus parameters from the H1 devices.
The device may have changed between reconcile operations.
Caution
Only unresolved parameters display in the reloaded Reconcile Report .
Note: The Log tab displays

the details of the reconcile
operation. Double-click any
item in the Log window to
display the relevant location
in the ToolboxST application.
7. After the reconcile operation and report are completed, close the report window.

Public Information
Parameter Reconcile Report Columns
Column Description
Block FOUNDATION Fieldbus block name
Device Value Uploaded value from FOUNDATION Fieldbus device to ToolboxST system
Displays Device Tag entered in Device Tag property for FOUNDATION Fieldbus function
Device Tag
block on H1 device
Configuration parameter downloaded value from ToolboxST system to FOUNDATION
ToolboxST Value
device
Linking Device Linking Device name
Segment Segment name
H1 Device H1 field device name
Equality Status of equality
Block Type FOUNDATION Fieldbus block type
Storage Memory class for parameter
Used in Code Parameter use in application code
6.24.16 FOUNDATION Fieldbus H1 Parameter Configuration Report

The FOUNDATION Fieldbus H1 Parameter Configuration report Configuration report generates a parameter report that
displays the initial value as configured in ToolboxST and the live value of the parameter as it exists in an H1 device. The
report also informs the user if the two values are equal. By generating this report for two like-kind H1 devices that are
intended to have the same configuration and operation, a user can compare the two reports and locate any differences in
parameter configuration if they exist. The report also provides the existing ToolboxST report features, such as print, filter,
refresh, and sort columns.
Note Refer to the section Report Features for a description of common report features.
➢ To generate a FOUNDATION Fieldbus H1 Parameter Configuration report

1. From the Hardware tab, select a block or device for which to create a report.
a. For an H1 block:
Right-click the block and select

H1 Block Configuration Report…
Public Information
Example Block Report
b. For an H1 device:
Right-click the block and select

H1 Device Configuration Report…

Public Information
Select All block parameters for the report to display every block in the device,
or
select Only assigned block parametersfor the report to display only the blocks
that are associated with the Foundation Fieldbus task in the application code.
Click OK to display the report results.
Example Device Report

2. Select a parameter in the report to navigate to the configuration.
Public Information
From the report, double-click a parameter
to display the configuration details.
FOUNDATION Fieldbus H1 Parameter Configuration Report Columns

Column Description
Block FOUNDATION Fieldbus block name
Device Value Uploaded value from FOUNDATION Fieldbus device to ToolboxST system
Configuration parameter downloaded value from ToolboxST system to FOUNDATION
ToolboxST Value
device
Linking Device Linking Device name
Segment Segment name
H1 Device H1 field device name
Equality Status of equality
Block Type FOUNDATION Fieldbus block type
Storage Memory class for parameter
Used in Code Parameter use in application code

Public Information
6.24.17 Auto-Reconfiguration Report
The Auto-Reconfiguration reports include:
• Configuration
• Difference
Note The contents of both types of reports can be exported to a .csv file.
6.24.17.1 Configuration Report

If one or more I/O packs are configured in the Hardware tab, the Configuration report lists all I/O packs in the configuration,
as well as file details and sizes that are downloaded for each I/O pack. Each I/O pack must have a unique barcode (configured
using the Add Module Wizard when the I/O pack is added), or it is not included in the report.
➢ To generate a Auto-Reconfiguration Configuration report

1. From the Device menu, select Build.
2. When the Build completes successfully, create the configuration report.
From the View menu, select Reports, Auto-Reconfiguration, then

select Configuration to display the report results.
Public Information
Configuration Report Example
Configuration Report Columns

Column Description
Item Module configuration
File(s) File name
Size (KB) File size in KB
Download Size (KB) Total download size of the auto-reconfiguration

Public Information
6.24.17.2 Difference Report
The Auto-Reconfiguration Difference report lists all unequal variables and parameters.
➢ To generate a Auto-Reconfiguration Difference report

1. From the Device menu, select Build.
2. When the Build completes successfully, create the difference report.
From the View menu, select Reports, Auto-Reconfiguration, then

select Difference to display the report results.
Public Information
Example Auto-Reconfiguration Difference Report
If no differences exist between the ToolboxST configuration and the Auto-Reconfiguration server, the following message
displays.

Public Information
Difference Report Columns
Column Description
Item Configured I/O pack
Tool Files configured in the Auto-reconfiguration server
R, S, T Controller Status of each controller’s configuration to the configuration in the Auto-reconfiguration server
Public Information
6.24.17.3 Auto-Reconfiguration Equality Status
The Component InfoView Status tab displays one of four equality states for Auto-Reconfiguration:
• Equal displays if there are no differences between the ToolboxST configuration and the Auto-Reconfiguration server.
• Not Equal displays if there are differences between the ToolboxST configuration and the Auto-Reconfiguration server.
• Disabled displays if the Auto-Reconfiguration property is set to False in the General tab Property Editor.
• Downloading displays if a download is occurring.
Status Tab

Public Information
6.24.18 Unlinked Programs / Userblocks Report
The Unlinked Programs / Userblocks report identifies programs and blocks that contain unlinked variables. Code changes to a
block library code are not applied to unlinked blocks; therefore, running this report identifies them for the user.
➢ To generate an Unlinked Programs / Userblocks report

Unlinked Programs/Userblocks to display the report results.
Public Information
The Find Results tab displays any identified unlinked
programs or userblocks .
Double-click the Device to navigate to the location of the

program/userblock and view the configuration.

Public Information
6.24.19 Report Features
Many reports provide a set of common features located on the View menu Toolbar, as follows. This section provides the
procedures to use these features.
• Open report
• Save report
• Retrieve (generate) report
• Export report
• Import report
• Print report
• Sort (modify) columns
• Filter
• Refresh
• Zoom
• Find text
• Help
Toolbar Icons
Icon Description
Open a report from a file
Save the report to a file
Print the report
Sort (modify) report columns
Apply or remove a filter from a report
Find text within a report
Zoom in
Zoom out
Refresh the report
Get help
Public Information
➢ To enable the Toolbar
From the report View menu, select

Toolbar to display the toolbar icons.
➢ To enable the Status Bar
From the report View menu, select Status Bar.
The status bar displays at the bottom of the

report window.
➢ To save a report
From the report File menu , select Save Report and

save the report as a .csv file. Open the .csv from
Some reports can be your selected location to open the report in Excel.
saved, modified, and

imported back into the
ToolboxST system.
➢ To print a report: from the report File menu, select Print.

Public Information
➢ To change the zoom level of a report:
From the Report View

menu, select Zoom
and the desired value
➢ To sort a report column: click any column heading to apply a sort to that column. The first click sorts the column in
ascending order; a second click sorts the column in descending order.
Public Information
➢ To change the order of the report columns
1. From the Report menu, select Change Columns to display the Select [report type] Report Columns dialog box.
Note Refer to the section Organize Columns.
Select column names from

either Selectable or Viewable,
and use the arrow keys to move.
Column
names that
display in
blue cannot
be moved.
Or
2. Select a column header and use the drag-and-drop feature.
Click a column header(displays outlined in

blue) and drag and drop in either direction

Public Information
➢ To Find (search) text within a report: from the Report menu, click Find to display the Find dialog box.
Click to locate and

highlight the next
Enter text instance of search text
If selected,
capitalization
in the test
string must
match the
text in the
report exactly
If selected, the text string is Click to select the

found as a whole (for example, direction of the search
day would not match Monday
Public Information
6.24.19.1 Report Filter
Apply a filter to a report to display a specific subset of the original report.
➢ To apply a report filter: from the Report menu, click Apply Filter to open the Edit Report Filter dialog box.
Available Available
columns comparison
(double-click and Boolean
to add to an operators
equation) (double-click
to add to an
equation)
Click to add
parentheses
Click OK to
accept the
filter equation
Enter filter that displays.
equation to
be used. Click Clear
to delete the
equation.
Click Cancel
to cancel the
equation but
keep the
current
settings.

Public Information
Report Operator Expressions
Expression Description
< 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
Expression to the left of the operator must match the wildcard expression to the
right of the operator
When using the LIKE operator, you can prefix or suffix a wildcard character, either * or
LIKE
%, to the right-hand value. The wildcard character can stand for any number of
alphanumeric characters, including zero. The wildcard character can only be present
at the beginning or the end of the right-hand value (for example, *value or value* or
*value*)
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
You can use as many groups of parentheses as necessary to define an expression.
String values must be enclosed in single quotes , for example 'string'
Wildcard characters cannot be used in the middle of the string.
➢ To remove a report filter: from the Report menu, click Remove Filter. The filter is removed and all available rows
display.
Public Information
6.24.19.2 Import Reports
Reports that can be imported include:
• I/O Variable
• I/O Configuration
• Global Variable
• Block Pin
• Variable Alias
• Second Language
The Variable Alias report and the Second Language report can be imported from either a .csv or an .xml file, but the other
reports can only be imported from a .csv file.
➢ To import an I/O Variable, I/O Configuration, Global Variable, or Block Pin report
1. From the File menu, select Import, then select the desired report.
2. From the Open Report dialog box, select the report and click Open to import the data. Any data that cannot be
modified is highlighted when the report displays.
➢ To import a Variable Alias or Second Language report
Note Only the Alias and Second Language properties can be modified.
1. From the File menu, select Import, then select either Variable Alias Report or Second Language Report.
2. From the Open Report dialog box, select either a .csv or an .xml file and click Open to import the data. Any data that
cannot be modified is highlighted when the report displays.
➢ To import a GE Rationalization report

1. From the File menu, select Import and GE Rationalization report.
2. From the Open Report dialog box, select the report and click Open. Any data that cannot be modified is highlighted
when the report displays.

Public Information
➢ To avoid issues with second language special characters during import
1. Make sure the file is a .csv file.
2. Open the .csv file with Notepad.
3. From the Notepad File menu, click Save As.
4. Save the file with Encoding set to UTF-8.
In the lower part of the Save As dialog box, select UTF-8

from the Encoding drop-down list.
Tip: Change the Save as type to All Files (*.*) so you will
still be able to save the file as a .csv file.
Click Save .
5. Import the file into ToolboxST and verify that all the special characters display correctly.
Public Information
6.24.19.3 Importable Report Data
Certain columns (and their associated data types) in reports can be imported from a .csv file.
If you use Microsoft Excel to modify the .csv file, make sure you save the file back to a
.csv file from an .xls file.
If the .csv file contains UTF-8 special characters, to avoid issues with displaying
special characters after import back into ToolboxST open the file with Notepad and
Attention save the file with Encoding set to UTF-8. Refer to the procedure To avoid issues with
second language special characters during import.
Note GE recommends that users modify .csv files with Notepad or Wordpad rather than Microsoft Excel.
I/O Variable and I/O Configuration Report

Can Be
Column Name Type Description
Imported
I/O Variable String No I/O variable name
Used to find the I/O point in the device; should not be modified externally in
Locator String No
the .csv
Used to select corresponding I/O point screw to import the Cable Number,
Screw Name String No
Wire Number, Wire Jumpers, Interposing TB, and Screw Note
Used to select corresponding I/O point jumper to import the Jumper Value
Jumpers String No
data
Sense String Yes String value
Connected
String Yes Variable name to be attached to I/O point
Variable/Variable Name
PPROs can have up to three S-type terminal boards. Each has a unique bar
Bar Code String [ ] Yes code. To modify the bar codes, the whole array must be modified (the value
must be a string array)
Group Name/Panel Name String Yes Can be set to a predefined group in the distributed I/O
TB Location String [ ] Yes Redundancy of an I/O pack determines whether TB Location is imported
Should contain a predefined value of the respective enum (can vary in each
Config Type Enum Yes
I/O pack)
Should contain a predefined value of the respective (can vary in each I/O
Raw Low Enum Yes
pack)
Engr Low Enum Yes
I/O pack)
Raw High Enum Yes
I/O pack)
Engr High Enum Yes
I/O pack)
Can be set to Alarmed/Not Alarmed. Otherwise, can be set to Not Alarmed or
SeqOfEvents Enum Yes AnalogAlarmDefault, depending on variable type. A Boolean can be set to
Alarmed/NotAlarmed.
Entry Low Double Yes Default lower limit for setpoint entry on HMI
Entry High Double Yes Default upper limit for setpoint entry on HMI
Default upper limit for HMI displays (bar graph, trending, and such). If a
Display High Double Yes Format Spec has been specified and this property has no specification, the
Format Spec Engineering Max is used.

Public Information
I/O Variable and I/O Configuration Report (continued)
Can Be
Imported
Default lower limit for HMI displays (bar graph, trending, and such). If a
Display Low Double Yes Format Spec has been specified and this property has no specification, the
I/O device connected to the I/O variable as identified in the device summary
Device Tag String Yes
drawing
Jumper Value String Yes Should be a predefined jumper value to import this column
Cable Number String Yes
Wire Number String Yes
Wire Jumper String Yes To import this column, screw is located using Screw Name column data
Interposing TB String Yes
Screw Note String Yes
Global Variable Report

Column Name Type Importable Description
Name String No I/O variable name
Used to find the I/O point in the device; should not be modified
Locator String No
externally in the .csv file
Description String Yes Values can be modified in the .csv file and imported back to the device
Second Language
String Yes Alias to be set to the variable
Description
Alias String Yes Alias name to be set to the variable
EGD Page String Yes Assigns the variable to an EGD page
If set to True, enables the variable as an Event. Events are stateless
messages not queued in the controller. When an Event occurs, a
Event Boolean Yes
time-tagged transition message is sent to all HMIs configured for
Events.
Format Spec String Yes
Enum
Importable value is a predefined enum; it can be set to None, Full,
Global Name Prefix (GlobalNamePrefix- Yes
Program, Block, and Task
Type)
If set to True, enables the variable as a Hold, which is similar to an
Hold Boolean Yes Alarm. The Hold queue contains a list of time-tagged Hold states in the
turbine startup sequence.
Access Enum Access Yes Can be set to either Read-only or Read-Write
Data Type Enum Data Type Enum Yes Can be set to one of the enum values
Public Information
Global Variable Report (continued)
Can be set to Alarmed/Not Alarmed. Otherwise, can be set to Not
Alarm String Yes Alarmed or AnalogAlarmDefault, depending on variable type. A Boolean
can be set to Alarmed/NotAlarmed.
Selects a system-configured Alarm Class, which is used by an HMI to
Alarm Class String Yes
classify and color Alarms
If set to True, causes the Alarm to be generated on a 1–to–0 transition.
Alarm On Zero Boolean Yes
Alarm property must be set to Alarmed (True).
Enum Control
Control Constant Yes Can be set to an enum value (True, False, ReadOnly, and such)
Constant
Display High Double Yes Format Spec has been specified and this property has no specification,
the Format Spec Engineering Max is used.
Display Low Double Yes Format Spec has been specified and this property has no specification,
Display Screen String Yes Default HMI screen for this variable
NVRAM Boolean Yes Indicates that the variable should be saved in non-volatile RAM.
Determines the number of digits to the right of the decimal point. This is
the default for precision when the number displays on the HMI. If a
Precision Int Yes
Format Spec has been specified and this property has no specification,
the Format Spec Precision is used.
Virtual HMI Point Boolean Yes If set to True, imports the variable into the HMI as a virtual point.
If set to True, prevents modify-variable commands from being written
CEL Command Filter Boolean Yes
into the Command and Event Log (CEL) (default is False)
Historian Deadband Double Yes
Historian Deadband Enum Deadband Can be set to EngineeringUnits, PercentOfRange,
Yes
Definition Definition RemoveWorkstationOverride
Enables data collection of this variable in the Recorder if the value is
changed from Not Logged to a non-negative number for analog
Recorder Deadband Double Yes variables, or changed to Logged on Change or Logged Continuous for
Boolean variables. This value represents the amount that the data value
must change before it is stored.
Recorder Deadband Enum Deadband Can be set to EngineeringUnits, PercentOfRange,
Yes
Auto Reset Enum AutoReset Yes Enabled, Disabled
Enum
Alarm Shelving Yes Enabled, Disabled
AlarmShelving
Alarm Shelving Max
UInt Yes Value should be between 1 and 4294967295
Duration
Plant Area IPlantAreas Yes Should be one of the pre-configured value sets in the system

Public Information
Block Pin Report
Pin Description String Yes Pin Description
Block Description String Yes Description of instanced block
Data Type Data Enum Type Yes Pin Type
Variable Alias Report

Name String No Variable name
Alias String Yes Alias to be set to variable
Second Language Report

Second Language
String Yes Alias to be set to variable
Description
Description String Yes Description can be changed
Public Information
6.25 Forced Variables
Forced variables are variables and I/O points whose value is permanently overridden with a specific value. They are managed
using the Forced Variables dialog box while connected to a controller.
➢ To display Forced Variables: from the Component Editor View menu, select Forced Variables.
➢ To force a value or change a previously forced value: from the Forced Variables dialog box, double-click a
value to display the Send Value dialog box.
Note Refer to the section Modify 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 dialog box and select Remove All
Forces.

Public Information
6.26 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: from the Component Editor View menu, select Global Variables.
Properties display for Click to toggle between a display

the currently selected of all global variables and just
row in the Data Grid the ones that are modifiable
The Global Variables window allows you 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 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). Most properties
of variables that are instanced from a library can only be modified by using the Overridable Properties feature. (Refer to the
section Overridable Properties.)
Public Information
6.27 Alarm Rationalization
Alarm rationalization produces the detail design necessary to manage an alarm lifecycle. During this process, alarm
definitions are systematically compared to criteria (conditions) set forth in the alarm philosophy document for the plant. If an
alarm meets this criteria, the alarm set point, consequence, and operator action are documented, and the alarm is prioritized
and classified according to the philosophy.
The most common uses of Alarm Rationalization are:
• Alarm Rationalization in an external system

• Alarm Rationalization within ControlST, which allows users to export alarms from a controller for external editing, then
import them back into either the controller or a Library Container.
➢ To export GE alarms for Rationalization in an external system
From the View

menu, select
Export Alarms for
Rationalization

Public Information
From the drop-down list, select Exida SILAlarm.
Note: Measurement System and a drop -down list becomes available .
Select from the Available Attributes table using the arrows to add them to or remove them from the
Selected Attribute table. Click Export to export alarms for Rationalization.
Tip: To return to default attributes and aliases in the rationalization application

, click Restore to Defaults.
When the warning message displays, click OK.
GE Rationalization is an available selection for export (as displayed in this figure). However, it is only available for
backwards compatibility.
➢ To export GE alarms for Rationalization in ControlST: generate a GE Rationalization report.
Public Information
Note The GE Rationalization report contains a column for Parent Alarms and for Child Alarms. A large number of
parent/child relationships can cause these two columns in the .csv file to be incompatible with the Excel application. The
application allows a maximum limit of 32,767 characters in a cell.
When a GE Rationalization report is generated, it can be saved as a .csv file, modified, and then imported back into the
ToolboxST application. For the procedures to export and import GE Rationalization reports, refer to the section Export and
Import Reports.

Public Information
6.27.1 Import Alarms to Library Container
The rationalization report can be imported to a Library Container.
➢ To import alarms to the library: from the System Editor Tree View, open the Library Container Editor.
From the File

menu, select
Import and GE
Rationalization
Report
The report displays all variables found in the library; variables missing from the library display in red. It is possible to
re-export the report to include all rows not found during the original import.
➢ To export missing variables from the library
From the report

File menu, select
Re-Export
Alarms for
Rationalization
➢ To import the report back into the controller: from the controller File menu, select Import and GE
Rationalization Report.
The report automatically overrides properties in the controller configuration to change the linked library code.
Public Information
6.28 Watch Window
A Watch Window displays a collection of variables, their attributes, and live values, in a stand-alone window. The Watch
Window feature can be accessed from the ToolboxST System Editor, as well as from the individual Component Editors. Once
a Watch Window is created, it can be exported to and imported from .csv files.
➢ To open a stand-alone Watch Window: from the Start menu, select All Programs, , ToolboxST, and Watch
Window.
➢ To create a Watch Window: from the System Editor Tree View, right-click the system and select Insert New,
Tool and Watch Window.
Enter a Name,
and a Description
(optional), and
click OK.
Note If this Watch Window is being opened for the first time, the list is empty. Add or import a new Watch Window.
Export Import Add Remove

Variable selected
variable
➢ To open an existing Watch Window: from the System Editor Tree View, right-click the system and select Insert
Existing and Watch Window.
➢ To open a Watch Window: from a Component Editor View menu, select Watch Windows.


Public Information
6.28.1 Add Variable
➢ To add a variable: from the Watch Window Edit menu, select Add Variable and Using Add Wizard . When the
Welcome page displays, click Next.
Select the data

source and
click Next.
If you selected
System
Component in the
previous page,
select the desired
component from
the drop-down list
and click Next.
Public Information
Click Add.
When the
Select a
Variable dialog
box displays,
select desired
variables and
click OK.
The variables
will display here.
Click Finish .
Once a variable is added to a Watch Window, right-click the variable row header to perform the following actions:
• Add Variable allows you to add additional variables.

• Select All selects all variables.
• Remove Variable(s) removes selected variables.
• Go to Definition in Logic allows you to display the variable definition from its location.
• Change Live Value allows you to change the live value when the Watch Window is online with the controller.
• Copy to Clipboard allows you to copy the selected variable to the clipboard.
• Paste allows you to paste a variable to another location, such as a Trend.
• Add to Trender allows you to add selected variables to a Trend.
• Move Selected to Top moves the selected variable to the top of the list.
• Move Selected Up moves the selected variable up one row.
• Move Selected to Bottom moves the selected variable to the bottom of the list.
• Move Selected Down moves the selected variable down one row.
Note When a system component providing signals to a Watch Window is replicated, the Watch Window is replicated as
well.

Public Information
➢ To organize columns in a Watch Window: from the View menu, select Organize Columns.
Select a column from either the Columns that

Hidden or Shown lists and use the display in blue
arrow buttons to move that column. cannot be moved.
6.28.2 Force Live Values

➢ To force the live value of a variable

1. From the Watch Window, double-click the live value of a selected variable.
2. Enter the desired value and select the Force Value check box. (Refer to the section Forced Variables.)
3. Click Send to send the forced value to the controller.
4. Click Close.
6.28.3 Drag-and-drop Option

Variables can be moved to other windows and editors using the drag-and-drop option. For example, you can move:
• Block pins from the Block Diagram Editor to a Watch Window

• Variables in the Watch Window to a block pin on the Block Diagram Editor, forming a connection
• Variables from one Watch Window to another Watch Window, copying the selected variable into the target window
• Variables from an excitation control or a static starter diagram to a Watch Window
Public Information
6.28.4 Import and Export
A Watch Window can be exported to and imported from a .csv file. From there, other components can use a previously
selected collection of variables.
Note The Watch Window tool only exports grid columns necessary to retrieve variable information. For example,
DatasourceName from the exported file is used to retrieve the variable’s remaining properties from the system. User-defined
columns such as User Comment are also included.
➢ To export a Watch Window to a .csv file

1. From the Component Editor View menu, select Watch Windows.
2. From the Watch Windows for <Watch Window name> dialog box, double-click the desired Watch Window.
3. From the Watch Window File menu, select Export or click Export Watch. Locate and select the desired folder and
save the Watch Window as a .csv file.
➢ To import a Watch Window from a .csv file

2. From the Watch Windows for <Watch Window name> dialog box, double-click the appropriate Watch Window.
3. From the Watch Window File menu, select Import or click Import Watch. Locate and select the appropriate folder
and save the Watch Window as a .csv file.
➢ To save a Watch Window: from the <Watch Window name> File menu, select Save As to save the Watch Window
as a .watch file in a user-selected location,
or select Save to save the Watch Window as a .watch file in the Tools folder in the system.

Public Information
6.29 LiveView
The LiveView feature allows you to display a graphical representation of live data from various sources in the system.
LiveViews can be added to a ToolboxST system, to a component, or opened as a standalone editor.
6.29.1 Add and Open LiveViews

➢ To open a standalone LiveView: from the Start menu, select PACSystems, GE ControlST, ToolboxST, and
LiveView.
➢ To add a LiveView from the System Editor
From the Tree

View, right-click the
system item and
select Insert new,
Tool , and LiveView
➢ To add an existing LiveView: from the System Editor, right-click the system and select Insert Existing and
LiveView.
➢ To edit a LiveView: from the System Editor, right-click a LiveView and select Edit System Component.
➢ To start a LiveView: from the Tree View, double-click LiveView.
➢ To add a LiveView from a Component Editor: from the View menu, select LiveViews.

Add New. When the New
LiveView dialog box displays,
enter a name and a description
(optional) and click OK
Public Information
➢ To open an existing LiveView in either Edit Mode or Run Mode from the Component Editor
1. From the View menu, select LiveViews.
2. Right-click the desired LiveView and select View.
6.29.2 Upgrade LiveView

➢ To upgrade LiveView
1. Open LiveView in the new version.
2. From the Editor Edit mode, save the LiveView, close it, then reopen the Editor.
6.29.3 Editor Features

Tools contains General Properties displays the
and Animation controls properties of the selected control
Log Control displays error

and informational messages

Public Information
6.29.4 Standard Toolbar
New Save Copy Delete Redo Stop Tools
Properties
Window
Open Cut Paste Undo Start Log View
6.29.5 Layout Toolbar

Align Align Align Center Control Bring Advance
Lefts Rights Middles Horizontally Control Height to Back Mode
Full
Screen
Align Align Align Center Control Bring Tab

Centers Tops Bottoms Vertically Width to Front Order
6.29.6 General Controls

Var:Live is a splitter
Label is a Live Value is control variable name in
convention a live value the first half and a live
label control as label text value in the second half
Setpoint Button Hyperlink button navigates

forces a value to the to another LiveView, a .chm
associated variable file, or any URL
Public Information
Additional Controls
Control Description
Image Displays graphics in either bitmap, .gif, .jpeg, or icon format
Panel Allows you to group collections of controls
Flow Layout Panel Dynamically displays contents either horizontally or vertically
6.29.7 Animation Controls

Animation Controls
Animation
Description
Control
Push-button Sends a value to the controller when the button is clicked
Switch Control Sends a value to the controller when the Off or On labels are clicked
Bar Graph Displays the status, in a user-configurable color, of the live value
Toggle Allows toggle between the Switch Control and the Push-button back and forth between Off and On
Momentary Requires user to hold the On control with the cursor; otherwise, it switches back to Off
If set to True, causes the push-button to write the On Push value to the attached signal at a periodic
interval (Interval property) so long as the push button is in the Pressed state.
Refresher
If set to False, the behavior of the push-button will be turned off. The On Push value will be written one
time only whenever the push button is pressed.
Periodic interval, in ms, at which the On Push value should be written to the attached signal. There is
Interval
variability in the actual interval produced, due to the non-real time nature of the operating system.

Public Information
Analog Meter is the pointer Status Indicator Bar Graph displays
deviated with respect to the indicates the status the live value of the
live value of the variable of a Boolean variable variable
Pushbutton attaches Switch Control attaches

to a Boolean variable to a Boolean variable
LiveView Animation Controls
➢ To add a variable to a control
Public Information
➢ To configure bar graph colors
Reference point
Select a Bar
Color for the
High Alarm and
High Warning
range above the
reference point
Select a Bar
Color for the
Normal range
above the
reference point
Select a Bar
Color for the
Low Alarm and
Low Warning
range above the
reference point
Live value of the

attached variable
➢ To select a control behavior
From the Properties

window, expand the
Behavior property and
select either Momentary
or Toggle

Public Information
If the Behavior
property is set to
Toggle and the On
Push property is
set to True, the
state of the
attached variable is
set to True when
the left-mouse
button is clicked
If the Behavior
property is set to
Momentary and
the On Push
property is set to
False, the state of
the attached
variable is set to
True when the left-
mouse button is
clicked
When the button is

released, the variable
state returns to False
Public Information
6.29.8 Controls Properties
Controls Properties
Accessibility Name, description and role
Appearance View appearance, including background color, border style, font, and such
Shortcut menu that displays when the user right-clicks, whether controls are automatically validated, and such,
Behavior
and includes whether the control can accept dragged data
Design Contains the Locked property. Locked, if set to True, prevents the control from being moved or resized.
Focus If set to True, enables validation of the control
Layout Includes properties such as location, auto scroll, margin, and maximum and minimum size
If set to True, prohibits objects from being moved or re-sized using the pointer. Values must be changed in the
Locked
Property Editor to enable moving and re-sizing.
Locked enables
or disables the
ability to move
and resize objects
Locked Property

Public Information
6.29.9 Attach Variable
➢ To attach a variable
From the Edit

menu, select
Attach Variable
and Using Add
Wizard
Or
From the Properties window,

click the ellipsis button to
display the Attach Variable
Wizard. When the welcome
page displays, click Next
Public Information
Select the data source for
the variable and clickNext
Browse to select the

.tcw file and click Next

Public Information
If you selected System Component in the
previous page, select the desired component
from the drop-down list and clickNext
Click Add. When

the Select a
Variable dialog
box displays,
select desired
variables and
click OK
Variables display
here. Click
Finish
Public Information
Once variables have been attached to LiveView using the wizard, additional variables can be attached directly from the
system component.
➢ To attach additional variables
Right-click the variable and selectAttach

Variable and From [controller name]
Note You can also attach a variable by entering the variable name in the Property View.

Public Information
6.30 Constants
Constants include both control constants and undriven variables.
6.30.1 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 Component Editor Software tab, locate and select the variable to convert.
2. From the Property Editor, set Scope to Global and Control Constant to True.
3. From the Property Editor, assign an Initial Value (optional).
6.30.2 Undriven Variables

The larger set of read-only variables includes any variable that is not written to. The Undriven Variables & Control Constants
screen allows you to display either type of constant.
All control constants display in the Control Constants window, where the constants can be reviewed and the Initial Values can
be modified.
➢ To display constants
From the View

menu, select
Constants
Public Information
From the View

menu, select
Constants

Public Information
6.30.3 Import and Export Constants
Constants for a controller can be exported to a comma separated value (.csv) file for external viewing and changes. Previously
exported constant files can be imported back into the controller. During an Import, the initial values Entry High Limits and
Entry Low Limits are updated according to the values in the .csv file. A sample .csv file is provided below to illustrate the
output format:
Name, Description, Live Value, ToolboxST Initial Value, Value Override, Connection, Data
Type, Units, Access, Format Specification, Entry Low Limit, Entry High Limit, Entry Limits
Override, Shelve_Prog1_1.Shelve_LProg_Anlg.LLL_SP, Low Low Low SP, —90, —90, False, INT,,
ReadOnly,,,,False
ControlConstant1,0,,,BOOL,,,
ControlConstant2,30,10,51,REAL,,,
ControlConstant3,True,,,BOOL,,,
ControlConstant4,13,8,20,INT,,,
ControlConstant5[0],14,5,12,54,REAL,,,
ControlConstant5[1],34,12,54,REAL,,,
➢ To export or import control constants

1. From the ToolboxST View menu, select Constants.
2. From the Undriven Variables & Control Constants File menu, select either Export to CSV or Import from CSV.
3. From the dialog box that displays, select a location for the data and click Save.
Public Information
6.30.4 Reconcile Differences
The Reconcile Differences feature allows you to synchronize the live value and the initial value for constants. The live value
is the value of the constant currently being used in the running controller. The initial value is the value of the constant in the
ToolboxST configuration.
➢ To reconcile value differences
From the File

menu, select
Reconcile
Differences.
The Reconcile Differences dialog box displays constants with both initial and live values.

Public Information
The Controller Value is the value in Select the check box next
the running controller. to the correct value to
The ToolboxST Initial Value is the synchronize the constant,
value in the ToolboxST configuration. then click OK
The constants are synchronized as follows:
• For constants when the ToolboxST initial value was checked, that value is either sent to the controller (where the OK
button is clicked), or a pcode record is created, causing the next online download to change both the initial and live
values.
• For constants when the live value was checked, the ToolboxST initial value is set equal to the controller live value. This
causes a minor revision configuration change to Not Equal. A Build and Download to the controller is required to
complete the reconcile function.
Public Information
Messages
Message Type Message Content
Undriven Constants Reconcile: Need to Build and Download for the reconcile action to be
complete for ProgUndrivensAndControlConstants.ControlConstantArray. On the next online
Warning
download, the Live Value will change from 0,1,2,3,4,5,6,7,8,9,10,11,12 to
6,1,2,3,4,5,6,7,8,9,10,11,12.
Warning complete for ProgUndrivensAndControlConstants.UndrivenReal. The ToolboxST Initial Value has
changed from 9.8 to 11.8.
Warning complete for ProgUndrivensAndControlConstants.UndrivenTask.ARRAY_SUM_1.ENABLE. The
ToolboxST Pin Connection has changed from True to False.
Undriven Constants Reconcile: ProgUndrivensAndControlConstants.UndrivenBool has a different
Warning Live Value than the last Initial Value downloaded to pcode. A controller reboot could cause the
current Live Value of False to change to True.
Undriven Constants Reconcile: Could not reconcile variable ProgUndrivensAndControlConstants.
Error
UndrivenTask.ARRAY_SUM_1.ENABLE. This variable is not modifiable.
Undriven Constants Reconcile: The live value has been reconciled to match the ToolboxST initial
Info Value for ProgUndrivensAndControlConstants.UndrivenReal. The Live Value has changed from
10.8 to 11.8.

Public Information
6.31 I/O CheckOut
The I/O CheckOut feature allows you to verify the operation of each I/O value.
➢ To display I/O values: from the Hardware tab, select an I/O module.
From the View menu,

select I/O Checkout
to display an I/O list
Public Information
7 Mark VIe — Working Online
The Mark VIe component provides 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 application is used to configure the software for the Mark VIe component. 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.
7.1 Connect to Controller

Many actions in the Mark VIe Component Editor require an active connection to a controller.
➢ To connect to a controller
1. From the System Editor, open an Mark VIe Component Editor.
2. From the Device menu, select Online or click Go On/Offline.
If you are connecting to a simplex controller, a connection is automatically established with the M1 controller. In a Warm
backup or Dual configuration, a dialog box displays to select either a redundant controller (either M1 or M2) or the controller
currently designated as the supplier of initialization data.
Mark VIe — Working Online GEH-6703P User Guide 519

Public Information
7.2 Controller Status
When the ToolboxST application is connected to an 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 displays individually for each controller in the redundant set. Colored text displays state information.
Icons Conditions
All controllers functioning normally.
− Control state is controlling

− Controller and DDR Equality equal
One or more of the following:
− Control State not controlling

− Controller and DDR Equality not equal
− Idle or Frame Idle Time < 20%
Control state is failed
Major difference or parameters not equal
Minor difference in controller or DDR
Controller or I/O diagnostic
Status tab displays red to indicate

that a Major Difference in the
Controller Equality is causing a
Not Equal state for DDR Equality.
Public Information
7.2.1 Status Tab Attributes
If the indicated Control State is not Controlling, rest the cursor over the current state to display additional information or
double-click Control State to display the information in a separate window.
Valid Control States

State Description
Run State Current run state of the controller. The states are Not ready, Ready, or Running
Current state of the controller. When a controller is turned on, it transitions through several states
Control State before arriving at the normal controlling state.
Refer to the section Status Control Attributes.
Current fault state of the controller. The fault states are Trip, Alarm, and No Faults. If the state is
Fault State Trip or alarm, double-click the attribute to display the Controller Diagnostics [on controller] dialog
box.
Presence of controller diagnostic messages. Double-click the attribute to display the Controller
Controller Diagnostic
Diagnostics on [controller] dialog box.
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.
Controller Equality
If the Controller Equality state is Not Equal, perform the Build and Download commands. A Major
Difference status also requires the Build and Download commands, and the controller is restarted
when the download is complete.
Indicates whether equality exists between the parameter values in the ToolboxST configuration and
Parameter Equality the parameter values currently active in the controller. Valid states are Equal and Not Equal.
Double-click the attribute to display the Reconcile Parameter Differences dialog box.
Indicates whether equality exists between the DDR configuration in the ToolboxST application and
DDR Equality
the configuration currently running in the controller. Valid states are Equal and Not Equal.
Designated Controller Controller that supplies initialization data to the other controllers
Indicates whether the R, S, and T controllers are frame-synchronized to the single device within
Frame Synchronized
either the controller or I/O pack to which all other devices are synchronizing frames
Controller responsible for communicating on the UDH for the Mark VIe component. The UDH
UDH Communicator
Communicator sends the EGD exchanges and alarms produced by the device.
Percentage of CPU time left in the controller after all functions have been completed. It accounts
System Idle Time for the critical control functions, as well as background processing and communication overhead. If
there is less than 10% idle time, the status displays in yellow.
Percentage of CPU time left in the controller after the critical control functions of input, compute,
Frame Idle Time
and output have been completed. If there is less than 20% idle time, the status is shown in yellow.
Number of forced variables in the controller

Number of Forced machine. Forcing of control logic for an operating
Variables process is strongly discouraged.
Warning Forcing of protective functions is never permissible for

an operating unit. All safety measures should be
Indicates whether the controllers are exchanging the Control state variables. If the number shown
Heart Beat
is incrementing, the Control state variables are being exchanged.
Controller Time Time that the controller is using.
Base Load Version of the base load running in the controller

Public Information
Valid Control States (continued)
State Description
Firmware Version of the firmware running in the controller
Indicates whether a download and restart of the controller are allowed.
Application Status
Refer to the section Download Wizard.
Controller Equality — Major Difference

Any modification that causes a memory allocation change and requires the controller to fetch data from the Flash memory
into the RAM causes a Major Difference between the configuration in the ToolboxST application and the configuration
currently running in the controller. A Major Difference status requires a Build and Download to the controller. The controller
is restarted after the download is complete. The following modifications result in a Major Difference status in the controller:
• Adding the first I/O pack to a controller, removing the last I/O module, or deleting all I/O modules
• Compressing variables
• Compress non-volatile RAM (NVRAM)
• Changing the background blockware period
• Changing frame rate
• Changing controller redundancy
• Changing IONet network redundancy
• Changing the platform type
• Changing any NTP configuration
• Changing any controller Network Adapter IP addresses, subnet mask, gateway IP address, scope, media, or transport
• Delete or rename a Network Adapter that the controller was using
• Adding or redirecting optional block library references
• Changing Frame state timeouts
• Removing last point off Modbus slave
• Marking the first I/O module to be shared or clearing the last I/O module from being shared
• Connecting the first controller-to-controller input or output variable
• If the set index of shared IONet changes
• If the controller was set to multicast mode on IONet but an I/O pack that does not support multicast as added, which
resets the configuration back to broadcast mode
• Adding the first FOUNDATION Fieldbus linking device, removing the last FOUNDATION Fieldbus device, or removing all
FOUNDATION Fieldbus devices
• Removing Wind Condition Top Box Monitor (WCBM)
• Disabling web pages
• Disabling compressed data log
• Disabling Wind Farm Management system
Public Information
7.2.2 Status Control Attributes
State Description
Powerup Power up controller
Master initialization Controller is loading its own configuration
Designated controller
Determine which controller is designated in a redundant controller configuration
determination
Perform initialization of non-designated controllers with NVRAM, command variables, and
Data initialization
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
Exchange state variables so that a controller joining a running system will not have a step in
Exchanging
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

Public Information
7.3 Secure State
The ToolboxST application can be used to increase security protection for controllers. Controllers can be run in either of two
states: Open or Secure. When the controller is in the Open state, it processes all commands received. In the Secure state,
certificates are used to verify both the identity of the user accessing the controller and the actions that the user is allowed to
perform.
The Secure state requires that certificates be assigned to both the controller and the user accessing the controller. Certificates
are issued by a Certificate Authority (CA) Server.
Controllers request certificates directly from the CA Server using the IP address and CA name that was configured in the
system. The CA Server must be available when the controller requests a certificate and switches from the Open to the Secure
state. When the controller certificate expires, a new one is obtained by taking the controller from Secure to Open state and
back again.
The user certificate is also issued from the CA Server and stored in the user certificate store. The ToolboxST application
retrieves the certificate from the store, and uses it to establish a secure connection to the controller. User access levels are
defined in the certificate. The controller uses this information to determine which user commands to accept and which to
reject.
Note When the user certificate expires, refer to the SecurityST* Cyber Security Management System Maintenance Guide
(GEH-6765) for the renewal procedure.
A second server, called a Remote System log (RSyslog), logs all security-related events. To send security-related messages, a
controller must know the IP address of the RSyslog. The RSyslog also receives security-related messages from the
ToolboxST application. Examples of data collected by the RSyslog include:
• Name of logged-on user

• Opening or closing of the controller configuration
• Added or deleted roles
• Forced or unforced variables
For a controller to be placed in the Secure state, it must be configured at the ToolboxST system level. It receives the
configuration information during the Build and Download processes. When the system item is selected in the System Editor,
the Property Editor displays the following properties:
• CA Server Full Name (includes domain name)

• CA Server IP Address
• CA Server Thumb Print
• RSystem Log Server IP Address
Public Information
Additionally, at the device level, the Command Event Log Property must be set to Log to Disk.
➢ To set the Command Event Log to Log To Disk
From the General tab Command

Event Log Property, Log to
Disk, right-click and select Yes
from the drop-down menu.
➢ To request a Secure state

1. Open a ToolboxST system (.tcw file).
2. From the System Editor, double-click the component.
3. Go online with the controller.
4. Set the device to Secure state.
From the Device menu,

select Security State.

Public Information
Click Go to Secure.
For dual and TMR configurations, select Go to Secure for each controller.
Attention
Note When the process is in the Authenticated state, the controller is retrieving a certificate revocation list from the CA
Server to verify that the requestor has a valid certificate.
Once the request has been approved,

the state of the controller is secure.
The Component Info View Status tab displays the Security state for each configured controller.
Public Information
Example of Controller Security State

Public Information
7.4 Download Controller Configuration
The Download item in the Device menu is used to download the component and configuration settings to the controller and
I/O modules.
Device Menu Download Options
7.4.1 Controller Setup

After a controller and associated I/O modules have been added to the system, prepare the controller for use by configuring the
IP address and redundancy information. The Controller Setup Wizard guides the user through the configuration process.
A controller cannot communicate on a network until these controller setup tasks are
completed.
Attention
Prerequisites
Verify the following criteria before configuration:
• The ToolboxST application has been properly installed

• The ToolboxST system file has been properly configured
• Controller(s) and associated I/O modules have been added to the system.
Note If using a Shared IONet system, repeat the procedures in this section for both the Mark VIe and VIeS components.
7.4.1.1 Controller and Network Redundancy

The default configuration for controller redundancy is Triple Modular Redundancy (TMR) or three controllers.
➢ To change redundancy
1. From the General tab Tree View, select General.
2. From the Property Editor, select Redundancy, and from the drop-down list select the correct option to match the
installed controller hardware (simplex, dual, or TMR). The Summary View displays the set of controllers for the
redundancy selected (one, two, or three).
3. From the Hardware tab, set the Network Redundancy to indicate the number of IONet networks (simplex, dual, or
TMR) that are used with this set of controller(s). Refer to GEH-6721_Vol_I for more information on redundancy options.
Public Information
4. Click to save the change. From the Component InfoView, the Log tab displays status information.
7.4.1.2 Configure UDH IP Addresses

Typically, the computer running the ToolboxST application has two Ethernet ports (corresponding to PDH and UDH
networks). The UDH network must not be connected to any other local area network or used for any purpose other than
connecting to the controllers from the ToolboxST application. Network Adapter 0 corresponds to the ENET1 port on the
controller, which is reserved for the UDH network.
➢ To configure the HMI computer IP address

If the HMI computer with ToolboxST application is not properly set up with a UDH network IP address, perform the
following procedures using your Windows operating system screens.
Note The default IP address is used as an example in this procedure. Because the default IP address assigned to the first
controller is 192.168.101.111, the UDH Ethernet port on the computer running the ToolboxST application must be assigned
an address in the same subnet, or 192.168.101.xxx, where xxx is in the range 002 to 255 (except the addresses used by the
controllers).
1. From the Start menu, select Control Panel and Network and Sharing Center.
Select Change
adapter settings to
display the network
connections for the
computer.

Public Information
Select the Ethernet port to be used for UDH (typically
named Local Area Connection or Local Area
Connection 2), right-click, and select Properties.
Note Administrator privileges are required to access the Properties dialog box.
From the
Networking
tab, select
Internet
Protocol
Version 4
(TCP/IPv4),
then click
Properties.
Public Information
Select Use the
following IP
address.
In the IP address
field, enter
192.168.101.11,
then confirm the
Subnet mask
255.255.255.0.
2. Click OK and close each of the previous dialog boxes.

3. From the Start menu, open a Windows Command prompt.
4. Type ipconfig, press Enter, and verify that the IPv4 address is correct.

Public Information
➢ To change the UDH network address and subnet of the ToolboxST application
1. From the System Editor Tree View, select the UDH.
2. From the Property Editor, set the GatewayIPAddress to be

the network address for the ToolboxST application. Reminder that
this needs to be on the same subnet as the Mark VIe controllers
and is unique for the end site where the control system is
deployed.
3. Set the correct SubnetMask for the site UDH network. The
default subnet mask is 255.255.255.0.
➢ To change the UDH network address of the controller set
1. From the System Editor, double-click the controller set to open the Component
Editor.
2. From the General tab Tree View, select Network Adapter 0. The Property
Editor displays the Network as UDH, the Host Name for this device on the
network, and the IP Address. The default IP address assigned to the first
controller in the system is 192.168.101.111. For TMR controllers, this address is
assigned to R controller, with 192.168.101.112 assigned to S controller, and
192.168.101.113 assigned to T.
3. Enter the new IP address for the R controller. If using redundant controllers,
their IP addresses are automatically updated along with the change to the R
controller.
Public Information
7.4.1.3 Configure and Transfer IP Address to UCSB / UCSC Controller
Prerequisites
• The control system hardware and network cabling have been connected properly
• All system equipment has been successfully powered on
• The controller has been added to the system with the correct redundancy
➢ To set up a UCSB / UCSC controller

1. Open the ToolboxST system (.tcw) file and open the Component Editor.
2. From the Device menu, select Download, and then select Controller Setup.
3. If prompted, enter the Modify Data site-specific password. For initial setup, enter the factory default user password.
4. When the Controller Setup Wizard Welcome window displays, click Next to continue.
5. Select a configuration method from the available options:
a. To set the controller’s network address using the COM port, select Configure Network Address, then click
Next.
If this is a new UCSB controller received directly from the factory, or a UCSB that has
not been previously configured, the IP address must be set using a USB flash device.
Skip to step b in this procedure.
Attention

Public Information
i. Enter the device password, then select a COM port and the appropriate controller Channel.
ii. Connect an RJ-45 serial cable adapter from the main board of the controller to a serial port on your computer:
• UCSB RJ-45 adapter (GE part number 342A4944P1)

• UCSC RJ-45 adapter (GE part number 121T6659P0001)
iii. Click Next to continue.
iv. The Controller Setup Wizard displays the progress of the connection. When it is complete, click Finish.
v. Disconnect the Ethernet cable from the replacement controller’s COM port, and disconnect the serial adapter
from the engineering workstation.
vi. Reboot the controller.
vii. Configure the replacement controller and/or set of controllers with the site-specific controller password. (Refer
to the section Controller Password Change for this procedure.)
Note The boot LED blinking after this operation is normal and signifies the unit has booted and is waiting for an
application download.
Public Information
b. To re-initialize and transfer the configuration from ToolboxST to the controller hardware using a USB device, select
Initialize USB Flash Device and click Next to continue.
i. Insert a non-encrypted removable USB 2.0 (only) flash device with a 4 GB minimum capacity into the HMI
computer USB port.
ii. Initialize the controller.

Public Information
Click Scan to search for available USB devices.
Select the appropriate Channel and click Write

to program the device for the selected channel.
Modify TCP/ICP settings from the General tab.
iii. Remove the USB flash device from the USB port of the HMI computer, then click Finish.
iv. Remove power from the controller.
v. Insert the USB flash device into the controller. For a UCSB, press and hold in the Backup/Restore button. For
a UCSC, press and hold the PHY PRES button.
Note Refer to the Mark VIe and Mark VIeS Control Systems Volume II: System Guide for General-purpose
Applications (GEH-6721_Vol_II), the sections UCSC Restore and UCSB Backup and Restore for these
procedures.
vi. Apply power to the controller while continuing to press the button until the On LED on the front of the
controller becomes solid green, then release the button. The On LED turns off when the process is complete.
vii. Remove power from the controller, remove the USB flash device, then re-apply power to the controller.
viii. If using redundant controllers, repeat this procedure for the S and T controllers (if TMR) or S (if dual). Be sure
to select the correct Channel.
Public Information
7.4.1.4 Configure and Transfer IP Address to UCCA / UCCC / UCSA Controller
Prerequisites
• All system equipment has been successfully powered on.
• The computer that runs the ToolboxST application and the controllers must be configured to be on the same subnet for
UDH Ethernet communication.
Use one of the following methods to configure the TCP/IP address of the UCCA / UCCC / UCSA controller for
communication on the UDH Ethernet network.
➢ To set up a UCCA / UCCC / UCSA controller

This procedure may be completed before power is applied to the control cabinet.
Next.

Public Information
• UCCA RJ-45 adapter (GE part number 342A4931ABP1) and controller connector (GE part number
342A4931ABP2) or a miniature D shell, null modem serial cable (GE part number 336A3582P1), connected
with a micro-miniature pigtail (GE part number 336A4929G1)
• UCCC RJ-45 adapter (GE part number 342A4931ABP1)
• UCSA RJ-45 adapter (GE part number 342A4944P1)
vii. Configure the replacement controller and/or set of controllers with the site-specific controller password. Refer to
the section Controller Password Change for further instructions.
Note On a UCSA, the boot LED blinking after this operation is normal and signifies the unit has booted and is
waiting for an application download.
Public Information
b. Select Format Flash to reconfigure the Ethernet settings and transfer the configuration from the ToolboxST
application to the controller hardware using a CompactFlash device (PCMCIA adapter or USB device).
Turn off power to the controller and unplug the CompactFlash from the controller. Insert the CompactFlash into the
card reader, then plug the card reader into the USB port of the computer that is running the ToolboxST application.
Flash Card Reader
Note From a Windows 7 computer, run the ToolboxST application as an Administrator to format a CompactFlash card.

Public Information
If the Controller Setup Wizard displays this message , close ToolboxST .
From your desktop , right -click the ToolboxST icon and select Run as Administrator.
Re-open the system .tcw file in ToolboxST and begin the Controller Setup procedure again .
Click Scan to find the

CompactFlash card you
inserted into the USB port
and verify the health of the
CompactFlash.
Select the controller (R,S,

or T) for which the IP
address will be set.
Click Write to download to

the flash card.
Verify the controller name and the IP address. The IP addre ss is 192.168.101.1xy (where x = controller number;
1 for G1, 2 for G2, and so forth) and y = TMR number; 1 for R, 2 for S, and 3 for T).
Public Information
Note If the scan cannot locate the flash card, either the card reader is improperly connected or the flash card is faulty.
6. From the Controller Setup Wizard, click Write to format the CompactFlash.
7. Verify that the CompactFlash download completed successfully message displays, then click Finish.
8. Insert the CompactFlash into the controller.
9. Apply power to the controller (red boot LED should flash at 1 Hz).
10. If the Mark VIe control interfaces with a SecurityST platform that is utilizing MAC filtering, update the MAC filtering to
account for the new controller core (as appropriate) per SecurityST guidelines and procedures.
11. Repeat this procedure for each controller (if using a redundant controller set). Be sure to select the correct Channel that
matches the redundant controller.
Note On a UCSA, the boot LED blinking after this operation is normal and signifies the unit has booted and is waiting for
an application download.
7.4.1.5 Configure and Transfer IP Address to UCPA Controller
The UCPA requires a special serial port cable (GE part number
115T8986P0001) and a DB9 COM port to USB port adapter for the setup of
network IP address. The factory default IP address is 192.168.101.111. The
correct UDH IP address must be properly set up so that the UCPA can
communicate to the site HMIs.
➢ To change the UDH network IP address for the UCPA

1. Verify that the computer running the ToolboxST application has been configured with the correct UDH IP address. Also,
verify that from the ToolboxST Component Editor, the controller Platform is set as UCPAHxA. This is valid for both
versions of the UCPA (H1A or H2A).
2. From the Component Editor, General Tab, Property Editor, Network Adapter 0, confirm that the correct UDH IP
address has been configured or change it to the appropriate address as a relative subnet to the UDH IP address from Step
1.
3. Connect the serial cable to the UCPA serial port. Connect a port adapter (DB9 COM port to USB) to the other end of the
serial cable, and then connect to the computer that is running the ToolboxST application.
4. From the ToolboxST Component Editor General tab, select Devices, Download, Controller Setup to launch the
Controller Setup Wizard.
5. Complete the Controller Setup Wizard using the default choices.
7.4.1.6 Verify UDH Communications

➢ To verify UDH communications
1. From the Start menu, a Windows Command prompt.
2. Type ping and the IP address used for the controller(s), and press Enter. Successful communication between your
computer and the controller displays a Reply message in the Command window.

Public Information
7.4.2 Controller Interoperability
Beginning with ControlST V07.04, Mark VIe redundant configurations can support interoperable controllers, with different
platform types interoperating in a redundant set. Each controller in the redundant set displays as a separate Platform entry in
the Property Editor. If the <R> controller Platform is set to a controller type that is not interoperable then only a single
platform entry is provided for all controllers. If one controller in an interoperable set fails, operators can replace it with the
same or a different supported controller type while the process being controlled is still running, without losing plant control.
(ToolboxST supports online replacement.)
Examples of interoperable controllers are:
• UCSBH1A, UCSCH2A
• UCSBH4A, UCSCH2A
Note For Simplex configurations, only one platform displays and controller interoperability is not available.
➢ To replace a controller with an interoperable controller

1. In the Mark VIe control rack, replace the controller with a supported interoperable controller. For example, replace the
<S> UCSBH1A controller with a UCSCH2A controller.
2. From the ToolboxST application, change the <S> controller Platform property type to match the interoperable
replacement controller (UCSCH2A).
Redundant Interoperable Controllers Platform Properties
When changing the controller Platform property, for Platform S and T, only valid platforms are available in the drop-down
menu.
Filtered Compatible Interoperable Controllers Platforms
When changing Platform R, all available platforms are displayed in the drop-down menu. If the major revision is set and an
incompatible platform is selected, a Warning dialog box indicates that a reboot is required.
Click No to select a valid, compatible platform. Click Yes to change platforms.
Public Information
Major Revision with Incompatible Interoperable Controllers Platform Warning
After changing the <S> platform type, the <R> controller equality is still Equal and Controlling.
Designated Controller Still Equal and Controlling
3. From the ToolboxST application, perform a Controller Setup to configure the proper IP address for the new controller by
writing the configuration to a USB flash device.
Note For detailed instructions, refer to the section Configure and Transfer IP Address to UCSB / UCSC Controller.
4. Perform a Build and Download to the S controller. The download will only affect the replacement controller.
Note If you replace a controller with a different controller type (such as UCSBH1A with UCSCH2A) and try to perform
a Download without first performing a Build, you will be prompted to perform a Build. A Build is necessary because you
are still controlling with the replaced controller type (UCSBH1A) as the Designated Controller (R).

Public Information
Prompt to Build after Controller Replacement
Example Download to S Controller
After the download completes, the replacement controller automatically restarts and enters the Controlling state.
Public Information
Redundant Interoperable Controllers Equal and Controlling
5. Because you have made a change to the configuration and the current backup file is only downloaded to the replacement
controller, it is recommended that you send the backup file to all controllers.

Public Information
7.4.3 Controller Password Change
For additional details, refer to Mark VIe and Mark VIeS Control Systems Volume II:
Attention System Guide for General-purpose Applications (GEH-6721_Vol_II), the chapter
Controller Diagnostic Alarms, alarm 547.
➢ To change the controller password
Public Information
Note For a device configured with redundant controllers, the password applies to all controllers in that device.
Note This password is required for configuring the network address during controller setup.
Controller Password Synchronization

When a failed controller in a redundant set is replaced, the replacement controller password is set to the factory default
password and must be synchronized to the same password as the other controllers in the set. A diagnostic alarm message in
the Status tab notifies the user that the default password has been detected for the replacement controller and prompts the user
to change the password. For example, if the T controller failed and was replaced, the diagnostic alarm message Default user
password detected displays in the Status tab for the T controller.
➢ To synchronize controller passwords

1. From the Device menu, select Download, then select Change Controller Password....
2. Enter the default factory password as the Current Password.
3. Enter the same password for the replacement controller as is used for the other controllers in the set as the New
Password.
4. Re-enter the new password for Confirm Password.
5. Click OK to complete the process and synchronize the controller password for all three controllers.
When the password for the replacement controller is successfully synchronized to the other controller passwords in the set, a
message displays in the Log window.
Example T Controller Password Sync Success Log Message

Public Information
7.4.4 Download to Controller
The ToolboxST application is used to configure the Mark VIe component and its distributed I/O modules. Depending on the
components used, the following software can be downloaded:
• Boot Loader starts the operating system for the controller and I/O modules, much like the BIOS on a desktop computer.
Changes to the boot loader are very infrequent.
Note Not all devices have the boot loader. In this case, the boot loader is contained within the base load.
Base Load contains the operating system for the controller and I/O modules. While changes to the base load are more
likely than changes to the boot loader, they still occur infrequently.
• Firmware provides the functionality of the controller and I/O modules. It can be updated over the lifetime of the
controller to incorporate new features and bug fixes.
• Application Code contains the configuration of the controller as created in the ToolboxST application. Whenever a
change is made to the configuration, the application code must be downloaded. There are two types of application code
download: online and offline. An online download (very commonly performed) changes the configuration without
interrupting control and the new configuration takes effect between control frames. An offline download requires a
controller restart (performed less frequently).
• Parameters contain specific configuration for the I/O modules.
Boot loader, base load, firmware, offline application code downloads, and parameter
downloads all require the target device to be restarted. Before downloading new
software to a controller, take the necessary steps to secure the control equipment to
prevent equipment damage and personal injury.
Warning
Note The type of software download needed is determined by which changes have been made to the controller
configuration.
The Download Wizard is used to download software to a Mark VIe component and its distributed I/O modules over an
Ethernet connection. The Download Wizard can automatically examine the system configuration to locate out-of-date
software, or you can manually select individual items to download.
Public Information
➢ To download software to a controller
Note Certain conditions do not allow a download, such as an incorrect platform type. Check the Component InfoView for
errors that may prohibit a download.
1. Disable the I/O modules from the configuration. It can be easier to download to the I/O modules after the controller is
successfully online.
From the
Component
Editor Hardware
tab, select all I/O
modules
From the Property

Editor, set
Configuration
Required to False
2. From the toolbar, click the Build icon. From the Component InfoView Log tab, verify that there are no errors or
resolve issues before proceeding.
3. From the Component Editor Device menu, select Download and Download Wizard.
Or, from the toolbar, click the Download icon.
Note You can perform a Download without performing the Build command. However, if you have changed
configuration settings since the last Build operation, a message box indicates that the software is out of date. Click Yes to
build the current configuration.

Public Information
4. When the Welcome Wizard displays, click Next .
If a change occurred that requires a restart of the controller, a wizard page displays with a Restart Controller after
Download check box selected.
5. When the download has completed, click Finish.
6. Repeat this procedure as needed until the configurations display as equal from the Build.
7. From the toolbar, click the Go On/Offline icon to go online with the controller.
If the configuration being downloaded contains I/O packs with IDs that are different
from the currently running configuration, incorrect firmware can be installed to some
I/O packs. If this occurs, confirm that the controller is running the new configuration,
restart the entire system, then restart the ToolboxST Download Wizard.
Attention
The APP_STATE block can prohibit a download and restart of the controller.
Attention
If the DOWNLOAD_OK input of the APP_STATE block is set to True, all downloads are allowed. If this value is set to
False, all downloads (except Update DDR and Device Backup) are prohibited. This condition also applies to an attempted
download of an I/O pack from the Hardware tab of the Component Editor. If the download is prohibited, a warning displays in
the Component InfoView, and the Download Mark VIe Controller wizard displays the prohibited download. For additional
information on the APP_State block, refer to the Mark VIe Controller Standard Block Library Instruction Guide
(GEI-100682).
Public Information
Download Prohibited Warning in Component InfoView
Special Consideration for Dual Download Wizard

When using PPRF, PPNG, PSCA, or PSCH in dual network mode, if the I/O module
indicates that a reboot is required then the I/O module may go to the offline state after
Start is clicked in the dual Download Wizard. The outputs will not remain online even
though the ToolboxST allows the user to test the new configuration.
Attention
When using PCMI, do not add or remove Mark VI VME boards during an online
download.
7.4.5 Update Dynamic Data Recorder

The Update Dynamic Data Recorder (DDR) feature updates the standalone data collectors that can be reconfigured without
affecting any of the control code.
➢ To update the DDR: from the Device menu, select Update Dynamic Data Recorder and follow the instructions
on the ToolboxST windows.
7.4.6 View/Set Time

The View/Set Time feature is used to view and set the time on a controller.
➢ To view and set the controller time: from the Device menu, select View/Set Time... and follow the instructions
7.4.7 Backup Files to Controller

The Backup Files to Controller feature is used to send backup files to all controllers when a change is made to the
configuration.
➢ To back up files to the controller: from the Device menu, select Download, then select Backup Files to
Controller.

Public Information
7.5 Upload Controller Configuration
The ToolboxST application retrieves 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. From the Component Editor Device menu, select Upload.
2. When the welcome wizard displays, click Next.
Public Information
Public Information
7.6 Backup/Restore Controller Configuration
If the controller fails, perform one of the following backup and/or restore procedures:
• UCSB Backup and Restore

• UCSC Restore
7.6.1 UCSB Backup and Restore

If the UCSB controller fails, back up the UCSB configuration (including the UDH IP address), install a replacement
controller, and restore the configuration to the replacement UCSB to allow for communication to the ToolboxST application.
A software recovery push-button located on the bottom of the controller is used to update the NAND flash. A 2.0-compliant,
non-encrypted USB with a minimum capacity of 4 GB must be used. For detailed instructions, refer to the Mark VIe and
Mark VIeS Control Systems Volume II: System Guide for General-purpose Applications (GEH-6721_Vol_II), the section
UCSB Backup and Restore.
7.6.2 UCSC Restore

If the UCSC controller fails, restore the configuration to allow for communication between the UCSC and the ToolboxST
application. The Physical Presence (PHY PRES) button located on the front of the controller is used to initiate the procedure.
A non-encrypted USB 2.0 (only) flash device with a minimum capacity of 4 GB must be used. For detailed instructions, refer
to GEH-6721_Vol_II, the section UCSC Restore.
Note Upon shipment from the factory, a controller that supports EFA does not include the software to support
communication from the PHY PRES button to the EFA. To enable this, the user needs to download to the controller at least
once (using ToolboxST).
Public Information
7.7 Command Event History
The Command Event History option allows you to display diagnostics events and command history stored in the controller.
➢ To display command event history
From the View menu,

select Command Event
History to display the
Command Event Log

Public Information
Public Information
7.8 Diagnostics View
The Diagnostics View displays diagnostic messages for components, such as errors or warnings, that indicate hardware
functionality and communication issues. Retrieving these messages should be the first step in diagnosing any hardware or
communication issues. Diagnostics can be viewed for controllers and I/O modules.
7.8.1 Controller Diagnostics

➢ To display controller diagnostics: from the component View menu, select Diagnostics, then select Controller
Diagnostics.
Click Reset Select to display

Diagnostics to Click Refresh messages with one
clear messages List to manually status. Clear to
with 0 status retrieve messages display all messages
In a duplex or TMR
configuration, use
this drop-down list
to select the
desired
redundancy
component to
retrieve messages
Message
time stamp
Message
fault code
Message
status
(0=inactive;
1=active)
Message
description
7.8.2 Controller Advanced Diagnostics

The Controller Advanced Diagnostics displays additional information from the controller.
➢ To display controller advanced diagnostics

1. Open the Component Editor and go online with the controller.
2. From the component View menu, select Diagnostics, then select Controller Advanced Diagnostics.
3. From the Tree View, expand the Diagnostics item.
4. Select a diagnostic report.
6. Click Send Command to display the report.

Public Information
7.8.3 I/O Diagnostics
The I/O Diagnostics View displays diagnostic messages for a component’s I/O module. Retrieve these messages to diagnose
problems with hardware I/O.
➢ To display I/O diagnostics: from the component View menu, select Diagnostics and I/O Diagnostics.
Note For more information, refer to the section I/O Diagnostic Viewer.
7.8.4 I/O Status

➢ To display I/O status: from the component View menu, select Diagnostics and I/O Status.
Public Information
7.9 Frame Timeline Profiler
The Frame Timeline Profiler displays the amount of time various controller tasks take to run within a controller frame and an
Execution Group frame. Such tasks include transferring data from I/O into signal space, executing high and low priority
blockware, and generating EGD.
➢ To view controller task time frame data

1. Go online with the controller. From the Component Editor toolbar, click the Go Online/Offline icon.
2. From the View menu, select Frame Time Profiler to display the Frame Time Profiler dialog box.
Frame times per task are displayed on a timeline for each core in a multi-core controller.
Frame Timeline Profiler
➢ To refresh controller task time frame data: from the Frame Time Profiler dialog box, click the Refresh icon
(located in the upper right corner of the window).
Using the Zoom icon, users can zoom in or out on the timeline data either horizontally only (default), or both horizontally and
vertically.
➢ To control horizon/vertical zoom: from the Frame Time Profiler dialog box, click the Zoom icon (located in
the upper right corner of the window) to switch (toggle) between horizontal only zoom or horizontal and vertical zoom.

Public Information
7.10 Totalizers
The controller maintains a set of 64 or 128 counters (depending on the controller platform) in non-volatile RAM (NVRAM)
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. (Refer to the section Connect to Controller.)
➢ To view Totalizer values

1. Establish a connection to the R controller.
2. From the Device menu, select Administer and Totalizers.
Public Information
7.10.1 Totalizer Passwords
All users can view Totalizer values, but modifying the values requires a temporary password obtained from GE.
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.
2. From the Device menu, select Administer and Totalizers.
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. Open the file in Notepad and follow directions to obtain a
password.
4. Copy the password to the Windows clipboard and return to the View/Set Totalizers dialog box.
Note Totalizer passwords are usually valid for 24 hours from time of creation.

Public Information
7.10.2 Totalizer Values
Once you have entered a valid password, you can modify Totalizer values. (Refer to the section Totalizer Passwords).
➢ To modify a Totalizer value

1. Open the View/Set Totalizers dialog box and enter a valid password.
2. From the Modify Totalizer Value dialog box, enter the new value and click OK.
Public Information
8 Mark VIe Sequential Function Chart
(SFC) Editor
A Sequential Function Chart (SFC) is a graphical programming model that allows you to organize an application by creating a
state machine containing three types of components: Steps, Actions, and Transitions.
8.1 SFC Operations

8.1.1 Create SFC
➢ To create an SFC
1. Open a .tcw file and create a Mark VIe component (refer to the section Creation Wizard).
2. From the Component Editor Software tab, add a Sequential Function Chart to Prog1.

Prog1 and select Add Special Task
and Add Sequential Function Chart
to display the Add SFC dialog box
3. From the Add SFC dialog box, enter a name for the SFC and click OK.
Mark VIe Sequential Function Chart (SFC) Editor GEH-6703P User Guide 563
Public Information
When the SFC is created, the Initial Step is already defined.
From the Logic Editor, you can configure the properties and edit the SFC.
From the Tree View, click the new From the toolbar, click Edit SFC
sfc to display the SFC Logic Editor to make changes to the logic
Public Information
8.1.2 SFC Properties
SFC Properties
Appearance
Description Description
Name Name
Step Description Text Defaults Sets the default color, font, and fill style of description text for Steps
Transition Description Text Defaults Sets the default color, font, and fill style of description text for Transitions
Text Shape Defaults Sets the default color, font, and fill style of free-form text shapes
Automation
Instance Script Script that runs when the task is instanced
Sets the default color, font, and fill style of Steps, Transitions, and free-form text. These
Transition Description Text Defaults
settings can be modified and applied to all SFCs.
General
Always Show Descriptions on Steps When set to True, steps and transitions will automatically have a Description text shape
and Transitions next to them
Default Transition Descriptions to When set to True, the Description for each transition defaults to a text equivalent
Show Logic Equations (equation) of the transition condition logic
EGD EGD page that contains all published variables from the SFC
New Transition Condition Options Sets the default contents of the Transition condition logic
Put Action of Interest Status on EGD When set to True, publishes the Action of Interest status variables on the EGD page
Put Step Active Times on EGD When set to True, publishes the Active Time variable for each Step on the EGD page
Put Transition Progression Status on When set to True, publishes the Transition progression status variable for each
EGD Transition on the EGD page
Version User-defined version of an SFC
HMI Link Source Source file containing visuals for SFC elements
HMI Linked Object for SFC Network HMI object that visualizes the overall SFC network
HMI Linked Object for Steps HMI object that visualizes an SFC step
HMI Linked Object for Transitions HMI object that visualizes an SFC transition
Execution Order Sets the order in which the program is run
Frame Multiplier Number of frames at which the SFC task runs
Schedule Offset Offset from the beginning of the frame at which the SFC task runs
Note Most SFC property settings can be exported to an .xml file that can be modified in a text editor and imported into other
SFCs. For further details on the import and export options, refer to the section SFC Content Menu.
➢ To export or import SFC property settings:

1. Right-click on the SFC diagram to display the SFC context menu.
2. Select Export SFC Options to generate an .xml file containing SFC property settings, or select Import SFC Options
to read and upload the .xml file containing SFC property settings from one SFC to another.
Public Information
8.1.3 SFC Context Menu
The SFC context menu displays the available editing commands for an SFC.
➢ To display the SFC context menu: right-click anywhere in the SFC diagram.
SFC Context Menu Items

Command Description
Cut
Copy
Standard Windows clipboard command used to transfer data for shapes selected within the SFC
Paste
diagram
Delete
Select All
Insert New Page Creates a new diagram page and inserts it before the currently displayed page
Delete Page Removes the selected page from the SFC diagram
Rename Page Changes the name of the page on the screen and on the printed version
Append Page Adds a new blank page to the end of the SFC diagram
Auto-Arrange SFC Used to simplify the layout of the SFC diagram by arranging steps and transitions in order of
Diagram execution and avoiding overlapping of shapes. This action is cannot be undone.
Validate SFC Check the SFC for illegal operations such as jumps out of a parallel branch and unsafe networks.
Illegal operations will eventually result in build errors, but this command allows the user to check for
them while working on the SFC.
Edit Border Modify the print sheet border and footer. Sheet border settings can be configured for each device
and Library Container, and can be imported and exported to be shared with other SFCs and the
blockware diagrams.
Import SFC Options Read an .xml file containing SFC property settings. The .xml file does not need to contain all
properties, and will skip unrecognized elements and attributes.
Export SFC Options Generate an .xml file containing an SFCs property settings. The .xml file can be edited with an
external text editor to remove unwanted options when creating a standard file.
Public Information
8.1.4 Edit SFC
➢ To edit an SFC: from the SFC toolbar, click Edit SFC.
Note When in editing mode, the Edit SFC button displays as Editing SFC, and additional buttons are displayed on the
toolbar.
SFC Toolbar
Toolbar Buttons
Button Name and Icon Description of Use
Toggle between editing and viewing modes

Edit SFC
Run the SFC

Run SFC
Pause the SFC

Pause SFC
Reset a paused SFC (if the SFC is running, Reset is disabled)

Reset the SFC
Place a Hold on every Transition in the SFC

Single Step
Display the following states:
(Offline) indicates that the ToolboxST application is not online with the controller
PAUSED indicates that the SFC is not running (Action and Transition condition logic is not
running)
SFC Status
RUNNING indicates that the SFC is active (Action logic in active Steps is running, and
Transitions are being evaluated)
SINGLE STEP indicates that the SFC is active, but a Hold was placed on all Transitions.
COMPLETE indicates that the END Transition was reached and the SFC is complete
Zoom In, Zoom Out
Change the zoom level of the SFC logic editor
Select Steps and Transitions

Select Tool
Create a free-form text shape

Text Tool
Geometric Shape Tool
Draw geometric shapes including rectangles, ellipses, and lines
Change the orientation and size of the SFC diagram. When printed, the diagram is scaled
Virtual Paper Size and/or rotated to the printer’s paper size.
Create a new Step

Step Drawing Tool
Create a new Transition

Transition Tool
Public Information
Toolbar Buttons (continued)
Button Name and Icon Description of Use
Create a new END Transition

END Transition Tool
Align multiple selected shapes

Alignment Tool
8.1.5 Add Step

➢ To add a Step:
1. From the SFC toolbar, click the Step Drawing Tool and move the cursor to the logic sheet to display Click to add Step.
Public Information
8.1.6 Add Action
➢ To add an Action: from the SFC toolbar, click the Selection Tool and double-click a step.
From the Qualifier column,

Click the Add Action select the action qualifier Select the check box to make
button to add an action (refer to the table below this an Action of Interest
Note The Active and Finished fields indicate the status of the Action.
Action Qualifiers
Qualifier Description
N The Action runs every frame that the Step is Active.
The Action runs for a specific number of ms while the Step is Active, indicated by the Time value, then
L
stops running.
The Action does not run until the number of ms indicated by the Time value has been reached, after
D
which the Action runs every frame the Step is Active.
P The Action runs only once and is triggered by a rising edge on the Action’s Pulse Input.
L and D Action Qualifiers: a Time value, either a reference variable or an immediate value, must be specified in the Time
column for the Action.
P Action Qualifier: a Pulse Input Boolean value must be specified in the Pulse Input column for the Action.
By default, a PERMIT block is automatically created in a new Transition. The output of the PERMIT is connected to the
Transition_Condition_Value, and any conditions for the Transition can be connected to the PERMIT’s inputs.
The PERMIT standardizes the Transition conditions so that HMI screens have a common method to display information about
Transitions.
Public Information
➢ To define an Action’s logic: from the SFC toolbar, click the Selection Tool and double-click a step.
An Action can be authored in Terms of Blockware in the logic sheet.
Note Always connect the Action_Finished local variable to a Boolean expression. The Action_Finished variable enables the
Actions of Interest feature to know that the Action has finished its operation. This is recommended even if the application
does not use Actions of Interest.
8.1.7 Add Transition

➢ To add a Transition: from the toolbar, click Transition, move the cursor to the sheet, and click OK.
➢ To define a Transition’s condition logic: from the toolbar, click the Selection Tool and double-click a
Transition.
A Transition Condition can be authored in Terms of Blockware.
Note Always connect the Transition_Condition_Value local variable to the result of the Transition Condition Boolean
expression. The Transition_Condition_Value variable enables the SFC to progress if the Transition Condition Value evaluates
True when the Transition is Active.
Public Information
Connected Transition_Condition_Value Local Variable
➢ To use a Step’s Action of Interest status in a Transition condition: from the toolbar, click the Selection Tool
and double-click a Transition.
Using a Transition condition’s Boolean expression, such as defining whether or not the configured Actions of Interest for the
Initial Step have been completed, add a Move block whose source (SRC) pin is the MySFC.Initial_Actions_Of_Interest_
Status global variable and whose destination (DEST) pin is the Transition_Condition_Value local variable.
A Step’s Action of Interest Status is referenced from a Transition Condition.
Move Block as Action of Interest in Transition Condition
Public Information
8.1.8 Add End Transition
➢ To add an End Transition
1. From the toolbar, click End SFC Transition Drawing Tool.
2. Move the cursor to the SFC logic sheet to place the End Transition. Enter a name and click OK.
➢ To move a Step or Transition

1. From the toolbar, click Selection Tool and click the Transition to be moved.
2. Move the Step or Transition to its destination.
Public Information
➢ To connect Steps to Transitions: from the toolbar, click the Selection Tool and click the Step to be linked.
Public Information
8.1.9 Variable Connections
There are several required variable connections when defining SFCs in the ToolboxST application. For example:
• When defining a Transition’s Transition Condition, always connect the Boolean expression’s output to the Transition_
Condition_Value local variable. This enables the Transition to progress.
• When defining a Step’s Action Logic, always connect a Boolean expression to the Action_Finished local variable. This
enables Actions of Interest Control to be used in the SFC by having the Action state when it has finished. This is
recommended even if Actions of Interest Control is not being used in the application. It makes using the Actions of
Interest Control feature in the application much easier later in development if needed.
8.1.10 Add Free-form Text

➢ To add a free-form Text shape
1. From the SFC toolbar, click the Text Tool icon and move the cursor to the logic sheet to display the text shape hint,
Highlight a region to add Text.
2. Left-mouse click and drag to draw a rectangle text shape, then release the left-mouse button to create the text shape.
Free-form Text Shapes and Hint
3. In the property grid, enter the free-form text and configure the properties for the text shape:
Public Information
• Fill Color: select the fill color for the text shape.
• Font: select the text font.
• Foreground Color: select the color of the text.
• Is Filled: set to True to fill the text shape with color, or
False for no fill color.
• Text: enter the text you want displayed in the text
shape.
Note Text shapes can also by created by pasting text from another application such as Microsoft Word or Excel.
8.1.11 Geometric Shape Tool

➢ To add a geometric shape
1. From the SFC toolbar, click the Geometric Shape Tool icon and move the cursor to the logic sheet to display the text
shape hint, Highlight a region to draw a shape.
2. Left-mouse click and drag to draw a a rectangle text shape, then release the left-mouse button to create the text shape.
Geometric Shapes and Shape Hint
3. In the property grid, configure the Geometric Shape properties for the shape:
Public Information
• Fill Color: select the fill color for the shape.
• Geometric Shape: select a shape (Rectangle, Ellipse,
or Line)
• Is Filled: set to True to fill the shape with color, or
False for no fill color.
• Line Color: select a color for the shape line.
• Line Thickness: select the line thickness.
8.1.12 Shape Wire Connections

The SFC Logic Editor inserts wire connection lines between shapes as simply as possible. However, if shapes are drawn too
close, the connection lines become 6–point wires. To adjust the wire connections, move the Steps and Transitions around on
the diagram to straighten out the connection lines. You can also resize Branch and Join shapes and move junction points.
6–point Wire Connection Lines
Adjusted Wire Connection Lines
Public Information
8.1.13 Display Descriptions on Steps and Transitions
Each Step and Transition has a Show Description property. When the Show Description property is set to True, a text shape
is automatically created to store and display the Description text.
Step without Description Text

Steps and Transitions Show Description Property
Step with Description Text Shape Displayed
Unlike a free-form text shape, the Description text’s position is relative to the Step or Transition to which it is linked, and
moves with it. However, you can resize or move the text relative to the Step or Transition, and adjust the font and colors.
When the Description text is selected, a tooltip hint identifies the link.
➢ To enable or disable Descriptions for all steps and transitions at once:

use the Show All Descriptions on Steps and Transitions property (set to True to display description text, set to
False to not display description text).
Public Information
8.1.14 Display Transition Condition Logic in Description
The Description property of a Transition can be set to include a substitution string, {TransitionCondition}, that will be
replaced with a descriptive textual representation (equation) of the transition condition logic in that transition. For example, a
transition driven by a Rung block as follows:
would display as follows:
Not all Transition Condition logic can be displayed as text. The equation strings are limited to four block types that can drive
the transition condition:
• LOGIC_BUILDER
• LOGIC_BUILDER_SC
• RUNG
• MOVE
• PERMIT
All other blocks will display (custom logic) in the equation.
Inputs (to the supported block types) must be Named variables. For example, in the illustration used for a transition driven by
a Rung block above, the D input of the Rung is connected to an unnamed pin, AND_1.OUT, so (custom logic) is displayed for
that input in the description equation.
Since the description substitutes the {TransitionCondition}, you can build up more descriptive strings. For example, Wait for
the tank to fill ({TransitionCondition}) would display as Wait for the tank to fill (TankFull OR TankFillFailed).
➢ To enable or disable description equations for all Transitions at once:

set the Default Transition Descriptions to Show Logic Equations property to True to display description
equation, or set to False to not display description equation).
Public Information
8.1.15 Virtual Paper Size
The SFC Logic Editor is designed to display exactly what you will see when printing—pagination and paper size are
indicated in the background of the editor. However, diagrams are usually arranged on one paper size and printed on another.
In this case, the SFC will automatically be scaled and/or rotated to fit on and maximize the use of the printed paper.
Pagination can be inconvenient when designing and using large SFCs. An SFC is often better suited for Portrait or Landscape
paper. Sometimes the paper is too small. For these situations, the SFC Logic Editor can switch between Landscape and
Portrait, normal and large sizes. In the large size (Large Portrait or Large Landscape), the SFC contents are shrunk by 50%, so
you can fit four times as much logic on the paper with smaller font sizes.
➢ To select the virtual paper size: from the SFC toolbar, click the Virtual Paper Size icon and select the size from
the drop-down menu (check mark displays next to the selected item).
Virtual Paper Sizes
Public Information
8.2 Online Operations
➢ To run an SFC in a controller from the ToolboxST application
1. From the Mark VIe Component Editor, go online with the controller.
2. From the Software tab Tree View, select the SFC item to open the logic sheet.
3. From the tool bar, click Run the SFC.
4. To pause the SFC, click Pause to display the Pause SFC dialog box and click OK.
➢ To reset an SFC back to its Initial Step: from the toolbar, click Reset to display the Reset SFC dialog box and
click OK. The reset Initial Step displays green.
The SFC must be either paused or complete to reset.
Attention
Public Information
➢ To change an SFC mode
1. From the tool bar, click Mode to display the Single Step Mode SFC dialog box and click OK.
2. To place the SFC back into Free Running mode, click Mode again and click OK.
Note When the SFC is placed into Single Step Mode, all Implicit Holds are removed from Transitions, and previously set
Operator Holds are restored.
➢ To apply or remove Operator Holds

1. From the logic sheet, right-click the Transition and select Apply HOLD to Transition.
2. To remove an Operator Hold, right-click on Transition and select Remove HOLD from Transition.
➢ To acknowledge a HOLD applied to a Transition: from the logic sheet, right-click the Transition that has a
HOLD applied and select Acknowledge Hold.
Note If the Transition Condition for Trans1 was set to True at the time the HOLD was acknowledged, the SFC would
continue.
➢ To apply a FORCE to a Transition: from the logic sheet, right-click the Transition and select Force Transition.
Public Information
8.3 Publish SFC on EGD Page
An SFC’s Control and Monitor interface, which can be placed on an EGD page, includes:
• Run
• Reset
• Transition Hold
• Transition Hold Acknowledge
• Transition Force variables
In addition, the SFC’s Step Active Flags, Transition Active Flags, and Transition Condition Value are placed onto EGD
automatically.
You have the option to place items from the SFC Monitor Interface on EGD. These items include Action of Interest Status,
Transition Progression Status, and Step Active Times variables. By default, the Step Active Times are automatically placed on
EGD in the ToolboxST application.
➢ To place an SFC and its Control Interface on EGD: from the Software tab Tree View, select an SFC.
From the Property Editor, select EGD

page. From the drop-down list, select
the EGD page where the SFC and it’s
control interface will be published
To remove the
SFC from EGD,
from the drop-
down list, select
the blank entry
Public Information
➢ To place other SFC activities on an EGD page
From the Property

Editor , select
True for each of
the SFC activities
to place them on
an EGD page
Public Information
Notes
Public Information
9 Mark VIe FOUNDATION Fieldbus™
Interface
9.1 Overview
The Mark* VIe control FOUNDATION Fieldbus™ interface is a fieldbus protocol based on international standards and designed
for applications in manufacturing, process automation, and buildings automation. The guidelines for this fieldbus standard are
published by the Fieldbus Foundation.
FOUNDATION Fieldbus technology provides a standardized communications and controls system to allow the customer the
ability to install components from various manufacturers as they deem necessary. There are a variety of manufacturer’s
components that are certified as compatible with FOUNDATION Fieldbus technology and therefore can be interchanged for a
competitor’s similar component. This allows GE customers to use a wider variety of equipment in the Mark VIe control
system. Refer to the Mark VIe Control FOUNDATION Fieldbus Interface Application Guide (GEH-6761) for additional
information.
The ability to interchange a certified device from one manufacturer with a certified device from another manufacturer
(interoperability) is made possible by the fact that devices and software are conforming to the same standard. The Fieldbus
Foundation tests and registers the devices to ensure interoperability of registered instruments from multiple vendors. This
enables the end user to select the best instruments for the application regardless of the host system supplier.
Mark VIe FOUNDATION Fieldbus™ Interface GEH-6703P User Guide 585

Public Information
9.2 Configuration
All configuration of fieldbus linking devices and attached segments, fieldbus devices, fieldbus blocks, and related parameters
and properties is performed in the ToolboxST* application. The configurations are displayed and edited in the Component
Editor’s Hardware and Software tabs.
Note For additional information, refer to the Mark VIe Control FOUNDATION Fieldbus Interface Application Guide
(GEH-6761), the section System Parameters.
9.2.1 Linking Devices

The FOUNDATION Fieldbus linking device (PFFA) is used to interconnect H1 fieldbus networks and segments to high-speed
Ethernet (HSE) to create a larger system and provide a standardized communications and controls system for installing
components from various manufacturers. It includes a serial COM port for redundant operation, a LAN port for HSE, and
four fieldbus H1 ports.
From the Component Editor Hardware tab, the following operations can be performed for a linking device:
• Instance (add) a PFFA linking device

• Edit a linking device’s parameters
• Modify a linking device
• Attach a segment to a linking device
9.2.1.1 Instance (Add) a Linking Device
Note A major difference occurs when adding the first linking device and requires a restart-required load. Any linking device
added after that is a minor difference and only requires an online load. A major difference also occurs when removing the last
linking device and requires a restart-required load. Any linking device removed other than the last one is a minor difference
and only requires an online load.
➢ To instance a linking device

1. From the Start menu, select Programs, GE ControlST, ToolboxST, and ToolboxST to display the ToolboxST
System Editor.
2. If the correct system is not displayed, from the File menu, select Open System, locate and select the system .tcw file
(such as FF_Test), and click Open to display the System Editor.
3. From the Tree View, double-click the Mark VIe controller (such as FF2) to display the Component Editor.
4. From the Hardware tab, right-click the Distributed I/O item in the Tree View and select Add Module... to open the
Add Module Wizard.
5. From the Module Redundancy drop-down list, leave the default as Simplex or select HotBackup.
Public Information
6. From the Type list, select the PFFA module.
7. Click Next to open the Add Linking Device Wizard.

The Select Device Revision section displays the default device version details.
8. (Optional) In the Enter Device Identification section, enter a PD Tag and a Device ID for LDevR. For a HotBackup
configuration, the PD Tag automatically displays. Copy the Device ID provided for LDevR and paste into the Device ID
fields for LDevS.
Note The Physical Device (PD) tag is a unique, configurable, system dependent name for the device.
Tip � The DeviceID can be entered directly or searched for by using the ellipsis (…) mechanism.
9. In the Configure Device section, from the HW Form drop-down list, leave the default as H1B or select H1A for LDEvR
(Simplex). Repeat for LDevS for a HotBackup configuration.

Public Information
Note Beginning with ControlST V07.01, the PFFAH1A is obsolete and has been replaced with PFFAH1B. For further
details on PFFAH1B, refer to the Mark VIe and Mark VIeS Control Systems Volume II: System Guide for
General-purpose Applications (GEH-6721_Vol_II), the chapter PFFA FOUNDATION Fieldbus Linking Device, the section
PFFA Linking Device.
10. From the LAN Port drop-down list, leave the default as IONet1 or select IONet2 for LDEvR (Simplex). Repeat for
LDevS for a HotBackup configuration (default is IONet 2).
11. From the Position drop-down list, leave the default position as 24 (ToolboxST) or enter another position number for
LDEvR (Simplex). Repeat for LDevS for a HotBackup configuration (default ToolboxST Position is 231).
12. Click Next to continue.
13. Review the configuration summary, then click Finish to add the module.
Public Information
The PFFA linking device (such as PFFA-21) displays in the Tree View and a graphical representation displays the
Summary View. The Properties display in the Property Editor.
PFFAH1B Linking Device
FOUNDATION Fieldbus Linking Device Properties

Category Property Notes
Appearance Description Description of the selected device
Determines whether the linking device must be present and functioning for the
Configuration Required
controller to go online
Path to CIMPLICITY screen file containing the HMI Linked Object. This path can be
HMI Link Source
relative or absolute.
HMI Name of the library screen object found in the HMI Link Source file. This ties this
HMI Linked Object linking device to a screen object when dragging the linking device onto a CimEdit
screen.
CFF Revision CFF revision of this linking device
DD Revision DD revision of this device
Device ID Linking device ID
Device Revision Device revision of this linking device
Identification Group Group in which this linking device resides
Location Location(s) of this linking device
Module ID Unique ID number for this linking device
Name Name of this linking device
PD Tag Plant site unique value for the linking device
Configuration Compatibility Code Configuration compatibility code
I/O Compatibility Code I/O compatibility code
Library
Name Library (dll) where linking device is defined
Information
Supports Auto Configuration If true, this I/O linking device supports automatic configuration from the controller
Version Library version

Public Information
FOUNDATION Fieldbus Linking Device Properties (continued)
Manufacturer ID Manufacturer ID of this linking device
Manufacturer
Manufacturer Name Manufacturer name of this linking device
➢ To view and edit a linking device's parameters

1. Select the Diagnostics tab to view diagnostic parameters.
Linking Device Diagnostics Parameters

Heading Description
Time Time and date of alarm or event
Alarm ID Unique identifier for alarm
Active Indication if alarm is active or not
Module Module with which alarm is associated
I/O Pack I/O pack with which alarm is associated
Group Group with which alarm is associated
Description Description of alarm
2. Select the Status tab to view status parameters.
Linking Device Status Parameters

Heading Description
Module Module with which status notation is associated
I/O Pack I/O pack with which status notation is associated
Group Group with which status notation is associated
Revision Type Type of revision
I/O Pack Revision I/O pack revision number
ToolboxST Revision ToolboxST application version
Public Information
9.2.1.2 Modify a Linking Device
➢ To modify a linking device
1. From the System Editor Tree View, double-click the Mark VIe component (such as FF3) to display the Component
Editor.
2. From the Hardware tab Tree View, right-click a linking device and select Modify from the shortcut menu.

Public Information
3. From the Modify dialog box, modify the values as needed and click OK to save the changes.
Public Information
9.2.2 Attached Segments
An H1 segment (or fieldbus) connects the linking device to the fieldbus device. A segment is a section of a H1 fieldbus. Up to
four H1 segments can be attached to each linking device. Segments can be linked by repeaters to form a longer H1 fieldbus.
Each segment can include up to 16 H1 devices.
9.2.2.1 Attach Segment to Linking Device Port

➢ To attach Segments to a linking device
1. From the System Editor Tree View, double-click the Mark VIe component (such as FF3) to display the Component
Editor.
2. From the Tree View, expand the linking device to display attached segments and available ports.

Public Information
3. Select an available Port to display the associated properties. (The Summary View remains blank.)
Port Properties
Identification
Name Name of the selected port
Port Number Number of the port
Port Type Type of port
4. From the Tree View, right-click the Port and select Attach Segment from the shortcut menu.
Public Information
5. The attached Segment displays in the Tree View and in the Summary View.
PFFAH1B Attached Segment
Attached Segment Properties

Identification
Name Name for H1 segment
Segment Description Primary language description of H1 segment
Segment Schedule
Actual Microcycle Time (ms) Macrocycle used; it is only valid after a build has been completed
Desired Macrocycle Time (ms) Multiples of controller frame rate set by user (such as 40, 80, 160, and so forth)
Unscheduled Overhead Percent Time allowed for asynchronous communications (percent of Macrocycle)

Public Information
Selecting the Segment in the Summary View highlights it in yellow. The Segment properties display in the Property Editor.
PFFAH1B Attached Segment Highlighted and Properties Displayed
Attached Segment Properties

Identification
ID/Location Component ID or location
Name Name of component
Tag Plant site unique value for connector
Manufacturer
Manufacturer Name Name of vendor that manufactured this component
Miscellaneous
Category Category for this component
Type Type of component
Revision
Revision Revision of this component
Public Information
9.2.2.2 Configure Attached Segment Macrocycle
A macrocycle is a single iteration of a schedule within a device. The attached segment macrocycle is configured by modifying
the attached segment’s properties in the Hardware tab Property Editor.
➢ To configure an attached segment macrocycle: from the System Editor Tree View, double-click the Mark
VIe component (such as FF3) to display the Component Editor.
From the Tree View , select the

attached Segment (PFFA-
22_Segment2 ) to be configured.
From the Property Editor, in the

Desired Macrocycle Time test
box, select the time ( 160 ) from the
drop-down list .
In the Unscheduled Overhead

Percent text box, select the time
(50 ) all for asynchronous
communications (this is a percent
of the macrocycle time).
Note The desired macrocycle time must be in multiples of the controller’s frame rate to which the segment’s linking device
belongs.
The ToolboxST application updates the predicted macrocycle time when:
• A generic fieldbus function block is assigned to a fieldbus device placeholder in the segment.
• An assigned fieldbus function block is unassigned from a fieldbus device placeholder in the segment.
The ToolboxST application updates the selected macrocycle time when the desired macrocycle time is updated.
When running at a 320 microsecond macrocycle, input health may be impacted under certain instances. Any failure that
results in the secondary PFFA switching to the primary PFFA may result in missed data for up to and including three
macrocycles. During this period of time, the status can go to UNCERTAIN. This should be accounted for in the application
design when using 320 microsecond macrocycle segments. Events that cause the PFFA to switch are as follows:
• Dual download that results in a Designated Controller (DC) switch

− Forcing a desired controller to become DC before download
− Clicking the Revert button after the first controller is downloaded
• DC failure
• Network switch failure on the DC's network

Public Information
• Primary PFFA failure
• Primary PFFA's H1 segment connection failure
9.2.2.3 View Attached Segment Macrocycle Timeline

A segment’s macrocycle timeline is viewed in a standalone window.
➢ To view a segment’s macrocycle timeline

1. From the ToolboxST System Editor Tree View, double-click the Mark VIe component (such as FF3) to display the
Component Editor.
2. From the Hardware tab Tree View, expand the linking device (such as PFFA-21) to display the list of attached
segments and available ports.
Right-click the attached Segment

(PFFA-22_Segment2 ) and select
View Macrocycle Timeline from
the shortcut menu.
Public Information
The Macrocycle Timeline Viewer displays.
Macrocycle Timeline Viewer
The following can be performed from the Macrocycle Timeline Viewer:
• View which assigned fieldbus function blocks will execute at what time during the macrocycle.
• View time allotted during the unscheduled portion of the macrocycle for the reading of views of assigned fieldbus
function blocks configured for placement on EGD.
• Refresh the macrocycle timeline view by invoking a method which recalculates the macrocycle timeline calculation
algorithm.
• Switch to view a different segment’s macrocycle timeline.
• Print the displayed macrocycle view

Public Information
9.2.2.4 Attached Segment Summary View
When segments are attached, the Summary View displays the following tabs:
• Summary
• Link Settings
• Link Master Information
• System Management Information
➢ To display the attached segment Summary View: from the ToolboxST System Editor Tree View, double-click
the Mark VIe component (FF3) to display the Component Editor.
From the Hardware tab

Tree View , select the
attached Segment
(PFFA-21_Segment1 ).
The Summary tab displays the linking device, attached segment, and any attached H1 devices. The parameters displayed on
the other tabs provide additional configuration options for the linking device and the segments attached to it.
PFFAH1A Attached Segment Summary Tab View
Public Information
The Link Settings tab displays the Name ,
Description, Range, and Value of the link.
The Link Master Information tab displays the Name , Description,

Range, and Value of the link master for the link.
The System Management Information tab displays

the Name , Description, Range , and Value of the
system management functions of the link.

Public Information
PFFA Configuration Parameters
The following tables provide a list and description of the PFFA configuration parameters displayed within each Attached
Segment Summary View tab.
Link Settings Tab Parameters

Name Description Range
ConsecUnpolledNodeld Range of consecutive node addresses that are not polled by the LAS 0 – 228
FirstUnpolledNodeld The node address of the first node not polled by the LAS 20 – 248
MaxInterChanSignalSkew It is an Unsigned8 variable whose allowable values are 0 and 7. 0-7
The attributes SlotTime and MaxResponseDelay should be set such that
MaxResponseDelay 4 – 11
the product represents the maximum response delay in octets of the device
This is the minimum inter PDU delay required by the device to operate
MinInterPduDelay 7 – 120
correctly
PostTransGapExtension It is an Unsigned8 variable whose allowable values are 0 and 7. 0–7
Each frame on the H1 link starts with a preamble octet which is used by the
receiving nodes (Devices) to synchronize to the signal clock. The number
PreambleExtension 0–7
of preamble(s) can be extended when setting this parameter. The default
value is 0. Networks including digital repeaters may require larger values.
The delay (caused by the physical device) between the last octet received
PerDIpduPhIOverhead 2 – 63
and the first octet received in the next frame
Transmission time for a byte or how fast the device can reply upon receipt
SlotTime 8 – 4095
of a PDU
The Link Index for this segment and is unique across all segments of this
ThisLink 4097 – 65535
controller
Can be selected. This is the highest resolution time sync class of which the
TimeSyncClass 0–5
device is capable.
Link Master Information Tab Parameters

As the accuracy of the LAS schedule has the highest priority
DefMinTokenDelegTime the remaining time for granting the token might be less than 2 – 32767
DefTokenHoldTime
Determines how long a device can hold a token (that is, how
DefTokenHoldTime 276 – 65000
much time the device can use for acyclic bus traffic)
The LAS Live list database of the link will be distributed in that
LasDatabaseStatusSpduDistributionPeriod 100 - 55000
time period to other LAS resp. link master devices on the link.
This parameter specifies the time that the LAS uses within a
LinkMaintTokHoldTime token rotation for link maintenance which is probing for new 292 – 65000
node addresses and sending LAS status frames.
This parameter specifies the internal delay time a Link Master
MaximumInactivityToClaimLasDelay device needs from the detection of the failure of a LAS to the 1 – 4095
time the Link Master sends a ClaimLAS request.
MaxSchedulingOverhead How fast the device can reply upon receipt of a PDU 0 – 63
This parameter specifies the target time in which all devices
TargetTokenRotTime 1 – 60000
have been given the token for acyclic data transfer.
In milliseconds – Time Distribution PDU will be sent on the bus
TimeDistributionPeriod 10 – 55000
in 95% or less of this time period.
Public Information
System Management Information Tab Parameters
This is the preset value for the SM service timeout timer in 1/32 of a
T1StepTimer millisecond ticks. It defines the time which the SM kernel of the host will 0 – 524288
wait for a response to a SM request to the field device.
The timer T2 is a sequence duration timer. Its purpose is to guarantee
T2Set AddressSequenceTimer that incorrectly performed or incomplete sequences are aborted in the 0 – 3000000
System Management Kernel of the device.
This time is used by the Sm kernel of the host after a new address was
T3SetAddressWaitTimer assigned to a field device to wait before checking for the field device at 0 – 2000000
the new node address.
This variable is the interval in seconds between time messages on the
ApClockSyncInterval 1 - 255
link. It is set by system management during node address assignment.

Public Information
9.2.2.5 Detach Segment from Linking Device Port
At times, due to system reconfiguration, problems with a linking device port, or for other reasons, a segment may need to be
detached.
Note All devices connected to a segment must be deleted before a segment can be detached.
➢ To detach a segment from a linking device port

1. From the ToolboxST System Editor Tree View, double-click the Mark VIe component to display the Component
Editor.
2. Select the Hardware tab.
3. Detach the desired segment.

Tree View , right-click
the Segment ( PFFA-
21_Segment4 ) and
select Detach Segment
The available Port (Port_FF4 )

displays in the Tree View .
Tip � A linking device can be deleted from the Hardware tab Tree View. This causes all segments to detach under the linking
device.
Public Information
9.2.2.6 Restore Segment Defaults
If multiple changes have been made to an attached segment and you want to return to the original attached segment
configuration, use the Restore Segment Defaults option.
➢ To restore segment defaults: from the ToolboxST System Editor Tree View, double click the Mark VIe
component (such as FF3) to display the Component Editor.
From the Hardware tab Tree

View , right-click the
Segment ( PFFA-
21_Segment3 ) and select
Restore Segment Defaults
9.2.2.7 Compatibility Revision

Beginning with ControlST V07.03, if an H1 device on a segment needs to be replaced with a new H1 device with a higher
device revision, the H1 placeholder does not need to be replaced if the new H1 device supports the compatibility revision of
the placeholder. The FOUNDATION Fieldbus H1 device property, Device Revision, displays the device revision. Prior to the
implementation of the Compatibility Revision feature, if a different H1 device revision was used as a replacement, ToolboxST
indicated that the device match was missing (mismatched). With the Compatibility Revision feature, ToolboxST reads the
compatibility revision and matches the H1 device placeholder revision to the replacement revision if the devices are
compatible. When the H1 device is downloaded, it is downloaded as if it were the revision of the original H1 placeholder.
Note Refer to the Device Definition (DD) files or the vendor for a list of compatible devices.

Public Information
9.2.3 Device Definition Files
Device Definition (DD) files enable an application to understand a fieldbus device. DD files can be imported at the system
(.tcw) level using the FOUNDATION Fieldbus DD Manager and at the controller (device) level during the Add H1 Field Device
process which uses the FOUNDATION Fieldbus DD Manager.
The DD file can also contain a set of processing routines that must be performed when the object is accessed or displayed.
These routines, called methods, are part of the DD file. They can be defined for each object present in a device. For example,
there are methods defined for calibration procedures associated with transducer blocks. Refer to the section Menus and
Methods for additional information.
➢ To import DD files using the DD File Manager

1. From the Start menu, select Programs, GE ControlST, ToolboxST, and ToolboxST to display the ToolboxST
System Editor.
2. If the correct system is not displayed, from the File menu, select Open System, locate and select the system .tcw file
(such as Salem_FF), and click Open. The system displays in the System Editor.
3. From the Tree View, double-click the controller to display the Component Editor.
From the View menu, select

FOUNDATION Fieldbus
DD Manager.
Public Information
From the DD
Importer dialog box ,
fieldbus device DD
files can be sorted by
Manufacturer,
Device Category ,
and Device Name .
Select the fieldbus

device to import DD
files for.
Click Import (1) .
The imported device

displays as
Imported .
Click Close .
The ToolboxST application can import DD files of the following type:
• .ff5 files (DDv5)

• .ffo files
• .sy5 files (DDv5)
• .sym files
Note The .cff file determines which DD files (.ffo, .ff5, .sym, or .sy5) for a device are imported.
Imported DD files can be viewed in the ToolboxST application’s System Editor and in the controller Component Editor from
the View menu using the FOUNDATION Fieldbus DD Manager. They also display during the Add H1 Field Device process which
uses the FOUNDATION Fieldbus DD Manager. The FOUNDATION Fieldbus DD Manager displays the DD files in the DD Importer
dialog box.

Public Information
9.2.4 Fieldbus Device Placeholders
The addition of fieldbus devices to a H1 segment involves the use of a placeholder. A fieldbus device placeholder is a
representation of a fieldbus device. They are created inside a Mark VIe controller. Before a placeholder can be tied to a
physical fieldbus device, it must go through the commissioning process. After commissioning, the fieldbus device becomes
live and active in the system and is included in the download process of the controller.
If you delete an H1 device that has associated blockware, perform a build of the
controller before you insert a new H1 device on the segment. This build will result in
errors if there are any function blocks on the Software tab that were assigned to the
H1 device that was deleted. These function blocks either need to be deleted or
unassigned and re-assigned to another H1 device block on that segment before a
successful build will occur. If these blocks are not unassigned and re-assigned, then
Attention there is a possibility that an inserted H1 device will generate the PDTags necessary for
the blockware to assume that the original H1 device is present and it will not rebuild
the macrocycle. This could potentially lead to build and download errors.
9.2.4.1 Instance (Add) a Fieldbus Device Placeholder

A fieldbus device placeholder is instanced into a Mark VIe controller from the Hardware tab.
➢ To instance a fieldbus device placeholder: from the ToolboxST System Editor Tree View, double-click the
Mark VIe component (such as FF3) to display the Component Editor.

View , right-click the Segment
(PFFA-21_Segment1 ) and
select Add H1 Device from the
shortcut menu.
Public Information
From the Add H1
Device Wizard ,
highlight the type of
fieldbus device
placeholder ( 848,
Fieldbus
Temperature Device,
Rosemount Inc.).
Click Next .

Public Information
Select a Device
Version from the
list (mandatory).
Select PD Tag and

enter a PD Tag for
the fieldbus device
placeholder .
Click Next .
Public Information
Review the
operation .
Click Finish.

Public Information
The device placeholder displays in the
Tree View and the Summary View .
PFFAH1A H1 Device Placeholder
Fieldbus Device Categories

Category Example
Coriolis Mass Flow/Density Viscosity Transmitter, Tank Radar Level Transmitter,
Unknown
Fieldbus Transmitter, and other devices not placed in other categories
Multivariable Field Indicator
Other
FBK Starter Kit
Temperature Temperature Transmitter
Pressure Pressure Transmitter
Flow Electromagnetic Flow meter
Final Element Control Valve Positioner
Final Control Element FPAC
Valve Positioner Valve Positioners (YVP)
Public Information
From the Tree View , select
the fieldbus device placeholder .
The Property Editor displays

the properties.
Fieldbus Device Properties

Device Alert Configuration Enable Device Alerts Set to true to enable the alerts for the device
Device Category Device category for H1 field device
Device ID H1 field device ID
Device Node Index Node ID that is unique across a segment
Identification Device Type FOUNDATION Fieldbus H1 field device type
Location Site location of H1 field device
Name Name of H1 field device
PD Tag Plant site unique value for H1 field device
Manufacturer ID Manufacturer ID registered with FOUNDATIONFieldbus
Manufacturer Name of vendor registered with the FOUNDATIONFieldbus
Manufacturer Name
that manufactured the device
Capability level Selected capability level of device
Miscellaneous
Supports Block Instantiations Displays as true if device supports block instantiations
CFF Revision Capabilities File revision for H1 field device
Revision DD Revision Device Description file revision
Device Revision H1 field device revision

Public Information
The ToolboxST Hardware tab displays information about fieldbus devices. When the system is online, the Hardware tab
displays the following:
• Indication if a fieldbus device is on the Live List in the Summary View
– If the fieldbus device is not in the Live List, a red X ( ) displays, the fieldbus
device is not online
• Indication if a fieldbus device is emitting a device alert or process alarm ( )

• Current fieldbus device state using the fieldbus device state overlay symbols
Note When a fieldbus device is added to a system, it acts as a placeholder until it is commissioned. The commissioning
process makes the fieldbus device live and active in the system.
The ToolboxST application classifies a fieldbus device in one of the following states:
• Uninitialized State
− Fieldbus device does not have a PD_TAG
− Fieldbus device does not have a permanent node address
– Overlay symbol:
• Initialized State
− Fieldbus device has a PD_TAG
− Fieldbus device does not have a permanent node address
− Fieldbus device revisions match placeholder revisions
– Overlay symbol:
• Commissioned State
− Fieldbus device has a PD_TAG
− Fieldbus device has a permanent node address
– Overlay symbol:
• Mismatch State
− Fieldbus device revisions have not been obtained. Check for a communications failure diagnostic to determine if
there is a problem or if it is just taking a while to update.
− Fieldbus device revisions do not match the placeholder revisions. Re-add the placeholder using a DD file matching
the revisions.
− Fieldbus device has a node address collision with a fieldbus device placeholder of a different type
− Fieldbus device has a node address that does not exist in the ToolboxST configuration
− No DD files are available for the fieldbus device in the ToolboxST DD file database
– Overlay symbol:
Public Information
The following diagram displays the fieldbus state transitions.
Fieldbus Device State Flow Diagram

Public Information
9.2.4.2 Fieldbus Device Placeholder Multiple Capability Levels
The Capability Level property can be edited if the device .cff file allows multiple capability levels. The ToolboxST
application imports it through the Add H1 Device Wizard.
After selecting a specific capability

level, the Capability Level displays
in the Hardware tab Property
Editor for the device placeholder
(Default level displays when the
level has not been changed ).
This differentiates among the multiple

capability levels for the device.
Public Information
An offline function block application configuration can be built in the Component Editor Software tab using the instanced
function blocks available in the Hardware tab that pertain to the selected capability level of the device placeholder. The
ToolboxST application builds the function block application configuration using the instanced blocks and downloads it to the
device through the Download Wizard.
Once the device placeholder is added with a capability level it cannot be modified in the ToolboxST application. The device
placeholder must be removed and a new one added with the desired capability level. The ToolboxST application handles the
cases in which blocks that were assigned in the Software tab are not available after the placeholder is removed and the new
one added with a different capability level. This is done by first making the blocks unassigned, but keeping the reference tags.
When a new device is added with the same reference tags, the blocks are automatically found and assigned to the device.
9.2.4.3 Fieldbus Device Placeholder Summary View

➢ To display a fieldbus device placeholder Summary View: from the ToolboxST System Editor Tree View,
double-click the Mark VIe component (such as FF3) to display the Component Editor.
From the Hardware tab Tree View , select the fieldbus device placeholder
[3051 (PFFA-21_1_20 )] to display the device in the Summary View .

Public Information
➢ To display a fieldbus device placeholder configuration: from the ToolboxST System Editor Tree View,
From the Hardware

tab Tree View ,
expand the field
device placeholder
[3051 (PFFA-
21_1_20) ] and
select one of the
fieldbus blocks
(Resource Block
2) to display a
tabbed view of all
parameters inside
the selected fieldbus
block in the
Summary View .
The parameters are

grouped in tabs
defined by the
parameter’s class ,
attribute, and other
specific groupings .
The possible groups

are shown in the
following table .

Public Information
Examples of possible no_download parameters include:
• XD_CAL_DATE
• XD_CAL_LOC
• XD_CAL_WHO
• (Manufacturer-specific calibration values)
Note A host that conforms to a specification level that precedes the addition of this capability will likely ignore this
capability and may download parameters that are listed in the no_download collection. Such a host may support a
non-FF-standard mechanism to prevent download of certain parameters.
Block Parameter Summary View Tabs

Tab Description
Inputs Block parameters whose values can be determined by the output of another block
Outputs Block parameters whose values can be accessed by another block’s input
Configuration Block parameters that cannot be referenced by another block’s input or set by a block’s output
Block Dynamics Variables modified by a field device without stimulus from the fieldbus network
Diagnostics Variables indicating device status
Service Used when performing routine maintenance
Operate Block parameters manipulated to control a block’s operation (for instance, set point)
Alarm Block parameters containing alarm limits
Variables used locally by host applications. Local variables are not stored in a fieldbus device. For
Local example, a local variable can be used to guide the menu structure (that is, the user edits a variable
and based on that value a new menu is presented).
Alarm Configuration Block parameters containing configuration for Fieldbus Device Alerts and Process Alarms
Parameters containing operation dynamics; Information required by a plant operator to run the
View 1
process. (Always present)
Parameters containing operation statics; Information which may need to be read once and then
View 2
displayed along with the dynamic data. (Always present)
Parameters containing all dynamics; Information which is changing and may need to be referenced
View 3
in a detailed display (Always present)
View 4 Parameters containing other statics; configuration and maintenance information (Always present)

Public Information
9.2.5 Device Level Blocks
To ensure device interoperability, FOUNDATION Fieldbus technology uses a fully specified, standard user layer based on blocks
and device descriptions (DDs). The user layer defines a function block application process (FBAP) using resource blocks,
function blocks, transducer blocks, system management, network management, and DD technology.
➢ To view or edit device level blocks: from the ToolboxST System Editor Tree View, double-click the Mark VIe
From the Hardware tab Tree View,

expand a fieldbus device
placeholder, and select a block
(for example Resource Block 2).
The properties displayed in the

Property Editor can be modified
as needed.
Public Information
Fieldbus Device Block Properties
Block Index Index of block object in object dictionary
Plant site unique value for the block
The block must be taken Out of Service (OOS) to write the value during a
Block Tag
download. When a new block tag value is sent to a fieldbus device, the block that
is receiving the new block tag value must be placed OOS.
DD Revision DD revision of the block
Identification User-entry field to provide a name for a function block on an H1 device
The Device Tag can be used to locate a function block on an H1 device by
Device Tag running a report. The Device Tag field in the FOUNDATION Fieldbus Configuration
Report and the FOUNDATION Fieldbus Parameter Reconcile Report display the
Device Tag.
Number assigned by the fieldbus that uniquely identifies the profile on which the
Profile ID
block is based
Miscellaneous Enable View 1 for EGD When True, enables View 1 variables for EGD
Execution Period Time (in ms) between initiation of block execution (for periodic execution)
Schedule
Execution Time Total time (in ms) required for the block algorithm to run
9.2.5.1 Menus and Methods

Menus and Methods are available as a right-click option from Resource and Transducer blocks. Each menu includes a series
of items, such as variables, edit displays, methods, or other menus.
Methods are an optional (but highly desirable) addition to DD files. They are a set of read, write, and display related functions
defined for each variable accessed from the device. The Method Interpreter tells the host what messages to send and allows
conditional behavior of the host based on the response. Methods are used to define/automate procedures (such as calibration)
for operation of field devices. All user selectable methods are referenced from a menu.
Menus organize the DD visualization elements such as Graphs, Charts, Grids, Images, and Methods in the Host user interface.
The menus can be present at device level and at block level. The following are the types of menus:
Context menu It is typically a root menu that pops up on the right-click of the device tree node or block node under the
device.

Public Information
Window menu The user interface of this menu is a window. It contains the visualization elements whose layout of the
window comes from the device definition. The following are examples:
• Graphs
A graph is used to display a data set that is stored in a device. The main user interface elements of a graph are the X and Y
axis, the waveforms, and the legends.
• Charts
A chart is used to display continuous data values from the device. The main user interface elements of a chart are the X and Y
axis, the waveforms, and the legends.
Public Information
• Grids
A grid is used to display vectors of data along with the heading or description of the data in that vector. The vectors can be
displayed horizontally (rows) or vertically (columns).
• Image
The image displays the graphic image on the Menu window.
• Method
A method defines a set of actions to be performed by the host. Methods are a collection of statements that come as scripts in
the DD file given by the device developer. The execution of methods can lead to offline configuration changes or online
parameter value changes. The method wizard in the host application UI allows the user to run the methods step-by-step and
also allows the user to see the messages being sent out by the device to the host. The wizard also has the option of logging all
the messages that were sent back by the device.

Public Information
9.2.5.2 Resource Blocks
The resource block describes characteristics of the fieldbus device such as the device name, manufacturer, and serial number.
The following conditions apply:
• The user cannot make modifications

• The user can change parameters
• There is only one resource block in a device
• The resource block is the only obligatory block in FOUNDATION Fieldbus devices
• The resource block contains ID information and general information related to the whole resource or state of the resource
(no real details about device functionality).
9.2.5.3 Transducer Blocks

The transducer blocks are used to configure devices. Transducer blocks decouple function blocks from the local input and
output functions required to read sensors and command output hardware. (This is where parameterization, calibration, and
diagnostics for the device are done.) They contain information such as calibration date and sensor type. There is usually one
transducer block channel for each input or output of a function block.
9.2.5.4 Function Blocks

Function Blocks (FBs) are used in user-defined function block applications to provide various functions required in a control
system (such as input, output, signal selection, and other control actions). The fieldbus has defined several device profiles
outlining the root requirement for several device types. This includes pressure, temperature, valves, and some others. Function
blocks are built into fieldbus devices, as needed, to achieve the desired control functionality.
The macrocycle is a time interval that represents a single iteration of the function block schedule within a device. Most
function blocks perform once per macrocycle, but they can be scheduled to perform more than once per macrocycle by
providing more than one entry for them in the schedule. Refer to the Mark VIe Control FOUNDATION Fieldbus Block Library
(GEI-100758) for additional information.
Certain fieldbus devices also support the following:
Enhanced Function Blocks are standard fieldbus function blocks which have been enhanced with additional parameters by
the manufacturer. The ToolboxST application supports these enhanced fieldbus function blocks in all operations and contexts
the standard fieldbus function blocks are supported (for example Assigning and Dynamic Help).
Profiled Custom Function Blocks are standard fieldbus function blocks which have been extended with parameters by the
manufacturer. The ToolboxST application supports these Profiled Custom Function blocks in all operations and contexts the
standard fieldbus function blocks are supported (for example Assigning and Dynamic Help).
Public Information
9.2.5.5 Block Instantiation and Removal
Certain fieldbus devices support block instantiation (it displays in the Hardware tab Property Editor). This means that a
fieldbus device has a particular number of slots to be customized. The user can instance a certain number of supported blocks,
defined in the device’s .cff files, into the fieldbus device. These blocks can then be used throughout the configuration tool.
The ToolboxST application enables block instantiation inside of fieldbus devices that support the feature.
➢ To perform a block instantiation

1. From the ToolboxST System Editor Tree View, double-click the Mark VIe component (FF3) to display the
Component Editor.
From the Hardware tab Tree View , right-click a

fieldbus device that supports block instantiation
[ 2051 (PFFA-21_1_20) ] and select Block
Instantiation from the shortcut menu.

Public Information
From the Block Instantiation dialog box , in the Instantiable Block Type(s)
list, select the type of block ( Analog Input) to instantiate and click Instantiate.
The block displays in the Instantiated Block(s) list.
Click OK .
Public Information
2. The Hardware tab Tree View displays the instantiated block and the internal data model is updated with the
instantiated block(s).
Instantiated blocks can also be removed.
➢ To remove instantiated blocks

Component Editor.
From the Hardware tab Tree View , right-click a

fieldbus device that supports block instantiation
[ 2051 (PFFA-21_1_20) ] and select Block
Instantiation from the shortcut menu.

Public Information
From the Block Instantiation dialog box , select the
instantiated block to be removed and click Remove .
2. The Hardware tab Tree View is updated, along with the internal data model, removing the instantiated block.
Public Information
9.2.5.6 Sorting of Fieldbus Blocks
A fieldbus device placeholder’s fieldbus resource, transducer, and function blocks are sorted and display in the following
order:
• Resource block
• Transducer blocks by block tag
• Function blocks by profile ID then by block tag
Note The ToolboxST application ensures that all tag names are mutually exclusive throughout a Mark VIe component,
which means all PD tags and block tags are mutually exclusive of each other as well.

Public Information
9.2.6 Fieldbus Enabled Logic
Application code can be created which includes any combination of fieldbus and Mark VIe function blocks. A special
fieldbus task contains logic which contains only fieldbus function blocks, or a combination of fieldbus and Mark VIe function
blocks.
9.2.6.1 Create a Special Fieldbus Task

Special fieldbus tasks can be defined in a Mark VIe component or in a library.
➢ To create a Special Fieldbus Task in a Mark VIe component: from the ToolboxST System Editor Tree View,
From the Software tab, right -click a Program (Prog1 ),

select Add S pecial Task , and Add FOUNDATION
Fieldbus Task from the shortcut menu .
Public Information
From the Add FF Task
dialog box , enter a Name
for the task ( Fieldbus).
Click to select the Select

Library Block checkbox
and select the Library
Block(s ) to add .
Click OK .
A Task displays in the

Tree View with a fieldbus
icon.
From the Tree View , select

the task (Fieldbus).
From the Property Editor,

the properties in the
following table display .

Public Information
Special Fieldbus Task Properties
Appearance Description Description of this task
Name Name of the task
Automation Instance Script Script that runs when the task is instanced
Help File Locally assigned help file
Help Text Locally defined help that supersedes global help
Protection Consists of the following four options for access rights:
- Access Roles Assign user roles to protect each access right for this object
General
- Modify Data Permits modification of data values and forcing of variables
- Modify Design Permits modification of the design
- View Design Permits viewing of the design
Version User defined version of a user block
Denotes how often the task is run based upon which segment macrocycles are
involved with assigned fieldbus function blocks.
Scheduling
Execution Rate Execution Rate = All Macrocycle rates to which assigned fieldbus function blocks
belong rounded to the next frame using the frame multiplier and schedule offset for
the Mark VIe controller.
Select FOUNDATION Fieldbus from the

From the Summary View , the
drop-down list to display the FOUNDATION
fieldbus task editing space displays.
Fieldbus blocks available for use.
Public Information
A special fieldbus task provides several key items including:
• ToolboxST block palette

− The ToolboxST block palette for a special fieldbus task displays the generic fieldbus function blocks in the
FOUNDATION Fieldbus category in addition to the traditional Mark VIe function block categories.
− The ToolboxST application only supports the generic fieldbus function blocks listed in the section Instance Generic
Fieldbus Function Blocks in standard and enhanced forms.
• A fieldbus task icon ( ) displays in the Tree View.

• Block editing space in the Summary View where:
− Unassigned generic fieldbus function blocks display Unassigned in black, where the PD tag would be for an
assigned function block. They also display a question mark icon ( ) in the upper right hand corner.
− Assigned fieldbus function blocks display the PD tag, in green, in the fieldbus device the function block is assigned
to. An operation icon in the upper right hand corner (such as for the FF_AI block) replaces the question
mark.
− Only Mark VIe function blocks are given execution orders as the fieldbus function block execution order in the
macrocycle is determined by connection.
• Standardized ToolboxST logic sheet border

Public Information
➢ To create a special fieldbus task inside a Library: from the ToolboxST System Editor Tree View, double-click
the Library Container (L1 to display the Component Editor).
From the Software tab Tree View , right-click a Library

(Lib1 ), select Add Special Task , and Add FOUNDATION
Fieldbus Task from the shortcut menu.
Enter a Name for the

new Task Definition
(Lib1Task1 ) and
click OK .
Public Information
The task displays in the Tree View .
Select the task ( Lib1Task1 ).
From the Property Editor, the

properties listed in the following
table display.

Public Information
Special Fieldbus Task Properties
Description Editable description of this task
Appearance
Name Name of the task
Automation Instance Script Script that runs when the task is instanced
Detached Summary File Path to a summary diagram for the task definition
Help File Locally assigned helpfile
Instance Name Instance name for a newly-created instance
Protection Consists of the following four options for access rights:
- Access Roles Assign user roles to protect each access right for this object
- Modify Data Permits modification of data values and forcing of variables
General
- Modify Design Permits modification of the design
- View Design Permits viewing of the design
Revision History History of revision made
Version User defined version of a user block
Visualization Consists of the following two visualization settings for this task:
- Path to Visualization Path to the visualization file for this task
- Visualization Type Selects how the visualization for this task will be presented
Group Category Name of a category to which this task belongs
Scheduling
Schedule Offset Offset from the beginning of frame at which the task runs
While creating a special fieldbus task inside a library, the following can be performed:
• Instance Mark VIe function blocks into a special fieldbus task.

• Instance generic fieldbus function blocks into a special fieldbus task.
− A generic fieldbus function block can be assigned or unassigned inside a library special fieldbus task.
• Support automation to assign unassigned fieldbus function blocks by using a substitution string attribute when instancing.
Public Information
9.2.6.2 Instance Generic Fieldbus Function Blocks
Generic fieldbus function blocks can be instanced into the editing space of a special fieldbus task by dragging the appropriate
generic fieldbus block from the FOUNDATION Fieldbus block palette into a special fieldbus task. Refer to the Mark VIe Control
FOUNDATION Fieldbus Block Library Instruction Guide (GEI-100758) for detailed information about the function blocks.
➢ To instance a generic fieldbus function block into a special fieldbus task: from the ToolboxST System
Editor Tree View: double-click the Mark VIe component (such as FF3) to display the Component Editor.
From the Software tab Tree

View , select the fieldbus task
(Fieldbus).
The available blocks display in

the Summary View .
From the Summary View , select

FOUNDATION Fieldbus from the drop-down
list.
Select the block ( FF_CC ) and drag -and -drop it

onto the editing space .
From the Property Editor, the properties listed

in the following table display .

Public Information
FOUNDATION Fieldbus Block Properties
Block Type Name of the block of which this block is an instance
Appearance
Unique identifier that allows the block (as well as its attributes and pins) to be referenced
Instance Name
from other places in the tool
Assignment Block Assignment Block tag name of the assigned block
Automation Instance Script Script that runs when the block is instanced
Height Height if the block in the diagram
Left Location of the left of the block in the diagram
Selected Pin Pin currently highlighted (click a pin to select it)
Diagram
Show Description When true, the description text for the block is displayed on the diagram
Top Location of the top of the block in the diagram
Width Width of the block in the diagram
Publish View One
EGD When true, the FOUNDATION Fieldbus block’s View One is published on EGD
on EGD
Detached Summary
Backsheet for the selected block
General File
Version Version number of the source for this block instance
Public Information
Each unassigned generic fieldbus function block has a question mark icon ( ) as its operational icon. When the generic
fieldbus function block is assigned, the question mark operational icon is replaced with the specific operational icon (such as
for the FF_AI block) that identifies the function of the function block. The ToolboxST application supports the
following generic fieldbus function blocks in standard and enhanced forms:
Block Label Operational Icon
Analog Alarm FF_AAL
Analog Input FF_AI
Analog Output FF_AO
Arithmetic FF_AR
Bias/Gain Station FF_BG
Custom Control FF_CC
Custom Calculation FF_CCL
Custom Input FF_CI
Custom Output FF_CO

Public Information
Control Selector FF_CS
Device Control FF_DC
Discrete Input FF_DI
Discrete Output FF_DO
Dead Time FF_DT
Input Selector FF_IS
Integrator FF_IT
Lead Lag FF_LL
Public Information
Multiple Analog
FF_MAI
Input
Multiple Analog
FF_MAO
Output
Multiple Discrete
FF_MDI
Input
Multiple Discrete
FF_MDO
Output
Manual Loader FF_ML
Output Splitter FF_OS

Public Information
P, PD Controller FF_PD
PID, PI, I Controller FF_PID
Ratio Station FF_RA
Signal
FF_SC
Characterizer
Setpoint Ramp
FF_SPG
Generator
Timer FF_TMR
Unassigned Unassigned
Public Information
9.2.6.3 Special Operations
The following operations can be performed while defining fieldbus logic:
• Assign a generic fieldbus function block to a fieldbus device placeholder

• Unassign a fieldbus function block from a fieldbus device placeholder
• Connect Blocks
• Place a fieldbus function block on EGD
• View a fieldbus task’s macrocycle timeline
Assign a Generic Fieldbus Function Block to a Fieldbus Device Placeholder
➢ To assign a generic fieldbus function block to a fieldbus device placeholder: from the ToolboxST System
Editor Tree View, double-click the Mark VIe component (FF3) to display the Component Editor.
From the Software tab Tree View , expand and select a task ( Fieldbus),
the attached blocks display in the Tree View and Summary View .

Public Information
From the Summary View ,
right-click the generic fieldbus
function block (FF_AO_1 )
and select Assign from the
shortcut menu.
From the FOUNDATION

Fieldbus Block
Assignment dialog box ,
expand the fieldbus device
placeholder ( 3150 ) to
display the fieldbus function
blocks of the same type.
Select a block (Analog

Output) and click OK .
Tip � The ToolboxST application only displays linking devices, attached segments, and fieldbus device placeholders which
contain the same type of generic fieldbus function block (AO in this example) trying to be assigned, to filter the selection
paths for the user.
Public Information
The extended parameters and extended
From the Hardware tab Tree View , select the functionality for the assigned block display
block ( Analog Output) that was assigned. in the Summary View Parameter
Editor in tabs .
Tip � Only the set of parameters that exist in both the previous generic fieldbus function block and the newly assigned
fieldbus function block retain their configured values when being changed from a generic fieldbus function block to an
assigned fieldbus function block.

Public Information
The following occur when a generic fieldbus function block is assigned:
• The PD tag of the fieldbus device placeholder that the block was assigned to displays (in blue) in the Software tab
Summary View with the fieldbus function block.
• An operational icon (such as ) replaces the question mark icon ( ) in the upper right-hand corner of the
fieldbus function block display.
• The fieldbus task’s execution rate is updated and displays in the Software tab Property Editor.
• The ToolboxST application updates the object model to indicate the current fieldbus task is associated with the segment
that owns the newly assigned fieldbus function block.
Unassign a Fieldbus Function Block from a Fieldbus Device Placeholder
➢ To unassign a fieldbus function block from a fieldbus device placeholder: from the ToolboxST System
Editor Tree View, double-click the Mark VIe component (such as FF3) to display the Component Editor.
Public Information
From the Software tab Tree View , expand and select a task ( Fieldbus),
the attached blocks display in the Tree View and Summary View .
From the Summary

View , right-click a
fieldbus function block
(FF_AO_1 ) and
select Unassign from
the shortcut menu.
The block is
unassigned .

Public Information
The following occurs when a fieldbus function block is unassigned:
• The PD tag of the fieldbus device placeholder which the block was assigned to is replaced with Unassigned in black.
• The operational icon (such as ) is replaced with the question mark icon
( ).
• The fieldbus task’s execution rate is updated and displays in the Software tab Property Editor.
• The ToolboxST application updates the object model to indicate the fieldbus task is no longer associated with the
segment that owns the unassigned fieldbus function block.
Public Information
Connect Blocks
Fieldbus function blocks can be connected to ToolboxST function blocks (as long as the data types match on both pins being
connected) by using the standard wiring tool ( ) or the drag-and-drop features that exist in the ToolboxST application.
The following are examples of connections in a fieldbus task:
Straight Fieldbus Function Block Connection
Fieldbus Function Block to Mark VIe Function Block to Fieldbus Function Block Connection
If an improper connection is attempted, a flashing Red X displays and

holding the cursor over the X displays a ToolTip explaining the problem .

Public Information
Place a Fieldbus Function Block on EGD
Fieldbus function blocks can be placed on EGD. This operation takes all parameters from View 1 and places them on the
default EGD slow page (updated about every 5 sec) with unique names. This enables the drag-and-drop technology from the
ToolboxST application to the CIMPLICITY screens.
➢ To place a fieldbus function block on EGD: from the ToolboxST System Editor Tree View, double-click the
Mark VIe component (FF3) to display the Component Editor.
From the Software tab Tree View ,

select the fieldbus function block
(FF_AO_1 ) to place on EGD.

EGD section, select Publish View
One on EGD and select True from
the drop-down menu .
If the block is assigned, the block’s

View One data is published on EGD .
If the block is not assigned, the

ToolboxST application remembers
the action and when the block is
assigned, the view one data is
published on EGD.
Public Information
9.2.6.4 Block Properties
Fieldbus blocks contain properties which can be configured and applied to commissioned online fieldbus devices. The
fieldbus block properties are edited in the Component Editor in the Property Editor. The fieldbus function, transducer, and
resource blocks are edited in the Hardware tab while the fieldbus function blocks can also be edited in the Software tab.
Fieldbus Block Properties in Hardware Tab Property Editor
Section Property Description
Block Index Index of the block object in the block library
Block Tag A plant site unique name for the block
Identification DD Revision The DD revision of the block
Number assigned by the fieldbus that uniquely identifies the profile on which the
Profile ID
block is based
Miscellaneous Enable View1 for EGD Enables View1 variables for EGD
Execution Period The time between initiation of block execution (for periodic execution) in ms
Schedule
Execution Time The total time required for the block algorithm to run in ms
Fieldbus Alarm Parameters (ending with _ALM) Properties in Software Tab Property Editor
Section Property Description
The value assigned when the alarm is in the active state. Used for filtering and
display in the WorkstationST Alarm Viewer. Valid range is 1-1000 where 1 is the
Active Severity
least severe. The range and usage is defined by OPC® for use in OPC AE
clients and servers.
For a Boolean variable, select the Alarmed string to make the variable an alarm.
Alarm
For an analog variable, select an alarm definition.
Alarm Class Select a System Configured Alarm Class
Alarm Inhibit Group Select the Alarm Inhibit Group for the alarm variable
Alarm On Zero Set to True to cause the alarm on a 1 to 0 transition. Requires Alarm = True
Alarms and Events Event Set to True to enable the variable as an Event.
Hold Set to True to enable the variable as a Hold.
The value assigned when the alarm is in the normal state. Used for filtering and
display in the WorkstationST Alarm Viewer. Valid range is 1-1000 where 1 is the
Normal Severity
least severe. Range and usage are defined by OPC for use in OPC AE clients
and servers.
Used to group variables into logical plant groupings for display in the
Plant Area WorkstationST Alarm Viewer. This is used instead of the HMI Resource due to
string length limitations.
SOE Description Description used for SOE.

Public Information
9.2.6.5 Block Parameters
Fieldbus device block parameters can be viewed from the Hardware tab. Unassigned generic fieldbus function block default
parameters can be modified.
➢ To display block parameters

Component Editor.
2. Select the Hardware tab.
3. From the Tree View, select an assigned block (such as an Analog Output). The parameters for the selected block are
displayed within the tabs in the Summary View.
Block Parameter Tabs
Note The tabs are vendor-dependent, so not all of these tabs may display for a device.
Public Information
The available tabs for each block type and the block parameter configuration columns within these tabs are described in the
following tables.
Fieldbus Device Block Parameter Tabs

Block Type Tab Description
Block parameters that cannot be referenced by another block’s input or set by a
Configuration
block’s output
Operate Block parameters manipulated to control a block’s operation (for instance, set point)
Variables used locally by host applications. Local variables are not stored in a fieldbus
Local device. For example, a local variable can be used to guide the menu structure (that is,
the user edits a variable and based on that value a new menu is presented).
Block parameters containing configuration for Fieldbus Device Alerts and Process
Resource Alarm Configuration
Alarms
Parameters containing operation dynamics; Information required by a plant operator
Resource View 1
to run the process (always present)
Parameters containing operation statics; Information which may need to be read once
Resource View 2
and then displayed along with the dynamic data (always present)
Parameters containing all dynamics; Information which is changing and may need to
Resource View 3
be referenced in a detailed display (always present)
Parameters containing other statics; configuration and maintenance information
Resource View 4
(always present)
Configuration
block’s output
The group of Block parameters that may need to be manipulated on a daily basis (for
Operate
example, set point).
Alarm Configuration
Alarms
Transducer Parameters containing operation dynamics; Information required by a plant operator
<Transducer> View 1
<Transducer> View 2
<Transducer> View 3
<Transducer> View 4
(always present)

Public Information
Fieldbus Device Block Parameter Tabs (continued)
Block Type Tab Description
Configuration
block’s output
Outputs Block parameters whose values can be accessed by another block’s input
The group of Block parameters that may need to be manipulated on a daily basis (for
Operate
example, set point)
Variables used locally by host applications. Local variables are not stored in a fieldbus
Local device. For example, a local variable can be used to guide the menu structure (that is,
the user edits a variable and based on that value a new menu is presented).
Function
Alarm Configuration
Alarms
Parameters containing operation dynamics; Information required by a plant operator
<Function> View 1
<Function> View 2
<Function> View 3
<Function> View 4
(always present)
Block Parameter Configuration Columns

Column Description
Name Parameter name used in the selected block (read-only)
Description Primary language description for parameter
Value Configuration value that is stored in ToolboxST
Select this option to exclude this parameter from download. Used when the DD file does not
mark a parameter as read-only when it should be.
If this column does not display, right-click in the table and select Show All Columns.
Exclude From Download

Only personnel experienced with the technology
and specific instrumentation involved should use
the Exclude from Download option.
Caution
Help Text Vendor-supplied help description for the parameter
Alternate Help Text Alternate vendor-supplied help description for the parameter
Public Information
9.2.7 Fieldbus Device Alerts
With the release of the ControlST* CD Version 04.03 the WorkstationST Alarm Viewer can now display fieldbus alerts. These
alerts are configured by alarm class as alarms, diagnostics, and so forth. FOUNDATION Fieldbus technology uses the existing
infrastructure, so all customization features typically available with the Alarm Viewer are available for FOUNDATION Fieldbus
alerts.
The following behaviors are supported from the Alarm Viewer, OPC AE Server, and GSM Server:
• Acknowledge
• Silence and Unsilence
• Lock
• Unlock
• Reset
• Filtering
− By fieldbus and non-fieldbus
− By fieldbus process alarm versus fieldbus device alert
− By device
− By plant area
Note Unacknowledged behavior is not supported because the state machine inside fieldbus devices does not support this
function.
Note Fieldbus Device Alerts (unlike ControlST Boolean alarms, Analog Alarms, Events, and Holds) are not available in
application code, meaning application code cannot be triggered to run when a Fieldbus Device Alert occurs. The Fieldbus
Device Alerts are available for online view and interaction from HMIs, Maintenance Workstations, and third-party software
through OPC AE Server, GSM Server, and WorkstationST Alarm Viewer.
Note To display or otherwise configure the FOUNDATION Fieldbus alerts, they must be enabled in the H1 device.

Public Information
➢ To enable H1 device alerts: from the ToolboxST System Editor Tree View, double-click the Mark VIe

View , select an H 1 device
(3051 ).

Device Alert Configuration
section, select Enable Device
Alerts and select True from the
drop-down menu .
After the device is commissioned,

it can send alerts.
To use the device alerts they must be added to the application code (FOUNDATION Fieldbus task).
➢ To add alerts to a FOUNDATION Fieldbus task

1. From the Component Editor Software tab, select a block (FF_AR Block).
2. Enable configuration for alerts for the device.
From the Summary View Alarm Configuration tab ,

when alerts have not been enabled , this alert displays.
Follow the directions provided .
Public Information
From the Summary View Alarm Configuration
tab, click select the functions to enable.
Note The UPDATE_EVT function cannot be disabled.
The Property Editor displays the

properties for the selected alarm.
3. From the tool bar, click the Build button.
4. From the tool bar, click the Download button to download the controller and the H1 device.
Note Downloading directly to the H1 device is not allowed (different from an I/O pack).

Public Information
Device Alert Properties
Category Property Description
True if Alerts are enabled for the device. To edit this parameter select the
Device Alert
Device Alerts Enabled parent device then change the value in the parameter grid. If this property
Configuration
is false, then all editing in the Alarm Configuration tab is disabled.
Alarm Limit Parameter The FOUNDATION Fieldbus parameter responsible for the Alarm Limit of the
Name current Fieldbus Alert.
Alarm Limit Value The alarm limit setpoint for the fieldbus Alert.
Alarm Priority Parameter The FOUNDATION Fieldbus parameter responsible for the Alarm Priority of
General Name the current Fieldbus Alert.
The FOUNDATION Fieldbus alarm priority or N/A if not defined. The value is
automatically set when the alert is enabled. The user can override the
Alarm Priority Value
default value assigned. The allowable range is from 2 to 15. The value 0
is assigned if the alert is disabled.
Public Information
The following existing entities that have fieldbus placeholders that are either commissioned or decommissioned, or fieldbus
function blocks that are either assigned or unassigned can be imported or exported:
• Device
• Library Container
• Watch Window
• Live View
• FF Configuration
• Global Variable Report
• Block Pin Report
• Programs
• Trender Data
• Primary and Second Language Descriptions
After the import:
• The Unknown icon displays for any fieldbus device placeholder for which DD files cannot be found.
• A previously assigned fieldbus function block in a fieldbus task becomes unassigned if the fieldbus device placeholder is
not found
Note The imported device does not bring along the DD files it referenced.
9.2.8.1 FOUNDATION Fieldbus H1 Device Import/Export

The FOUNDATION Fieldbus H1 device import/export feature enables the user to export a .xml template file for a specific
FOUNDATION fieldbus H1 device type. The .xml template is then used to import any changes made to the template device into
target FOUNDATION Fieldbus H1 devices of the same type.
The Export H1 Template menu option is displayed at the FOUNDATION Fieldbus H1 device level.
Note This feature currently supports a one-to-multiple import; however, the user has to multi-select the individual target H1
devices for import. This is currently limited to a per-segment multi-select function.
Note All parameters in a FOUNDATION Fieldbus H1 device have a default value. Currently, the only parameters included in the
exported .xml template file are parameters that have had their default values changed. Any exported parameters with a default
value on the H1 device will not be written into target H1 devices upon import.
For example:
FOUNDATION Fieldbus Device 1, TAG_DESCRIPTION = “ ”
FOUNDATION Fieldbus Device 2, TAG_DESCRIPTION = “FF Device 2 Tag”
FOUNDATIONFieldbus Device 1 (device being exported) did not change the default value of parameter TAG_DESCRIPTION
from “ ”. FOUNDATION Fieldbus Device 2 imports the template file from FOUNDATION Fieldbus Device 1. FOUNDATION Fieldbus
Device 2 still has TAG_DESCRIPTION = “FOUNDATION Fieldbus Device 2 Tag” because the TAG_DESCRIPTION parameter
for FOUNDATION Fieldbus Device 1 was still the default value, and, as a result, was not exported to the template .xml file.

Public Information
➢ To export an H1 device template
1. Select an H1 device and export a template .xml file.
Right-click the H1 device (at device

level ), and select Export H1 Template.
Any changes made to the default values are written to the template .xml file.
Modified Values Written to Template XML File
2. Name and save the template .xml files to the default location at the system level.
Note The default naming convention is FOUNDATION Fieldbus Device Name_FOUNDATION Fieldbus Device Type_
DeviceRevision; however, this name can be changed to provide more detail to the contents of the template .xml file.
Public Information
Example Template .xml File Name

Public Information
➢ To import an H1 device template
1. Select an H1 device for import.
H1 Device before Import (TAG_DESC)
2. Import the H1 device template from the default location containing the template XML file is at the system level.
Right-click the device and select

Import H1 Template.
Note The Info tab indicates import status and notifies the user when import is complete or if errors occurred.
Public Information
3. After the import is complete, enter a Tag description.
In the TAG_DESC field, enter the Tag description to export.
Device after Import (TAG_DESC)
9.2.8.2 Info Tab Log Messages

The Info tab displays log messages notifying the user of import status, import success, import failure due to a corrupt .xml
file, device being imported, and indicates matching or different device revisions, and different device types.
Example Log Message — Successful Import, Matching Devices Types, Matching Device Revisions
Example Log Message — Unsuccessful Import, Different Device Types

During import, the system attempts to write all parameters included in the template .xml file to the target H1 device.
However, parameters can be deleted or added between device revisions. As a result, the Info tab displays a list of parameters
that do not exist on the target H1 device, as well as a warning message notifying the user that different Device Revisions were
detected and manual validation of the parameter import is necessary.
Example Log Message — Successful Import, Matching Devices Types, Different Device Revisions

Public Information
9.2.9 Multiple Language Support
The following entities support multiple languages:
• Descriptions of fieldbus device alert parameters

• Descriptions of fieldbus process alarm parameters
• Descriptions of fieldbus parameters contained on View 1
The system-wide setting of the primary and second language is defined from the System Editor in the Property Editor.
After primary and second languages are set:
• All fieldbus parameters import the HelpText using the language codes for the Primary Language from the DD files (if
available).
• All fieldbus parameters import the alternate HelpText using the language codes for the second language from the DD
files (if available).
• If an item in the DD files only gives one string with no language code, it is assumed to be English. In this case the
alternate HelpText remains blank.
Note The primary and second language descriptions are user-editable text. These fields are not filled out from the DD files.
9.2.10 Build and Download Devices

The following devices and items are built and downloaded using the ToolboxST application:
• Linking device
− Schedule
− General configuration
− IP address
• Fieldbus device
− Parameter configuration
− VCRs to publish and subscribe data
− Node address
− Block tags
− Capability level
• Mark VIe controller
− Control data publish and subscribe information
− Fieldbus function blocks on EGD
− Alarm and diagnostic configuration
− Application code
− DHCP client table
− NTP configuration file
Public Information
9.3 Online View and Interaction
9.3.1 Linking Devices
Information about linking devices is displayed in the ToolboxST application Component Editor Hardware tab. An online
linking device displays error, warning, and informational symbols in the Hardware tab Tree View and the Summary View
Diagnostics tab. This information is driven from the alarm and diagnostic subsystems inside the Mark VIe controller for use
in the ToolboxST application.
A Red X displays when the

linking device is not online .
A Yellow Triangle displays

when there is an alert or
diagnostic.
From the Summary View Diagnostics tab, the

symbols display in addition to other information
regarding the error, warning, or information.

Public Information
9.3.2 Fieldbus Devices
Information about fieldbus devices is displayed in the ToolboxST application Component Editor Hardware tab. When the
ToolboxST system is online the fieldbus device placeholder displays various informational symbols in Hardware tab Tree
View.
If the fieldbus device is not in the live

list, the device is not online . (If not
online the device icon in the
Summary View is 50 % transparent.)
The current fieldbus device state

displays using the fieldbus device state
overlay symbols.
If a fieldbus device is emitting a device

alert or process alarm, a Yellow
Triangle displays.
If a fieldbus device placeholder is emitting a device alert or process alarm, active block alerts display an icon ( ) in the
Tree View at the block level and the following locations:
• The Fieldbus Block inside the Fieldbus Device Placeholder emitting the Device Alert or Process Alarm
• Fieldbus Device Placeholder which contains the emitting Function Block
• Linking device H1 Segment which contains the emitting Fieldbus Device Placeholder
• Linking device which contains the emitting linking device H1 Segment
The ToolboxST application classifies a fieldbus device in one of four states:
• Uninitialized ( )
• Initialized ( )
• Commissioned ( )
• Mismatch ( )
Decommissioned devices display in the Hardware tab as follows:
• From the Tree View under a linking device’s attached segment in an expandable item for decommissioned devices
• A warning icon on the attached segment’s icon
• A warning icon on the linking device’s icon to which the attached segment belongs
Note Refer to the section Fieldbus Device Placeholders for additional information, including fieldbus device state
transitions.
Public Information
9.3.2.1 Commission Fieldbus Devices
Fieldbus devices must be commissioned when they are put in service.
Note No more than one H1 device can be commissioned at a time.

The ToolboxST Download Wizard does not commission devices. Commissioning must be done manually.
If an H1 Device is received from the factory with an already assigned permanent node address, it is possible that it will not
display in the decommissioned list of the ToolboxST application's Hardware View. The following background information
and procedure should be used to clear this condition and allow the user to commission H1 devices.
Normally, H1 devices come from the factory without a permanent node address assigned. This allows the Link Active
Scheduler (LAS) to assign one of the FOUNDATION Fieldbus specified four default addresses (248, 249, 250, or 251) so they can
be added to the live list and then commissioned by the host system.
The H1 Datalink Layer addresses are defined as follows:
Address Range Use

0x00 - 0x0F Standard, global, and flat node addresses
0x10 - 0x13 Reserved for segment LAS
0x14 - First Unpolled Node (FUN = 37

Usable permanent node addresses
default)
FUN to FUN+Number of Unpolled Nodes Range of unused addresses defined in ToolboxST Link Settings. H1 devices
(NUN=210 default) in this range will not be in the live list.
FUN+NUN to 0xF8 Other usable permanent node addresses
0xF8 - 0xFB (248,249,250,251) default addresses - used for decommissioned devices

0xFB - 0xFF (252,253,254,255) visitor addresses - for temporary (handheld) devices
The ToolboxST application (by default) has link settings configured to optimize the communications with commissioned
devices on each H1 segment. This means that the First Unpolled Node (FUN) is set to be the highest node address that the
ToolboxST application assigns during the commissioning process (FUN = 37). It follows that the Number of Unpolled Nodes
(NUN) is set to the default value of 210.
In this way the default ToolboxST application's link settings with FUN=37 and NUN=210 makes it so that any H1 device with
a previously assigned permanent node address between the values of 37-247 will not be added to the live list and therefore
will not be displayed in the decommissioned list.
To change this the link settings can be modified so that the range of unpolled node addresses is set to zero until after the H1
device with the previously assigned permanent address has been cleared and is then displayed in the live list with one of the
default addresses (248, 249, 250, or 251).

Public Information
The following figure displays the ToolboxST application’s default settings.
➢ To set the range of unusable node addresses to zero

1. Enable modifications to the Linking Device parameter values as follows:
a. From the Options menu, select Settings.
b. For the Mark VIe Controller item, change the parameter Linking Device Parameters from Read-only to False.
2. Set ConsecUnpolledNodeID to 0.
3. Set FirstUnpolledNodeId to 247.
4. Perform a Build and Download.
Public Information
After the link settings have been changed and downloaded, the device displays in the decommissioned list where it can be
Cleared.
➢ To clear a device
From the Hardware tab Tree View , right-click the

device and select Clear from the shortcut menu.
After it is cleared, the device can be commissioned using the normal commissioning process for H1 devices.

Public Information
➢ To commission a decommissioned fieldbus device
1. From the ToolboxST System Editor Tree View, double-click the Mark VIe component (such as FFTest) to display
the Component Editor.
2. From the Hardware tab, expand the linking device (such as PFFA-21), the attached segment (such as PFFA-21_
Segment4), the Decommissioned Devices item, and right-click the decommissioned device (such as
1E6D1100FF) and select Commission from the shortcut menu.
Note Commissioning a new device follows the same procedure except the new device is selected instead of one from the
Decommissioned Devices list.
Note Devices configured for use with FOUNDATION Fieldbus cannot display actual device and DD revision information until
they have been commissioned in the ToolboxST application. Therefore, all available placeholders by the same manufacturer
display in the H1 Device Commissioning Wizard. Verify the correct revisions before selecting the placeholder to ensure the
correct one is selected.
Public Information
Tip � If the device's Device ID, Manufacturer ID, Device Revision, and DD Revision match a pre-configured H1 device
placeholder, the matching H1 device placeholder is highlighted. If any of these do not match a single H1 device placeholder,
H1 device placeholders that exist on the H1 segment which match the decommissioned live H1 device's Manufacturer ID and
Device Type display.

Public Information
3. When a fieldbus device placeholder is commissioned for the first time, a notification displays that the Mark VIe
controller must be downloaded to recognize a newly commissioned device.
Public Information
Note Instead of commissioning a mismatched device, if you perform a Clear operation and then a Commissioning operation,
the H1 Device Commissioning Wizard displays with placeholders of the same manufacture with different device type, device
revision and DD revision, in which the wrong placeholder used earlier to perform the commissioning operation matches the
Device ID with that of the live device. This results in a Mismatch state. In this case, perform the commissioning steps again as
previously described.

Public Information
9.3.2.2 Decommission Fieldbus Devices
➢ To decommission a fieldbus device
Component Editor.
2. From the Hardware tab, right-click the commissioned H1 device and select Decommission from the shortcut menu.
3. From the H1 Device Decommissioning Wizard, select which state (Uninitialized or Initialized) to move the
commissioned H1 device to and click Next. A summary displays which device is being decommissioned and to which
state it is being moved.
4. Click Next to decommission the device. A Decommissioning Manager dialog box displays with progress and status
column indicators:
• To move a commissioned H1 device to the uninitialized state, the ToolboxST application clears the commissioned
H1 device.
• If something fails, the status column displays a red error icon and failure text.
5. Click Close. (The Close button displays on the Wizard whether the decommissioning succeeds or fails.)
When a device is decommissioned:
• The Device ID is removed from the fieldbus device placeholder.

• The PD Tag is reset to default for the fieldbus device placeholder.
• The physical device that was tied to the fieldbus device placeholder displays with its temporary address under the
attached segment.
9.3.2.3 Clear Fieldbus Devices

Decommissioned devices can be cleared. Clearing a fieldbus device removes the PD_TAG and Permanent Node Address
from the device and places the device in a new, unused state. A fieldbus device is cleared using the ToolboxST application.
➢ To clear a fieldbus device

1. From the ToolboxST System Editor Tree View, double-click the Mark VIe component to display the Component
Editor.
2. From the Hardware tab Tree View, expand the Decommissioned Devices item, right-click the device and select
Clear from the shortcut menu.
3. The Singular Clearing dialog box displays with progress and status column indicators. If something fails, the progress
column displays a red error icon and failure text.
4. Click Close.
Public Information
9.3.2.4 Simulate Inputs from Fieldbus Devices
The VARSIM block can be used to simulate inputs from FOUNDATION Fieldbus H1 field devices. This can be used to test logic
in the controller without having the actual field devices.
There are four input block types that this technique applies to: FF_AI, FF_DI, FF_MAI, and FF_MDI. These block types
create global variables which are logically connected to the output pin(s). The names of the global variables are determined
by combining the Device and BlockSuffix attributes of the block. Example: If an FF_AI block is instanced with the following
attributes:
A global variable named 10HAD70CP001AI1 is created.

Public Information
➢ To display the global variable: from the Mark VIe Component Editor Software tab, expand the FF Task and
input block 10HAD70CP001:FF_AI, and select Variables. The global variable displays in the Summary View.
If the linking device or the field device associated with the block (by block assignment) is not present, then the live value of
the output has a Bad status such as 24 (NOT_LIMITED-NO_COMM_WITH_NO_USABLE_VALUE-BAD) as displayed in
the following figure:
To simulate a good value on the output pin, add a VARSIM block to the field device. Two connections must be made with a
VARSIM block: one for the value and one for the status. For the value, connect an output of the VARSIM block to the global
variable created previously in the FOUNDATION Fieldbus block. For the status, connect to the same global variable but add .
Status to the end of the variable name.
Example: To simulate a value of 17 with good status (128) for the FF_AI block discussed previously, create a VARSIM block
as displayed in the following figure:
The FF_AI block displays live simulated values marked with an S:
Public Information
9.3.3 Fieldbus Enabled Application Code
The following application code is available for use:
Watch Window can be used with the fieldbus function block pins connected to ToolboxST variables. For additional
information, refer to the section Watch Window in the chapter Mark VIe Component Editor.
Trender can be used with the following:
• Fieldbus function bock pins connected to ToolboxST variables

• Fieldbus function block parameters
Tip � Trender signals which are not of interest can be removed. For additional information, refer to the Trender Instruction
Guide (GEI-100795).
Custom Block Drawings are supported in the Software tab for fieldbus function blocks which provide the following
indicators:
• Fieldbus function block assigned or unassigned status

• Fieldbus function block emitting a process alarm or not emitting a process alarm
Process Values are viewed in the Software tab with the following options in the right-click Diagram Settings dialog box:
• Process value with status value option

• Process value with decoded status enumeration option
• Process value with status value and decoded status enumeration option
The ToolboxST application, in the Software tab, provides visual indication that:
• A process value has bad status

• A fieldbus function block is emitting a configured process alarm
Parameter data grids display a left-most Live Value column when online with the appropriate fieldbus device. This
maintains consistency with the Software and Hardware tab’s Live Value used for ToolboxST variables and I/O points. The
parameter data grid can enumerate the status value when online with the appropriate device.

Public Information
9.3.4 Download
The ToolboxST application downloads FOUNDATION Fieldbus configurations for linking devices and fieldbus devices. The
FOUNDATION Fieldbus Configuration and Integration (CIT) tool kit is the interface between the ToolboxST application and
FOUNDATION Fieldbus devices.
Beginning with ControlST V07.00, when a user makes a change to a FOUNDATION Fieldbus device, performs a Build, and
Downloads the changes to the controller or FOUNDATION Fieldbus devices, the download scan Wizard analyzes the internal
database (on disk) and displays any H1 devices, segments, or linking devices that are different. The progress bar indicates the
progress of the comparison analysis. Previous ToolboxST versions relied on ST_REV information from the controller live list
to determine equality and if a download was needed, which may have resulted in a longer amount of time for the controller
live list to be equal to the actual device ST_REV information. (For example, a successful download followed immediately by
a subsequent download scan might have shown inequalities due to the fact that the controller live list might not have been
updated for every device since the last download.) With the database difference analysis feature, database analysis time varies
depending on the size of the controller but there is no lag time for the analysis to complete after the completion of the
download. Additionally, the device ST_REVs are not read explicitly as part of the download process. Devices that need
updated ST_REVs read are initiated by the download but are not necessary for a successful download.
Database Differences Analysis at Device Level
Public Information
Database Differences Analysis at System Level
When a user performs a download for FOUNDATION Fieldbus devices using the Download Wizard, they can select from one of
the following download options:
• Incremental Parameter Download runs a system comparison and identifies which parameters were modified and
downloads only the parameters that were changed.
• Full Parameter Download performs a full system device download of all parameters for the device.
Note Users can run a Reconcile report to run a system comparison and determine if a full download is needed.
• PFFA Schedule Download performs a full parameter download to a PFFA (including all segments and H1 devices
configured on the PFFA) and ignores any non-commissioned H1 device placeholders. This download can be used when
scheduled communication (Software tab) issues are encountered. This option will clear and reset the PFFA schedule links
and any H1 device communications from the PFFA will be interrupted during the download.

Public Information
FOUNDATION Fieldbus Download Options
Note The options selected on the FOUNDATION Fieldbus Download Options dialog window are stored locally. The next
FOUNDATION Fieldbus download will retain the previous download selections.
Additionally, users have the option to select the number (1-5) of PFFA modules that will be downloaded in groups at one time
(in parallel). Downloading multiple PFFA modules at one time reduces the total time of the download process. However, the
amount of time an individual PFFA module takes to download can take longer than a serial download. In a parallel download,
all PFFA modules share the unused bandwidth on the H1 network for the download, in a serial download the PFFA module
being downloaded has access to all of the unused bandwidth on the H1 network for the download.
The Download Wizard does the following:
• Displays linking devices that need to be downloaded using the orange not equal sign
• Displays linking devices that do not need to be downloaded using the green equal sign
• Displays fieldbus devices that need to be downloaded using the orange not equal sign
• Displays fieldbus devices that do not need to be downloaded using the green equal sign
• Displays the status of the download
• Updates the download log as the download progresses
• Scans for differences in the ToolboxST configuration versus the actual configuration
• Places appropriate fieldbus resource, transducer, and function blocks OOS and then places them back in service as part of
the download procedure
• Displays red X icons on H1 device placeholders, listed by PD_TAG, that do not display on the live list as
commissioned to indicate it cannot find a matching commissioned H1 device
• Downloads multiple H1 devices in a download batch
• Instantiate blocks during the block instantiation phase of download
Public Information
• All H1 devices that are downloaded successfully have their ST_REV copied from the live list to display device equality
in the Controller I/O Status window. However, the ST_REV read is not considered part of the download process. Devices
that need updated ST_REVs read are initiated by the download but are not necessary for a successful download. ST_
REVs are read on a background thread.
Note It is possible for a database differences analysis to show that no downloads are necessary; however the controller
I/O Equality may show as Not Equal. There are certain cases in which when a change is made to a block, which results in
flagging the device's Resource Block as Needs to be Downloaded, and the change is undone. A Download scan will
display nothing to be downloaded but the Needs to be Downloaded flag does not get cleared by the undo action.
Performing a forced download to the device or reconciling parameters using a Parameter Reconcile report can establish
controller equality again.
The ToolboxST Download Wizard does not do the following:
• Commission devices (commissioning is a manual operation)

• Download items to decommissioned devices (fieldbus devices in the mismatch, initialized, or un-initialized state)
Note If the download options are changed on the FOUNDATION Fieldbus Download Options dialog window of the Download
Wizard, after the download is completed, the Save icon is enabled. If the user does not save the system and tries to perform
another download, the system notifies the user that the system has not been saved from the previous download. The user must
save before they are able to proceed with another download. Changes made on the FOUNDATION Fieldbus Download Options
dialog window will be remembered for the next download.

Public Information
9.3.4.1 Download Linking Devices
The ToolboxST application performs the download of a linking device in a similar manner to the download of an I/O pack.
The Mark VIe controller must be downloaded first for the linking device to be given the appropriate IP Address. Once the
linking device has an IP address, the linking device can be downloaded with the necessary information including:
• PD_TAG
• Link information
• Write the NTP MIB object with the correct time server IP address based on the configured redundancy information. The
following rules are used to determine the correct NTP time server:
− If the linking device is simplex then give the IONet addresses of whatever is on that IONet. (Example: if TMR
controllers and a simplex linking device are on T IONet, assign 192.168.3.10 and 192.168.3.9 or 8.)
− If a simplex controller and simplex linking device are on the IONet assign 192.168.1.8 and 192.168.2.8. Port
forwarding the linking devices can actually get to the different subnets, but if possible it makes sense to give the
address on the same subnet trying to span across multiple controllers to give redundancy.
• Write the transmission delay time
• Write the redundancy message configuration
• Write the optimized T3 timer and set the FF T3 timer=0
Note The CIT tool kit does not download the T3 timer so it has to be written to using FMS writes.
• Download the first unpolled node ID (FUN) and number of unpolled node ID's (NUN) based on the number of existing
nodes per segment if the user enters 0 for both of these settings.
Linking devices must be fully assigned (downloads complete) before fieldbus devices on H1 segments can be commissioned
and display live in the ToolboxST application. Using the Download Wizard, the rest of the linking device download occurs as
part of the download process to send schedule information.
Public Information
9.3.4.2 Download Fieldbus Devices
The ToolboxST application performs the download of fieldbus devices. The linking device must be fully assigned before
fieldbus devices can be downloaded. Fieldbus devices have the following information downloaded to them:
• Parameters download each time they are changed by the user and whenever the defaults read from the DD files are not
null or empty.
− Always set LIM_NOTIFY = MAX_NOTIFY unless it is less than 3. Then set LIM_NOTIFY=3
− Always set REPORTS to enabled in the FEATURE_SEL parameter.
− Always set CONFIRM_TIME = 640000.
Note The FOUNDATION Fieldbus Alarm Confirm Time option is set in the system settings for the Mark VIe control.
Refer to the section Controller Settings.
• Block instantiation information

• Capability file information
• FBAP and schedule
After a controller restart download on a redundant system, the linking device download needs to pend (about two minutes)
until the primary linking device is found at the designated controller. However, if it is a TMR system and T is the designated
controller (DC), then either R or S controller's linking device can be used.
In a simplex system (simplex linking device or simplex controller) there is also a wait after a restart required controller
download. In both cases:
• The wait stops when the linking device is found in the appropriate live list.
• The wait can be cancelled by the user.
9.3.5 Upload
The ToolboxST application is used to perform the upload of a controller’s configuration that contains fieldbus function blocks
and fieldbus devices. If the ToolboxST application does not have the DD files for a specified fieldbus device inside the
placeholder, the following happens:
• The import continues.

• Once the import is finished, any fieldbus devices that the ToolboxST application did not have the DD files for displays
the default / unknown fieldbus device placeholder icon in the Hardware tab Tree View.
• Information is displayed to find the DD files on the fieldbus web site (www.fieldbus.org) such as:
− Manufacturer name
− Manufacturer ID
− Device name
− Device ID
− Device revision
− DD revision

Public Information
9.3.6 Device Alerts
If a fieldbus device placeholder is emitting a device alert or process alarm, active block alerts display an icon ( ) in the
Tree View at the block level and the following locations:
From the Hardware

tab Tree View :
Attached segment
Fieldbus device
Block
Tip � When device alerts display in the Alarm Viewer they are time stamped (synched). The only time they are not synched
is when a download has been done to a device and they have not yet resynched. At that time they display a 1972 time stamp.
Public Information
The Alarm Viewer Variable Name displays in the following format:
Controller/H1 Device (PD Tag)/Block Tag/Fieldbus Parameter Name.
9.3.7 Live Values

The ToolboxST application provides for viewing and interaction with live values of fieldbus blocks and parameters. Live and
intractable values are displayed from the following locations in the ToolboxST application:
• The Hardware and Software tabs’ Summary View, in the Parameter tabs
• Trender
• Watch Window
• The Software tab’s Summary View, in the diagram editing space
Double-clicking on a live value when online displays the Change Live Value dialog box.
The following operations are performed from the Change Live Value dialog box:
• Write a fieldbus parameter:

− Even if the fieldbus parameter does not have a controller token. (For example, a fieldbus function block view 1
added to a Watch Window.)
− Some fieldbus parameters are read only.
− Some fieldbus parameters are writeable.
− Writeable bit-string parameters are enumerated for the user.
− Provides the user with the proper variable Name, Current Value, Original Value, Send and Close, Send, Inc and
Send, Dec and Send, and Close options.
Note If the fieldbus parameter cannot be written (for example, because of the fieldbus function block’s current
mode), the response displays from the fieldbus device to which the write was attempted.

Public Information
• Force a value as follows:
− Any fieldbus input to the Mark VIe controller

− Any controller output to a fieldbus device
− Any status value is enumerated for the user
− Writeable bit-string parameters are enumerated for the user
− Provides the user with the proper Variable Name, Current Value, Original Value, Send and Close, Send, Inc and
Send, Dec and Send, Close, and Force value options
− Non-forceable items:
■If two fieldbus function block pin connections are connected directly to each other, the live value on that
connection is non-forceable. To set a value being sent from one fieldbus function block to another fieldbus function
block, you can use the simulate option of the fieldbus function block to force the value as desired.
■Parameters from views are non-forceable. (May not have an associated Controller Token.)
The following figure gives a visual indication of which items can be forced:
Forcible and Non-forcible Items
Public Information
9.4 Other Functions and Features
9.4.1 Drag-and-drop to CIMPLICITY Screen
The ToolboxST application allows the drag-and-drop of assigned fieldbus function blocks configured to put View 1 on EGD
onto a CIMPLICITY HMI screen. The ToolboxST application populates the clipboard with the proper data to enable the
CIMPLICITY smart object to:
• Indicate the PD tag of the device to which the fieldbus function block is assigned
• Display the description of the assigned fieldbus function block
• Display the assigned fieldbus function block’s View 1 parameters over EGD
• Write to an assigned fieldbus function block’s View 1 parameters over EGD using Command Message Protocol (CMP)
which can be written to indicated by the DD files. (This is how HMIs write values over EGD to Mark VIe Controllers
through CIMPLICITY Screens.)
• Perform the Goto Logic Function
9.4.2 Print Fieldbus Logic

The ToolboxST application can print fieldbus logic using the following options:
• Print fieldbus task

− When printing fieldbus function blocks you must print the configured parameters for the fieldbus function block
• Print fieldbus device placeholders
− This includes printing all or only used fieldbus blocks with their configured parameters. (All relevant block
parameters are printed by way of reports.)
• Print linking device (PFFA)
− Parameters (All relevant parameters are printed by way of reports.)
• Print controller topology:
− Linking devices
− H1 segments including:
■ Topology from the Summary View
■ Fieldbus device placeholders and commissioned devices
• Print macro cycle viewer: A view similar to the macro cycle viewer display area spread across multiple pages with
selected macrocycle, block execution, publish/subscribe duration, and so forth are printed.

Public Information
9.4.3 Compress FOUNDATION Fieldbus Schedule
When a user configures a FOUNDATION Fieldbus device in ToolboxST, the FOUNDATION Fieldbus Schedule is created to
manage the communication between the FOUNDATION Fieldbus devices. This schedule is then applied during downloads. If
FOUNDATION Fieldbus devices are renamed, deleted, and/or moved between builds, schedule errors may occur. Beginning with
ControlST V07.05, users can compress the FOUNDATION Fieldbus Schedule to clear these errors and optimize the schedule.
➢ To compress the FOUNDATIONFieldbus Schedule

1. From the System Editor Tree View, double-click the Mark VIe component (FFTest for this example) to display the
Component Editor.
2. From the Hardware tab, right-click Distributed I/O and select Compress FOUNDATION Fieldbus Schedule.
3. A Warning dialog box indicates that FOUNDATION Fieldbus device communications will be interrupted during or after the
next Download following compression, which may cause processes under control to fail or trip. Click OK to continue.
Public Information
Before performing a Download, make sure all FOUNDATION Fieldbus devices and
processes are in a Safe state.
Caution
4. After the compression command is completed, perform a Build before the next Download.
Since the new, reorganized schedule is not created until the next Build is performed, the FOUNDATION Fieldbus Schedule
need only be executed once between Builds. All FOUNDATION Fieldbus devices that indicate differences during the
Download scan should be downloaded during the next Download to ensure that the new schedule is fully deployed, and
all communications are restored.

Public Information
9.4.4 Reports
The ToolboxST application can generate the following reports:
• Current List of fieldbus placeholders organized by linking device and segment

− Each fieldbus placeholder conveys information regarding commissioned or decommissioned status
• Variable
− Global
− Configuration
− Web
− EGD
• Block pin
• I/O
− Variable report
− Configuration report (this is the only report from the FOUNDATION Fieldbus)
• I/O diagnostics
− Alarm
− Revision
− Communication
− Hardware
9.4.5 Dynamic Help

The ToolboxST application supports dynamic help for the fieldbus feature. The following options are supported:
• Dynamic help documentation for each supported block type when the Info tab is selected while targeting a FOUNDATION
Fieldbus resource, transducer, or function block in both standard and enhanced forms
• Dynamic help for FOUNDATION Fieldbus parameters
− Descriptions from DD files
− Other help from DD files
• Documentation on DD attributes in block and parameter displays as well as conditional expressions. DD attributes
include:
− Validity
− Handling
− MIN_VALUE, MAX_VALUE
− DISPLAY_FORMAT
− EDIT_FORMAT
− Enumeration / Bit Enumeration Lists
Public Information
10 Mark VIe and Mark VIeS Advanced
I/O Functions
Several I/O functions are available with the Mark VIe or Mark VIeS component.
• PSVO, PCAA, PSVP, and PMVE Valve Circuit Calibration

• PGEN Power Load Unbalance (PLU) Configuration
• HART® Device Configuration
• PPRF PROFIBUS Communications Configuration
• PCNO I/O Module Configuration
• PMVE I/O Module Configuration for Mark V Migration
• PSCA Module Configuration
• PSCH Module Configuration
• PIOA I/O Module Configuration for ARCNET
• PUAA I/O Configuration
• Universal I/O Shared IONet Configuration
10.1 PSVO, PCAA, PSVP, and PMVE Valve Circuit

Calibration
Linear Variable Differential Transformers (LVDTs) associated with PSVO, PCAA, PSVP, and PMVE (MVRA or MVRF)
servos must be calibrated when a new I/O pack or terminal board is used on a system. The I/O pack stores information about
the hardware in its configuration. If the hardware changes, the I/O pack clears a variable (Reg#_Calibrated_R,S,T or Reg#_
CalibratedNV_R,S,T), indicating that the servos must be recalibrated.
Note Only one valve can be calibrated at one time.
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.
Refer to the Mark VIe and Mark VIeS Control Systems Volume II: General-purpose Applications, the sections:
• PSVO Module Control Module

• PCAA Core Analog Module
• PSVP Servo Control-Steam
The Calibrate Valve dialog box provides an automated sequence as well as a verification mechanism to configure and
maintain values for each valve circuit.
Mark VIe and Mark VIeS Advanced I/O Functions GEH-6703P User Guide 691
Public Information
➢ To calibrate valve circuits
1. From the Component Editor, select the Hardware tab.
2. From the Tree View, select the desired PSVO, PSVP, PCAA, or PMVE with an attached MVRA or MVRF.
3. From the Summary View, select the Variables tab, then click Go On/Offline.
4. In the Variables tab, scroll to CalibEnab# and double-click it in the row header.
5. Change the value to True.
Note Only enable one valve for calibration at one time. When the procedure is repeated, set the previously calibrated valve
to False.
6. From the Summary View, click the Regulators tab and enable the desired regulator. Select the appropriate regulator
type from the drop-down list.
7. Verity that the Enable check box is selected.
Do not make any changes to the regulator configuration during valve calibration.
Each calibration command is monitored by the ToolboxST application to verify
performance.
Attention
8. Click Calibrate to display the Calibrate Valve dialog box.
The following figure displays the calibration of ratiometric LVDTs for an LMPosition regulator on a simplex PMVE MVRA
I/O module. Different regulator types, redundancies, and servo I/O modules will display slightly different results.
9. From the dialog box, click Calibration Mode to enable all command buttons and start the calibration command in each
I/O module. A Trender window displays dynamic signals. For further details, refer to the Trender Instruction Guide
(GEI-100795).
LVDT voltages are the values that represent the minimum and maximum actuator positions stored in the I/O module. These
values are not live data. They display after a Save command is performed.
Public Information
Note PulseRate regulator types only support Manual mode (Step 11c). When entering Calibration Mode for PulseRate
regulators, do not perform an auto-calibration sequence. Go directly to Manual mode.
10. If you are performing auto-calibration, complete the following steps in this sequence:
a. Click Minimum End and wait for the actuator to reach its minimum end position.
b. Click Fix Minimum End to collect the voltage value at the minimum end position.
c. Click Maximum End and wait for the actuator to reach its maximum end position.
d. Click Fix Maximum End to collect the voltage value at the maximum end position.
e. Click Calibrate to apply the minimum and maximum values collected.
f. Click Save to save the calculated values. The calculated values are saved for each servo module.
Note Voltage minimum and maximum values are saved for all servo modules. The PSVO and PSVP modules also save
RCoilOpen and RCoilShort thresholds on the Servo tab. The PCAA module saves ExcitMonCal values on the LVDT tab.
Note Only one command state can be active at any one time.
11. After calibrating the LVDTs, complete the following in any order to verify servo performance.
a. Click Position to apply open loop current steps to the valve actuator, and monitor the position as the actuator moves
from Min to Max and back to Min.
b. Click Current to apply a closed loop position ramp to drive the valve actuator, and monitor the current as the
actuator moves from Min to Max and back to Min.
c. Click Manual to enable closed loop position steps. Input a position in the SetPoint text box, click Send, and
monitor the position feedback as it moves to the SetPoint.
d. Click OFF to exit verification mode.
12. When calibration is complete, click the X in the upper right corner. Click OK to save the calibration trend, which is saved
in the system directory in the Tools folder for the applicable controller. The calibration window then closes.
Repeat this procedure for each associated servo valve.
Public Information
10.2 HART Device Configuration
10.2.1 Module Configuration for HART Devices
The following modules support HART devices:
• PHRA (Simplex)
• YHRA (Simplex)
• PUAA/YUAA (Simplex)
• YSIL (TMR)
➢ To add and configure an I/O module for HART devices
To add Highway Addressable Remote Transducer (HART) I/O devices to a component

configuration, a HART enabled Analog I/O module must be added in a Cabinet
Group. A Cabinet provides a grouping concept to allow interface to the Emerson Asset
Management System (AMS) application. For further details, refer to Mark VIe and
Mark VIeS Control Systems Volume II: System Guide for General-purpose Applications
Attention (GEH-6721_Vol_II), the section PHRA HART Analog I/O Module.
1. From the Hardware tab Tree View, right-click Distributed I/O, select Add Group, make sure the Group Type
Cabinet is selected from the Type drop-down menu, then click OK.
Note If a Cabinet Group already exists, skip this step.
2. Right-click the Cabinet Group and select Add Module.

3. From the Module Redundancy drop-down menu, select the appropriate redundancy.
4. From the Select Type list, select the module that supports HART devices and click Next.
5. In the Terminal Board Position column, enter the position value(s) (for example, enter the position as 1A1A) and click
Next.
6. Click Finish to add the I/O module.
Example of PHRA Module Added to Cabinet Group
Public Information
7. From the Summary View, click the Parameters tab to configure the module for an AMS, if applicable.
8. Enable and configure each input and/or output as needed for the HART device:
a. For PHRA and YHRA modules, configure from the Inputs and Outputs tabs.
b. For YSIL, configure from the Analog Inputs tab.
c. For PUAA, configure from the Current Inputs and Current Outputs tabs.
Configure the I/O input type for 0-20 mA.
Attention
➢ To upload HART device IDs: from the Tree View, right-click the I/O module and select Upload HART IDs.
Public Information
10.2.2 HART Process Variables and Extended Status Bytes I/O
Configuration
Note This does feature does not apply to the YSIL module.
By default, HART inputs and outputs do not display the HART process variables and extended status bytes. The user must
configure a number greater than zero (0) in the HART Control Variables column and the Status Variables column, per point,
for the I/O channel configuration to display the HART variables in the connected variable grid.
➢ To configure HART Control Variables

1. From the appropriate Analog tab, select a variable (such as AnalogInput01) and enter a value within the range 1–5 in the
Hart_CtrlVars column.
2. Select the HART tab to view the value entered in the Hart_CtrlVars column reflected in the control variables.
For example, if a value of 5 is entered in the Hart_CtrlVars column, the grid displays five control variables.
3. Repeat this procedure per point.
Example of Configured HART Control Variable Inputs
Public Information
Example of Configured HART Control Variables Outputs
➢ To configure HART Extended Status Bytes

1. From the appropriate Analog tab, select a variable (such as AnalogInput01) and enter a value within the range 1–28 in the
Hart_EXStatus column.
2. Select the HART tab to view the value entered in the Hart_EXStatus column reflected in the extended status byes for
the HART device.
For example, if a value of 15 is entered in the Hart_EXStatus column, the grid displays four status variables containing
bytes 1–16.
3. Repeat this procedure per point.
Public Information
Example of Configured HART Extended Status Byte Inputs
Public Information
Example of Configured HART Extended Status Byte Outputs
Public Information
10.3 PPRF PROFIBUS Communications Configuration
The PROFIBUS master gateway (PPRF) is a PROFIBUS DP-V0 or DP-V1, Class 1 master that maps I/O from PROFIBUS
slave devices to Mark VIe controllers on the I/O Ethernet. Only one I/O pack can be actively communicating with its
associated PROFIBUS network. PPRF can be configured in the following redundancies:
• 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.
10.3.1 Add PROFIBUS Slave Device

➢ To add a PROFIBUS slave device
1. Verify that the PPRF has been added with the correct redundancy.
Note The GSD Manager is not available until a PPRF module has been added.
2. From the Hardware tab Tree View, right-click Distributed I/O and select GSD Manager.
From the GSD

Manager dialog
box, select a
device and click
Add File .
Public Information
From the Hardware tab Select the PROFIBUS Network
Tree View, select the PPRF tab to configure the network Slave device
3. From the Device view, insert the slave device in the network by selecting and dragging the device to the purple-colored
line in the PROFIBUS Network view.
To begin configuration,
double-click the slave device
Public Information
10.3.2 Configure PROFIBUS Slave Device
Note Groups and DPV2 are not supported by the PPRF. Signal Configuration is not required.
The slave device opens with the Modules view displayed. Click the Help button on each page for detailed configuration
information. Configuration pages include the following:
• Modules Page
• General Page
• Parameters Page
• DPV1 Page
10.3.2.1 Modules Page
From Available Modules , select and either

double-click a module or click Append to add
it to the Configured Modules list.
Public Information
10.3.2.2 General Page
Select the Watchdog Control check

Click the icon to toggle Station Address box to place this device in fail safe
between displaying and displays the mode. Interval is the time period that
hiding the Navigation Area. device address. elapses before fail safe mode.
Select
General.
Note The default time interval before fail-safe mode for a DP device is 200 ms. For a PROFIBUS PA device, the setting
should be 5000 ms.
Public Information
10.3.2.3 Parameters Page
Select a parameter to change

the value. Click OK to return
to the Hardware tab.
Public Information
10.3.2.4 Extensions Page
Click Help for configuration information.

Click OK to return to the Hardware tab.
Public Information
10.3.2.5 DPV1 Page
If DPV1 is supported by this device, the following screen displays. The PPRF must be an H1B (BPPC) I/O pack.
Select the Enable DPB1 check Click Help for configuration information.
box for each DPV1 device. Click OK to return to the Hardware tab.
Public Information
10.3.2.6 Device Description
Device Description displays information about the Slave device.
Click OK to return to
the Hardware tab.
10.3.2.7 GSD Page

The General Station Description (GSD) displays the content of the GSD file in text view. Click Help for more details.
Click OK to return to
the Hardware tab.
Public Information
10.3.3 Configure PPRF Master Device
➢ To configure the master device
From the PROFIBUS

Network tab, double-
click the PPRF icon
to display the
configuration screen
for Bus Parameters.
From the drop-down list,

select a master device.
Bus Parameters
displays
PROFIBUS
network
properties.
Bus Monitoring
displays how
the PROFIBUS
network is
monitored by
the gateway.
Bus Parameters Page
Public Information
If any changes are made to the master device configuration and you click OK, the I/O
pack must be restarted after the controller and the I/O pack are downloaded.
Attention
10.3.4 Enable PPRF Slave Device

➢ To enable the slave device: from the Tree vView, click Station Table.
Click Activate to enable the slave

device on the network, then click OK.
Public Information
10.3.5 Display PROFIBUS Network
➢ To display the PROFIBUS network overview
Select Address Table to change

the PROFIBUS slave addresses.
Public Information
➢ To configure I/O variables

Tree View, select a slave
device to display
configuration values in the
Summary View.
Click in the columns to

change values.
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 so that Boolean
Mark VIe variables can be attached to the individual bits.
Variables Tab Columns
Column Description
Connected Variable Displays the connection to other defined variables in the ToolboxST application
Displays the data type of the variable configured in the Mark VIe component
Var Data Type Space can be reserved for unused inputs and outputs, enabling subsequent online
loads when variables are added.
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
Fieldbus Point Data Type
rows display Continued. The default byte data type for rows associated with
configuration bytes must be changed to a supported data type.
Raw Min, Raw Max, Eng Min, Eng Values used to calculate scaling from raw units (the PROFIBUS point) to engineering
Max units (the Mark VIe variable)
Transfers are expanded into individual bits and displayed in the Booleans tab below the
Boolean
Variables tab
If set to True, enables input event scanning on a Boolean transfer
An input event is similar to an SOE, but has a 10 ms resolution.
Input Event Enabled
Any field except Var Data Type and Fieldbus Point Data Type It can be modified without
restarting the controller or I/O pack.
Note The Direction, Module, and Fieldbus Point Offset columns are Read-only.
Public Information
Supported Fieldbus Point Data Types
PROFIBUS Point Data Type Mark VIe Variable Data Type Scaling
Boolean Boolean —
Integer
Integer16
Float √
Double integer
Integer32
Float √
Unsigned integer
Unsigned16
Float √
Unsigned double integer
Unsigned32
Float √
Floating point (32 bits) Float √
Note Only certain point-to-variable data transfer conversions are supported.
➢ To configure PROFIBUS diagnostics
From the Hardware tab Tree View,

right-click PPRF and select the
PROFIBUS Diagnostics tab.
If any PROFIBUS device generates a non-status only diagnostic, the ProfibusDiag variable has a value of True. For
applications that require diagnostic presence indication, attach a defined BOOL-type variable to ProfibusDiag.
Non-status diagnostics are ones that indicate problems. Status-only diagnostics contain only the standard portion (the first six
octets). These, in addition to the master address and identification number, have one or more of the following diagnostics
values set.
• Master_Lock (slave parameterized by another master; octet 1, bit 7

• Bit always set to True (octet 2, bit 3)
• WD_On (watchdog on; octet 2, bit 3)
• Freeze_Mode (slave freeze mode activated; octet 2, bit 5)
• Sync_Mode (slave sync mode activated; octet 2, bit 5)
• Reserved bits (octet 3, bits 0-6)
• Ext_Diag_Overflow (slave error message overrun; octet 3, bit 7)
Note The connected variable may be added, changed, or removed and loaded without restarting the controller or I/O pack.
➢ To display additional tabs: from the Tree View, select a slave device to display tabs in the Summary View.
1. From the Tree View, select a slave device.
2. From the Summary View, select the Standard Diagnostics tab.
3. In the Connected Variables column, add desired variables. Entries in all columns are read-only.
Public Information
10.3.6 Standard Diagnostics Tab
The values that display in the Standard Diagnostics tab are the standard portion of a PROFIBUS diagnostic message (the first
six octets). Except for the Master_Addr (master address) and Ident_Number (identification number) values, which are UINT
types, the remaining values are BOOL types. The connected values must have matching data types.
The last value in the Standard Diagnostics tab, Station_Diagnostic, is not part of the PROFIBUS standard diagnostic message.
It provides a station diagnostic present indication. It is set to True if the slave device generates a non-status only diagnostic.
For applications that require station diagnostic presence indication, attach a defined Boolean-type variable to the Station_
Diagnostic.
10.3.7 Device Diagnostics Tab

Values that display in the Device Diagnostics tab include:
• Byte offset (range: 0 to 61)

• Bit offset (range: 0 to 7)
• Bit length (range: 0 to 8)
The bit length must be 0 for multi-byte data widths, 1 for Booleans, and 1 to 8 for bit fields (these cannot cross byte
boundaries). The connected variable must be a BOOL if the bit length is 1 and an Integer if the bit length is 1 to 8. If the bit
length is 0, the variable data type determines the byte length.
The Device Diagnostics tab, which is initially empty, is used to connect variables to data fields within the Device-related
portion of a diagnostic message. Entries in the Diagnostic Byte Off, Diagnostic Bit Off, and Diagnostic Number Of Bits
columns identify bits, bit fields, and analog values within the Device-specific diagnostic, which is exclusively defined on a
per-device basis.
➢ To specify a bit-wide diagnostic value

You can also connect a Boolean-type variable to the specified diagnostic bit. (If the connected variable is not provided, it may
be added and downloaded. However, since the ToolboxST configuration assumed an integer type because of the blank
variable field, the I/O pack is restarted.)
➢ To specify a bit field diagnostic value

The specified bit field must fit within an 8-bit boundary and may extend from 1 to 8 bits. You can also connect an integer
variable (not a BOOL or FLOAT).
A connected variable can be added and downloaded later without restarting.
➢ To specify an analog diagnostic value

The analog value, which must fit within a 32-bit boundary, is treated as a Big Endian (high byte followed by low byte) value.
You can also connect an analog variable to define the data type of the diagnostic value. (A connected variable can be added
and downloaded later without restarting.) No type conversions are performed.
The I/O pack must be restarted if lines are added or removed from the Data Grid, or if an existing entry’s connected value is
changed from a Boolean to an analog-type or vice versa. All other changes to existing entries can be made and downloaded
without restarting the controller or I/O pack.
To add a line without specifying the connected variable, you must enter a space in the Connected Variable field to enable the
other fields for data entry.
Public Information
Identifier Diagnostics Tab
The Identifier Diagnostics tab, which is initially empty, is used to connect variables to bits within the Identifier-related portion
of a diagnostic message. Each bit, which corresponds to a module in the slave device, is set to True to indicate a problem. The
data type for a connected variable must be a BOOL. The Identifier Number range is 0 to 495.
➢ To specify an identifier diagnostic
Note If lines are added or removed from the Data Grid, the I/O pack must be restarted after being downloaded.
Existing Data Grid modifications (adding, removing, or changing connected variables, changing the Identifier Number and
such) can be downloaded without restarting the controller or the I/O pack.
To add a line without specifying the connected variable, you must enter a space in the Connected Variable field to enable the
other fields for data entry.
10.3.8 Channel Diagnostics Tab

The Channel Diagnostics tab, which is initially empty, is used to connect variables to the type octet of the channel-related
portion of a diagnostic message. The channel diagnostic type octet contains two fields, a 3-bit channel type, and a 5-bit error
type, whose values are defined in the PROFIBUS standard. (The error type field values of 16-31 are manufacturer-specific).
The data type for a connected variable must be a UINT. The Identifier Number range is 0 to 495 and the Channel Number
range is 0 to 63.
Note The system must be running, and the ToolboxST application must be able to connect to the Mark VIe component.
➢ To display advanced diagnostics: from the Tree View, right-click PPRF and select Troubleshoot Module and
Advanced Diagnostics.
Public Information
10.3.9 Export Configuration
You can export a configured PROFIBUS network to reduce the configuration time required to create multiple PROFIBUS
networks.
To avoid configuration conflicts and corruption of data, do not edit exported files
outside the ToolboxST application.
Attention
➢ To export a PPRF configuration: from the Hardware tab Tree View, right-click the existing PPRF with network
devices already defined and select Export Configuration.
From the Tree View,

right-click the PPRF
and select Export
Configuration
Public Information
From the Browse
for Folder
window, either
select an empty
folder or click
Make New Folder
to create a folder
to export the
configuration to.
Public Information
10.3.10 Import Configuration
You can also import a network configuration to duplicate that network. Two import options are available:
• PROFIBUS Network and Setup

• PROFIBUS Network
Either option imports the PROFIBUS device networks and keeps the same type of device at the same PROFIBUS drop
address. However, when you select Import PROFIBUS Network and Setup, all I/O data files are imported with the devices.
This prevents having to add I/O data manually.
➢ To import a PPRF configuration

1. Add a new PPRF module.
2. From the Hardware tab Tree View, right-click the PPRF to import to and select either Import PROFIBUS Network
and Setup or Import PROFIBUS Network.
From the Browse

for Folder window,
select the folder
containing the files
to be imported.
Public Information
10.3.11 Advanced Import
Note Refer to the section Controller Settings.
The Advanced Import option provides an additional dialogue box during an import, and allows different GSD versions to be
used during an import when multiple versions are available. It also allows exported devices to be skipped during the import.
After you select the export folder, the following dialog box displays. To enable the Advanced Import option, Show Advanced
Importer Screen must be set to True in the controller settings dialog box.
From the DTM Device To not import an exported device,

column, select a device. from the Action column, select Skip.
Note The GSD file must be imported into the configuration for that selection to display in the DTM Device column.
A main feature is selecting a specific GSD from the DTM column. This is useful when the Device Type ID or Ident Number
is identical for multiple versions of a specific device. If two revisions of a device have the same device ID, the same revision
will be selected for both devices being imported. You can select the appropriate GSD in the DTM Device column for each
device.
An additional feature is the capability to skip the import of a device that was exported.
Note For Creation Mode, use the Use Hilscher generic DTMs if available default selection only.
Public Information
10.4 PCNO I/O Module Configuration
The CANopen I/O pack (PCNO) is a network management master that maps I/O from CANopen devices to Mark* VIe
controllers on the IONet.
Only the following devices are currently supported on the PCNO CANopen network:
• WoodwardTM GS6 and GS16 valves

• Woodward Digital Valve Positioners (DVPs) and Dual DVPs
• Woodward GS40 and GS50 fuel valves
• Woodward Liquid DLE Fuel Metering System (LFMS)
• GE Sensing DPS 8000 pressure transducers
• Moog Digital Valve Positioner (DVP)
Note Mixing these devices on the same CANopen network is not supported.
Note For further details, refer to the Mark VIe and Mark VIeS Control Systems Volume II: System Guide for
General-purpose Applications (GEH-6721_Vol_II), the chapter PCNO CANopen Master Gateway.
➢ To add a PCNO I/O module and devices: from the Component Editor Hardware tab, right-click Distributed
I/O and select Add Module.
From the Module

Redundancy
drop-down list,
select Simplex.
Select
PCNO and
click Next.
Public Information
From the drop-down list,
select the module version.
Select the desired hardware

form and click Next to preview
configuration information.
Public Information
Review the
configuration
information and
click Finish.
If this is the first

module being
added, a
message will
display. Click Yes
From the Parameters tab, select the appropriate baud rate.
Devices 1-25
and 125 are
configurable
The selected baud rate affects the number and type of devices that can exist on the CANbus. For a list of supported devices
per network, refer to the Mark VIe and Mark VIeS Control Systems Volume II: System Guide for General-purpose
Applications (GEH-6721_Vol_II), the chapter PCNO CANopen Master Gateway, the section Installation, the table Supported
Devices per Network.
Note The Woodward Dual DVP and GS40/GS50 fuel valves can only be used with the PCNOH1B version.
Public Information
Right-click a device (1-25), select Attach,
and select the desired device from the list.
To select a Woodward LFMS, right-click

Device_125, select Attach, then select
Woodward LFMS.
Note Only one type of device per CANopen network is allowed.
Public Information
➢ To connect variables
From the Connected Variable column,

click the ellipsis button to display the
Select a Variable dialog box
The Variables tab contains a list of counters that provide an indication of CANopen message transmission and reception. Each
time the I/O pack sends a message to a slave device, the corresponding RPDO count is incremented. Each time the I/O pack
receives a message from a slave device, the corresponding TPDO count is incremented. In the case of the GE Sensing DPS
pressure sensors, RPDOs are not supported so they do not display in the Variables tab.
A connected variable can be changed with an online load. Adding or removing CANopen devices requires an offline load.
➢ To display external CANopen device configuration details: from the Tree View, select PCNO and press F1.
Public Information
➢ To go online with PCNO without an attached device
From the Value column

for the DeviceRequired
parameter, select False
Note The DeviceRequired parameter only functions with PCNOH1B.
Public Information
10.5 PSCA I/O Module Configuration
Note Refer to Mark VIe and Mark VIeS Control Systems Volume II: System Guide for General-purpose Applications
(GEH-6721_Vol_II), the section PSCA Serial Communication Module.
The Serial Communication Input/Output (PSCA) module provides the electrical interface between one or two I/O Ethernet
networks and a serial communications terminal board.
➢ To add a PSCA I/O module

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

Redundancy
drop-down list,
select Simplex.
Select PSCA
and click Next.
Note The PSCA I/O module is only available in simplex mode.
2. From the wizard page, select configuration information and click Next.
3. Confirm the configuration and click Finish.
Public Information
➢ To attach a device: from the Tree View, expand the PSCA to display the seven ports.
Right-click a port and

select Attach and the
desired device
Port 7 is provided for

the Modbus Master
Ethernet connection
Attached devices display

in the Summary View
Public Information
10.6 PIOA I/O Module Configuration for ARCNET Support
➢ To configure a PIOA I/O module
1. From the Hardware tab Tree View, right-click Distributed I/O and select Add Module.
Select the module

redundancy
(simplex or TMR)
and the PIOA
ARCNET Interface
Module , and click
Next
Configure the
terminal board.
Select the JA1

terminal board
connector (the
only connector
that supports the
ARCNET protocol)
and click Next
2. Click Next and Finish.
Public Information
From the Tree View, select From the Summary View, select
the PIOA I/O module ARCNET as the Network Type
Public Information
10.7 PUAA/YUAA I/O Configuration
The Universal Analog (PUAA/YUAA) I/O module can be configured to function like any I/O pack (such as PAIC/YAIC,
PAOC, PRTD, PTCC/YTCC, and so forth) or a combination of I/O modules. There are 16 available channels (I/O points) that
can be configured in various modes through the ToolboxST application. For further details, refer to the Mark VIe and Mark
VIeS Control Systems Volume II: System Guide for General-purpose Applications (GEH-6721_Vol_II).
Note The PUAA/YUAA I/O module does not have to be rebooted after configuration, with one exception. A reboot is
required the first time HART is enabled on any point, 1-8 or 9-16. For example, using points 1-8, if you enable HART on
point 1, a reboot is required. Enabling HART on any subsequent point in group 1-8 would not require a reboot. Using the
same scenario for points 9-16, if you enable HART on point 9, a reboot is required again. If HART is enabled on any
subsequent points in group 9-16 would not require a reboot.
Furthermore, a reboot is required if the last point with HART enabled in either group 1-8 or 9-16 is disabled, meaning there
are no longer any HART enabled points within a group of points (group 1-8 or group 9-16). For example, if points 1 and 2
have HART enabled, disabling HART on point 2 would not require a reboot. However, disabling point 1, which is the last
point with HART enabled in group 1-8, would require a reboot.
The available I/O modes are:
• Unused
• Current Input
• Voltage Input
• Digital Input
• Pulse Accumulator
• RTD
• Current Output
• Thermocouple
Note Current Inputs and Current Outputs support HART devices. For a list of I/O modules that support HART devices, refer
to the section HART Device Configuration.
Digital Inputs support SOEs.
When the channels are configured (a mode other than Unused is selected for a channel), Summary View displays
configuration tabs for the selected modes.
Public Information
➢ To configure a PUAA/YUAA I/O module
Note The PUAA/YUAA I/O module must be added within a Hardware Cabinet Group. If a Cabinet Group already exists,
skip step 1 in this procedure. For additional information on Groups, refer to the section Organize Modules.
1. Add a Group to contain the module. From the Hardware tab Tree View, right-click Distributed I/O, select Add
Group, make sure the Group Type Cabinet is selected from the Type drop-down menu, then click OK.
2. Add a PUAA/YUAA I/O module. Right-click the Cabinet Group and select Add Module.
Note PUAA is only available in a Simplex configuration.
3. From the Module Redundancy drop-down menu, select the appropriate redundancy.
4. From the Select Type list, select the PUAA/YUAA module and click Next.
5. In the Terminal Board Position column, enter the cabinet position value(s) (for example, 1A1A) and click Next.
6. Review the module configuration, then click Finish to add the PUAA/YUAA I/O module.
The Summary tab displays the PUAA/YUAA I/O module and indicates that channels (1/O points 1–16) are not yet configured
(Unused mode is the default).

7. To configure the I/O points, select an I/O mode that corresponds to the desired functionality.
From the Hardware Configuration tab, place your cursor in the Mode column
in the row for an I/O point. From the drop-down menu, select the appropriate
mode (CurrentInput is selected for this example).
To modify an I/O point mode after initial configuration the following procedure must
be performed to prevent damage to hardware during transition between I/O point
modes:
a.) Set the mode to Unused and perform a successful Build and Download.
b.) Change the field wiring to match the new I/O point mode.
Caution c.) Once the wiring is completed, select the appropriate mode from the drop-down list
and perform a successful Build and Download.
If the Unused mode is not selected first, and successfully built and downloaded, the
new configuration will not be accepted and a diagnostic will be generated.
Public Information
The ToolboxST application displays a mode tab for each selected mode type, and lists the I/O points that are configured with
that mode.
Configured I/O Points and Mode Tabs
Tip � Double-clicking on a row in the Configuration tab Summary View displays the specific I/O point mode tab.
8. To view all I/O points that are configured for a specific I/O point mode, select a mode tab.
For example , select the Current Inputs tab to

display the configured Current Input I/O points.
The Current Input tab contains the selected Current Input points on the I/O module terminal board that can be individually
configured. Additionally, variables can be connected to the I/O points and associated with the blockware application code.
Public Information
The Summary tab displays the configured I/O points with the symbols that represent their selected modes.
Configured I/O Point
Example PUAA Module I/O Points (Configured)
Public Information
10.8 Universal I/O Shared IONet Configuration
All Universal I/O packs (such as PUAA) support sharing inputs using the Shared IONet feature. Just as changing a point
mode on a Universal I/O pack will clear the minor revision of the owning device, the consuming device will also have a
cleared minor revision. The consuming device will also be marked dirty, requiring a Save the next time it is opened in the
ToolboxST application. Any connected variables attached to a shared point on the consuming device will be removed when a
change is made to the point mode. A warning displays in the Log window to notify the user which variables were removed.
➢ To configure Shared IONet on a Universal I/O pack

1. From ToolboxST, open the system .tcw file and open the Mark VIe component.
2. Configure the Universal I/O pack with the desired point modes.
3. Perform a Build, then close the device.
4. Perform a Shared IONet Download from the system level. (Before performing a Download, the user will be prompted to
Build the consuming device. Once complete, the Download can be performed.)
Note For further details on Shared IONet, refer to the Mark Controllers Shared IONet User Guide (GEH-6812).
Public Information
Notes
Public Information
11 Mark VIeS Component Editor
The Mark VIeS Component Editor provides a comprehensive user interface for configuring a Mark VIeS controller. The
elements of the configuration are grouped by specific function tabs. Areas of the editor provide various displays, depending
on the currently selected item.
11.1 Creation Wizard

➢ To create a component
1. From the System Editor Tree View, right-click the system and select Insert New, Controller, and Mark VIeS
Controller.
2. Enter a Name, select the Version, and click Finish.
Mark VIeS Component Editor GEH-6703P User Guide 735

Public Information
➢ To open the Component Editor: from the System Editor Tree View, double-click the component.
Tabbed pages organize

the elements of the Summary View provides a
component configuration graphic overview of the controller.
Tree View
lists the items
that can be
configured.
The list
changes when
a different tab
is selected.
Property
Editor
allows you to
edit the item
currently
selected in
the Tree
View.
Component
InfoView
displays
information
about the
currently
selected item.
➢ To edit the component: select an item in the Tree View. The configuration information for that item displays in the
Summary View and Property Editor.
➢ To import an existing component: from the Tree View, right-click a parent component and select Insert Existing
and select Device. Select the Device.xml file for the component to be imported and click Open.
Public Information
11.3 Tree View
11.4 Summary View

11.5 Property Editor

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.

Public Information

Tab Description
Where Used

Public Information
11.6.1 Log Tab


Public Information
11.6.2 Status Tab
details.
11.7 Data Grids

Note Some Data Grids, especially those without an Append Row, may not support all available features.
11.7.1 Edit Data

To... Do this:


Public Information
To... Do this:
configuration

button to add it. columns to the Data Grid.
Select a
column name
and use the up
arrow to move
it to the left-
most side of
the Data Grid.

Public Information
To… Do this:
location.
for the append row in the destination grid and select Paste Row(s) to insert the rows into
their new location.
Trender window or Watch Window Trender window or Watch Window are visible. Then, drag the row header for the variable
change column ordering, and always select the exact destination range in the ToolboxST configuration before pasting data
from Excel.
Public Information
11.8 Controller Settings
The ToolboxST application provides settings that change the way various functions within the component operate.
➢ To open the Settings dialog box: from the Component Editor, select the Options menu, then select Settings.
Controller Parallel Online When set to True, allows you to download application code to redundant controllers in
Download parallel
Show Boot Loader Displays the boot loader in the Download Wizard when it does not have to be downloaded
Enable I/O diagnostic Alarm When set to True, makes available I/O diagnostic alarm events for automatic updates in
Events the I/O Diagnostic Viewer.
When set to True, displays diagnostic icons in the Tree View and serves as a permissive to
Show Diagnostic Icons
show more enhanced diagnostic icons in both the Tree View and the Summary View.
Show More Enhanced Diagnostic When set to True, displays enhanced diagnostic icons in the Tree View and the Summary
Icons View (Show Diagnostic Icons must be set to True for this option to be enabled).

Public Information
11.9 Security
Access Rights
Access Roles
Public Information
11.9.1 Passwords


Public Information
access.
Protection.


discouraged.

Public Information

System
Component
library.
block.

Public Information
This feature allows you to report problems with the controller. The report is generated and attached to an e-mail to the
ToolboxST support team.

2. Enter information in the Send Problem Report dialog box and click Send.
Public Information
11.11 Upgrade Component and I/O Modules
ControlST supports a variety of control equipment, including updated firmware and configuration tools that are available as
component editors within the ToolboxST application. During installation of a new ControlST release version, newer versions
of some components may be installed as well. To use the new versions, you must upgrade each component separately. You
may also upgrade multiple I/O modules for a component at the same time.
➢ To upgrade a component
Redundant Safety I/O packs mounted on the same terminal board must all be the
same hardware form, and running the same firmware version.
Do not attempt this replacement unless you have enough I/O packs with the newer
hardware form available, including spares.
Attention It is recommended that you back up the ToolboxST .tcw file prior to upgrading the
system.
After a component has been upgraded, you cannot undo the upgrade. You also cannot
upgrade a component to its current or a previous version.
Attention
1. Install the latest version of the ToolboxST application.
2. Open the ToolboxST application, open the system .tcw file, and double-click a component.
3. From the File menu, select Upgrade.
4. Select the component(s) and appropriate I/O modules to upgrade.
In the Version Upgrade dialog box, the New column defaults to the highest compatible version that supports the existing
I/O module hardware.
If any version does not support the hardware of the existing I/O module, a Caution
symbol is displayed in the New column. This notifies the user that they should only
upgrade the version if the intent is to replace the existing I/O module with supported
hardware.
Attention

Public Information
To select all I/O modules for upgrade, click the top box in Item column box.
From the New column drop -down list, select
the new version.
To select one I/O module, select the box next to the I/ O module name.
Click the document icon next to the version to
To select multiple I/O modules, press and hold the Ctrl or Shift Key and
display release notes for the selected version .
select each I/O module.
Note: If a Caution symbol is displayed , place your cursor over

the icon to display a Warning notification that you should only
upgrade the version if you intend to replace the existing I/O
module with supported hardware.
Click the double-arrow icon and choose to upgrade all selected

components and I/O modules to the most recent version
or
Upgrade all selected I/O modules to the latest version with the
same (matching) I/O and configuration compatibility codes.
(This option applies only to I/O modules.)
When any of the I/O modules are selected for upgrade to a version
that does not support the hardware , a Warning dialog box displays
requesting user confirmation to proceed . If you select Yes , the
selected I/O modules will be upgraded .
5. From the Version Upgrade dialog box, click OK to upgrade the component.
Public Information
11.12 Compare to Controller
This feature allows you to generate a report that compares the configuration in the ToolboxST software to the controller
configuration.
➢ To generate a Compare to Controller report

1. From the Component Editor File menu, select Compare to Controller to display the Select Channel dialog box.
2. Select the desired channel, and click OK.

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

Public Information
11.13 Compare Devices
This feature allows you to compare the configurations of two different devices.
➢ To generate a Compare Devices report
From the File

menu, select
Compare Devices.
When the Select
Items to Compare
dialog box displays,
select the device
and click Compare.
Public Information
11.14 Mark VIeS Component Menus
Mark VIeS Component Menu Items (continued)
Menu Command Use
Upgrade Change the version of the component support software
Compare to Controller Open the Select Channel dialog box to begin the compare.
Compare Device by Program
Open the Select Channel dialog box to begin the compare.
File (s)
Compare Devices… Compare ToolboxST component configurations
Imports an I/O Variable or Configuration report, a Global Variable report or a Block Pin
Import report from a .csv file, or a Variable Alias report, or Second Language report from a .
csv or .xml file.
Edit Paste Paste the copied item in the Tree View into the Summary View
Select All Select all available items.
Bookmarks Mark and toggle between items in the Tree View
Forced Variables Display a list of forced variables

Forcing of control logic for an operating process is strongly
View discouraged.

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

Public Information
Menu Command Use
LiveViews Display live data from the open component
Variable generates a list of all global or configuration variables. You can also generate
a Web variable report, a Compressed Data Log variable report, an EGD variable list
report, Alias report, or a Second Language report.
Block Pin generates a list of all block pins in the controller software.
I/O generates a list of all hardware input and output variables.
Alarm generates a report of all variables marked as alarms.
GE Rationalization provides a report of alarms using the GE Rationalization column

definitions
Reports
Hold generates a report of all variables marked as hold variables.
Event generates a report of all variables marked as events.
NVRAM generates a list of all variables marked as non-volatile.
View IONet EGD provides network status values of all IONet communication displayed in
the current component
I/O Diagnostics provides network communication status values of all IONet

communication displayed in the currently configured controller.
Coding Practices opens the Options for Coding Practice Report dialog box.
Generate a list of both control constants and undriven variables (refer to the section
Constants
Constants).
Diagnostics Display regular and advanced controller diagnostics, as well as I/O status.
IO CheckOut Open the IO CheckOut dialog box
Display state exchange voting and output disagreements for the dual and TMR
Disagreements
controllers
Export Alarms for
Compare alarm criteria in plant alarm philosophy
Rationalization
Opens the PFD Calculator spreadsheet (.xls) used to calculate the Probability of
Failure on Demand and Risk Reduction Factor (PFD-RRF) for Mark VIeS Functional
Safety System components and determine the Safety Integrity Level (SIL) of the
PFD Calc
Safety Integrity Function (SIF)
Users must have Microsoft Excel 2010 (Standard) or higher installed to open the PFD
Calculator.
Public Information
Menu Command Use
Online Connect or disconnect from a controller
Convert the current configuration into binary files that can be downloaded to a
Build
controller
Perform the following functions:
Controller Setup opens a wizard that allows you to perform basic configuration tasks.
Change Controller Password... allows the user to change the controller password for
Download the device.
Download Wizard downloads base load, firmware, and application code to the
controller and distributed I/O modules.
View/Set Time displays a dialog box that manages the controller time.
Device
Retrieve configuration information from the controller and uses it to create a new
Upload
controller component in the system
Compress Rearrange variables to minimize the amount of space used
Restore Password
Clear all passwords and protect the component
Protection
Security State Go from Open state to Secure state
Lock / Unlock Toggle the controller between Lock and Unlock mode
Return the current CRC of the application code files in the controllers. This is used to
Brand verify if the application code loaded into the controllers and I/O packs is a previously
certified version
Options Settings Display a dialog box with controller settings
Contents Open the Mark VIeS help file
Controller Help Open the Mark VIeS controller help file
Distributed IO Help Displays a list of pack help files to open
Options include:
ToolboxST displays current information about your version

Help
Release Notes
Mark VIeS displays current information about your version of the support software
Distributed IO displays a list of I/O pack help files

Send Problem Report Display a System Change Request form to request system issues
About Display version and copyright information

Public Information
11.15 General Tab
The General tab Property Editor allows you to configure general properties and attributes of the controller, including
redundancy (simplex, dual, or Triple Modular Redundant (TMR) and frame rate (its basic scheduling rate).
General Tab Properties

Application Reflects the application type
Enable Alias Prefix If set to False, the device prefix name is not displayed in CIMPLICITY screens (default is False)
Time of the Build command performed after the most recent major change. (Major changes
Major Revision
require the controller to be restarted after download.)
Time of the Build command performed after the most recent minor change (minor changes do
Minor Revision
not require a controller restart).
Name of the current controller. It is read-only in the Component Editor, and can only be changed
Name
from the System Editor.
NTP Configuration Determines how the Network Time Protocol client synchronizes the controller time
Configuration Manual When set to True, displays the Mode property that allows you to override the system NTP
Override settings and use the local device settings only.
Mode Disabled; the controller does not perform any time synchronization
Platform Type of hardware on which the control code is started
Read-only property that reflects the version of the product associated with the selected
component.
Product Version
The version number is set when the configuration is first created, and is updated with each
product upgrade.
Includes:
Access Roles are assigned to protect each access right for this component.
Modify Data allows you to modify data values and force variables.
Logic forcing procedures can result in personal

injury or death, if not strictly followed. Only
adequately trained personnel should modify any
Protection programmable machine.
Forcing of control logic for an operating process is

strongly discouraged.
Warning
Forcing of protective functions is never permissible
for an operating unit. All safety measures should be
Modify Design Allows you to modify the controller design
Determines the level of redundancy of the controller:
Simplex is a single non-redundant controller.
Dual is a two-controller configuration where one controller provides backup for the other.
Redundancy
TMR is a triple module redundant configuration where there are three controllers that vote on
decisions for reliability.
A controller configured as simplex cannot have dual IONets.
Public Information
General Tab Properties (continued)
Includes:
Active Diagnostics Severity defines the OPC AE severity value for a diagnostic alarm in the
OPC Properties active condition. This value displays in alarm clients.
Normal Diagnostics Severity defines the OPC AE severity value for a diagnostic alarm in the
normal condition. This value displays in alarm clients.
When set to True, allows the Mark VIeS controller to accept routed network packets.
Enable Routing This property is only necessary when the component and the producing component are not on
the same physical network.
Background Period Reflects the timeframe, in seconds, of blocks with background methods
Determines the frame period in ms. A frame is the basis for controller scheduling;
Frame Period 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.

If passwords were set for this component, the following properties require a password.
Password Protected General Tab Properties

Description N/A √
NTP Configuration N/A √
Platform N/A √
Redundancy N/A √
OPC properties (Active Diagnostics Severity; Normal N/A √
Diagnostics Severity)
Scheduling properties (Background Period (sec); Frame N/A √
Period (sec)
Adding modules N/A √

Public Information
11.15.2 Attributes
Attributes are device-level values that affect how the configuration is generated. When the Attributes item is selected in the
Tree View, those controller attributes can be edited in the Summary View data grid.
Attributes Columns
Column Description
Name Unique identifier for the attribute
Description Stores added comments about the attribute
Value Displays and modifies the current attribute value
11.15.3 Attribute Value Editor

The Attribute Value Editor allows you to enter values for a wide variety of data types.
➢ To open the Attribute Value Editor: from an attribute Data Grid, click a Value Cell and click the Ellipsis button.
Name of the
attribute
being
modified
If selected, the
attribute values
are restricted to
an enumeration
(a predefined
set of allowable
values).
To add a value to the Data type of

enumeration, enter the Name, the attribute
Value, and (optionally)
Description and click OK.
Public Information
The network adapters present in the controller display as items in the Tree View. The number of adapters depends on the
controller hardware type and configuration. In most applications, Mark VIeS 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.
Tree View.
Network Adapters Properties
Adapter Settings
IP Address IP address for the selected network adapter
Wire Speed Speed of the network to which the selected adapter connects
Network Settings
Sets the network connected to the selected adapter (available networks are determined in the System
Network
Editor)
Controls the significant portions of the IP address

Public Information
11.16 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 an I/O pack. For each
compatibility code set, there are multiple hardware forms used to identify physical characteristics of the I/O pack. Each I/O
module that can be added to a controller is identified by both its hardware form factor and its compatibility codes.

If passwords were set in the General tab Property Editor for this component, the following functions require a password.
Hardware Tab Password Protected Functions

Add Module √ √
Add Group N/A √
Attach Layout Drawing N/A √
Public Information
11.16.2 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.
From the Tree View,

From the Network

Redundancy drop-down
list, select either simplex,
dual, or TMR
I/O redundancy depends

on controller redundancy
- if the controller is
simplex, the I/O can be
either simplex or TMR
- if the controller is dual,
the I/O can only be dual
- if the controller is TMR,
the I/O can only be TMR

Public Information
11.16.3 Add Modules
➢ To add a module: from the Hardware tab Tree View, right-click Distributed I/O and select Add Module.
From the drop-down list, select the

I/O pack redundancy, then select
the module type and click Next
Public Information
Note If the module being added does not have an auxiliary terminal board, the page below will not display.
Click Release Notes for information about the

From the drop-down list, select the selected module version. If the Module Required
I/O pack version. Listed versions check box is selected, the module must be present
depend on the compatibility codes. and functioning for the controller to go online.

Public Information
11.16.4 Configure YSIL I/O Module
A YSIL I/O module can only be added to a group. Groups and the option to add a group display in Group layout only.
Toggle and Sort icons
Public Information
➢ To configure a YSIL I/O module
1. From the Tree View, right-click Distributed I/O and select Add Group to display the Add Group dialog box.
When the Add

Group dialog box
displays, click OK
From the Tree

View, right-click
the group and
select Add Module

Public Information
2. When the Add Module Wizard displays, select the I/O pack.
With TMR
selected,
select the
YSIL I/O pack
and click Next
Note The YSIL I/O module cannot be selected unless the module redundancy is TMR.
Public Information
Enter the Position
(I/O pack location).
The format is:
Stack (single digit)

Column (single
letter)
Row (single digit)
Mounting position
(single letter, if
applicable)
Example: 1A1, 1B2A
Click Next
Enter the Position Click Bar Code to display the

(location) of each ellipsis button and select from
terminal board the bar code file, then click Next

Public Information
Review the
configuration
information (use
the scroll bar to
view all details),
then click Back
to make changes
or click Finish
The Summary tab displays a graphic representation of the YSIL I/O module.
Public Information
Public Information
11.16.4.1 Modify YSIL I/O Module
➢ To modify a YSIL I/O module
1. From the Tree View, right-click the YSIL I/O module and select Modify to display the Modify dialog box.
Modifiable values for the

Main Terminal Board
are:
Bar Code
Position

Auxiliary Terminal
Boards are:
Physical Position
Position
Bar Code

I/O Pack
Configurations are:
ENET1 Port
ENET2 Port
Make changes and click

OK
11.16.4.2 View Module Reports

There are several reports available for the YSIL I/O module. You must be online with the controller to view these reports.
They include reports for:
• Alarm
• Revision
• Communication
• Hardware
Public Information
11.16.5 Organize Modules
I/O modules can be organized into Groups. The Add Group menu option displays only when group mode is selected.
Click to toggle
between layout
mode and
group mode
➢ To create a Group: from the Hardware tab Tree View, right-click Distributed I/O and select Add Group.
From the drop-down list, select a

Enter a Name (up to eight Type (when General is selected, the
alphanumeric characters). Group icon changes to an I/O folder).
Enter a
Description
(optional).
Select the icon

to display in the
Tree View, then
click OK.
➢ To add I/O modules to a Group

1. From the Hardware tab Tree View, drag an I/O module to the desired group.
2. When the cursor changes to a symbol, release the mouse button to move the module.

Public Information
11.16.6 Modify I/O Modules
➢ To modify an existing module: from the Tree View, right-click the module and select Modify.
Modifiable properties
include:
Terminal Board Type
Bar Code
Position
TB Connector
11.16.7 View Modules
Summary View
displays I/O modules in
either group or network
layout. Click the folder
icon to toggle between
the two views
Public Information
Note For information about the settings configured by I/O pack-specific tabs, refer to the I/O pack documentation.
When you select a module from the Tree View, the Summary View provides tabs. The tabs that display vary according to the
I/O module. Tabs that display for all I/O modules include:
• Summary
• Variables
• Diagnostics
• Status
The Summary View toolbar is as follows:
Expand/ Print the

Collapse Zoom the graphical
this view diagram in view Hide/Show
advanced
columns or rows
Detach this Zoom the

view from diagram out
main view
The I/O module in this example is a YAIC. The Summary tab displays a graphical overview of the selected module,
including any diagnostics.

Public Information
Parameters tab allows you to configure all I/O module-specific parameters. After a parameter is changed, updated
pseudocode files must be downloaded to the I/O packs. This download operation does not require a restart 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.
Click the icon to

display or hide
advanced
columns or rows
Note For some I/O modules, these tabs are split into more module-specific input/output tabs that better define their function.
The Variables tab displays available variables from the I/O module that have no physical endpoint. These variables exist
only internally in the I/O module, and can be connected to another variable for use in code.
The Extra Circuits tab contains input/output variables found on the I/O module terminal boards, which can be associated
with the application software. For some I/O modules, these tabs are split into more I/O module-specific input/output tabs that
better define their function.
The Input and Output tabs contain input/output variables found on the I/O module terminal boards, which can be
associated with the application software.
The Diagnostics tab allows you to check Alarms and errors on I/O packs. Each I/O pack has a unique set of diagnostic
signals that can be monitored.
Inactive Alarm(s)
Active Alarm(s)
Public Information
The Status tab allows you to check the I/O pack version and network communication status.
Status Tab Properties

Prod ID Unique address of the producing device 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

Public Information
11.16.8 Upgrade I/O Modules
Note To upgrade multiple I/O modules simultaneously, refer to the section Upgrade Component and I/O Modules.
It is possible to perform an upgrade to the firmware of a single I/O module.
➢ To upgrade a module: from the Tree View, right-click the module and select Upgrade.
Public Information
11.16.9 Diagnose I/O Modules
When a problem with a module is detected, symbols display in the Summary tab. All symbols provide Tool Tips.
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).
Tree View Diagnostic Symbols
Error (ex. link unhealthy)
Warning (ex. active alarm)
Informational (such as inactive alarm)
Normal
Summary Tab Diagnostic Symbols
Inactive Alarm(s)
Active Alarm(s)
I/O pack version status indeterminate
Link broken
Link error
Link warning
Link information
Note Place the mouse over the icon to display Tool Tips.

Public Information
11.16.9.1 I/O Diagnostic Viewer
➢ To open the I/O diagnostic viewer
2. From the Summary tab, right-click an I/O pack or terminal board and select Troubleshoot and Diagnostics.
Diagnostic information display

for the selected I/O module.
11.16.9.2 I/O Diagnostics Report

➢ To create an I/O diagnostic report: right-click an I/O pack or terminal board in the Summary tab and select
Create Module Report and the desired report.
11.16.10 Download 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.
11.16.11 Compare 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.
Module parameters directly affect the operation of the controller and associated I/O
modules. To reduce the risk of improper operation or damage to the unit, always
check the Compare Parameters dialog box before downloading new parameter values
to a component.
Caution
Public Information
➢ To open the Compare Parameters dialog box: from the Hardware tab Tree View, right-click a module to
compare and select Compare Parameters.
11.17 Software Tab

The Software tab contains all application software downloaded to that controller. Right-click the Programs item in the Tree
View to display 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.

If passwords were set in the General tab Property Editor, the following functions require a password.
Software Tab Password Protected Functions

Add Program N/A √
Add Program Group N/A √
Add Task N/A √
Add Variable N/A √
Change Controller Password N/A √

Public Information
11.17.2 Add Program
➢ To add a program, program group, or existing program: from the Tree View, right-click Programs and select
Add Program.
If adding a
program group,
enter a name
and click OK
Note The Add Existing Program command reads an .xml file from another system or controller into the current controller.
Public Information
11.17.3 Add Task
Tasks can be inserted within a program.
➢ To add a task: from the Tree View, right-click the name of an embedded or unlinked program and select Add Task.
Enter a Name to
insert an
embedded task
or
select the Select
Library Block
check box to insert
a linked task.
Select a
category and a
definition from
that category.
Enter a name
for the linked
task.
Click All to
display all
categories and
definitions.
Click None to
clear all
categories.
11.17.4 Enable and Disable Tasks

Tasks can be enabled or disabled in the configuration to prompt the runtime to execute that task or not.
➢ To enable or disable a task

1. From the Software tab Tree View, expand Programs, expand a task, and right-click Variables to display the task
variables in the Summary View.
2. In the Data Grid, set the variable _EnableInitial Value column value to True or False:
a. To enable the task, select True.
b. To disable the task, select False.

Public Information
OR
When the controller is online, double-click the live value of the variable _Enable for the task, select True to enable the task
or False to disable the task, then click Send & Close.
Public Information
When the controller is online, the task icon in the Tree View indicates the executing state of the task as either enabled or
disabled.
Task Icons in Tree View
Task Icon Executing State

Enabled
Disabled

Public Information
If the task is disabled and selected in the Tree View, the Summary View displays the text Task Disabled.
Task Disabled
11.17.5 Add Special Task

The Cause and Effect Matrix is a Special Task that can be inserted within a program. Refer to the chapter Mark VIe Cause
and Effect Matrix for additional details.
Public Information
A controller has two types of libraries:
• Function block libraries describe software that is part of the controller firmware
• User block libraries combine these function blocks into user blocks
➢ To reference a function or a user block library

1. From the Tree View, right-click Programs and select Library References.
2. From each 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.
11.17.7 Instance All
Note It is not possible to undo this command.
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.

Public Information
11.17.8 Overridable Properties
➢ To select overridable properties: from the Tree View, right-click Programs and select Overridable
Properties.
Select properties to be overridden

and click the arrow to move them.
The Protection
property defines
access rights to
the properties list.
Public Information
11.17.9 User Block
The user blocks of a controller program display in the Tree View within the Programs item under tasks, or other user blocks.
➢ To instance a user block: from the Tree View, right-click a user block and select Instance.
11.17.9.1 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 Tree View, expand the User Block item, right-click Variables and select either Add
Variable or Add Undefined Variables.
2. From the Add New Variable dialog box, enter the name 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.
11.17.9.2 User Attributes
Note Refer to the section Work with User Blocks.
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.

Public Information
11.17.9.3 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.
User Block Properties
Unlink Unlinks the user block from the definition
Block Type Name of the user block definition in the library from which this user block started
Name Name of this user block
Protection Expands to show the access rights for this user block definition
11.17.10 Add User Block

➢ To add or instance a user block: from the Tree View, right-click the task and select from the shortcut menu.
A user block can either be linked from a user block library or embedded in a container.
The Summary View displays the block diagram for either the user block selected in the Tree View or its container.
11.17.11 Unlink Permanently

A program that is linked to a Library Container can be permanently unlinked from the controller.
Note Linked tasks and user blocks can also be unlinked permanently.
➢ To unlink a program: from the Tree View, right-click a program item and select Unlink Permanently.
The linked icon next to the item in the Tree View changes and the program is unlinked from the library.
Public Information
11.17.12 Property Editor
The Property Editor displays the properties of the item selected in the Tree View.
Property Editor Properties

Programs
Removes the unused variables for all linked user blocks in this device when the user block is
Remove Unused Variables
instanced
Description Allows you to describe the program
Library Type Name of the library definition from which this program came
Name Allows you to name the program
Protection
permissions for this program
Task
Name Name of this task
Instance Script Runs when the task is instanced.
Detached Summary File Path to the summary diagram for the user block definition
Help File Allows you to locate the Help file by clicking the ellipsis button
Help Text Locally defined Help that supersedes the global Help
Protection
Revision History Allows you to edit the revision history by opening the Edit Text dialog box
Version User-defined version of a task
User Block
Block Type Name of the library block that the selected block is an instance of
Unique identifier that allows the block to be referenced from other locations in the ToolboxST
Instance Name
application
Instance Script Causes the script to run when the block is instanced
Height Height of the selected block in the diagram.
Left Location of the left of the selected block
Selected Pin Pin currently highlighted in the diagram
Show Description When set to True, displays the description of the selected block
Top Location of the top of the selected block
Width Width of the selected block
Block Data Type Data type for variant pins in the selected block instance
Enable When set to True, enables variables for the selected block
Version Version number for the source of the selected block instance
Execution Order Determines when this block is started

Public Information
11.17.13 Program Variables
Program variables are Global variables associated with a particular program. The variables are displayed in the Tree View
within the Programs item. Undefined variables for a program are Global variables that have been referenced in a controller,
but have not been defined as part of a program or user block. Undefined variables for tasks and user blocks are Local
variables that have been referenced within the task or user block.
➢ To add a variable to a program: from the Software tab, expand the Programs item.
Right-click the Variables

item and select Add
Variable or Add
Undefined Variable
Public Information
User block and task variables are local by default, and display under the associated user block item in the Tree View.
Note Variables can also be added in the Summary View by directly editing the last row of the variable grid.
Variables can be edited both in the Data Grid and the Property Editor. The Data Grid is used to view or edit variable
definitions, and can be configured to display a subset of the variable properties.
Data Grid Variable Properties

Alarms and Events
Alarm Severity Value assigned to an Alarm in the active state. The valid range is 1 through 1000, where 1 is the least severe.
If set to Alarmed (True), enables the variable as an Alarm. Alarms are used for problems that require the operator’s
Alarm
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 color Alarms.
Alarm Inhibit Group Selects the Alarm inhibit group for the Alarm variable.
If set to True, causes the Alarm to be generated on a 1-to-0 transition. The Alarm property must be set to Alarmed
Alarm On Zero
(True).
Alarm Shelving If enabled, temporarily removes selected Alarms from the Alarm Viewer display
Alarm Shelving Max
Period of time during which the selected Alarm(s) remains removed from the display
Duration
Child Alarms Alarms configured as child to the variable (variable should be an alarm)
If enabled, removes the Alarm from the Alarm Viewer display when the Alarm transitions to the normal state. The
Auto Reset
operator is not required to acknowledge the alarm.
Consequence of Provides an ellipsis button that opens an Edit Text dialog box to enter consequences.
Inaction <in If a second language is configured, an additional property, Consequence of Inaction in <language name> also
English> displays to enter consequences in that language.
If set to True, enables the variable as an Event. Events are stateless messages that are not queued within the controller.
Event
When an Event occurs, a time-tagged transition message is sent to any HMIs that have signed up for Events.
If set to True, enables the variable as a Hold, which is similar to an alarm. The Hold queue contains a list of time-tagged
Hold
Hold states in the turbine startup sequence.
Normal Severity The value assigned to an Alarm in the normal state. The valid range is 1 through 1000, where 1 is the least severe.
Operator Action <in
If a second language is configured, an additional property, Operator Action in <language name> also displays
English>
Parent Alarms Alarms configured as parent to the variable (variable should be an alarm)
Potential Causes
If a second language is configured, an additional property, Potential Causes in <language name> also displays
<in English>
Cannot be modified. It is automatically entered from the hardware library if the hardware point is defined as a Sequence
of Events (SOE). SOE are similar to event messages, but they are associated with I/O transitions rather than
SOE Description
application-variable transitions. They are also typically time stamped to a much finer resolution (1 ms) than Alarms or
Events.

Public Information
Appearance
Determines when the pin displays on the block diagram:
• Never: Never show the pin on the block diagram, but it shows up in the Block Pin Connections window
Visibility
• Used: Show the pin when connected to something
This property is
• Always: Always show the pin on the block diagram
only applicable for
• Hidden : Never show the pin anywhere. Depreciated in favor of Internal, but has same effect.
Libraries.
• Internal : Never show the pin anywhere. Used for internal states like totalizer counters.
• Parameter : Only show the pin in the block's parameter list (ControlST V03.03 and later)
Format
Default upper limit for displays on the HMI (for example, bar graph or trending displays). If a Format Spec has been
Display High Limit
specified and this display-high property is not specified, the Format Spec Engineering Max is used.
Default lower limit for displays on the HMI (for example, bar-graph or trending displays). If a Format Spec has been
Display Low Limit
specified and this display-low property is not specified, the Format Spec Engineering Min is used.
If set to True, allows the Entry High Limit and Entry Low Limit of a linked numeric variable to be modified
Override Entry The Override Entry Limits property is only available for numeric variables contained within a linked program,
Limits task, or user block, with the Allow Entry Limits property set to True.
Allow Entry Limits Override must be set True in a Library module for this feature to be available.
Allow Entry Limits If set to True, enables the Override Entry Limits property for the library variable inside a device.
Override The Allow Entry Limits property is only available for numeric global variables inside a Library Container.
HMI Resource Allows you to configure access and visibility of variable and alarm data
Determines the number of digits to the right of the decimal point.
Precision 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.
Engineering units If a Format Spec has been specified and Units is not specified, the Format Spec Units is used with the
Units
SDB version of the HMI device. This attribute is not used. Only the format specification's Units string is used.
Public Information
General
Variable tag name that can be customized by the user. Aliases are available to the WorkstationST component and the
HMI.
ToolboxST can also be placed in Alias mode so the Alias is displayed instead of the variable name in logic sheets,
Alias
properties, and dialogs. This allows standard application code to be created in one variable naming convention, but
edited and viewed in a second naming convention as needed. Refer to the section Variable Names and Aliases for
further details.
Array Number of elements in this array variable
Connection Allows a variable to be connected to another variable
Program variable description in Primary language
Description
This property displays if only one (Primary) language is configured.
Enumerations Values represented in separate CSV records
Fully qualified name of the variable. For example, a variable name gas_fuel_opt in a user block named Config under the
Full Name
Program CORE would have a full name of CORE.Config.gas_fuel_opt.
Inherit Description
of Connected
Variable
If set to True, causes the selected pin to inherit the description of any connected global variable
This property is
only applicable for
Libraries.
Name Variable name
Nonvolatile Indicates that the variable should be saved in non-volatile RAM
Type Refer to the following table, Variable Data Types
Keep During
Instance
This property is When set to True, keeps this variable during instance, even if unused.
only applicable for
Libraries.
Override Properties If set to True, identified overridable properties (set for each device) in instanced linked code in a device will not be
This property is updated with new values from the library when code is re-instanced, but instead will maintain any changes made to that
only applicable for instance.
a device. This property is only valid for a linked object.
Override Value Determines if the setting for Value overrides the setting in the library
This property is This property only displays in the data grid for a library, but it cannot be modified in the library.
only applicable for This property is only valid for a Control Constant in a linked object and hysteresis is the sub-variable for analog
a device. alarms.
Description
Primary Language Variable description in primary language
Second Language Variable description in secondary language

Public Information
Logging
Historian Deadband Boolean and set to Logged on Change
Historian Deadband
Defines the deadband value as either engineering units or percent of range.
Definition
Enables the automatic collection by the Recorder when:
Recorder
Boolean and set to Logged Continuous or Logged on Change
Deadband
Recorder
Deadband Defines the deadband value as either engineering units or percent of range
Definition
CEL Command If set to True, prevents modify-variable commands from being written into the Command and Event Log (CEL) (default is
Filter False)
Usage
Allows a variable to be designated as a configuration setting. The default value is False, which prohibits changing live
Control Constant
values. Setting the property to True allows you to change live values.
If set to True, downloads extended information to the controller that is used by the web server, as well as other
Download Info
processes
External Access
The variable's global name prefix type (None, Full, Block, Program, Task).
This controls the form of the global name that displays on the EGD page. For example, the name for variable IGVA in
user block VG_Health in task Task1 in program CORE would display (depending on the Global Name Prefix) as:
None: IGVA
Global Name Prefix
Full: CORE.VG_Health.IGVA
Block: VG_Health.IGVA
Program: Task1.IGVAv
Task: Task1.IGVAv
Scope of the variable (Local, Member, or Global):
Local variables can only be used in the program or user block in which it is created.
Scope
Global variables can be used in other programs and user blocks. A variable must be Global to be transmitted over EGD.
Member variables are similar to Local variables, but differ in that they are visible to child tasks and user blocks.
Defines the behavior of pins on a user block
Usage
Input pins display on the left side of the user block
This property is
Output pins display on the right side of the user block
only applicable for
State pins display on the right side of the user block
Libraries.
Constant entry is a number; no live data is provided for this pin
Entry High Limit Default upper limit for setpoint entry on the HMI
Entry Low Limit Default lower limit for setpoint entry on the HMI
Is Critical When set to True, the variable is marked as critical to safety or operation, and must be driven and driving a block pin.
Public Information
Variable Data Types
Data Type Description
Any (ANY) Any data type
Boolean (BOOL 8–bit Boolean
Integer (INT) 16–bit signed integer
Double Integer (DINT) 32–bit (long) signed integer
Real (REAL) 32–bit floating point
Long Real (LREAL) 64–bit (long) floating point
Unsigned Integer (UINT) 16–bit unsigned integer
Unsigned Double Integer (UDINT) 32–bit (long) unsigned integer
Numeric (ANY_NUM) Any data type except Boolean
Analog or Boolean (Simple) Any simple data type
➢ To select a variable data type
From the
Summary View,
select a variable.
From the Type
drop-down list,
select the
variable type.
Or:
from the
Property
Editor,
select Type
and the
variable type

Public Information
11.18 Ethernet Global Data (EGD) Tab


Public Information


page.

Public Information

display.
Mode
Default Page
Layout Mode
Period Multiplier
Skew
Public Information

display.
Mode
Default Page
Layout Mode
Period Indicates the transmission period of the page in ms.
Period Multiplier
Skew

Public Information

dialog box.
Public Information
the signature.

11.18.5 EGD Configuration Server Tab

from that server.
the open component.
When a component is saved, the EGD configuration is automatically published to the EGD configuration server. To avoid
unintentional overwriting of data, do not configure more than one .tcw file for a server.

Public Information
With the system item selected, the EGD configuration server tab can be enabled on the System Editor Property Editor. When
enabled, the Produced Pages item has two additional context menu items as follows:
• Compare command compares the component's EGD-produced data configuration with the EGD configuration server’s
content.
• UnConsumed Data command generates a report showing variables produced by this component that are not listed in
any other device’s consumed data file.
Note You can select devices to search against. The individual pages, with just variables, perform the same Compare.

1. From the Tree View, right-click Referenced Devices and select Select Devices.
2. From the Select Devices dialog box, select or clear the check boxes next to each component name and click OK.
variable information is used. The configuration is automatically refreshed when a component is opened, and when a Build is
performed in the component.
➢ To refresh the configuration of a referenced device: from the Tree View, right-click the device to be refreshed
and select Refresh.
11.18.7 Create Undefined Variables

The Create Undefined Variables option allows you to create variables in a component created from a referenced device. The
list of undefined variables is generated when a Build command is performed. As the variables become available from the
referenced device, they are deleted from the list.
➢ To create undefined variables for a single or multiple referenced device(s): from the Tree View, right-click
either the device or Referenced Devices and select Create Undefined Variables.
Public Information
11.19 Modbus Slave Tab
The Modbus Slave feature allows a Modbus Master to Read data directly from the Mark VIeS Safety controller using the
Modbus protocol over Ethernet. (The Write command from the Modbus Master is not supported.)
11.19.1 Configure Modbus Slave

➢ To configure a Modbus Slave
1. From the Component Editor, select the Modbus Slave tab.
2. From the Property Editor, modify properties as needed.
Note Modifying Modbus properties results in a minor difference in the ToolboxST configuration. However, removing all
Modbus points creates a major configuration difference that forces an offline load.
Modbus Properties
Property Description Valid Range
Specifies the time in minutes that the slave remains connected to the master over
Connection Timeout 1 to 10
Ethernet when no requests are being received.
Port choices:
Ethernet Port Specifies the Ethernet port to be used for slave-Ethernet communication
502 and 503
Specifies the timeout period expressed as character time X 10. For example, 35
Inter-Character Timeout
represents 3.5 character times, or 0.0036 seconds at 9600 baud, 1 start bit, no 35 to 1000
(ICT)
parity, 1 stop bit.
Choices:
None, Odd,
Parity Specifies check character Even,
Mark, and
Space
Response Delay Additional delay time in ms before the slave responds to a master request. 0 to 999
Limits the number of commands processed per second. This is based on commands
Command Limit that have changed, not commands that are identical to previously received 0 to 25
commands.
Data Swapped Changes the transmission order if the data is greater than 16 bits when set to True. True or False
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
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. Possible codes are 4, 6 or None. None is selected only if the Modbus Master needs no reply
when communication fails between the Mark VIeS Safety controller and the target processor.

Public Information
11.19.2 Modbus Slave Register Pages
The Modbus Slave tab Summary View contains four tabs used to exchange data with a Modbus Master. The pages differ by
the access the Master receives to the data (Read-only) and the type of data (a Boolean or a 16-bit word) as follows:
Page Data Type Access

Holding Register 16-bit Register Read-only
Coil Single Bit Read-only
Input Register 16-bit Register Read-only
Input Single Bit Read-only
Note For Modbus resources, go to http://www.modbus.org.
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 from the Property Editor, select None as the Interface.
When a variable is added, the columns that display are listed in the following table.
Variable Columns
Column Description
Variable that is read or written from the device or the referenced device
Connected Variable
A connected variable must be added before the other columns become active.
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.) All
BOOLs within a word must be set to the same Read direction.
• INT is a signed 16-bit word that takes one register
Point Data Type
• 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
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. Data types that are 32 bits or more
Address (DINT, UDINT, REAL, and LREAL) should be placed on odd addresses. The valid range for addresses
is 1 to 65534. When specifying an address for a BOOL variable, the bit 0-15 within the 16-bit word is
represented by a decimal. For example, 1.00 selects register address 1 and bit 0, and 10423.7 selects
register address 10423 and bit 7.
Raw Min Convert Modbus Slave variable data into engineering units
Raw Max The Raw Min and Raw Max columns control the minimum and maximum for the raw data. The Eng Min
Eng Min 0 and Eng Max columns control the minimum and maximum engineering units to which the raw data will
Eng Max be scaled. (The BOOL data type cannot be scaled.)
Read-only identifier automatically generated from the register page name, the address, and, if
Name
necessary, an added unique number
Public Information
11.19.3 Data Format
All variables handled by the controller Modbus I/O are transferred to the controller signal space at the start of each task if
they are referenced in the control code. This method allows data type conversions and scaling. The data type conversion is
controlled by the type of Modbus variable and controller signal data type.
Float values are rounded prior to being stored in short or long registers. Short and long registers are clamped to their
minimum and maximum limit if the conversion exceeds their specified range.
Available Controller Data Type Conversions

Coil Register Bit 1 Register 2 Registers 4 Registers
Modbus Data Type
BOOL BOOL INT UINT DINT UDINT REAL REAL
BOOL Yes Yes N/A N/A N/A N/A N/A N/A
INT N/A N/A Yes Yes Yes Yes Yes Yes
UINT N/A N/A Yes Yes Yes Yes Yes Yes
Controller
DINT N/A N/A Yes Yes Yes Yes Yes Yes
Signal Data
UDINT N/A N/A Yes Yes Yes Yes Yes Yes
REAL N/A N/A Yes Yes Yes Yes Yes Yes
LREAL N/A N/A Yes Yes Yes Yes Yes Yes

Public Information
11.19.4 Data Scaling
Data scaling converts the Modbus variable into a signal that represents engineering units. Multiple signals can share one
scaling record.
The Modbus variable assumes a range

of 0 to 4000, while the controller signal is
between -40 and 160 degrees
The gain is defined as:

Gain = EngRange/RawRange
Gain = (Engmax – Engmin)/(Rawmax – Rawmin)
Gain = (160 - (-40))/(4000 – 0) = (160 + 40)/4000
Gain = 200/4000 = 1/20 = 0.05
The offset is defined as:
Offset = Engmin – (Rawmin x Gain)
Offset = -40 - (0 x 0.05) = -40
The formula to convert the Modbus variable to a controller signal is:
Controller signal = Modbus variable x Gain + Offset
Controller signal = Modbus variable x 0.05 + (-40)
Controller signal = Modbus variable x 0.05 - 40
If the Modbus variable’s raw value is 1000, the controller value is (1000 x .05) - 40, or 10 degrees.
Note The range of the Modbus variable is determined by the data type and not by the scaling record. Each integer data type
has an implied range. The raw data range in the scale dialog box is only used to compute the gain and offset of the variable
when converting it to a signal.
The formula to convert the controller signal to a Modbus variable is:

Modbus variable = (Controller signal - Offset)/Gain
Modbus variable = (Controller signal - (-40))/0.05
Modbus variable = (Controller signal + 40)/0.05
If the controller signal is 10, the Modbus variable is (10 + 40)/0.05 or 1000. Modbus variables and controller signals do not
have to be associated with a scale definition, even if a data type conversion is required. A gain of 1 and an offset of 0 are used
in these cases.
An INT variable is a signed 16-bit number. In this mode, the most significant bit is treated as a sign bit where a one is used for
negative values. Controller signals are converted into INT Modbus variables by applying the scaling information, rounding
the values to the nearest integer value, and then clamping the result in the range of −32768 to +32767.
A UINT variable is an unsigned 16-bit number. Controller signals are converted into UINT Modbus variables by applying the
scaling information, rounding the values to the nearest integer value, and then clamping the result in the range of 0 to +65535.
A DINT variable is a signed 32-bit number. The value is transmitted on Modbus as two consecutive 16-bit integers with the
least significant word in Register N and the most significant word in Register N+1. In this mode, the most significant bit is
treated as a sign bit where a one is used for negative values. Controller signals are converted into DINT Modbus variables by
applying the scaling information, rounding the values to the nearest integer value, and then clamping the result in the range of
–2147483648 to +2147482647.
Public Information
A UDINT variable is an unsigned 32-bit number. The value is transmitted on Modbus as two consecutive 16-bit integers with
the least significant word in Register N and the most significant word in Register N+1. Controller signals are converted into
DINT Modbus variables by applying the scaling information, rounding the values to the nearest integer value, and then
clamping the result in the range of 0 to +4294967295.
A REAL variable is a signed 32-bit IEEE 754 standard number. The value is transmitted on Modbus as two consecutive
16-bit integers with the least significant word in register N and the most significant word in register N+1. In this mode, the
most significant bit is treated as a sign bit and the next eight bits are a biased exponent followed by a 23-bit significant.
Controller signals are converted into FLOAT Modbus variables by applying the scaling information.
Note To ensure data coherency, LONG Modbus variables should always start on an odd register number, and the master
should send both registers to the controller in the same Modbus transaction.
To ensure data coherency, FLOAT Modbus variables should always start on an odd register number, and the master should
send both registers to the controller in the same Modbus transaction.
11.19.5 Command and Response Definition

This section describes the commands and responses supported by the UCCA to implement the Modbus communications and
functions. The UCCA is a Slave station on an RS-232C data link that responds to commands from the Master. Messages are
transmitted and received using the RTU transmission mode where RTU transmits data in 8-bit bytes.
11.19.5.1 Message Format

The Serial RTU transmission mode uses the following format (where follower address, function code, CRC-16 MSB, CRC-16
LSB are all bytes):
Station ID Function Code … Function Specific Data … CRC-16 MSB CRC-16 LSB
CRC-16 are two bytes that complete every serial Modbus message. These bytes check errors and are calculated to ensure that
no transmission error occurred while the message was in transit. The method for calculating the CRC-16 is a public protocol.
Refer to the Gould Modicon Modbus Protocol Reference Guide for information on calculating a correct Cycle Redundancy
Check (CRC).
The same functions are supported over Ethernet and the serial ports. All Modbus messages are received on the specified
Ethernet port. The Ethernet physical layer provides a CRC-32 check on all transmissions so the Modbus CRC-16 is not
included. Modbus over Ethernet adds the following header to the message formats.
Invocation Invocation Protocol Protocol Length Length Station ID Function … Function

ID MSB ID LSB MSB LSB MSB LSB Code Specific Data …
Invocation ID is not used by the controller Modbus. Set to 0.

Protocol ID is not used by the controller Modbus. Set to 0.
Length is the byte count of the remaining part of the message and is used by the Modbus to receive the rest of the message,
which is exactly what is sent and received over the serial connections.

Public Information
11.19.5.2 Message Errors
When a message that cannot be acted upon is received, it is either ignored (and the controller waits for the next message) or
an exception message is generated. Any messages that are misunderstood, incomplete, or altered in some manner (framing,
parity, or CRC-16 error) are always ignored because it is not possible to reliably determine the intention of the message. The
master must detect this timeout condition and resend the message as necessary.
Any time a message receipt is being sent over a serial connection and an interval of time corresponding to 3.5 character times
(based on the baud rate) occurs without receipt of a character, the message receipt in progress is aborted and ignored. Other
message failures are responded to with an exception response if no reception error has occurred, and if the message was not a
broadcast (follower address was zero). The following table displays the exception code responses that are supported when a
normal response is impossible.
Exception Code Responses

Code Name Description
01 Illegal function Message function received is not supported
02 Illegal data address Address referenced in the data field is not in a permissible range
03 Illegal data value Value transmitted in the data field is illegal
04 Device failure Data source is unhealthy
99 Illegal slave address Illegal slave address sent through Ethernet
The exception message reply from the controller is formatted as follows:

Station ID (controller address) must be in the range of 1 to 255.
Function code is always equal to the master’s function code with the MSB set. As an example, an exception response sent
back to a master that sent a message with function code 02 hex, would have a function code of 82 hex (or 130 decimal) in the
exception reply.
Exception codes are as described in the table, Exception Code Responses. Only codes 01 through 03 and 06 are supported.
Public Information
11.19.6 Function Code Descriptions
The nine function codes implemented in the controller are used to read from the four Modbus table types. The following table
lists the function codes included in the messages sent from the DCS that are supported by the controller. Each function code
and the controller reply are described in this section.
Function Code Descriptions

Code Description
01 Read output coils
02 Read input coils
03 Read holding registers
04 Read input registers
07 Read exception status
11.19.6.1 Function Code 01: Read Output Coils

Function code 01 is used to read the output coil table. The message sent from the master is formatted as follows:
Function Code (01) Start Coil (MSB) Start Coil (LSB) Number of Coils Number of Coils
(MSB) (LSB)
Starting output coil number is two bytes long, and can be any value less than the highest output coil number available in
the output coil table. The starting output coil number is equal to a number one less than the first output coil returned in the
normal response. For example, to get the first output coil, enter 0 for the starting output coil number. The high-order byte of
the starting output coil number field is sent as the first byte. The low-order byte is sent next.
Number of output coils to return is two bytes long, and must be from 1 to 2000, inclusive. It specifies the number of
output coils returned in the normal response. The sum of the starting output coil value and the number of output coils must be
less than or equal to the highest output coil number available in the output coil table. The high-order byte of the number of
output coils field is sent as the first byte. The low-order byte is sent next.
Data bytes (data field) are the packed output coil status data. Each byte contains eight output coil values. The LSB of the
first byte contains the value of the output coil whose number is equal to the starting output coil number plus one. The value of
the output coils are ordered by number, starting with the LSB of the first byte and ending with the MSB of the last byte. If the
number of output coils is not a multiple of eight, then the last data byte contains zeros in one to seven of its highest order bits.

Public Information
11.19.6.2 Function Code 02: Read Input Coils
Function code 02 is used to read the input coil table. The message sent from the master is formatted as follows:
Function Code (02) Start Coil (MSB) Start Coil (LSB) Number of Coils (MSB) Number of Coils (LSB)
Starting input coil number is two-bytes long and can be any value less than the highest input coil available in the input
coil table. The starting input coil number is equal to one less than the number of the first input coil returned in the normal
response. For example, to get the first input coil, enter zero for the starting input coil number. The high order byte of the
starting input coil field is sent as the first byte. The low order byte is sent next.
Number of input coils to return is two-bytes long and must be from 1 to 2000, inclusive. It specifies the number of input
coils returned in the normal response. The sum of the starting input coil value and the number of input coils must be less than
or equal to the highest input coil available in the input coil table. The high order byte of the number of input coils field is sent
as the first byte. The low order byte is sent next.
Data bytes (data field) are the packed input coil status data. Each byte contains eight input coil values. The LSB of the first
byte contains the value of the input coil whose number is equal to the starting input coil plus one. The value of the inputs are
ordered by number, starting with the LSB of the first byte and ending with the MSB of the last byte. If the number of input
coils is not a multiple of eight, then the last data byte contains zeros in one to seven of its highest order bits.
11.19.6.3 Function Code 03: Read Holding Registers

Function code 03 is used to read holding registers. The message sent from the master is formatted as follows:
Function Code Start Register Start Register Number of Registers Number of Registers
(03) (MSB) (LSB) (MSB) (LSB)
Starting holding register number is two-bytes long and can be any value less than the highest holding register number
available in the holding register table. The starting holding register number is equal to one less than the number of the first
holding register returned in the normal response. For example, to get the first holding register number (holding register
number one) enter zero for the starting holding register number. The high order byte of the starting holding register number
field is sent as the first byte. The low order byte is sent next.
Number of holding registers value is two-bytes long and must be from 1 to 128, inclusive. It specifies the number of
holding registers returned in the normal response. The sum of the starting holding register value and the number of holding
registers must be less than or equal to the highest holding register number available in the holding register table. The high
order byte of the number of holding registers field is sent as the first byte. The low order byte is sent next.
Function Byte Count First Register First Register … Data Registers Last Register (LSB)
Code (03) (MSB) (LSB) Requested …
Holding registers are returned in the data field in numerical order, with the lowest number holding register in the first two
bytes and the highest number holding register in the last two bytes. The number of the first holding register is equal to the
starting holding register number plus one. The high order byte is sent before the low order byte of each holding register.
Public Information
11.19.6.4 Function Code 04: Read Input Registers
Function code 04 is used to read input registers. The message sent from the master is formatted as follows:
Function Code (04) Start Register Start Register Number of Registers Number of Registers
(MSB) (LSB) (MSB) (LSB)
Number of input registers value is two-bytes long and must be from 1 to 128, inclusive. It specifies the number of input
registers returned in the normal response. The sum of the starting input register value and the number of input registers must
be less than or equal to the highest input register number available in the input register table. The high order byte of the
number of input registers field is sent as the first byte. The low order byte is sent next.
Function Code Byte Count First First Register … Data Registers Last Register (LSB)
(04) Register (LSB) Requested …
(MSB)
Input registers are returned in the data field in numerical order, with the lowest number input register in the first two bytes
and the highest number input register in the last two bytes of the data field. The number of the first input register in the data
field is equal to the starting input register number plus one. The high order byte is sent before the low order byte.
11.19.6.5 Function Code 07: Read Exception Status

Function code 07 is used to read the exception status data, defined as the first eight output coils. These can indicate the
controller status or condition of any other state. Function code 07 thus provides a short form of request for reading the first
eight output coils, output coils one through eight. The message sent from the master is formatted as follows:
Function Code (07)
Function Code (07) Data Byte
Data bytes (data field) are the packed output coil status data. The data byte contains eight output coil values. The LSB of
the byte contains the value of output coil number one. The MSB contains the value of output coil number eight.

Public Information
11.20 Mark VIeS Reports
Mark VIeS control reports provide a variety of controller information in a viewable format. Generated reports display in a
Reports can also be sorted, filtered, and searched to quickly locate information. This chapter describes the following reports
and their use, as well as how to create the reports, and report features:
• Variable
• Block Pin
• I/O
• Alarm
• Hold
• Event
• NVRAM
• IONet EGD
• I/O Diagnostics
• Coding Practices
• Unlinked Programs/User Blocks
11.20.1 Variable Report

The Variable reports enable the user to create reports listing every signal (variable) used in the control code and it used to
collect current data for parameters and specifics for third-party devices. This section describes the following Mark VIeS
control variable-related reports:
• Global variables
• Variable configuration
• Web
• Compressed data log
• EGD point list
• Alias
• Second language
Public Information
11.20.1.1 Global Variable Report
The Global Variable report lists all Global variables used in the application code. Operators can view the variable definition
for variable descriptions and parameter data.
➢ To create a Global Variable report

1. Generate a Global Variables report.
From the View menu, select Reports, Variable, and Global.

report is being created, then the Global
Variable report displays the results.
Global Variable Report Example
2. Review the list of Global Variables.

Public Information
3. View variable definition data.
Double-click a Global
Variable to go to where
the variable is defined
Public Information
Global Variable Report Columns
Column Description
Name Global Variable name
Used in Code If True, any connection used in the code
Written Multiple If True, indicates the variable is written more than once in the code
Control Constant If True, indicates the variable is a control constant
Alarm Indicates either alarmed or not alarmed (for Booleans), and provides the definition for Analog alarms
Locator Full variable name, used to find the I/O point in the device
If enabled, causes the Alarm to be cleared before the operator acknowledges the Alarm condition when
Auto Reset the process returns to normal limits.
Refer to the WorkstationST Alarm Viewer Instruction Guide (GEI-100620).
Alarm Shelving Max Duration Maximum time, in minutes, that an alarm can remain shelved
Consequence of Inaction Consequence if operator does not address the alarm
Operator Urgency How important for operator to address the alarm
Potential Causes What may have occurred to cause this alarm
Second Language Consequence of
Consequence in second language if operator does not address the alarm
Inaction
Second Language Operator Urgency How important in second language for operator to address the alarm
Second Language Operator Action Action in second language the operator should take to avoid defined consequences
Second Language Potential Causes What may have occurred to cause this alarm in second language
Access Variable access type
Alarm Class Selects a system-configured Alarm Class, which is used by an HMI to classify and color Alarms
Alarm Inhibit Group Alarm Inhibit Group with which this variable is associated
If set to True, causes the Alarm to be generated on a 1–to–0 transition. Alarm property must be set to
Alarm On Zero
Alarmed (True).
Array If set to True, variable is an array
Default upper limit for HMI displays (bar graph, trending, and such). If a Format Spec has been
Display High
specified and this property has no specification, the Format Spec Engineering Max is used.
Display Low Default lower limit for HMI displays
Display Screen Default HMI screen name
Entry High Upper limit for setpoint entry on HMI
Entry Low Lower limit for setpoint entry on HMI
If set to True, enables the variable as an Event. Events are stateless messages not queued in the
Event controller. When an Event occurs, a time-tagged transition message is sent to all HMIs configured for
Events.
Format Spec Name of the Format specifications used to control the method of presenting variables in an HMI
Global Name Prefix Importable value is a predefined enum; it can be set to None, Full, Program, Block, and Task
If set to True, prevents modify-variable commands from being written into the Command and Event Log
CEL Command Filter
(CEL) (default is False)

Public Information
Global Variable Report Columns (continued)
Historian Deadband
Historian Deadband Definition Definition of Historian Deadband value
If set to True, enables the variable as a Hold, which is similar to an Alarm. The Hold queue contains a
Hold
list of time-tagged Hold states in the turbine startup sequence.
I/O True if value is connected to an I/O
Intrinsic True if variable is intrinsic one
NVRAM Indicates that the variable should be saved in non-volatile RAM
Determines the number of digits to the right of the decimal point. This is the default for precision when
Precision the number displays on the HMI. If a Format Spec has been specified and this property has no
specification, the Format Spec Precision is used.
Read Value is Read from the variable in the code, EGD, or I/O
Enables data collection of this variable in the Recorder if the value is changed from Not Logged to a
non-negative number for analog variables, or changed to Logged on Change or Logged Continuous for
Recorder Deadband
Boolean variables. This value represents the amount that the data value must change before it is
stored.
Recorder Deadband Definition Definition of the Recorder Deadband value
SOE True if variable is configured as an SOE
SOE Description Description of SOE
Written Value is written to variable in the code, EGD, or I/O
Public Information
11.20.1.2 Variable Configuration Report
The Variable Configuration report lists all configured variables used in the Mark VIe control application code. Operators can
view the variable definition for variable descriptions and configuration data.
➢ To create a Variable Configuration report

1. Generate a Variable Configuration report.
From the View menu, select Reports, Variable, and Configuration.

report is being created, then the Variable
Configuration report displays the results.
Variable Configuration Report Example

Public Information
Double-click a variable
to go to where the
variable is configured
Public Information
Variable Configuration Report Columns
Column Description
Name Variable name
Enum If set to True, indicates that the variable has an enumeration
Units Indicates engineering units
Precision Indicates the variable precision
Control Constant If set to True, indicates that the variable is a control constant
Used In Code If set to True, is any connection used in the code
Indicates either alarmed or not alarmed for Booleans, and provides the definition for Analog
Alarm
alarms
Alarm On Zero If set to True, indicates that the Alarm occurs on a 1–to–0 transition
Event If True, indicates that the alarm is an Event
Hold If True, indicates that the alarm is a Hold
SOE If True, indicates that the alarm is an SOE
NVRAM If True, indicates that the alarm is a NVRAM
Array If True, indicates that the Alarm is an array
Alarm Class Indicates a group of alarms that share a common priority and color scheme
Display High Default upper limit for HMI screens
Display Low Default lower limit for HMI screens
Entry High Default upper limit for the set-point entry on the HMI
Entry Low Default lower limit for the set-point entry on the HMI
Recorder Deadband Enables data collection of a variable in the Recorder if the value changes
If set to True, prevents modify-variable commands from being written into the Command and
CEL Command Filter
Event Log (CEL) (default is False)
Historian Deadband Enables data collection of a variable in the Historian if the value changes
Alias
HMIs
Second Language
Description
If enabled, causes the Alarm to be cleared before the operator acknowledges the alarm
Auto Reset
Alarm Shelving Max
Duration

Public Information
11.20.1.3 Web Report
The Web report provides variable name, description, type, alias, second language description, and location in the application
code, as well as where the variable is used and if the variable is written multiple times in the code.
➢ To create a Web report
To generate a Variable Web report, Controller Web Pages must be enabled and the
variables must have the Download Info column set to True.
Attention
1. Generate a Web report.
From the View menu,

and Web.
The Web report displays

the results.
Public Information
Double-click a variable to go
to where the variable is used
Web Report Columns

Column Description
Name Variable name
Used in Code If set to True, is any connection used in the code
Alias
HMIs
Second Language
Description

Public Information
11.20.1.4 Compressed Data Log Report
The Compressed Data Log report provides Wind turbine controller variables being collected on the compressed data log for
the controller. Variable data collected includes description, type, use in code, written multiple, initial value, alias, second
language description, locator, controller collected, display high, display low, entry number, external access, global name
prefix, units, and usage. This report can be used for troubleshooting and informational reference.
➢ To create a Compressed Data Log report
From the View menu, select Reports, Variable, then

select Compressed Data Log.
Example Compressed Data Log Report
Public Information
From the Compressed Data Log report, double-click
a variable to view the configuration details.

Public Information
Compressed Data Log Columns
Column Description
Name Variable name
Used in Code Connection used in code
Written Multiple Written more than once in the code
Initial Value Initial value of variable
Second Language Description in second language (if configured in System Editor)
Controller Collected Variable is collected by the controller (type)
Display High Default upper limit for display on HMI
Display Low Default lower limit for display on HMI
External Access Variable access type
Global Name Prefix Global name prefix
11.20.1.5 EGD Report

The EGD Report provides a list of EGD points that are associated with EGD communication. Users can view the
configuration for each point as well as the settings for troubleshooting, locations (devices), and information reference.
➢ To create an EGD Point List report

1. Generate the EGD report.
From the View menu, select Reports, Variable, and EGD.
Public Information
EGD Point List Report Example
2. Select a variable or point and navigate to the EGD configuration.

Public Information
From the EGD Point List report, double-click a row item
to display the EGD configuration.
Public Information
EGD Point List Report Columns
Column Description
Variable Variable name
Point Name EGD point name
Point Offset EGD point address
Direction Access, either Read-Write or Read-only
Data Type EGD variable data type (BOOL, REAL, UINT)
CIMPLICITY
HMI screen
Resource
Units Units of the EGD variable
Producer ID Unique address of the producing device
Period (ms) Time frame for the EGD points to be updated
Exchange Name Name of the exchange
Destination Destination IP address
Variable tag name that can be customized for use with the
Alias
WorkstationST application and all HMIs
Second Language
Description
Path Location path (or the full name of the item)
Format Specification System-owned format specification assigned to a variable
Exchange Length Length of the exchange
Exchange Number Number of the exchange
Exchange Revision Revision of the exchange

Public Information
11.20.1.6 Alias Report
The Variable Alias report provides the variables and variable alias names. Users can export the report to Excel, enter the
alternative variable alias names, then import the report back into the ToolboxST system to display the alias names in the
Alarm Viewer and other areas where the variable names are available.
➢ To create an Alias report

1. Generate the Variable Alias report.
From the View menu, select Reports, Variable, and Alias.
Public Information
The Alias Report displays the variables and
associated alias names.
2. To enter alias names, save the report as a .csv file, enter alias names, then import the data back into the ToolboxST
system.
Alias Report Columns

Column Description
Name Variable name
Alias Variable alias

Public Information
11.20.1.7 Second Language Report
The Variable Second Language report provides the variable name, the second language description, and the variable
description. Users can save the report file, enter the second language descriptions, then import the report back into the
ToolboxST system to display the descriptions in the Alarm Viewer.
➢ To generate a Second Language report
From the View menu, select Reports, Variable, and Second Language.
Public Information
Example Second Language Report
Second Language Report Columns

Column Description
Name Variable name
Second Language Desc Variable description in selected second language
Description Variable description in selected primary language

Public Information
11.20.2 Block Pin Report
The Block Pin report lists all block pins for every variable in the controller software and the associated blocks. Operators use
the block pin report as a cross-reference report containing pin descriptions, programs, tasks, and where the pins are used.
➢ To generate a Block Pin report

1. Create a block pin report.
From the View menu, select Reports, and Block Pin.
Example Block Pin Report
Public Information
2. Select a block pin and navigate to the pin connections.
From the Block Pin report, double-click a pin to display

the pin connection in the block diagram.
The Software tab displays the program, task, and block in which the pin is used.
Double-click the associated pin to display the connections.

Public Information
Block Pin Report Columns
Column Description
Pin Pin name
Pin Description Pin description
Block Block name
Block Description Description of the instanced block
Task Task Name
Program Program name
Block Execution Determines the order in which the block executes
Connection Pin variable connection
Data Type Pin data type
Program Execution Determines the order in which the program executes
Usage Usage type (such as input, output, contact, state)
11.20.3 I/O Report

The I/O report provides a cross-reference list of signal names to device names. Using this report, operators can locate a device
to find the logic, link to drawings and logic, and locate replaceable items. The following sections describe each available
Mark VIeS control I/O-related report that can be created in detail:
• I/O Variable report

• I/O Configuration report
11.20.3.1 I/O Variable Report

The I/O Variable report provides a list of I/O variables. Using this report, operators can locate a device to find the logic, link
to drawings and logic, and locate replaceable items.
➢ To create an I/O Variable report

1. Generate a variable report.

to display the I/O variable report results.
Public Information
Example I/O Variable Report

Public Information
From the variable report, double-click an I/O variable to display the configuration.
I/O Variable Report Columns

Column Description
Direction Direction of the I/O variable (input or output)
Screw Name Name of the screw on the terminal board
Screw Number Number of the screw on the terminal board
TB Hardware Form Hardware form for the module terminal board
Jumpers List of jumpers in the module
Jumper Value Position used to set the module jumpers
Module Name Module name
Wire Jumpers IDs of the external wire jumpers
Screw Note Additional information about the screw
Wire Number ID of the wire attached to the screw
Cable Number ID of the cable attached to the screw
ID of the terminal board junction between the Mark
Interposing TB
VIe control and the I/O
Sense of the connected relay (used only for relay
Sense
and solenoid circuits)
Bar Code Terminal board bar code
Public Information
I/O Variable Report Columns (continued)
Column Description
Configured redundancy of the I/O pack (simplex,
Pack Redundancy
dual, TMR)
Config Type I/O configuration type
Data Type I/O variable data type
Engr High I/O high value in engineering units
Engr Low I/O low value in engineering units
Raw High Raw I/O high value
Raw Low Raw I/O low value
SeqOfEvents Sequence of Events (SOE)
Signal Invert Signal inversion
If the I/O variable is used by the Control Sequence
Used in Code
Program (CSP), the application code
Mode I/O point configuration mode

Public Information
11.20.3.2 I/O Configuration Report
The I/O Configuration report lists all configured I/O variables in the current configuration. Using this report, operators can
view the configuration of the I/O module for troubleshooting, ordering replacement parts, and informational reference.
➢ To create an I/O Configuration report

1. Generate a configuration report.

Example I/O Configuration Report
Public Information
From the variable report, double-click an I/O variable to display the configuration.
I/O Configuration Report Columns

Column Description
Module Name Name of the module
Config Label Name of the configuration parameter
Config Value Value of the configuration parameter
Category Parameter category (for example, input, outputs)
Category Group Parameter category group name

Public Information
11.20.4 Alarm Report
Note Variables are marked as Alarms in the Property Editor.
The Alarm report provides a list of all alarms in the current configuration and the aspects associated with them. Users can
view the module(s) associated with the alarms in the Alarm Viewer for alarm troubleshooting.

From the View menu, select Reports, and Alarm.
Public Information
2. Select an alarm to navigate to the configuration.

to display the alarm configuration details.

Public Information
Column Description
Name Variable name
HHH Enabled High high high alarming state for the variable when it is defined as an analog Alarm
Alias
and all HMIs
If enabled, causes the Alarm to be cleared before the operator acknowledges the
Auto Reset
Alarm condition when the process returns to normal limits
If enabled, allows the operator to temporarily remove the Alarm from the Alarm Viewer
Alarm Shelving
display
Alarm Shelving Max
Duration
Second Language
Description
Consequences of Inaction Consequence if operator does not address this alarm
Second Language
Consequence in second language if operator does not address this alarm
Consequences of Inaction
Second Language Indication in second language of how important it is that the operator addresses this
Operator Urgency alarm
Second Language
Potential Causes
Second Language
Action in second language the operator should take to avoid defined consequences
Operator Action
Public Information
The GE Rationalization report lists GE Rationalization parameters for the current alarms generated for the variables. Users
can export the report to Excel, enter specific information to manage plant-specific alarms, and then import the updated report
back into ToolboxST to make the values available from Alarm Help in the Alarm Viewer.
Alarm help files are only generated when the Publish Alarm Help property is set to
True in the system Property Editor.
Attention

1. Generate a GE Rationalization report.
2. View the variable alarm details in the report.
Example GE Rationalization Report

Public Information
Column Description
Second Language
Description
Hysteresis
Alarm Shelving
Alarm Shelving Max
Duration
Format Spec
alarm state
alarm condition.
Consequence of
Inaction
Second Language
Consequence of
Inaction
Operator Urgency
consequences
Second Language
Operator Urgency
System Editor)
Public Information
11.20.6 Hold Report
Note Variables are marked as Holds in the Property Editor.
The Hold report identifies all steam turbine variables marked as Holds for troubleshooting and information reference.
➢ To create a Hold report

Example Hold Report

Public Information
From the Hold report , double-click a variable
to view the configuration details.
Hold Report Columns

Column Description
Name Variable name
Hold ID Identification number of the Hold
Second Language
Description
Public Information
11.20.7 Event Report


Public Information
From the Event report, double-click a variable to
view the configuration details.

Column Description
Name Variable name
Second Language
Description
Public Information
11.20.8 NVRAM Report
Note Variables are marked as Nonvolatile in the Property Editor.
The NVRAM report lists all configured variables that are downloaded and used in the RAM and marked as non-volatile.
NVRAM variable values are saved so in the event of power loss or if you power down and power up, the controller restores
the last stored values.
➢ To generate a NVRAM report

1. Create a NVRAM report.
From the View menu, select Reports, and NovRAM.
Example NVRAM Report
2. Select a variable and view the configuration values.

Public Information
From the NovRAM report, double-click a variable to display
the configuration values.
NVRAM Report Columns

Column Description
Name Variable name
IsArray Identifies whether the NVRAM is an array
Second Language
Description
Public Information
11.20.9 IONet EGD Report
The IONet EGD report provides network status values for all IONet communication displayed in the current component and
reflects totals of the controller exchange. EGD communication, configuration, and status specific to EGD communication
(system and controller) can be used for troubleshooting and information reference.
➢ To create an IONet EGD report
From the View menu, select Reports, and IONet EGD.
Example IONet EGD Report

Public Information
IONet EGD Report Columns
Column Description
Total Exchanges Total number of exchanges
Produced Exchanges Total number of produced exchanges
Consumed Exchanges Total number of consumed exchanges
Produced Messages Total number of produced messages
Consumed Messages Total number of consumed messages
Missed Messages Total number of missed messages
Late Messages Total number of late messages
Out of Order Messages Total number of out-of-order messages
Invalid Egd Versions Total number of invalid EGD versions
Too Short Messages Total number of too-short messages
Unknown Exchanges Total number of unknown consumers
Unknown Producers Total number of unknown producers
Public Information
11.20.10 I/O Diagnostics (Module) Report
The I/O Diagnostics reports list all diagnostic alarms for the device that need attention. The following sections describe the
Mark VIeS I/O diagnostics-specific reports:
• Alarm
• Revision
• Communication
• Hardware
11.20.10.1 I/O Diagnostics (Module) Alarm Report

The I/O Diagnostics Alarm report generates a list of all diagnostic alarms for a device at the device, I/O module, or Group
level), at the time the report is created. Users can print the report and open the module(s) in the Diagnostic Viewer to get help
for alarm troubleshooting.
➢ To generate an Alarm report

1. Select a device for which to create an Alarm report.
a. For a device:
From the View menu, select Reports, I/O Diagnostics, and Alarm.

Public Information
b. For a Group:
From the Group Level, select Create Module Report, and Alarm.
From the Module, select Create Module Report, and Alarm.
Public Information
2. Locate an alarm and view the details in the Diagnostic Alarm Viewer.
3. View the Diagnostic Alarm Help containing possible causes and solutions for troubleshooting.

Column Description
Module Module name

Public Information
11.20.10.2 I/O Diagnostics (Module) Revision Report
The I/O Diagnostics Revision report provides the revisions for the I/O modules at the device, Group, or module level.
Revision values that are used in the I/O module and in the ToolboxST system, including application, firmware, boot, base,
Pcode, and others, are viewed for comparison (configuration to hardware match) or informational reference.
➢ To generate a Revision report

1. Select a device for which to create an Revision report.
a. For a device:
From the View menu, select Reports, I/O Diagnostics, and Revision.
Public Information
b. For a Group:
From the Group Level, select Create Module Report, and Revision.

Public Information
From the Module, select Create Module Report, and Revision.
2. Locate a module in the report and view the details in the Status Viewer.

Column Description
Module Module name
Public Information
11.20.10.3 I/O Diagnostics (Module) Communication Report
The I/O Diagnostics Communication report provides informational status of the I/O module communication at the device, I/O
module, or Group level that the operator uses to detect and resolve communication issues.
➢ To generate a Communication report

1. Select a device for which to create an Communication report.
a. For a device:
From the View menu, select Reports, I/O Diagnostics, and Communication.

Public Information
b. For a Group:
From the Group Level, select Create Module Report, and Communication.
From the Module, select Create Module Report, and Communication.
2. View the I/O module communication status details in the report.
Public Information
I/O Communication Report Columns
Column Description
Module Module name
Pack Logical I/O pack name associated with the module
Required? Module required for controller boot: True or False
Prod ID Unique address of the producing device of I/O pack IONet EGD
Exch ID Exchange ID of I/O pack IONet EGD
Health Health state of I/O pack IONet EGD: Healthy or Unhealthy
Period I/O pack IONet EGD period
Size I/O pack IONet EGD data length
Recv Cnt Number of times EGD received the data exchange
Missed Cnt Number of times EGD did not receive the data exchange
Late Cnt Number of times EGD received the exchange later than expected
Connection IONet number
Bad Data Time Stamp? Bad data is a time stamp: True or False
Bad Minor Sig? Bad minor signature: True or False
Bad Major Sig? Bad major signature: True or False
Healthy? Data exchange status healthy: True or False
Is Bad Config Time Stamp? Bad configuration is a time stamp: True or False
Long? Data too long: True or False
Never Sent? Data exchange never sent: True or False
On Preferred Sender? Data exchange is sent on the preferred IONet: True or False
Out of Order Cnt Number of address changes that occurred
Producer? Data exchange is produced by this producer: True or False
Stale Data Cnt Number of stale data messages
Stale Data? Exchange data is stale: True or False
Time Out? Exchange has timed out: True or False
Too Long Cnt Number of messages that are too long
Too Short? Exchange data is too short: True or False
Unequal Minor Sig? Unequal module is a minor signature: True or False

Public Information
11.20.10.4 I/O Diagnostics (Module) Hardware Report
The I/O Diagnostics Hardware report lists hardware information for an I/O pack at the device, I/O module, or Group level,
such as firmware ID, serial number, used boards, and bar code. The hardware information in the report can be used for
ordering replacement parts, gathering bar codes, maintenance, troubleshooting, and informational reference.
➢ To generate a Hardware report

1. Select a device for which to create an Hardware report.
a. For a device:
From the View menu, select Reports, I/O Diagnostics, and Hardware.
Public Information
b. For a Group:
From the Group Level, select Create Module Report, and Hardware.
From the Module, select Create Module Report, and Hardware.
2. View the I/O module hardware details in the report.

Public Information
I/O Hardware Report Columns
Column Description
Module Module name
Group Name of hardware group or rack to which the I/O pack or board belongs
Catalog Number Board hardware catalog number
Firmware ID Firmware ID of software
Serial Number Serial number of the hardware ID device
Bar Code Board hardware bar code
Index ID index
Label Label associated with the ID
Type Hardware type
Error Code Error code returned when trying to read the hardware ID
Connector Connector name of the terminal board in which the I/O pack is plugged
Public Information
11.20.11 Coding Practices Report
The Coding Practice report allows the user to check the variables in the ToolboxST configuration to review for invalid coding
(configuration). The following four types of coding practices reports can be generated:
• Unwritten variables
• Multiple writes
• Multiple output assigned variables
• Unused I/O
➢ To generate a Coding Practices report

From the View menu, select Reports, and Coding Practices.

Public Information
Leave the default values to display
all options in the report, or select
individual types.
Click View Report to view the results.
A list of coding practice report(s) displays at the top of the report.

For quick navigation, click a report link to go to that section of the report.
Example Coding Practices Report
Public Information
From the Coding Practices report , double-click a variable to display the configuration.
Coding Practices Report Columns

Column Description
Unwritten Variables Variables used in blockware logic, but have no assigned values
Variables used in multiple locations, such as blockware logic, EGD, or I/O point
Multiple Writes
configuration
Multiple Output Assigned
All variables attached to more than one output
Variables
Unused I/O Connected I/O values that are not used anywhere
Spares Unconnected and unused I/O values
➢ To save the Coding Practice report as a .csv or .html file
From the Coding Practice report File menu,

select Save As CSV or Save as HTML,
then select the location to save the report.

Public Information
11.20.12 Unlinked Programs / Userblocks Report
The Unlinked Programs / Userblocks report identifies programs and blocks that contain unlinked variables. Code changes to a
block library code are not applied to unlinked blocks; therefore, running this report identifies them for the user.
➢ To generate an Unlinked Programs / Userblocks report
From the View menu, select Reports, and Unlinked Programs/Userblocks.
Public Information
The Find Results tab displays any identified unlinked
programs or userblocks .
Double-click the Device to navigate to the location of the

program/userblock and view the configuration.

Public Information
Many reports provide a set of common features located on the View menu Toolbar, as follows. This section provides the
procedures to use the report features:
• Open report
• Save report
• Print report
• Filter
• Refresh
• Zoom
• Find text
• Help
Toolbar Icons
Icon Description
Print the report
Zoom in
Zoom out
Refresh the report
Get help
Public Information


report window.
➢ To save a report
Some reports can be

From the report File menu , select Save Report and
modified and imported save the report as a .csv file. Open the .csv from
back into the your selected location to open the report in Excel.
ToolboxST system.
➢ To print a report: from the report File menu, select Print.

Public Information

menu, select Zoom
➢ To change report columns


Column
names that
display in
blue cannot
be moved.
Public Information
Or


Available Available
columns comparison
to add to an
equation)
Click to add
parentheses
Click OK to
accept the
filter equation
equation to
to delete the
equation.
Click Cancel
to cancel the
equation but
keep the
current
settings.

Public Information
Expression to the left of the operator must match the wildcard expression to the
right of the operator
When using the LIKE operator, you can prefix or suffix a wildcard character, either * or
LIKE
%, to the right-hand value. The wildcard character can stand for any number of
alphanumeric characters, including zero. The wildcard character can only be present
at the beginning or the end of the right-hand value (for example, *value or value* or
*value*)
display.
➢ To save a filtered report: from the File menu, click Save Report.
Public Information
11.20.13.2 Find Report Data
The Find feature performs text searches within a report.
➢ To search for text within a report: from the Report menu, click Find to display the Find dialog box.
Click to locate and

highlight the next
If selected,
capitalization
in the test
string must
match the
text in the
report exactly


Public Information
11.20.13.3 Import Reports
Reports that can be imported include:
• I/O Variable
• I/O Configuration
• Global Variable
• Block Pin
• Variable Alias
• Second Language
Only the Alias and Second Language properties can be modified. The Variable Alias report and the Second Language report
can be imported from either a .csv or an .xml file. The other reports can only be imported from a .csv file.
➢ To import an I/O Variable, I/O Configuration, Global Variable, or Block Pin report
1. From the File menu, select Import and the desired report.
2. From the Open Report dialog box, select the report and click Open to import the data. Any data that cannot be
modified is highlighted when the report displays.
➢ To import a Variable Alias or Second Language report

1. From the File menu, select Import and either Variable Alias Report or Second Language Report.
2. From the Open Report dialog box, select either a .csv or an .xml file and click Open to import the data. Any data that
cannot be modified is highlighted when the report displays.
➢ To import a GE Rationalization report

Public Information
4. Save the file with Encoding UTF-8.

Click Save .

Public Information
.csv file from an .xls file.
I/O Variable and I/O Configuration Report

Can Be
Imported
I/O Variable String No I/O variable name
Locator String No
the .csv
Used to select corresponding I/O point screw to import the Cable Number,
Screw Name String No
Wire Number, Wire Jumpers, Interposing TB, and Screw Note
Used to select corresponding I/O point jumper to import the Jumper Value
Jumpers String No
data
Sense String Yes String value
Connected
String Yes Variable name to be attached to I/O point
Variable/Variable Name
PPROs can have up to three S-type terminal boards. Each has a unique bar
Bar Code String [ ] Yes code. To modify the bar codes, the whole array must be modified (the value
must be a string array)
Group Name/Panel Name String Yes Can be set to a predefined group in the distributed I/O
TB Location String [ ] Yes Redundancy of an I/O pack determines whether TB Location is imported
Config Type Enum Yes
I/O pack)
Should contain a predefined value of the respective (can vary in each I/O
Raw Low Enum Yes
pack)
Engr Low Enum Yes
I/O pack)
Raw High Enum Yes
I/O pack)
Engr High Enum Yes
I/O pack)
Public Information
I/O Variable and I/O Configuration Report (continued)
Can Be
Imported
Can be set to Alarmed/Not Alarmed. Otherwise, can be set to Not Alarmed
SeqOfEvents Enum Yes or AnalogAlarmDefault, depending on variable type. A Boolean can be set to
Alarmed/NotAlarmed.
I/O device connected to the I/O variable as identified in the device summary
Device Tag String Yes
drawing
Jumper Value String Yes Should be a predefined jumper value to import this column
Cable Number String Yes
Wire Number String Yes
Wire Jumper String Yes To import this column, screw is located using Screw Name column data
Interposing TB String Yes
Screw Note String Yes

Locator String No
the .csv file
Second Language
Description
Event Boolean Yes messages not queued in the controller. When an Event occurs, a
time-tagged transition message is sent to all HMIs configured for Events.
Name of the Format specifications used to control the method of presenting
variables in an HMI
Enum
Importable value is a predefined enum; it can be set to None, Full, Program,
Global Name Prefix (GlobalName- Yes
Block, and Task
PrefixType)
If set to True, enables the variable as a Hold, which is similar to an Alarm.
Hold Boolean Yes The Hold queue contains a list of time-tagged Hold states in the turbine
startup sequence.

Public Information
Data Type
Data Type Enum Yes Can be set to one of the enum values
Enum
Can be set to Alarmed/Not Alarmed. Otherwise, can be set to Not Alarmed
Alarm String Yes or AnalogAlarmDefault, depending on variable type. A Boolean can be set
to Alarmed/NotAlarmed.
Enum Control
Constant
Determines the number of digits to the right of the decimal point. This is the
default for precision when the number displays on the HMI. If a Format
Precision Int Yes
Spec has been specified and this property has no specification, the Format
Spec Precision is used.
If set to True, prevents modify-variable commands from being written into
the Command and Event Log (CEL) (default is False)
Enum
Historian Deadband Can be set to EngineeringUnits, PercentOfRange,
Deadband Yes
Definition RemoveWorkstationOverride
Definition
changed from Not Logged to a non-negative number for analog variables,
Recorder Deadband Double Yes or changed to Logged on Change or Logged Continuous for Boolean
variables. This value represents the amount that the data value must
change before it is stored.
Enum
Recorder Deadband Can be set to EngineeringUnits, PercentOfRange,
Deadband Yes
Definition RemoveWorkstationOverride
Definition
Enum
Auto Reset Yes Enabled, Disabled
AutoReset
Enum
AlarmShelving
Alarm Shelving Max
UINT Yes Value should be between 1 and 4294967295
Duration
Public Information
Block Pin Report
Pin Description String Yes Pin Description
Block Description String Yes Description of instanced block
Data Enum
Data Type Yes Pin Type
Type
Variable Alias Report

Alias String Yes Alias to be set to variable
Second Language Report

Second Language
String Yes Alias to be set to variable
Description
Description String Yes Description can be changed

Public Information
11.21 Watch Window
Window.
Enter a Name,
and a Description
(optional), and
click OK.

Variable selected
variable

Public Information
11.21.1 Add Variable
Select the data

source and
click Next.
If you selected
System
Component in the
previous page,
select the desired
component from
the drop-down list
and click Next.

Public Information
Click Add.
When the
Select a
Variable dialog
box displays,
select desired
variables and
click OK.
The variables
will display here.
Click Finish .

well.
Public Information



4. Click Close.



Public Information


11.22 LiveView
The LiveView feature allows you to display a graphical representation of live data from various sources in the system.
LiveViews can be added to a ToolboxST system, to a component, or opened as a standalone editor.
11.22.1 Add and Open LiveViews

➢ To open a standalone LiveView: from the Start menu, select PACSystems, GE ControlST, ToolboxST, and
LiveView.
➢ To add a LiveView from the System Editor
Public Information
From the Tree
View, right-click the
system item and
select Insert new,
Tool , and LiveView
➢ To add an existing LiveView: from the System Editor, right-click the system and select Insert Existing and
LiveView.
➢ To edit a LiveView: from the System Editor, right-click a LiveView and select Edit System Component.
➢ To start a LiveView: from the Tree View, double-click LiveView.
➢ To add a LiveView from a Component Editor: from the View menu, select LiveViews.

Add New. When the New
LiveView dialog box displays,
enter a name and a description
(optional) and click OK

Public Information
➢ To open an existing LiveView in either Edit Mode or Run Mode from the Component Editor
1. From the View menu, select LiveViews.
2. Right-click the desired LiveView and select View.
11.22.2 Upgrade LiveView

➢ To upgrade LiveView
1. Open LiveView in the new version.
2. From the Editor Edit mode, save the LiveView, close it, then reopen the Editor.
11.22.3 Editor Features

Tools contains General Properties displays the
and Animation controls properties of the selected control
Log Control displays error

and informational messages
Public Information
11.22.4 Standard Toolbar
New Save Copy Delete Redo Stop Tools
Properties
Window
Open Cut Paste Undo Start Log View
11.22.5 Layout Toolbar

Align Align Align Center Control Bring Advance
Lefts Rights Middles Horizontally Control Height to Back Mode
Full
Screen
Align Align Align Center Control Bring Tab

Centers Tops Bottoms Vertically Width to Front Order
11.22.6 General Controls

Var:Live is a splitter
Label is a Live Value is control variable name in
convention a live value the first half and a live
label control as label text value in the second half
Setpoint Button Hyperlink button navigates

forces a value to the to another LiveView, a .chm
associated variable file, or any URL

Public Information
Additional Controls
Control Description
Image Displays graphics in either bitmap, .gif, .jpeg, or icon format
Panel Allows you to group collections of controls
Flow Layout Panel Dynamically displays contents either horizontally or vertically
11.22.7 Animation Controls

Animation Controls
Animation
Description
Control
Push-button Sends a value to the controller when the button is clicked
Switch Control Sends a value to the controller when the Off or On labels are clicked
Bar Graph Displays the status, in a user-configurable color, of the live value
Toggle Allows toggle between the Switch Control and the Push-button back and forth between Off and On
Momentary Requires user to hold the On control with the cursor; otherwise, it switches back to Off
If set to True, causes the push-button to write the On Push value to the attached signal at a periodic
interval (Interval property) so long as the push button is in the Pressed state.
Refresher
If set to False, the behavior of the push-button will be turned off. The On Push value will be written one
time only whenever the push button is pressed.
Periodic interval, in ms, at which the On Push value should be written to the attached signal. There is
Interval
variability in the actual interval produced, due to the non-real time nature of the operating system.
Public Information
Analog Meter is the pointer Status Indicator Bar Graph displays
deviated with respect to the indicates the status the live value of the
live value of the variable of a Boolean variable variable
Pushbutton attaches Switch Control attaches

to a Boolean variable to a Boolean variable
LiveView Animation Controls
➢ To add a variable to a control

Public Information
➢ To configure bar graph colors
Reference point
Select a Bar
Color for the
High Alarm and
High Warning
range above the
reference point
Select a Bar
Color for the
Normal range
above the
reference point
Select a Bar
Color for the
Low Alarm and
Low Warning
range above the
reference point
Live value of the

attached variable
➢ To select a control behavior
From the Properties

window, expand the
Behavior property and
select either Momentary
or Toggle
Public Information
If the Behavior
property is set to
Toggle and the On
Push property is
set to True, the
state of the
attached variable is
set to True when
the left-mouse
button is clicked
If the Behavior
property is set to
Momentary and
the On Push
property is set to
False, the state of
the attached
variable is set to
True when the left-
mouse button is
clicked
When the button is

released, the variable
state returns to False

Public Information
11.22.8 Controls Properties
Controls Properties
Accessibility Name, description and role
Appearance View appearance, including background color, border style, font, and such
Shortcut menu that displays when the user right-clicks, whether controls are automatically validated, and such,
Behavior
and includes whether the control can accept dragged data
Design Contains the Locked property. Locked, if set to True, prevents the control from being moved or resized.
Focus If set to True, enables validation of the control
Layout Includes properties such as location, auto scroll, margin, and maximum and minimum size
If set to True, prohibits objects from being moved or re-sized using the pointer. Values must be changed in the
Locked
Property Editor to enable moving and re-sizing.
Locked enables
or disables the
ability to move
and resize objects
Locked Property
Public Information
11.22.9 Attach Variable
➢ To attach a variable
From the Edit

menu, select
Attach Variable
and Using Add
Wizard
Or
From the Properties window,

click the ellipsis button to
display the Attach Variable
Wizard. When the welcome
page displays, click Next

Public Information
Select the data source for
the variable and clickNext
Browse to select the

.tcw file and click Next
Public Information
If you selected System Component in the
previous page, select the desired component
from the drop-down list and clickNext
Click Add. When

the Select a
Variable dialog
box displays,
select desired
variables and
click OK
Variables display
here. Click
Finish

Public Information
Once variables have been attached to LiveView using the wizard, additional variables can be attached directly from the
system component.
➢ To attach additional variables
Right-click the variable and selectAttach

Variable and From [controller name]
Note You can also attach a variable by entering the variable name in the Property View.
Public Information
11.23 Constants
Constants include both control constants and undriven variables.
11.23.1 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 Component Editor Software tab, locate and select the variable to convert.
2. From the Property Editor, set Scope to Global and Control Constant to True.
3. From the Property Editor, assign an Initial Value (optional).
11.23.2 Undriven Variables

The larger set of read-only variables includes any variable that is not written to. The Undriven Variables & Control Constants
screen allows you to display either type of constant.
be modified.
From the View

menu, select
Constants

Public Information
be modified.
From the View

menu, select
Constants
Public Information
Public Information
11.23.3 Import and Export Constants
Constants for a controller can be exported to a comma separated value (.csv) file for external viewing and changes. Previously
exported constant files can be imported back into the controller. During an Import, the initial values Entry High Limits and
Entry Low Limits are updated according to the values in the .csv file. A sample .csv file is provided below to illustrate the
output format:
Name, Description, Live Value, ToolboxST Initial Value, Value Override, Connection, Data
Type, Units, Access, Format Specification, Entry Low Limit, Entry High Limit, Entry Limits
Override, Shelve_Prog1_1.Shelve_LProg_Anlg.LLL_SP, Low Low Low SP, —90, —90, False, INT,,
ReadOnly,,,,False
ControlConstant1,0,,,BOOL,,,
ControlConstant2,30,10,51,REAL,,,
ControlConstant3,True,,,BOOL,,,
ControlConstant4,13,8,20,INT,,,
ControlConstant5[0],14,5,12,54,REAL,,,
ControlConstant5[1],34,12,54,REAL,,,
➢ To export or import control constants

1. From the ToolboxST View menu, select Constants.
2. From the Undriven Variables & Control Constants File menu, select either Export to CSV or Import from CSV.
3. From the dialog box that displays, select a location for the data and click Save.
11.23.4 Reconcile Differences

The Reconcile Differences feature allows you to synchronize the live value and the initial value for constants. The live value
is the value of the constant currently being used in the running controller. The initial value is the value of the constant in the
ToolboxST configuration.
➢ To reconcile value differences
From the File

menu, select
Reconcile
Differences.
The Reconcile Differences dialog box displays constants with both initial and live values.
Public Information
The Controller Value is the value in Select the check box next
the running controller. to the correct value to
The ToolboxST Initial Value is the synchronize the constant,
value in the ToolboxST configuration. then click OK
The constants are synchronized as follows:
• For constants when the ToolboxST initial value was checked, that value is either sent to the controller (where the OK
button is clicked), or a pcode record is created, causing the next online download to change both the initial and live
values.
• For constants when the live value was checked, the ToolboxST initial value is set equal to the controller live value. This
causes a minor revision configuration change to Not Equal. A Build and Download to the controller is required to
complete the reconcile function.

Public Information
Messages
Message Type Message Content
complete for ProgUndrivensAndControlConstants.ControlConstantArray. On the next online
Warning
download, the Live Value will change from 0,1,2,3,4,5,6,7,8,9,10,11,12 to
6,1,2,3,4,5,6,7,8,9,10,11,12.
Warning complete for ProgUndrivensAndControlConstants.UndrivenReal. The ToolboxST Initial Value has
changed from 9.8 to 11.8.
Warning complete for ProgUndrivensAndControlConstants.UndrivenTask.ARRAY_SUM_1.ENABLE. The
ToolboxST Pin Connection has changed from True to False.
Undriven Constants Reconcile: ProgUndrivensAndControlConstants.UndrivenBool has a different
Warning Live Value than the last Initial Value downloaded to pcode. A controller reboot could cause the
current Live Value of False to change to True.
Undriven Constants Reconcile: Could not reconcile variable ProgUndrivensAndControlConstants.
Error
UndrivenTask.ARRAY_SUM_1.ENABLE. This variable is not modifiable.
Undriven Constants Reconcile: The live value has been reconciled to match the ToolboxST initial
Info Value for ProgUndrivensAndControlConstants.UndrivenReal. The Live Value has changed from
10.8 to 11.8.
Public Information
11.24 I/O CheckOut
The I/O CheckOut feature allows you to verify the operation of each I/O value.
➢ To display I/O values: from the Hardware tab, select an I/O module.
From the View

menu, select I/O
Checkout to
display an I/ O list

Public Information
Notes
Public Information
12 Mark VIeS — Working Online
The Mark VIeS component provides 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 used to configure the software for the Mark VIeS component. 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.
12.1 Connect to Controller

➢ To connect to a controller: from the Component Editor Device menu, select Online or from the toolbar, click
Go On/Offline.
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.
Mark VIeS — Working Online GEH-6703P User Guide 907

Public Information
12.2 Safety Controller Operations
Mark VIeS Safety controllers have two operating modes that are used for application execution: Locked and Unlocked. When
in Unlocked mode, full access to the controller is granted, including the ability to download code, set constants, force points,
and all other configuration and diagnostic operations. When in Locked mode, all changes to the controller operation are
prevented to ensure the integrity of the safety functions.
Within the Mark VIeS Safety controller, branding is used to support Locked mode and integrity checks. When the controller
is unlocked, and the operator is satisfied with system operation, the system configuration is branded so that it can be uniquely
identified. Once branded, a diagnostic alarm is generated if there are any changes to application code, constants, hardware
integrity, or network connectivity. The diagnostics based on branding include all communications through the IONet to
provide 100% network diagnostic coverage (DC) independent of the network hardware selected.
Note For further details, refer to the Mark VIeS Safety Control Functional Safety Manual (GEH-6723), the section Branding.
➢ To switch a controller to Lock or Unlock mode: from the Device menu, select the Lock/Unlock command to
display the Lock / Unlock dialog box. A dialog box displays asking you to confirm:
Click Unlock
and Close
The Locked attribute shows the status as Yes or No for the controllers.
Public Information
➢ To brand a controller: from the Device menu, select the Brand command, or from the toolbar, click the Brand
icon. The Brand attribute shows the cyclic redundancy check (CRC) values for the controllers, which verifies the
integrity of the data.

Public Information
12.3 Controller Status
When the ToolboxST application is connected to a component, operating state and equality information is available from the
Component InfoView Status tab. When used in a redundant controller configuration, the status displays individually for each
controller in the redundant set.
Colored text displays state information. Both the tab and the text are green, indicating the normal state for the control.
Color Conditions
All controllers functioning normally.
- Control state is controlling
- Controller and DDR Equality equal
- Control state not controlling
- Controller and DDR Equality not equal
- Idle or Frame Idle Time < 20%
- Control state is failed
- Controller Equality has a major difference
Major difference
Minor difference in controller or DDR
Public Information
12.3.1 Status Tab Attributes
If the indicated Control State is not Controlling, rest the cursor over the current state to display additional information or
double-click Control State to display the information in a separate window.

State Description
Current state of the controller. When a controller is turned on, it transitions through several states
Control State before arriving at the normal controlling state.
Refer to the section, Status Control Attributes.
Controller Equality Major Difference.
If the Configuration Equality status displays Not Equal, perform the Build and Download
commands.
Indicates whether configured I/O pack revisions (Bootload, Base Load, Firmware, and Parameters)
I/O Equality
are equal.
Brand Cyclic redundancy check (CRC) of the application code files in the controller
Designated Controller Controller that supplies initialization data to the other controllers
Controller responsible for UDH communication for the component. The UDH Communicator sends
UDH Communicator
the EGD exchanges and alarms produced by the device.
Indicates whether the R, S , and T controllers are frame-synchronized to the single device within
Frame Synchronized
either the controller or I/O pack that all other devices are synchronizing frames to.
Percentage of CPU time left in the controller after all functions have been completed. It accounts
System Idle Time
for the critical control functions, as well as background processing and communication overhead.
Percentage of CPU time left in the controller after the critical control functions of input, compute,
Frame Idle Time
and output have been completed. If there is less than 20% idle time, the status is shown in yellow.
Number of forced variables in the controller

Number of Forced machine. Forcing of control logic for an operating
Variables process is strongly discouraged.
Warning Forcing of protective functions is never permissible for

an operating unit. All safety measures should be
Indicates whether the controllers are exchanging the Control state variables. If the number shown
Heart Beat
is incrementing, the Control state variables are being exchanged.
Controller Time Time that the controller is using
Indicates the presence of controller diagnostic messages. Double-click the attribute to display the
Controller Diagnostic
Controller Diagnostics on [controller] dialog box.
Indicates the presence of diagnostic messages for a I/O module configured in the component.
I/O Diagnostic
Double-click the attribute to display the I/O Diagnostic Viewer.
Base Load Version of the base load running in the controller
Firmware Version of the firmware running in the controller
Locked Indicates whether the controller is locked or unlocked

Public Information
is restarted after the download is complete. The following modifications cause a Major Difference status in the controller:
• Adding the first I/O pack to a controller
• Changing redundancy type
• Changing the platform type, which changes the number of Ethernets
• Changing any NTP configuration on a controller
12.3.2 Status Control Attributes

Valid Control states include:
State Description
Powerup Power up controller
Master initialization Controller is loading its own configuration
Designated controller determination Determine which controller is designated in a redundant controller configuration
Perform initialization of non-designated controllers with NVRAM, command variables,
Data initialization
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
Exchange state variables so that a controller joining a running system won’t have a
Exchanging
step in its initial calculations
Turn on the application code and execute each task at least once before driving
Sequencing
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
Public Information
12.4 Secure State
Note This feature is available if it is supported by your version of the Mark VIeS control.
The ToolboxST application can be used to increase security protection for controllers. Controllers can be run in either of two
states: Open or Secure. When the controller is in the Open state, it processes all commands received. In the Secure state,
certificates are used to verify both the identity of the user accessing the controller and the actions that the user is allowed to
perform.
The Secure state requires that certificates be assigned to both the controller and the user accessing the controller. Certificates
are issued by a Certificate Authority (CA) Server.
Controllers request certificates directly from the CA Server using the IP address and CA name that was configured in the
system. The CA Server must be available when the controller requests a certificate and switches from the Open to the Secure
state. When the controller certificate expires, a new one is obtained by taking the controller from Secure to Open state and
back again.
The user certificate is also issued from the CA Server and stored in the user certificate store. The ToolboxST application
retrieves the certificate from the store, and uses it to establish a secure connection to the controller. User access levels are
defined in the certificate. The controller uses this information to determine which user commands to accept and which to
reject.
Note When the user certificate expires, refer to the SecurityST* Cyber Security Management System Maintenance Guide
(GEH-6765) for the renewal procedure.
A second server, called a Remote System log (RSyslog), logs all security-related events. To send security-related messages, a
controller must know the IP address of the RSyslog. The RSyslog also receives security-related messages from the
ToolboxST application. Examples of data collected by the RSyslog include:
• Name of logged-on user

• Opening or closing of the controller configuration
• Added or deleted roles
• Forced or unforced variables
For a controller to be placed in the Secure state, it must be configured at the ToolboxST system level. It receives the
configuration information during the Build and Download processes. When the system item is selected in the System Editor,
the Property Editor displays the following properties:
• CA Server Full Name (includes domain name)

• CA Server IP Address
• CA Server Thumb Print
• RSystem Log Server IP Address

Public Information
Additionally, at the device level, the Command Event Log Property must be set to Log to Disk.
➢ To set the Command Event Log to Log To Disk
From the General tab Command

Event Log Property, Log to
Disk, right-click and select Yes
from the drop-down menu.
➢ To request a Secure state

1. Open a ToolboxST system (.tcw file).
2. From the System Editor, double-click the component.
4. Set the device to Secure state.
From the Device menu,

select Security State.
Public Information
Click Go to Secure.
For dual and TMR configurations, select Go to Secure for each controller.
Attention
Note When the process is in the Authenticated state, the controller is retrieving a certificate revocation list from the CA
Server to verify that the requestor has a valid certificate.
Once the request has been approved,

the state of the controller is secure.
The Component Info View Status tab displays the Security state for each configured controller.

Public Information
Example of Controller Security State
Public Information
12.5 Download Controller Configuration
The Download item in the Device menu is used to download the component and configuration settings to the controller and
I/O modules.
Device Menu Download Options
12.5.1 Controller Setup

After a controller and associated I/O modules have been added to the system, prepare the controller for use by configuring the
IP address and redundancy information. The Controller Setup Wizard guides the user through the configuration process.
A controller cannot communicate on a network until these controller setup tasks are
completed.
Attention
Prerequisites
• The ToolboxST application has been properly installed

• The ToolboxST system file has been properly configured
• Controller(s) and associated I/O modules have been added to the system.
Note If using a Shared IONet system, repeat the procedures in this section for both the Mark VIe and VIeS components (or
Mark VIe and MarkStat components).

Public Information
12.5.1.1 Configure and Transfer IP Address to UCSB / UCSC Controller
Prerequisites
➢ To set up a UCSB / UCSC controller

Next.
If this is a new UCSB controller received directly from the factory, or a UCSB that has
not been previously configured, the IP address must be set using a USB flash device.
Skip to step b in this procedure.
Attention
i. Enter the device password and select a COM port and the appropriate Channel.
Public Information
• UCSB RJ-45 adapter (GE part number 342A4944P1)

• UCSC RJ-45 adapter (GE part number 121T6659P0001)

Public Information
b. To re-initialize and transfer the configuration from ToolboxST to the controller hardware using a USB device, select
Initialize USB Flash Device and click Next to continue.
i. Insert a non-encrypted removable USB 2.0 (only) flash device with a 4 GB minimum capacity into the HMI
computer USB port.
ii. Initialize the controller.
Public Information
Click Scan to search for available USB devices.
Select the appropriate Channel and click Write

to program the device for the selected channel.
Modify TCP/ICP settings from the General tab.
iii. Remove the USB flash device from the USB port of the HMI computer, then click Finish.
iv. Remove power from the controller.
v. Insert the USB flash device into the controller. For a UCSB, press and hold in the Backup/Restore button. For
a UCSC, press and hold the PHY PRES button.
Note Refer to the Mark VIe and Mark VIeS Control Systems Volume II: System Guide for General-purpose
Applications (GEH-6721_Vol_II), the sections UCSC Restore and UCSB Backup and Restore for these
procedures.
vi. Apply power to the controller while continuing to press the button until the On LED on the front of the
controller becomes solid green, then release the button. The On LED turns off when the process is complete.
vii. Remove power from the controller, remove the USB flash device, then re-apply power to the controller.
viii. If using redundant controllers, repeat this procedure for the S and T controllers (if TMR) or S (if dual). Be sure
to select the correct Channel.

Public Information
12.5.1.2 Configure and Transfer IP Address to UCCC Controller
Prerequisites
Use one of the following methods to configure the TCP/IP address of the UCCC controller for communication on the UDH
Ethernet network.
• The computer that runs the ToolboxST application and the controllers must be configured to be on the same subnet for
UDH Ethernet communication.
➢ To set up a UCCC controller

This procedure may be completed before power is applied to the control cabinet.
Next.
Public Information
ii. Connect a UCCC RJ-45 adapter (GE part number 342A4931ABP1) from the main board of the controller to a
serial port on your computer.
b. Select Format Flash to reconfigure the Ethernet settings and transfer the configuration from the ToolboxST
application to the controller hardware using a CompactFlash device (PCMCIA adapter or USB device).
Turn off power to the controller and unplug the CompactFlash from the controller. Insert the CompactFlash into the
card reader, then plug the card reader into the USB port of the computer that is running the ToolboxST application.

Public Information
Flash Card Reader
Note From a Windows 7 computer, run the ToolboxST application as an Administrator to format a CompactFlash card.
Public Information
If the Controller Setup Wizard displays this message , close ToolboxST .
From your desktop , right -click the ToolboxST icon and select Run as Administrator.
Re-open the system .tcw file in ToolboxST and begin the Controller Setup procedure again .
Click Scan to find the

CompactFlash card you
inserted into the USB port
and verify the health of the
CompactFlash.
Select the controller (R,S,

or T) for which the IP
address will be set.
Click Write to download to

the flash card.
Verify the controller name and the IP address. The IP addre ss is 192.168.101.1xy (where x = controller number;
1 for G1, 2 for G2, and so forth) and y = TMR number; 1 for R, 2 for S, and 3 for T).

Public Information
Note If the scan cannot locate the flash card, either the card reader is improperly connected or the flash card is faulty.
6. From the Controller Setup Wizard, click Write to format the CompactFlash.
7. Verify that the CompactFlash download completed successfully message displays, then click Finish.
8. Insert the CompactFlash into the controller.
9. Apply power to the controller (red boot LED should flash at 1 Hz).
10. If the Mark VIeS control interfaces with a SecurityST platform that is utilizing MAC filtering, update the MAC filtering
to account for the new controller core (as appropriate) per SecurityST guidelines and procedures.
11. Repeat this procedure for each controller (if using a redundant controller set). Be sure to select the correct Channel that
matches the redundant controller.
Public Information
12.5.2 Controller Password Change
For additional details, refer to Mark VIe and Mark VIeS Control Systems Volume II:
Attention System Guide for General-purpose Applications (GEH-6721_Vol_II), the chapter
Controller Diagnostic Alarms, alarm 547.
➢ To change the controller password

Public Information
Note For a device configured with redundant controllers, the password applies to all controllers in that device.
Note This password is required for configuring the network address during controller setup.
Controller Password Synchronization

When a failed controller in a redundant set is replaced, the replacement controller password is set to the factory default
password and must be synchronized to the same password as the other controllers in the set. A diagnostic alarm message in
the Status tab notifies the user that the default password has been detected for the replacement controller and prompts the user
to change the password. For example, if the T controller failed and was replaced, the diagnostic alarm message Default user
password detected displays in the Status tab for the T controller.
➢ To synchronize controller passwords

1. From the Device menu, select Download, then select Change Controller Password....
2. Enter the default factory password as the Current Password.
3. Enter the same password for the replacement controller as is used for the other controllers in the set as the New
Password.
4. Re-enter the new password for Confirm Password.
5. Click OK to complete the process and synchronize the controller password for all three controllers.
When the password for the replacement controller is successfully synchronized to the other controller passwords in the set, a
message displays in the Log window.
Example T Controller Password Sync Success Log Message
Public Information
12.5.3 Download to Controller
The ToolboxST application is used to configure the Mark VIeS component and its distributed I/O modules. Depending on the
components used, the following software can be downloaded:
• Boot Loader starts the operating system for the controller and I/O modules, much like the BIOS on a desktop computer.
Changes to the boot loader are very infrequent.
Note Not all devices have the boot loader. In this case, the boot loader is contained within the base load.
Base Load contains the operating system for the controller and I/O modules. While changes to the base load are more
likely than changes to the boot loader, they still occur infrequently.
• Firmware provides the functionality of the controller and I/O modules. It can be updated over the lifetime of the
controller to incorporate new features and bug fixes.
• Application Code contains the configuration of the controller as created in the ToolboxST application. Whenever a
change is made to the configuration, the application code must be downloaded. There are two types of application code
download: online and offline. An online download (very commonly performed) changes the configuration without
interrupting control and the new configuration takes effect between control frames. An offline download requires a
controller restart (performed less frequently).
• Parameters contain specific configuration for the I/O modules.
Boot loader, base load, firmware, offline application code downloads, and parameter
downloads all require the target device to be restarted. Before downloading new
software to a controller, take the necessary steps to secure the control equipment to
prevent equipment damage and personal injury.
Warning
Note The type of software download needed is determined by which changes have been made to the controller
configuration.
The Download Wizard is used to download software to a Mark VIeS component and its distributed I/O modules over an
Ethernet connection. The Download Wizard can automatically examine the system configuration to locate out-of-date
software, or you can manually select individual items to download.
Note Certain conditions do not allow a download, such as an incorrect platform type. Check the Component InfoView for
errors that would prohibit a download.
1. From the Component Editor Device menu, select Download and Download Wizard.
Note If the controller is in Unlock mode, the download continues. If it is locked, refer to the section Safety Controller
Operations.
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.
3. When the welcome page displays, click Next.

Public Information
Click Scan to
examine the
system
configuration and
locate out -of-
date software.
The scan
operation
automatically
select any new
software items
that need to be
downloaded .
Select Show
All to display
all software to
be downloaded
Click Next
4. Click Next when the following message displays: Downloading application code offline will shut the selected
controller(s) down. This will result in a process trip if running. I/O outputs will change during this
operation. Ensure that the process is secure prior to continuing.
5. When the Controller Download Status dialog box displays a completed download, click Close.
6. When the download is complete, click Finish. The Component InfoView Log tab displays any warnings or errors
that occurred during the download.
12.5.4 View/Set Time

The View/Set Time feature is used to view and set the time on a controller.
➢ To view and set the controller time: from the Device menu, select View/Set Time... and follow the instructions
Public Information
12.6 Upload Controller Configuration
The ToolboxST application can retrieve existing configuration information from a component using the upload wizard. When
a configuration is uploaded, it is stored as a new component in the currently open system. The uploaded configuration allows
you to compare components and retrieve existing code.
➢ To replace an I/O module: from the Component Editor Device menu, select Upload. When the welcome page
displays, click Next.

Public Information
Public Information
12.7 Backup/Restore Controller Configuration
If the controller fails, perform one of the following backup and/or restore procedures:
• UCSB Backup and Restore

• UCSC Restore
12.7.1 UCSB Backup and Restore

If the UCSB controller fails, back up the UCSB configuration (including the UDH IP address), install a replacement
controller, and restore the configuration to the replacement UCSB to allow for communication to the ToolboxST application.
A software recovery push-button located on the bottom of the controller is used to update the NAND flash. A 2.0-compliant,
non-encrypted USB with a minimum capacity of 4 GB must be used. For detailed instructions, refer to the Mark VIe and
Mark VIeS Control Systems Volume II: System Guide for General-purpose Applications (GEH-6721_Vol_II), the section
UCSB Backup and Restore.
12.7.2 UCSC Restore

If the UCSC controller fails, restore the configuration to allow for communication between the UCSC and the ToolboxST
application. The Physical Presence (PHY PRES) button located on the front of the controller is used to initiate the procedure.
A non-encrypted USB 2.0 (only) flash device with a minimum capacity of 4 GB must be used. For detailed instructions, refer
to GEH-6721_Vol_II, the section UCSC Restore.
Note Upon shipment from the factory, a controller that supports EFA does not include the software to support
communication from the PHY PRES button to the EFA. To enable this, the user needs to download to the controller at least
once (using ToolboxST).

Public Information
12.8 Diagnostic View
The Diagnostics View displays diagnostic messages for components, such as errors or warnings, that indicate hardware
functionality and communication issues. Retrieving these messages should be the first step in diagnosing any hardware or
communication issues. Diagnostics can be viewed for controllers and I/O modules.
12.8.1 Controller Diagnostics

➢ To display controller diagnostics: from the component View menu, select Diagnostics, then select Controller
Diagnostics.
Select the Show Actives

Click Reset Diagnostics to Only check box to display
clear diagnostic messages Click Refresh List to diagnostic messages with
with 0 status. Only inactive manually retrieve one status. Clear the check
messages can be reset. diagnostics messages. box to display all messages.
In a TMR or dual
configuration,
select from the
drop-down list the
desired
redundancy
component from
which to retrieve
diagnostic
messages.
Displays
message:
• Timestamps
• Fault codes
• Status
(0=inactive
• 1=active)
• Human-
readable
descriptions
12.8.2 Controller Advanced Diagnostics

The Controller Advanced Diagnostics displays additional information from the controller.
➢ To display controller advanced diagnostics

1. Open the Component Editor and go online with the controller.
2. From the component View menu, select Diagnostics, then select Controller Advanced Diagnostics.
3. From the Tree View, expand the Diagnostics item.
4. Select a diagnostic report.
6. Click Send Command to display the report.
Public Information
12.8.3 I/O Diagnostics
The I/O Diagnostics View displays diagnostic messages for a component’s I/O module. Retrieve these messages to diagnose
problems with hardware I/O.
➢ To display I/O diagnostics: from the component View menu, select Diagnostics and I/O Diagnostics.
Note For more information, refer to the section I/O Diagnostic Viewer.
12.8.4 I/O Status

➢ To display I/O status: from the component View menu, select Diagnostics and I/O Status.

Public Information
12.9 Disagreements Diagnostic View
The Disagreements diagnostic view displays the state exchange voting and the output disagreements for the dual and TMR
controllers.
In the controller, an input disagreement detector identifies input problems such as sensor failures, terminal board problems, or
network failures.
Periodically, the disagreement detector compares boolean and analog data. Individual analog data values are checked to make
sure they do not vary from the voted value (TMR) or another controller (dual) by more than 10%. Any abnormalities are
annunciated as a diagnostic alarm, and display in the Disagreements List dialog box.
➢ To open Disagreements Diagnostic View

1. From the View menu, select Disagreements.
2. From the Disagreements List dialog box, select either the Status Exchange or Outputs tab.
3. Select either Active or Historic and click Refresh List to display disagreement diagnostic information.
Public Information
13 Mark VIeS Black Channel Safety
Communication
Black Channel is a safety communications approach in which the new safety functionality is built over existing protocol
without impact to existing safety applications. The Black Channel feature provides the transfer of Safety control data between
two Mark VIeS Safety control devices without using the standard UDH network, providing a safer, less congested network. A
matching pair of transmitter and receiver blocks, BLACK_TX and BLACK_RX, are configured for the two Mark VIeS Safety
control devices in the application. The data is passed through Ethernet (similar to UDH EGD), and the BLACK_TX and
BLACK_RX blocks run a data integrity check on each respective side of the Black Channel. For more information on these
blocks, refer to the Mark VIeS Safety Control Block Library (GEI-100691), the chapters Black Channel Transmitter (BLACK_
TX) , Black Channel Receiver (BLACK_RX), and Black Channel Example.
Transmitting Device Receiving Device

App
EGD EGD App
BLACK _TX
Block BLACK_TX
EGD EGD Block
EGD
Exchange Exchange Vardef
Packet
Produced
Var 1
BlackChannel Consumed Var1
Var 2 BlackChannel
Page Var2
Var 3 Page
Var 4 Var3
Sequence Var4
Number Sequence
Transmit Receive Number
Connection Block
Block Connection
ID Data
Data ID
Signature
Exp
Connection
ID
Signature
Example Black Channel Configuration
Mark VIeS Black Channel Safety Communication GEH-6703P User Guide 937
Public Information
Notes
Public Information
14 Mark VIeS Cause and Effect Matrix
14.1 Overview
The Cause and Effect Matrix can be used to program the Mark VIeS Safety control system to perform tasks and operations as
needed using a Cause triggers Effect algorithm. The configuration is represented as follows:
• Causes that trigger an Effect are located in the rows on the left side of the Cause and Effect Matrix; the control system
detects these issues.
• Effects of the Causes are located in the column rows; these are the result if even one of the undesirable Causes occurs).
• The Intersection between a Cause and Effect indicates which Causes are tied to which Effects; an X indicates the Effect
is Active and a red X indicates the Effect is triggered.
Note The Virtual Mark VIeS controller also supports the Cause and Effect Matrix.
A Cause and Effect Matrix can support up to 32 Causes and 32 Effects. There is no limit to the number of Cause and Effect
Matrices a user can add to the application code.
Multiple Causes can be associated with an Effect and multiple Effects can be associated with a Cause (many-to-many
relationship). The Causes that correspond to an Effect are OR-ed to get the value of the Effect. This means that even if one
Cause for an Effect is True the Effect is active and triggered, which is indicated by a red X at the Intersection of the Cause
row and the Effect column. Any one Cause can result in the Effect if they intersect and are active. For example, if a user has
configured an Effect to shut off a pump, there could be six different Causes that result in this one Effect.
The ToolboxST application is used to configure the Cause and Effect Matrix and download the configured application to a
Mark VIeS controller or a Mark VIeS Virtual Controller. Each Cause can have up to six inputs (connected variables) and the
Cause is the result of logical operations configured for those six variables within the Cause row. Users can configure the
number of Cause inputs that trigger the Effect.
Cause and Effect Matrix
Mark VIeS Cause and Effect Matrix GEH-6703P User Guide 939
Public Information
The Cause and Effect Matrix features include:
• Causes
• Effects
• Intersection of Causes and Effects
• Tool Bar operations
• Variables and Pin connections
• Time Delay
• Bypass
• Cause set-point and hysteresis for Analog variables
• Latching
Note To display block help in ToolboxST, right-click the block and select Block Help or select the ToolboxST Info tab.
14.2 Add Cause and Effect Matrix

The Cause and Effect Matrix is added as a Special Task. Adding the block to the Block Diagram Editor using the Drag and
Drop feature is not available.
Before You Start

The user must meet the following conditions before the procedures in this section can be performed:
• Must have a system .tcw file with a Mark VIeS or Virtual Mark VIeS controller installed
• At least one program must be available to add the Special Task Cause and Effect
➢ To insert the Cause and Effect Matrix

1. Add a Cause and Effect Special Task within a program.
From the Software tab Tree View,

right-click the program, select
Add Special Task, then select
Cause and Effect to insert the
Cause and Effect block.
Public Information
2. Enter a valid name for the task and click OK.
3. Repeat steps 1 and 2 to add multiple Cause and Effect tasks within the same program. Each task contains one Cause and
Effect Matrix, with one Cause and one Effect.
Note Users can also add also multiple programs and add Cause and Effect tasks to each program.
4. From the Tree View, select the task to display the Cause and Effect Matrix in the Summary View.
Public Information
Cause and Effect Matrix
Note By default, when a Cause and Effect Matrix is added, the Intersection of the Cause and Effect is active (indicated by an
X). Refer to the section Intersection of Causes and Effects for further details.
Public Information
14.3 Block Columns
Causes are displayed in the block rows and Effects are displayed on the columns. The Intersection of the rows and column
identifies the association between Causes and the Effects. Cause Columns and Effect rows can be hidden or unhidden as
needed.
Cause and Effect Matrix Columns
Column Description
Connected variables that, when set to True, results in the Cause(s) that triggers
Inputs
the associated active Effect(s)
Operation Operator type (AND, OR, or VOTED) used for all inputs of a Cause
Amount of time in milliseconds that a Cause is configured to wait before the
Delay Values (ms)
Cause output transitions from False to True when an input delay is enabled
Causes When Bypass is enabled and a Bypass limit is set, the bypassed Cause is not
Bypass Values
used to trigger the associated Effect(s)
Latch Values Unlatches the Cause and allows reset of the Effect
Output Cause(s) that result from the configured inputs
Description Description of the configured Causes
No. Cause and Effect number
Output Result of the configured output driven by the configured Cause(s)
Latch Values Unlatches the Effect and allows reset of the Effect
Amount of time in milliseconds that the Effect is configured to wait before the
Effects Delay Values (ms)
Effect output transitions from False to True when an output delay is enabled
Description Description of the configured Effects
No. Cause and Effect number
➢ To hide a Cause and Effect Matrix column
Select and highlight the column, right-click and select Hide.
Public Information
The following table lists the Cause and Effect Matrix properties displayed in the Property Editor.
Cause and Effect Matrix Properties

Task Level
Block Type Name of the user block definition in the library from which the task is started
Description Task description
Name Task name
Instance Script Script that runs when task is instanced
Help File Locally assigned help file
Properties that control the Access Roles, Modify Data, Modify Design, and View Design
Protection
Version User defined version of the Cause and Effect Matrix
Frame Multiplier Number of frames at which the Cause and Effect task runs
User Block Level
Block Type Name of the Library block of which the Cause and Effect Matrix is an instance
Description Description of the instance of the Cause and Effect Matrix
Unique identifier that allows the block and its attributes and pins to be referenced from other
Instance Name
places in the ToolboxST application
Number of Causes Total number of Causes in the Cause and Effect Matrix
Number of Effects Total number of Effects in the Cause and Effect Matrix
Show Description When True, the Cause and Effect Matrix description is displayed in the Summary View
Execution Order Execution order in the Cause and Effect Matrix
➢ To add the block description
From the Property Editor, place your cursor in the Description

field and click the ellipsis… to display the Edit Text dialog box.
Enter the block description and click OK.
Public Information
➢ To display the block description in the Summary View
From the Summary View, select the

Cause and Effect Matrix, right-click and
select Show Description from the menu.
OR
From the Property Editor, select the
Show Description drop-down menu
and select True.
The description is displayed in the upper left corner of the block, beneath the block name.
Block Description Shown
Public Information
➢ To hide the block description from the Summary View
From the Summary View, select the Cause

and Effect Matrix, right-click and click the
checkmark next to Show Description.
OR
From the Property Editor, select the
Show Description drop-down menu
and select False.
Public Information
14.5 Intersection of Cause and Effects
The Intersection between a Cause and Effect row indicates an association between those Causes and the Effect. Where the
Intersection meets identifies which Causes are tied to which Effect. Any one Cause can result in (trigger) the Effect if they
intersect and are active (X). If any one Cause for an Effect is True, the Effect is triggered. When the Intersection is triggered it
is indicated by a red X. If an Intersection is not active, when the Cause(s) occurs the Effect will not be triggered.
Note By default, when a Cause and Effect Matrix is added the Intersection is active.
Other available features of an Intersections include:
• Connected variables and pins can be edited.

• Intersections can be added to Trender and Watch Window.
➢ To display the Intersection association details between Cause and Effect: select the Intersection to highlight
it and view the association details in the Property Editor.
The Property Editor displays the Cause number, Effect number, if the intersection is active or inactive, and the intersection
number.
Intersection Details in Property Editor
Public Information
➢ To activate or deactivate an Intersection: select the intersection to highlight it and select the box to activate (X) or
deactivate (no X) the Intersection.
Ac No
ti v
e t Ac
tiv
e
Tr
ig ge
re
d
Intersections Active, Not Active, and Triggered
Public Information
14.6 Tool Bar Operations
The Cause and Effect Matrix provides a Tool Bar in the upper right of the Summary View.
Cause and Effect Matrix Tool Bar
The tool bar provides the following operations:
• Add Cause
• Add Effect
• Delete Cause
• Delete Effect
• Add Cause Input Group
• Remove Cause Input Group
• Hide a Column
• Unhide All Columns
• Zoom In
• Zoom Out
• Print Cause and Effect Matrix
➢ To add a Cause: from the Cause and Effect Matrix tool bar, click the Add Cause icon.
Add Cause Tool Bar Icon
One Cause is added to the block, with the corresponding variables for the newly added Cause and Intersection. Select the
Variables tree item for the block to view the variables.
Note The total number of Causes for one Cause and Effect Matrix cannot exceed 32.
➢ To add an Effect: from the Cause and Effect Matrix tool bar, click the Add Effect icon.
Add Effect Tool Bar Icon

One Effect is added to the block, with the corresponding variables for the newly added Effect and Intersection. Select the
Variables tree item for the block to view the variables.
Note The total number of Effects for one Cause and Effect Matrix cannot exceed 32.
Public Information
➢ To delete a Cause: from the Cause and Effect Matrix tool bar, click the Delete Cause icon.
Delete Cause Tool Bar Icon
The deleted Cause, the intersections in the same row as that Cause, and any assigned variables are removed from the block.
The Causes in the row below the deleted Cause are renamed and the pin names (if variable is unassigned) for that row are
updated.
➢ To delete an Effect: from the Cause and Effect Matrix tool bar, click the Delete Effect icon.
Delete Effect Tool Bar Icon

The deleted Effect, the intersections in the same column as that Effect, and any assigned variables are removed from the
block. The Effects to the right of the deleted Effect are renamed and the pin names (if variable is unassigned) are updated.
➢ To add a Cause Input Group

1. Select a Cause to outline the row in the Cause and Effect Matrix.
Note Only one row at a time can be selected.
2. From the Cause and Effect Matrix tool bar, click the Add Cause Input Group icon.
Add Cause Input Group Tool Bar Icon

The input is added to the Inputs cell in the row of the selected Cause. The default input name will end in the next available
number.
Public Information
Cause Input Group Added
Maximum Cause Inputs Added
Note Up to six inputs can be added. After adding six inputs, the Add Cause Input Group icon is disabled.
Mark VIeS Cause and Effect Matrix GEH-6703P User Guide

Public Information
➢ To remove a Cause Input Group
1. Select a Cause to outline the row in the Cause and Effect Matrix.
2. From the Cause and Effect Matrix tool bar, click the Remove Cause Input Group icon.
Remove Cause Input Group Tool Bar Icon
The input is removed from the Inputs cell in the row of the selected Cause.
Note The Remove Cause Input Group icon is disabled if only one cause input is present.
➢ To hide a selected Cause Column or Effect Row

1. In either a Cause column or an Effect row in the matrix, select the column or row heading to outline it.
Column Selected
2. From the Cause and Effect Matrix tool bar, click the Hide Selected Column icon.
Hide Selected Column Tool Bar Icon
Note Only one column can be selected at one time.

The following columns cannot be hidden:
• Causes and Effects Output column
• Causes and Effects Description column
Public Information
➢ To unhide all hidden Cause columns or Effect rows
1. Place your cursor anywhere in the Cause and Effect Matrix.
2. From the Cause and Effect Matrix tool bar, click the Unhide All icon.
Unhide All Columns/Rows Tool Bar Icon
➢ To zoom in on the Cause and Effect Matrix: from the Cause and Effect Matrix tool bar, click the Zoom In icon.
Zoom In Tool Bar Icon
➢ To zoom out on the Cause and Effect Matrix: from the Cause and Effect Matrix tool bar, click the Zoom Out
icon.
Zoom Out Tool Bar Icon
➢ To print the Cause and Effect Matrix

1. From the Cause and Effect Matrix tool bar, click the Print icon.
2. Select the print Orientation and click Print.
Print Tool Bar Icon
Note Make sure you have a printer connected to your machine. Your local printer is used to print the Cause and Effect
Matrix.
Public Information
14.7 Configuration
In the basic configuration of a Cause and Effect Matrix, each Cause can have up to six configured inputs (connected
variables) that are displayed individually within the Cause row, and each Effect supports only one output (connected
variables). The Summary View displays the live values of the Cause inputs, the Cause output (True/False), the Effect outputs,
the state of Effect outputs (True/False) and the intersections (active/triggered/inactive). Connected variables can be:
• All Boolean variables

• All Analog variables
• Combination of Boolean or Analog variables
Users configure the number of Cause inputs that trigger an Effect. If one Cause is True, the Effect is True.
Additional configuration available for Causes, Effects, and Intersections includes:
• Password Protection can be configured for a Cause and Effect Matrix

• Cause and Effect outputs can be added to EGD
• Alarm variables are supported; both Causes and Effects can be alarmed
• Cause and Effect Matrix and individual Causes, Effects, and Intersection pins can be added to Trender and Watch
Window
• Cause and Effect Pick-up and Drop-out Time Delay
• Cause Bypass
• Cause Set-point and Hysteresis for Analog variables
• Cause VOTED operation Input Count
• Cause and Effect Latching
Note For block help in ToolboxST, right-click the block and select Block Help or refer to the Mark VIeS Safety Controller
(SIL) Block Library (GEI-100691) for additional block information and block pin variables.
14.7.1 Variables and Pin Connections

The Cause and Effect Matrix contains Rubber pins with different groups and users can attach variables to the pins. The block
pins can be added to Trender and Watch Window. Each Cause can have up to six inputs (connected variables) and the Cause
is the result of logical operations configured for those six variables within the Cause row. Each Effect supports only one
output (connected variables). Alarm variables are supported; both Causes and effects can be alarmed.
Note _OUTPUT and _LATCHED variables for each Cause and Effect and _INTERSECTION_VALUE for each Intersection
are placed on the EGD default page.
Public Information
➢ To view Cause and Effect variables
From the Tree View, select Variables for a Cause and Effect block to display all variables
for that block in the Summary View.
Public Information
Refer to the ToolboxST for a complete list of block variables.
Default Cause and Effect Matrix Variables

External Initial
Name Description Type EGD Page
Access Value
Enables bypassing the Cause;
CAUSE1_BYPASS_ENABLE automatic reset upon expiration of Read Only BOOL FALSE
set bypass time limit
Time (in milliseconds) amount the
CAUSE1_BYPASS_TIME_LIMIT Read Only UDINT 0
input is bypassed
Indicates if the Cause is being
CAUSE1_CAUSE_BYPASSED Read Only BOOL FALSE
bypassed
CAUSE1_COMPARE_FUNC1 Comparison function (GT or LT) Read Only INT GT
CAUSE1_COMPARE_FUNC2 Comparison function (GT or LT) Read Only INT GT
CAUSE1_DO_DELAY Drop-out delay (in milliseconds) Read Only UDINT 0
CAUSE1_ELAPSED_BYPASS_
Indicates elapsed bypass time Read Only UDINT 0
TIME
CAUSE1_HYSTERESIS1 Hysteresis Read Only ANY 0
CAUSE1_HYSTERESIS2 Hysteresis Read Only ANY 0
CAUSE1_INPUT1 Input Read Only ANY 0
CAUSE1_INPUT2 Input Read Only ANY 0
CAUSE1_LATCH_ENABLE Enables latching the Cause value Read Only BOOL FALSE
CAUSE1_LATCH_RESET Resets latched Cause value Read Only BOOL FALSE
Indicates if the Cause is latched or
CAUSE1_LATCHED Read/Write BOOL FALSE $Default
not
Operator for Inputs (AND, OR,
CAUSE1_OPERATOR Read Only UINT AND
VOTED)
Final cause value after the
CAUSE1_OUTPUT Read/Write BOOL FALSE $Default
operation on inputs
CAUSE1_PU_DELAY Pick-up delay (in milliseconds) Read Only UDINT 0
CAUSE1_SETPOINT1 Set-point Read Only ANY 0
CAUSE1_SETPOINT2 Set-point Read Only ANY 0
CAUSE1_VOTED_INPUT_COUNT VOTED inputs count Read Only UINT 0
Enables latching the intersection
EFFECT1_LATCH_ENABLE Read Only BOOL FALSE
value
Resets the latched intersection
EFFECT1_LATCH_RESET Read Only BOOL FALSE
value
EFFECT1_LATCHED Indicates if Effect is latched or not Read/Write BOOL FALSE $Default
EFFECT1_OUTPUT Effect output value Read/Write BOOL FALSE $Default
EFFECT1_PU_DELAY Pick-up delay (in milliseconds) Read Only UDINT 0
INTERSECTION1_
Intersection value Read/Write BOOL FALSE $Default
INTERSECTION_VALUE
Public Information
➢ To display a pin with a connected variable: Double-click one of the block pins in the Cause row or Effect column
with a variable attached to it.
The Property Editor displays the selected Cause row/Effect column number, description of the selected Cause/Effect,
connected variable name, and pin name.
Note If the user attaches a Global Analog variable to a Cause input, the corresponding Cause input’s Set Point and Compare
Function variables will be displayed just below the input.
Cause Pin with Connected Variable
Effect Pin with Connected Variable
Public Information
➢ To edit block pin connections and add/remove Cause inputs from pin connections
1. Place your cursor in a Cause row, Effect column, or Intersection and double click,
or right-click the Cause/Effect/Intersection and select Edit Pins from the menu.
The Edit Block Pin Connections — [pin] dialog box displays the pins for the selected Cause/Effect/Intersection.
Connected Variables
2. Enter or modify the Description field for the selected Cause/Effect/Intersection.
Effect Pin Connections
Public Information
Intersection Pin Connections
3. For a Cause, set the Inputs Count value (1-6) (enabled for Causes only) to add or remove inputs.
From the Input countdrop -down list,

select a value between 1 to 6.
The Cause input, set-points, and hysteresis variables are added or removed as per the inputs count.
Note For an Effect and Intersection the Inputs Count field is disabled.
Each time a pin value is changed, perform a Build and Download the application code to display the expected results.
Public Information
14.7.2 Time Delay
A Time Delay can be configured to determine how long the Cause and Effect Matrix will wait in milliseconds (ms) to
transition the Cause output from False to True or True to False. It is used to filter spikes in the inputs (input goes from True to
False to True to False); the logic waits for the set amount of delay time (in ms) before the Effect is triggered. Specifically,
Causes and Effects support an ON time delay and an OFF time delay before an Effect is triggered.
The Time Delay variables are:
• Pickup Delay: occurs when the Cause or Effect transitions from False to True
− CAUSE#_PU_DELAY
− EFFECT#_PU_DELAY
• Drop Out Delay: occurs when the Cause or Effect transitions from True to False
− CAUSE#_DO_DELAY
− EFFECT#_DO_DELAY
Time Delay Pins
Note Each time an Immediate Value is changed, you must perform a Build and Download the application code to see the
expected results.
Public Information
➢ To change the Immediate Value of a pin
1. Double-click the pin to display the Connect Pin dialog box.
2. Select Immediate Value.
3. Enter the value (in milliseconds) and click OK.
4. Perform a Build and Download the application code.

The Cause output transitions based on the set Time Delay values.
Public Information
➢ To set an input value
1. Place the cursor in the input row and double-click to display the Send Value dialog box.
2. Enter a value in the Next Value Next field and click Send & Close, then click Close.
Public Information
14.7.3 Bypass
Causes support a Bypass function, with a time limit specifying the maximum time (in milliseconds) for which the Cause can
be bypassed. The Cause can be bypassed when it is in Active or Triggered state. When a Bypass is enabled, the bypassed
Cause is not used to determine the output of the associated Effect(s).The user specifies the time limit until the Effect is
triggered (trip). This feature is primarily used for instrumentation maintenance. For example, if you are calibrating a pressure
transmitter you don’t want a trip to stop a running plant so the Cause can be bypassed during maintenance and then reset
when maintenance is completed.
Note If the Bypass Limit value is zero, the bypass is not active.
Note When a Bypass is active, the Intersection displays as active and triggered (red X) but the Effect will remain False.
➢ To configure a Bypass for a Cause

1. Enable the bypass by setting the CAUSE#_ BYPASS_ENABLE pin to True.
2. Set the CAUSE#_ BYPASS_TIME_LIMIT value (in ms).
The CAUSE#_ ELAPSED_BYPASS_TIME value updates when the bypass is active.
Public Information
➢ To enable a bypass value
1. Double-click the CAUSE#_ BYPASS_ENABLE pin to display the Send Value dialog box.
2. Select True or False for the value and click Send & Close, then click Close.
Note The CAUSE#_BYPASS_ENABLE value automatically resets after 1000 ms.
➢ To set the Bypass Time Limit

1. Double-click the CAUSE#_ BYPASS_TIME_LIMIT pin to display the Send Value dialog box.
2. Enter a value in the Next Value Next field and click Send & Close, then click Close.
3. Perform a Build and Download the application code to view the results.
Public Information
14.7.4 Set-point and Hysteresis
Hysteresis is a switch and reset function. In control systems, hysteresis can be used to filter signals so that the output reacts
less rapidly than it otherwise would because it considers recent history. For example, a thermostat controlling a heater may
switch the heater on when the temperature drops below A, and not turn it off until the temperature rises above B. (For
instance, to maintain a temperature of 20 °C, set the thermostat to turn the heater on when the temperature drops below 18 °C
and off when the temperature exceeds 22 °C.) Similarly, a pressure switch can be designed to exhibit hysteresis with pressure
set-points substituted for temperature thresholds.
Analog inputs have a set-point to be compared against so that a Boolean condition is generated. This condition supports
hysteresis and is activated (True) when the input is greater than or less than the set-point (unsafe). The comparison returns to
normal (False) when the input is less than the set-point. In ToolboxST, users configure the Cause input compare function
variable (CAUSE#_COMPARE_FUNC#) as Greater Than (GT) or Less Than (LT) with a set-point, which drives the Cause
output True or False.
The formula can be represented as follows:
Boolean input = If True, then True. If False, then False.
Analog input = Hysteresis is activated when input is ≥ set-point, and returns to normal when input is < the set-point
— hysteresis.
Cause Operator Hysteresis

Input > set-point = True output (switch function)
GT
Input < (set-point — hysteresis) = False output (reset function)
Input < set-point = True output (switch function)
LT
Input > (set-point + hysteresis) = False output (reset function)
The operations that can be applied to Cause inputs are AND, OR, or VOTED. If the inputs are Analog, the resulting Boolean
condition after set-point and hysteresis comparisons is used for this operation. There can only be one operator type used for
all of the Cause inputs. The health of the input is considered for Cause output calculation. An unhealthy input is a vote to trip
(true). The operator type drives the health of the input as follows:
• If the operator is OR, the Cause output becomes True if any Cause input is unhealthy.
• If the operator is AND, the Cause output becomes True if all inputs are healthy.
• If the operator is VOTED, the Cause output becomes True if the number of unhealthy inputs is greater than or equal to
the configured input count number for the VOTED option ( (majority, such as 2-out-of-3 ratio), plus the number of
healthy inputs that are true. The user selects the Input Count (1-6) to set how many inputs have to be unsafe before the
Effect is triggered (meaning how many variables are True before it is tripped). The user configures the Initial Value for
the inputs, which is the number of input counts the user wants to trigger the Effect (trip).
Note The number of inputs (Input Count) has to be configured to use the VOTED operation.
Public Information
➢ To configure a set-point for hysteresis comparison
Note Hysteresis is not displayed on the Cause and Effect Matrix.
1. Associate the variable CAUSE#_INPUT1 with a Global Analog variable to give a safe signal for use in determining if a
trip condition exists. For this example, an Analog variable is selected, which prompts the user to add a set-point and a
compare function (GT or LT).
Associate Cause Input with Global Analog Variable
2. Set a compare high and a compare low by setting the CAUSE#_COMPARE_FUNC# variable Immediate Value.
3. For a Cause input, set a high and low value for hysteresis by selecting the controller value for the CAUSE#_
HYSTERESIS# variable as LT or GT.
Public Information
CAUSE#_COMPARE_FUNC# Variable Controller Value Set to GT
4. Associate the variable CAUSE#_INPUT2 with a Global Variable.

5. Set the value for each Cause input (for example, if you have two inputs, CAUSE1_INPUT1 and CAUSE1_INPUT2). The
Cause output is the result of the comparisons between the Cause inputs, which is then used to determine if the output
Effect is True. For example, if the set-point for input 1 is set to 50 and the compare function is set as GT , if input is > 50
the Operator Type is used to determine if that in combination with input 2 results in the Effect output.
Public Information
Cause Input Value Set Greater Than Set-point Value
6. Select the Variables Tree View item, confirm that the Cause input Type is INT.
Public Information
7. Double-click the CAUSE#_OPERATOR pin and set the Operator Type as AND, OR, or VOTED.
8. If the Operator type VOTED is selected, change the CAUSE#_VOTED_INPUT_COUNT value to a number less than or
equal to the number of Cause inputs you have for this Cause. For example, if you have two inputs, CAUSE1_INPUT1
and CAUSE1_INPUT2, set CAUSE1_VOTED_INPUT_COUNT to 1 or 2.
9. Perform a Build and Download the application code to view the expected results. The Cause output value transitions
from True to False or False to True based on the inputs value (GT/LT) in relation to the set-point for each input.
For example, if the Cause input1 is greater than its set-point value, and Cause input2 is greater than its set-point value, the
Operator Type is AND, and the compare function is GT, then the Cause output value is True. For another example, if an
Analog Cause input with a VOTED operator has a 2–out–of–3 (majority) high or low comparison with an associated input,
VARHEALTH (bad health is a vote to trip), the Cause output is True.
Public Information
14.7.5 Latching
Causes and Effects support latching. The user enables latching on a per Cause or Effect basis. The Cause or Effect allows
resetting the latch using a variable in the application logic. The user can latch the Cause, the Effect, or both. Once an Effect is
triggered, the user has to reset the latch, which unlatches the Cause and allows the Effect to reset. If a Cause or Effect is
latched, it will not rest until the user unlatches it. The user must set the variable LATCH_RESET to True to reset the Latch and
the output will return to False. To enable a Latch for an input, the variable CAUSE#_LATCH_ENABLE must be set to True
first. To disable the Latch, first set CAUSE#_LATCH_ENABLE to False.
Do not latch an Effect if you have latched the Cause(s) for that Effect.
Attention
➢ To configure a Latch
1. Set LATCH_ENABLE to True.
2. Set LATCH_RESET to Variable.
Latched Effect
Public Information
14.7.6 Add to Trender or Watch Window
Cause and Effect Matrix and individual Causes, Effects, Intersections, and pins can be added to Trender and Watch Window.
➢ To add a Cause and Effect Matrix to Trender or Watch Window
From the Tree View, select a

Cause and Effect block, select
Block Options, and select either
Add To Trendor Add to Watch.
Select (New Trend) or (New
Watch) and configure as needed.
Public Information
Notes
Public Information
15 WorkstationST Component Editor
The WorkstationST Component Editor provides a comprehensive user interface for configuring WorkstationST features. The
elements of the configuration are grouped by specific function tabs that are enabled from the Component Editor Tree View.
Areas of the editor provide various displays, depending on the currently selected item.
15.1 Creation Wizard

➢ To create a component: from the System Editor Tree View, right-click the system name and select Insert New
and WorkstationST.
WorkstationST Component Editor GEH-6703P User Guide 973

Public Information
Public Information
➢ To open a WorkstationST Component Editor: from the System Editor Tree View, double-click the
WorkstationST component.
Tabbed pages organize Summary View provides

the elements of the an overview of the item
component configuration selected in the Tree View
Tree View
lists all
major items
in the
component.
The list
changes
when a
different tab
is selected
Property
Editor
allows you
to edit the
item
selected in
the Tree
View
Component
InfoView
displays
specific
feedback
information
about the
currently
selected tab
➢ To edit the component: select an item in the Tree View. The configuration information for that item displays in the
Summary View and Property Editor.
➢ To import an existing component

1. From the Tree View, right-click either a system or a group and select Insert Existing and select Device.
2. Select the Device .xml file for the component to be imported and click Open.

Public Information
15.3 Tree View
15.4 Summary View


Alphabetical List allows you

to view the properties arranged
alphabetically by name
Min-max allows
you to quickly Double-click
reside the Tree the double
view and the bar to view
Property Editor the Property
within their Editor in a
shared view detached
window
List by
category allows
you to view the
list of properties
organized by
category
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.
Public Information

Tab Description
Where Used


Public Information
15.6.1 Log Tab

Public Information
15.6.2 Status Tab
details.
15.7 Data Grids
Note Some Data Grids, especially those without an Append Row, may not support all features described in this chapter.
15.7.1 Edit Data

To... Do this:



Public Information
To... Do this:
configuration

button to add it columns to the Data Grid
Select a
column name
and use the up
arrow to move
it to the left-
most side of
the Data Grid
Public Information
To… Do this:
location.
for the append row in the destination grid and select Paste Row(s) to insert the
rows into their new location.
Trender window or Watch Window Trender window or watch window are visible. Then, drag the row header for the variable
change column ordering and always select the exact destination range in the ToolboxST configuration before pasting data
from Excel.

Public Information
15.8 Security
Access Rights
Access Roles
Public Information
15.8.1 Passwords


Public Information
access.
Protection.


discouraged.

Public Information

System
Component
library.
block.

Public Information
15.8.5 Feature Security
Beginning with ControlST V06.00, the WorkstationST OPC DA Server and Device Manager Gateway features have been
enhanced with the ability to establish secure SDI connections with controllers in systems where security has been enabled.
Certificates are only required to be installed and configured for these features when system level security is configured and
enabled. The WorkstationST Status Monitor can be used to display the configured feature certificates.
The Security Servers system-level properties provide the Certificate Authority Server (CA Server) the information needed by
the features, client applications, and controllers to allow them to authenticate certificates when secure connections are
established.
Example of System Overview Properties in ToolboxST Secure System
Note For the procedure to enter the CA Server Thumb Print property, refer to the section CA Server Thumb Print.
The Security Servers properties must be filled out for a system to operate in Secure mode. If these properties are filled out, the
system is secure. If these properties are blank, the system is open (does not support Secure mode).
The OPC Server only requires a certificate if the system is Secure and the 3rd party product ExperTune is used. The certificate
must be assigned to the LocalMachine location, My substore, and the certificate name must be GeCssOpcServer.
The Device Manager Gateway only requires a certificate if the system is Secure. The certificate must be assigned to the
LocalMachine location, My substore, and the certificate name must be GeCssDeviceManagerGateway.
Note Certificates must be created for each feature and added to the LocalMachine location, My substore, and the certificates
must be named as indicated in this section for each computer with these features enabled.
Public Information
The following steps provide an overview of the process to enable these features for proper operation:
1. Fill out the ToolboxST system properties section Security Servers to define the parameters. (This is a requirement to place
the controllers in Secure mode.)
2. Perform a Build and Download each controller that supports secure connections.
3. Verify that all HMI computers running WorkstationST software to communicate with controllers in Secure mode are in
the Domain.
4. Create and assign a certificate for all devices and computers in the system.
5. Create a certificate for the OPC DA Server only if controller values may be changed over an SDI connection (ExperTune
product is used) in a Secure system.
Note The OPC DA Server only requires a certificate if it is commanded to alter variables that are only accessible using
SDI messages, such as when used with the ExperTune product. This is rare, as most systems limit writes to variables that
are exposed on EGD pages, which does not require a certificate.
6. Create a certificate for the Device Manager Gateway for each workstation with this feature enabled only in Secure
systems.

Public Information
This feature allows you to report problems with the controller. The report is generated and attached to an email to the
ToolboxST support team.

2. Enter information in the Send Problem Report dialog box and click Send.
Public Information
15.10 WorkstationST Status Monitor
The WorkstationST Status Monitor provides status and control of the WorkstationST features on the local computer. The
Status Monitor is included in the Status tab in the Component Info View of the configured WorkstationST component.
The WorkstationST Status Monitor is configured to start when you log on to Windows, and then runs as a tray icon .
When a error occurs with the WorkstationST Service (or any configured feature), an error icon displays .
➢ To monitor and configure WorkstationST features: from the toolbar, click Launch Toolbox.
➢ To start or stop WorkstationST features: from the toolbar, click Start or Stop. Or right-click the feature, then
select Start or Stop from the shortcut menu. Start and stop requests are sent to the WorkstationST Service.
A service control manager is used to start the WorkstationST Service.
Note When the WorkstationST Service starts, it attempts to start all configured features, and to keep the features running. If
a feature is stopped from the Status Monitor, WorkstationST Service will not attempt to restart it. If the feature is started again
from the Status Monitor (or WorkstationST Service is restarted), the feature starts again.

Public Information
15.10.1 Status Monitor Shortcut Menu
Select Start Selected Feature(s) to

display the WorkstationST Status
of Features dialog box.
➢ To display additional status information: double-click the Tray icon.
Right-click a feature and select

View Alarm Server Status to
display specific status information.
Information displays for each configured feature. The WorkstationST Service runs a System Data Interface (SDI) server. The
Status Monitor uses an SDI client to obtain the information displayed. Information is not available when the WorkstationST
Service is not running.
Public Information
15.10.1.1 View Scheduled Tasks
All tasks scheduled in the WorkstationST component must be confirmed by an administrator to remain scheduled.
➢ To display scheduled tasks: double-click the Tray icon.
Right-click WorkstationST Service and

select View WorkstationST Scheduled
Tasks Information to display and confirm
previously scheduled tasks.

Public Information
15.10.1.2 View NTP (Time Sync) Detail Option
This menu option, which displays time synchronization information, is accessible when any feature in the status monitor list
is selected.
Place the cursor on each

column to display a tooltip.
File menu items include:

Specify Remote Host allows you to display NTP service status on a remote computer (the local computer is the default
display).
Data Logging displays a dialog box that allows you to log the Status Viewer’s data to a log file.
Select the check

box to enable data
logging, enter a
path, and click OK.
Public Information
15.10.1.3 Alarm Server Status
➢ To display alarm server status
Right-click
Alarm Server
and select
View Alarm
Server Status.

Public Information
From the Alarm Server Status Viewer, select
from the available tabs for more information.
Public Information
Select the Client Connections tab to
display alarm / event client information.

Public Information
Select the Alarm Queues tab, then click an ellipsis
button to display specific queue information.
File Menu Items

Item Description
Alarm Server Hostname Host name on the local computer (default) that has the Alarm Server enabled
Save Status to Text File Allows you to save the current Alarm Server status to a text file
Public Information
15.10.2 View Configured Feature Certificates
Note Refer to the section Feature Security for more information.
➢ To view certificates
1. Launch the WorkstationST Status Monitor from the tray icon.
2. Open the WorkstationST Certificate Manager.
From the Tools menu, select Certificate Manager.
3. Display the configured feature certificates.
From the WorkstationST Certificate Manager window, select the Feature Certificates
tab to display the data grid of configured certificates.
BOBSDOMAIN u m:b o b:G E IP:G e CssO p cUa Da ta A cce ssClie n t

BOB um:bob:GEIP:GeCssOpcUaServer
BOB um:localhost:UASDK:AlarmConditionServer
BOB
um:localhost:UASDK:DataAccessServer
BOB
BOB um:localhost:UA: Quickstarts:ReferenceServer
BOB um:Bob:UA Local Discovery Server

Public Information
The Feature Certificates window may display more than one certificate assigned to the same feature. This indicates multiple
configurations have taken place over time. Certificates that are no longer valid should be removed from the store location.
Note The Feature Certificate window is Read-only and cannot be used to import or export certificates.
H MI -AP 3-C A.H MI
H MI -AP 3-C A.H MI
Feature Certificate Store Location
Note If the Feature Certificates list is empty, the GeCssOpcServer and Device Manager Gateway feature’s certificates have
not been configured.
Public Information
15.11 WorkstationST Component Menus
Menu Command Use to
Import Import WindSCADA OPC data
File
Export Mark VIe variables so they can be used in PI Historian for Legacy Toolbox (Toolbox
Export
Classic) or WindSCADA OPC data
Edit Copy Copy the selected item in the Tree View
Display a list of Trenders for this component (refer to Trender Instruction Guide,
Trenders
GEI-100795)
Watch Windows Display a list of Watch Windows for this component (refer to the section Watch Window)
Alarm generates a list of alarm variables
Event generates a list of all variables marked as Events
GE Rationalization provides a report of alarms using the GE Rationalization column
Reports
View definitions
WorkstationST Data and Alarm Consumption provides a report of live data
consumption and alarm consumption viewed by WorkstationST, consumed devices, or as
text
Test OPC DA Client Open an OPC client window that connects to any OPC DA Server to verify communication
Test OPC AE Client Open the Test OPC AE Client window
Test OPC UA Client Open the Test OPC UA Client window
WorkstationST Open the Alarm Viewer (this only displays if an Alarm Viewer was installed)
Alarm Viewer
Export Alarms for Compare alarm criteria in plant alarm philosophy
Rationalization
Online Connect to or disconnect from a controller
Build Convert the current configuration into binary files that can be downloaded to a controller
Download Download the application configuration
Retrieve configuration information from the controller to create a new controller
Device Upload
component in the system
Put Device to SDB Store the component configuration to a System Database (SDB) (if available)
Restore Password Clear all passwords and protect the component
Protection

Public Information
Menu Command Use to
Open release notes for any of the following features:
WorkstationST Service (refer to WorkstationST Service)
Alarm Server,
Control System Health
Device Manager Gateway (refer to WorkstationST Device Manager Gateway
Instruction Guide, GEI-100757)
EGD Configuration Server
GSM (refer to ControlST GSM 3.0 User Guide, GEH-6757)
Historian (refer to WorkstationST Historian, GEI-100628)
Runtime HMI Config
HMI Graphics Without a Project
Mark V (refer to ControlST Mark V Feature System Guide, GEH-6759)
Help Modbus®
Network Monitor
OPC DA Server
OPC UA Server
OPC AE Server
Recorder
WorkstationST Web (refer to WorkstationST Web View Instruction Guide, GEI-100661)
Release Notes Opens the ToolboxST Release Notes Viewer for the current version
How-to Guides Displays ControlST Software Suite How-to Guides (GEH-6808) (if available)
Send Problem
Displays a System Change Request form to report any system issues
Report
About Displays version and copyright information
Public Information
15.12 General Tab
The General tab allows you to configure properties and attributes of a WorkstationST component. Features unique to the
WorkstationST application include the OPC DA Server, Recorder, Human-machine Interface (HMI) Configuration, and
Alarm Server. The Ethernet network and Network Time Protocol (NTP) can also be configured.
➢ To configure a WorkstationST component: open the Component Editor and select the General tab.
General Tab Properties

Allows the user to retrieve alarms by selecting the WorkstationST component currently
Alarm Server To Use
running the Alarm Server
When set to True, allows the WorkstationST component to accept EGD packets being routed.
Enable Network Routing This property is only required when the component and the EGD Producer are not on the
same physical network.
If set to False, the device prefix name is not displayed in CIMPLICITY screens (default is
Enable Alias Prefix
False)
Enable as a limited-access If set to True, prohibits all system components except this workstation from downloading and
workstation publishing to the EGD Configuration Server
Provides a comma-separated list of addresses configured on the WorkstationST computer's
Exclude Addresses
network adapters but reserved for other applications (virtual controllers and such)
Time of the Build command performed after the most recent major change (major changes
Major Revision
require the controller to be restarted after download)
Minor Revision Time that the last Build command was performed
Name of the current controller (this is read-only in the Component Editor and must be
Name
changed from the System Editor)
Access Roles: are assigned to protect each access right for this component
Modify Data: allows the user to modify data values and force variables
Logic forcing procedures can result in personal

injury or death, if not strictly followed. Only
adequately trained personnel should modify any
Protection programmable machine. Forcing of control logic
for an operating process is strongly discouraged.
Forcing of protective functions is never

Warning permissible for an operating unit. All safety
measures should be strictly enforced in
conjunction with this procedure.
Modify Design Allows you to modify the controller design
If set to True, uses the alias name defined for a variable instead of the GE variable name for
Use Alias Name
features that only supply a single variable
If set to True, adds firewall exceptions for ports and applications that a WorkstationST
Windows Firewall Exceptions computer requires for receiving EGD, SDI, and OPC DCOM communications from external
devices and clients
Measurement system used by the CIMPLICITY Advanced Viewer, as well as other HMI
applications
Default Measurement System
When the Viewer starts, the system selected here is used. If None is selected, data displays
in native units. If this measurement system is set in SecurityST, it becomes the default.

Public Information
General Tab Properties (continued)
If set to True, allows the second language description to be used by WorkstationST features
and prints certain alarm fields (such as Alarm State and Description) in second language text.
Typically, the features have both the primary and the secondary language descriptions. The
Use Second Language HMI Config feature, when importing to a CIMPLICITY project, can only import one description.
Therefore, this flag controls which description is imported. It also controls the description
obtained by active OPC DA clients. Likewise, the External Alarm Manager of the Alarm Server
drives CIMPLICITY alarms with the second language description.
If set to True, allows writes to OPC UA or DA server variables from connected OPC clients to
Enable Setpoint Logging
be entered in a log file
Enable WorkstationST owned If enabled, allows writes to be logged to WorkstationST-owned variables
Setpoint Logging The Enable Setpoint Logging property must be set to True, as well.
Defines the OPC AE severity value for a diagnostic alarm in the active condition (value
Active Diagnostics Severity
displays in alarm clients)
Defines the OPC AE severity value for diagnostic alarm in the normal condition (value
Normal Diagnostics Severity
displays in alarm clients)
Config Path Defines the path for downloading the WorkstationST runtime configuration
Path where Microsoft saves crash dumps for any faulting process. If this path is blank, crash
Crash Dump Location
dumps will not be created.
Number of Crash Dumps to Number of dumps Microsoft error reporting will keep for each crashing process. If set to 0,
Retain crash dumps will be disabled.
Public Information
15.12.1 Consumed Devices
When Consumed Devices is selected in the Tree View, the WorkstationST configuration receives information from the
devices listed in the Summary View. They can also be edited in the Summary View by toggling the Referenced column value
or by selecting Devices in the Property Editor.
Consumed Devices Columns

Column Description
Components that will be consumed by the WorkstationST computer
If set to Yes, features of this WorkstationST computer (such as the Recorder or OPC DA server)
receive variables from this component.
If set to Status Only, only the variables configured on the Status page will be consumed and are only
Referenced available to external OPC clients, but are not available for use by WorkstationST features.
If set to By Proxy, the device is not directly consumed, but variables from the device are available
through a TCP connection upon demand to the Primary or optional Secondary Proxy WorkstationST
computers.
Alarms are consumed for components where the Referenced column contains a value of Yes.
Device Name Name of the consumed component
Device Type Type of component (for example, Mark VIe control)
Primary Proxy WorkstationST component acting as the server for the component in the Device Type column
Secondary Proxy WorkstationST component acting as the server for the component in the Device Type column

Public Information
15.12.2 Features
WorkstationST features are enabled or disabled from the Summary View. When a feature is enabled (set to True), a tab for
that feature displays.
Summary View Features
Public Information
15.12.3 Time Card
If a time card is used by this WorkstationST component, information about the time card must be configured with NTP.
Time Card
allows you to
select the type
of time card
installed in the
WorkstationST
computer
Time Card

Public Information
15.12.4 Configure Network Time Protocol (NTP)
The NTP is configured on the System Editor. The configuration can be overridden on each WorkstationST component from
the Property Editor.
WorkstationST NTP Property Editor
NTP Properties
Overrides the system NTP settings, and uses local WorkstationST component settings
Configuration Manual Override
only
Selects the supported NTP configuration option to start on the WorkstationST
computer:
• Time Client
Configuration Option
• Primary Time Master
• Secondary Time Master
• Disabled
Disable NTP Broadcasts Disables or enables NTP broadcasts
Enable or disable NTP Server debug logging to file. This setting should only be enabled
NTP Server debug log enable during troubleshooting an NTP Server issue, then disabled as soon as debugging is
complete.
Specifies if WorkstationST will synchronize to a site time source and user determines
which option is used:
Site Time Reference Option • Broadcast
• Unicast
• None
Public Information
NTP Properties (continued)
When the Site Time Reference Option property is set to Unicast, this property displays
Site Time Reference #1 (Optional) the IP address or name of the customer NTP computer or Network Time Server and is
used to synchronize the system to a site time source.
When the Site Time Reference Option property is set to Unicast, this property displays
Site Time Reference # 2 (Optional) the IP address or name of the customer NTP computer or Network Time Server and is
used to synchronize the system to a site time source.
NTP Operating Mode Mode (Unicast, Broadcast, or Disabled) to be implemented on the target
Name of the WorkstationST computer that this WorkstationST computer will use as a
Primary Time Reference
time reference
Name of the WorkstationST computer that this WorkstationST computer will use as a
Secondary Time Reference
secondary time reference
An optional network name used as a preferred network when locating the address of
Primary Time Reference Preferred the Primary Time Source. This setting is used by WorkstationST components to
Network determine the address to use in the ntp.ini file to reach the Primary Time Source. The
settings can be useful to select one network when multiple networks are available.
An optional network name used as a preferred network when locating the address of
Secondary Time Reference the Secondary Time Source. This setting is used by WorkstationST components to
Preferred Network determine the address to use in the ntp.ini file to reach the Secondary Time Source.
The setting can be useful to select one network when multiple networks are available.

Public Information
15.12.5 Scheduled Tasks
Any configured executable file can be scheduled for starting. The configuration includes recurrence pattern options and
start/end options.
➢ To schedule a task
Task description is optional
Specify the file

to run and any
optional
startup
arguments, as
well as a
window style.
From the
Recurrence
Pattern
options,
specify how
the task
should run.
If No Start
Time is
selected, the
Recurrence
Pattern
selections
are used.
If desired,
specify an
end time
(optional)
Scheduled Tasks
Public Information
Scheduled Task Authentication
When a Scheduled Task is configured or edited in the WorkstationST application, and a Build and Download is performed,
the WorkstationST Service displays an Error until the new or edited task is authenticated.
➢ To authorize new or modified scheduled task to run

1. From the General tab Tree View, select the configured scheduled task to display the details.
2. Review the WorkstationST Service Error status details.
From the Status tab, right-click WorkstationST Service

and select View Additional Status Detail.

Public Information
3. View the WorkstationST Scheduled Tasks Information for the configured scheduled task.
Right-click WorkstationST Service and select View WorkstationST Scheduled Tasks Information.
4. Authorize the new or modified scheduled task to run.
You must be running the WorkstationST computer locally to authorize a Scheduled

Task.
Attention
Select the checkbox to authorize the configured scheduled task to run.
The Status for the authorized Scheduled Task confirms the authorization with an displays as OK.
WorkstationST Scheduled Task Authorized and Confirmed
Public Information
The network adapters display as items in the General tab Tree View. The WorkstationST configuration determines the number
of adapters. Most applications have two network adapters. One connects to the UDH; the other connects to the PDH.
Tree View.
Network Adapters Properties
Adapter Settings
IP Address Internet Protocol address for the selected network adapter
Wire Speed Speed of the network to which the selected adapter connects
Network Settings
Sets the network connected to the selected adapter (available networks are determined in the System
Network
Editor)
Controls the significant portions of the IP address

Public Information
15.13 Acoustic Monitoring (AM) Gateway
The AM Gateway feature enables the AM Gateway Server program used to relay combustion dynamics information to client
programs. It is typically used when a Remote DLN Tuning contract is in place to allow the remote site access to the
combustion dynamics data.
Note A Remote Dry Low NO x (DLN) tuning contract provides for periodic tuning for ambient conditions, fuel conditions,
and normal component wear.
When the Features items is selected from the General tab and the AM Gateway feature is set to True, the AM Gateway Config
Path property displays in the Property Editor. This property provides the full path to the main configuration file that defines
items such as which turbine units are enabled for remote tuning.
Public Information
15.14 On Site Monitor
The On Site Monitor (OSM) feature supports the Universal OnSite Monitor (UOSM). The UOSM is a standalone computer
that serves as a gateway to the customer’s system data, which is used by the GE Maintenance and Diagnostic (M&D) group to
detect and diagnose system problems.
The OSM collects system configuration data from the WorkstationST Config Reader and writes data files for the UPC
(Universal Product Code), which communicates with the M&D group. The OSM provides real time data using the
WorkstationST OPC DA Server.
When the General tab is selected, the On Site Monitor displays as a feature in the Summary View.
➢ To enable OSM
1. From the WorkstationST General tab Tree View, select Features.
The OPC DA Server feature

must be enabled before you
can enable On Site Monitor
2. From the drop-down list, select True to enable the On Site Monitor. The OSM Interface tab displays.
Note The OSM should only be enabled on a UOSM computer.

Public Information
15.15 Network Monitor Tab
The Network Monitor provides the status of all defined system devices (controllers, computers, network switches) connected
to at least one of the Ethernet-based networks. Information is also provided about the health of each network switch and its
ports. The Network Monitor allows proactive network maintenance by providing visual indications and alarms of abnormal
conditions. These include devices not connected in their configured location, unknown devices being connected to a switch,
or attempts to gain unauthorized access to switch Simple Network Management Protocol (SNMP) data. For additional details,
refer to the WorkstationST Network Monitor Instruction Guide (GEI-100693).
During system startup, the Network Monitor determines where the devices are physically connected. During normal system
operation, changes in network topology should not occur, therefore, any changes would indicate an abnormal condition. For
example, devices may be incorrectly reconnected after a network switch is replaced or new network cables are run. This
feature is also an important debugging tool because it allows network issues to be detected or ruled out very quickly. The
Network Monitor also enhances network stability and security by providing alarms in the event of an unauthorized connection
to the network.
Note Changes to the network switch connections will not be available for computers in a system running WorkstationST
V04.06 and earlier until they are upgraded.
With the release of ControlST V04.07, the ToolboxST application allows you to edit switch port connections using the
Network Switch Component Editor, rather than editing each component’s network adaptor. The component network adapter
information is imported into each switch’s configuration when the switch is first edited in V04.07. While it will no longer be
possible to view or edit the network adapter switch connections from each component editor, connections configured before
the upgrade will remain available for any WorkstationST computer that has not been upgraded. All upgraded WorkstationST
computers will use the new switch-centric information.
Network Monitor Data Flow
Public Information
➢ To configure Network Monitor
1. From the General tab Tree View, select Features.
2. From the Summary View, set Network Monitor to True.
3. Click the Network Monitor tab.
4. Select the alarms or events to be generated.
The data acquisition rate parameters allow the level of SNMP network traffic to be adjusted based on network bandwidth
rather than display update rate needs. The switch data request rate is separate from the device SNMP data because the amount
of SNMP data exchanged with the switches is very large compared to the data retrieved from the devices. Specifying a fast
device scan rate allows for fast detection of a device going online or offline, while fast switch data rates detect an unknown
device being added to the network or a device being moved to a different port. Knowing the device location is less important
than knowing whether the device is online. The network bandwidth necessary to retrieve the forwarding database from the
switches can be large in large systems, so separate parameters allows for tradeoffs to be made between bandwidth and the
speed of detection of abnormal conditions.
The system network drawing displays all physical networks, as well as network switches and devices, their physical locations,
and their interconnection. The host name and IP address of each device network connection on a per network basis, as well as
the switch and port where the physical connection is made is also provided. This information is entered for the network
switches and devices as they are added to a system.
When a new system is created, it automatically includes a UDH network. This is the default controller-level network to which
all controllers are connected. The Network Monitor only attempts to monitor devices configured as Ethernet, IP networks.
Additional networks are added as needed.

Public Information
Network Status
The system network status can be used to troubleshoot network problems. The Summary View in the System Editor displays
all system devices and their simplified connections to the defined networks. It also displays the composite health of each
component connection to each network by displaying healthy connections with a green line and unhealthy connections with a
red or orange line.
The Network Status Viewer allows you to troubleshoot network issues down to the device level. This utility retrieves status
data from the Network Monitor.
From the System

Editor , go online.
Then, from the
View menu, select
Network Status
Viewer
Network Status
Viewer displays
a hierarchy of
network, switch,
and devices
The Device View As Configured tab displays the devices in their configured locations, as well as deviations of the device
connections from their configured locations. This is used to find occurrences of a device connected to the wrong port that is
masking the location of an offline device, but configured to be connected to that port.
The Device View By Connection tab displays the actual location of each device’s switch and port.
Public Information
15.16 Alarm Tab
The Alarm tab is used to configure the WorkstationST Alarm Server, the Alarm Scanner option, external OPC AE servers, and
Alarm printing. The Alarm Server connects to all devices consumed by the workstation (the device that displays Yes in the
Referenced column when the Consumed Devices item is selected in the Tree View and enabled). The Alarm Server receives
alarm messages sent from these devices to provide live alarm viewing. The alarm messages can also be saved in log files.
The alarm Scanner feature scans variables from the OPC DA or OPC UA Servers running on the local workstation and
external devices being consumed by this WorkstationST. It then generates Alarms and Events based on the variable
configuration.
The external OPC AE Server selections provide the configuration necessary to consume Alarm and Events from these
external servers.
Note Refer to the WorkstationST Alarm Server Instruction Guide (GEI-100626) for additional information on the
WorkstationST Alarm Server.
➢ To configure the Alarm tab

2. From the Summary View, select True from the Enabled drop-down menu for the Alarm Server feature to enable the
Alarm Server.
3. From the Alarm tab Tree View, select the Alarm Server item to display the Alarm Server configuration properties.

Public Information
The following table describes the configuration properties of the Alarm Server.
Alarm Server Properties

CIMPLICITY Alarm Manager Interface
The Alarm Server can send alarms to a CIMPLICITY external Alarm Manager on any of
CIMPLICITY Alarm Manager the WorkstationST components configured in the system. More than one
WorkstationST devices WorkstationST component can be selected. This property is only available if Send
Alarms to CIMPLICITY is set to True.
If set to True, alarms are sent to the CIMPLICITY Alarm Manager. This option only
applies to CIMPLICITY V06.00 and earlier versions that preceded the Advanced
Viewer architecture. Advanced Viewer architectures use the WorkstationST Alarm
Server and Alarm Viewer instead of the CIMPLICITY Alarm Manager and Viewer. The
Send Alarms to CIMPLICITY alarm is automatically reset when the alarm transitions to the Normal state if
Acknowledged. This is recongnized by all Alarm Viewers currently displaying alarms
and events. When set to True, this option overrides the setting on the Automatically
Reset Acknowledged Alarms option. If set to False, alarms are not sent to the
CIMPLICITY Alarm Manager.
Disk
If set to True, the historical alarm files are deleted based on Historical File Age or
Disk Cleanup Enabled Maximum Historical Disk Space. If set to False, the historical alarm files are not
deleted.
Public Information
Alarm Server Properties (continued)
The number of days of historical alarm data to maintain before deletion occurs. The
difference is between the time of the newest and the oldest alarm data file. All historical
Historical File Age
alarm data files exceeding the time difference specified are deleted. A value of 0
disables this feature.
The maximum size (MB) that the historical alarm data files are allowed to use. If the
Maximum Alarm Historical Disk total size of all historical alarm data files exceeds this value, the oldest alarm data files
Space Allowed will be deleted until the total bytes used is less than this value. A value of 0 disables this
feature.
The minimum free disk space threshold (MB) before a Low Disk Space diagnostic
Minimum Free Space alarm is generated by the Alarm Server. A value of 0 disables the detection and alarm
generation. The default is 10.
General
If set to True, an Acknowledged alarm in the Normal state is automatically reset. If the
Automatically Reset Acknowledged
Send Alarms To CIMPLICITY option is set to True, setting this option has no effect and
Alarms
results in always resetting an Acknowledged alarm in the Normal state.
If set to True, the Alarm Server maintains Event queues and manages Events the same
Emulate CIMPLICITY and SOE
as alarms. This option allows the WorkstationST Alarm Viewer to emulate the
behavior
CIMPLICITY Alarm View.
If set to True, controller and I/O pack diagnostics are reported and logged to the
Enable Controller Diagnostic Alarm
historical alarm log. If set to False, controller and I/O pack diagnostic information can
Support
only be retrieved using the ToolboxST application.
Historical
Historical Alarm Path The fully qualified path where the Alarm Server writes the historical alarm data files.
Historical WorkstationST Alarms If set to True, the Alarm Server writes the alarms to the historical alarm data file. If set to
Enabled False, no historical alarm data files are created. The default value is True.
If set to True, the Alarm Server performs alarm synchronization between primary and
Periodic Alarm Synchronization
secondary Alarm Servers every 15 minutes.
Legacy Alarm System Interface
Connect to Legacy Alarm System If set to True, the Alarm Server connects to the Legacy Alarm System.
The host name or IP address of the computer running the Legacy Alarm System. This
Legacy Alarm System Host Name
option is only available if the Connect To Legacy Alarm System option is set to True.
Network Monitor / Control System Health Interface
Connect To Network Monitor or Configures the Alarm Server to connect and receive alarms from the Control System
Control System Health Health or Network Monitor.
The host name or IP address of the WorkstationST computer that the Network Monitor
Network Monitor or Control System
or Control System Health feature is running. This option is only available if Connect to
Health Hostname
Network Monitor or Control System Health is not set to None.

Public Information
15.16.1 External OPC AE Servers
The Alarm Server can be configured to receive Alarm and Event data from one or more third-party external OPC AE Servers.
The Alarm Server connects to each of the external OPC AE servers listed in the Tree View. The translation of OPC conditions
must be defined for each OPC AE server added. When an alarm is received, it is translated using the configured information
for the specific alarm. The alarm will be available on the Alarm Viewer live alarm display.
Note Each OPC AE server must be installed and configured before you add the server to the list and get the published
categories and condition names.
Refer to the WorkstationST OPC AE Server Instruction Guide (GEI-100624) for additional information.
➢ To add an external OPC AE Server: from the Tree View, right-click the External OPC AE Server item, then
click Add. A selection dialog box displays installed and operational servers.
To select a server on another computer,

enter a new Host Name and click
Refresh.
WS1
WS1.Softing.OPCToolboxDemo_ServerAE
Select an OPC AE Server

from the drop-down list and
click OK .
Note To be selected, the server must be installed and available.
When an OPC AE server is added and selected in the Tree View from the Alarm tab, the data grid displays the translation of
each event category and condition name published by the OPC AE Server.
To translate incoming alarms and events, condition states must be mapped for the selected OPC AE Server. Once the
WorkstationST configuration has been downloaded, all Alarm Server clients can display alarms and events from all
configured OPC AE Servers.
Public Information
Additional Properties
Connection Information
Enable Connection To If set to True, connects to the OPC AE Server, and consumes configured Alarms and Events.
Server If set to False, the configuration is preserved but ignored by the Alarm Server.
Host Name Host name used to connect to the OPC AE Server
Secondary Host
Host name used for connecting to the secondary OPC AE Server.
Name
Name of the OPC AE Server running on the specified host.
Server Name For redundant OPC AE Servers, the secondary server must be identical to the primary server, both in
name and configuration.
General
Time units used by the OPC AE Server. The Alarm Server uses this property to determine how to
OPC Server Time
process the time stamp from this server.
Units
The Alarm Server expects the time to be in Universal Time Coordinated (UTC).
User Credentials
A domain name or computer name for the specified user name. For computers running in a Windows
Domain Name domain, enter the domian name. For computers running in Windows workgroups, leave this blank and
create a local user account on both the AE client computer and the OPC AE server computer.
User Name User name (or a domain/username) for the External OPC AE Server, if required.
User Password Password for the optional user name
➢ To display alarm and event types: click the OPC AE Server tab. The alarm and event types display in the
Summary View.
Note The GeCssOpcAeServer is a WorkstationST runtime feature, and must be installed and running for this configuration
to work.

Public Information
15.16.2 Alarm Scanner
The Alarm Scanner is used to periodically scan Boolean and Numeric variables hosted by the WorkstationST OPC DA or
OPC UA server, or external EGD components, and to generate an alarm whenever the variable changes state. The Alarm
Scanner allows a third-party component or external software to generate an alarm within the alarm system. A variable can be
defined and configured in the OPC DA or OPC UA server, and its value manipulated by an OPC client.
The user selects variables that are configured as alarms or events hosted by the OPC DA or OPC UA server, which the Alarm
Scanner scans at the configured rate. An alarm and or event is generated whenever that variable changes alarm state, based on
the variable’s configured alarm attributes.
The Alarm Scanner can also scan workstation client-driven variables configured as alarms at the configured rate and generate
alarms and events based on the configuration of each variable. With ToolboxST V04.05 or later, the client-driven variables
are configured on the WorkstationST Component Editor Variables tab under the WorkstationST Variables item, as displayed
in the following figure.
From the Tree View , select WorkstationST Variables to display the variables.
Public Information
The Alarm Scanner configuration is found on the Alarms tab under the Alarm Scanner item.
➢ To configure the Alarm Scanner
From the Alarms tab

Tree View , select
Alarm Scanner .
From the Property

Editor, select Enabled
and set to True.
The Scan Rate can also

be set as required.
From the Alarms tab Tree View , right-click

Alarm Scanner and select Add Variable .

Public Information
From the Select a Variable dialog box Tree
View , locate the folder with the required variables .
Select the variable to be added and click OK .
Note Only variables from WorkstationST and External Device components that have been configured as an alarm or event
will be available for selection. Mark VI, EX2100 and LS2100 variables are not available to be scanned as they are already
part of the alarm system. Do not scan the controller component variables, since this causes redundant alarms to be generated.
The selected variable displays in the Alarm Scanner .
Note The variable attributes cannot be modified from the Alarm Scanner variable list. The variable’s configuration displays,
but settings can only be changed from the component or feature where the variable is defined (typically the OPC DA Server
tab).
Public Information
15.16.3 Fault Code Scanner
The Fault Code Scanner is a feature of the Alarm Server that provides a mechanism for devices and third-party software to
generate alarms by driving WorkstationST variables though OPC. The Fault Code Scanner is configured to monitor specified
INT or DINT variables. The value of the variable represents a specific fault condition (fault code), and the enumeration
associated with the variable provides the meaning of the values. The Fault Code Scanner monitors the value of the variable
and generates a new alarm whenever the value changes. The alarm text displayed for the alarm is supplied by the Format Spec
enumeration associated with the variable.
➢ To configure the Fault Code Scanner

1. From the System Editor Edit menu, select System Information to display the System Information Editor.
From the Tree View, select Format Specification Sets.
From the Summary View, select Enumerations and click the

elipsis button to display Enumeration Definition dialog box.
Enter the Name , Value ,

Description, and Second
Language Description (optional )
that correspond to the fault codes.
Click OK .
2. From the toolbar, click Save.

3. From the System Editor Tree View, double-click a WorkstationST component configured to run the Alarm Server
feature.

Public Information
Fault Code Scanner Configuration
Enable True or False to Enable or Disable the Fault Code Scanner function.
Scan Rate The period in milliseconds between fault code scans.
4. From the Tree View, right-click Fault Code Scanner and select Add Variable.
5. From the Select a Variable dialog box, locate and select the WorkstationST variables to be scanned.
6. From the WorkstationST Component Editor toolbar, click Build, then click Download.
7. Click Go Online and force the variable to test the generation of the alarms as displayed in the following figures.
Public Information
Normal
Fault Condition 1
Fault Condition 2
Fault Condition 3
Note If the variable value falls outside the range of the enumerated values, the alarm is still generated and the alarm
description indicates the reason that the alarm text lookup failed as displayed in the following figure.
Variable Value Outside Range

Public Information
15.16.4 External OPC UA Servers
The Alarm Server connects to each of the listed external OPC UA servers in the Tree View. The list of alarms is obtained
from the OPC UA server. The ability to configure additional alarm properties is provided. The alarm will be available on the
Alarm Viewer live alarm display.
When an OPC UA server is added, a connection is established with the server to obtain the current list of alarms.
Note Each OPC UA server must be installed and configured before being added to the list to receive a list of alarms.
➢ To add an external OPC UA server connection

1. From the WorkstationST Component Editor, General tab, select Features.
2. From the Summary View, set Alarm Server to True.
3. From the Alarm tab Tree View, right-click External OPC UA Servers and select Add Server Connection.
4. Configure the OPC UA server connection.
OPC UA Client Server Connection Configuration
Provide the OPC UA server configuration settings as follows:

Discovery URL: allows the user interface to browse registered OPC UA servers at the selected URL. The default URL opc.
tcp://localhost:4840 allows the Endpoint URL drop-down menu to display registered OPC UA servers on the local computer.
Endpoint URL: defines the OPC UA server’s endpoint and optional security settings. Select one of the servers available from
the Discovery server listed in the drop-down menu, or enter a known URL. Example URLs (provided hyperlinks) are
displayed for known GE OPC UA servers.
Public Information
Security Settings: the client can be configured to use a specific security profile using the Security Policy and Message
Security Mode drop-down menus, or the client can be made to use the most secure endpoint exposed by the server by
selecting the Use Best Security check box. To use no security and avoid exchanging application certificates, select a Security
Policy of None and a Message Security Mode of None (the server must support the None security profile).
Authentication Settings: the client can be configured to use an anonymous user or a user name and password.
The server
displays in the
Tree View
Server Properties
If set to True, creates a connection to the OPC UA server and consumes configured Alarms
Enable Connection To Server and Events.
If set to False, the configuration is preserved but ignored by the Alarm Server.
Host Name Host name of the computer where the OPC UA server is running
Server URL URL of the OPC UA server running on the specified host
Endpoint Configuration - Security Mode used for a secure connection. If Use Best Available Security is set to True, this
Security Mode setting will be ignored.
Endpoint Configuration - Security Policy used for a secure connection. If Use Best Available Security is True, this setting
Security Policy will be ignored.
Endpoint Configuration - Use If set to True, the client will attempt to connect to the server’s most secure endpoint, otherwise
Best Available Security the security settings defined in the Endpoint Configuration will be used.
User Token Information – User Name when a server implements a user name and password authentication. If blank, the
User Name user will be anonymous.
User Token Information –
Password when a server implements a user name and password authentication policy.
User Password
When the server connection is selected in the Tree View, two tabs display in the data grid: Variable and Active Severity
Mapping. Additional property values can be added to the alarms from the Variables tab.

Public Information
Variables Tab Columns
Column Description
Name Name of the alarm variable (read-only)
Value sent from the OPC UA server at runtime to add or subtract
Active Severity Offset This allows normalizing of the vendor-assigned values to values used in the system configuration. The
result of the calculation must be in the range of 1–1000.
Display Screen Name of the HMI screen where the variable displays
Enables or disables the Return to Normal (RTN) Unacknowledged alarm state
Auto Reset This state is reached when the process returns to normal limits, and the alarm clears automatically
before the operator has acknowledged the alarm condition.
Alias Alternate name to use for the variable
Second Language
Potential causes of the alarm (in the Description in second language if configured in System Editor)
Potential Causes
Second Language Action the operator should take to avoid defined consequences (in the description in second language
Operator Action if configured in System Editor)
Consequence of
Inaction
Second Language
Consequence of Consequence of inaction (in the Description in second language if configured in System Editor)
Inaction
Operator Urgency Length of time to perform corrective actions to avoid defined consequences
Second Language Length of time to perform corrective actions to avoid defined consequences (in the Description in
Operator Urgency second language if configured in System Editor)
Active Severity Mapping Tab Columns

Column Description
Used to combine variables into logical groups based on plant layout
Plant Area
These groups determine how the variables display in the Alarm Viewer.
Alarm Class Alarm class associated with this active severity mapping range
Lower Range Lower range of the active severity mapping
Upper Range Upper range of the active severity mapping
Public Information
15.16.5 Alarm Printing
The Alarm Printing feature configures the alarm types for printing, as well as the common format for the Alarm and Event
messages and sends alarms to the defined printer. This requires a dot matrix printer to be available on the local computer for
use. Each alarm type can be selected for printing, and custom filters can be defined for each type to control print output. The
print output is defined in the Format tab when Alarm Printing is selected in the Tree View and selecting columns and the
width for each. If the column value is longer than the specified width, the value is truncated. Alarms are printed continuously
as they are generated. Refer to the manufactures printer manual for configuration information.
➢ To configure Alarm Printing
From the Alarms tab ,

select Alarm Printing .
From the Property

Editor, select Enabled
and set to True.
Note If Printing Enabled is set to False (default setting), the Filters tab does not display.

Public Information
From the Format tab, use the
arrow buttons to move alarms
from Available to Selected
Public Information
When enabled, the Alarm Printing item in the Tree View displays sub-items
for Process Alarms, Events, Diagnostic Alarms, SOEs , and Holds .
When an alarm type is enabled for printing, the filtering configuration options
display in the Summary View .
Individual alarm classes can also be disabled for printing.

Public Information
Global Alarm Printing Properties
Enabled If set to True, sends enabled alarm types to the defined printer. The default is False.
Maximum number of print jobs allowed in the internal alarm manager queue (print spooler directory) waiting
Print Job Limit
to be printed.
Name of the defined printer being used by the alarm system.
The printer name displays in the Printer dialog box on the computer running the WorkstationST runtime.
Printer
Only local printers are supported.
A width of zero prints the full contents of the column.
Note Additionally, if the WorkstationST General tab setting Use Second Language is set to True, certain alarm fields (such
as Alarm State and Description) will be printed with the second language text.
Printing in Raw Mode for Dot Matrix

Alarm messages can be up to 131 characters wide and event messages can be up to 140 characters wide. For many dot matrix
printers, using a pitch size of 12 characters per inch and condensed mode on 8.5 inch wide paper will allow the alarm
messages and all but the widest event messages to be printed on a single line. Refer to the specific printer manual for
instructions on adjusting font and pitch for printing one alarm/event per line with no page eject.
15.16.6 Alarm Viewer

The Alarm Viewer displays and manages live and historical Alarm and Event information from a computer configured with
the WorkstationST application, and running the Alarm Server. Information displays by using advanced filtering and sorting
capabilities, as well as functions such as Acknowledging, Locking, and Silencing Alarms and Events.
Note Refer to the WorkstationST Alarm Viewer Instruction Guide (GEI-100620) for further details.
Public Information
15.17 HMI Config Tab
15.17.1 HMI Features
As a feature of WorkstationST Service, the HMI imports component data into a defined CIMPLICITY project and allows you
to manage HMI screen files. For additional information on managing HMI screen files, refer to the WorkstationST HMI
Configuration User Guide (GEI-100629).
Imported data includes:
• OPC DA, OPC UA, and EGD variables

• Alarms
• Alarm classes
• Components
• Ports
• Enumerations
• Measurement units
Components are selected in the General tab. Component variables are those published on EGD.
HMI screen file management functions include:
• Select screen files for a particular HMI to use

• Edit HMI screen files
• Download HMI screen files from a master location to a particular HMI
• Enable or disable auto-downloads
• Display status of HMI and master screen files

Public Information
➢ To add an HMI feature
1. From the Tree View, select Features.
2. From the Property Editor, select True to enable HMI and display the HMI Config tab.
Multiunit Path and File
HMI Config Tab
Public Information
HMI Config Properties
Enable Alarm Viewer Multiunit - Go To If set to True, displays multiple alarm names in the CIMPLICITY screen when started
Screen Capability by the WorkstationST Alarm Viewer.
Fully qualified path and file of the multiunit text file that is processed by the
WorkstationST Alarm Viewer.
This file contains the screen variable names and component name assignments to
Multiunit Path and File pass into the CIMPLICTY object model, OverlayEx Call. If this file is defined, it
overrides the file defined using the path of the NavCfg file.
The property Enable Alarm Viewer Multiunit – Go To Screen Capability must be set to
True to enable this property.
Project File Path Location and file name for the CIMPLICITY project that will receive imported data
If set to True, enables the CIMPLICITY project to send information to the Event Log
Set Point Audit Trail
about user-defined setpoints.
If set to True (default) and CIMPLICITY 7.x is being used, requires you to define the
CIMPLICITY project file path.
CIMPLICITY 7.x allows you to view and edit screens with a direct connection to
HMI Graphics without a Project WorkstationST Services. This eliminates the need to synchronize a CIMPLICITY
project database.
Refer to WorkstationST / CIMPLICITY Advanced Viewer Integration Instruction Guide
(GEI-100697).
Used to override the Use Second Language property in the WorkstationST General
tab when importing into a CIMPLICITY project.
Override Use Second Language If the override is False, the Importer uses the setting in the General tab.
If the override is True, the primary language description is imported into the
CIMPLICITY project.
Auto Download Screen Files Automatically downloads HMI screen files when the master screen files change.
Screen Editor Overrides the default editor, which is based on the screen file extension.
Overrides the default local screen directory.
This path can be absolute or relative. When relative, it is based on the location of the
CIMPLICITY project (defined in the Project File Path).
If the screen file path is blank, the default screen file path is \screens, relative to the
Screen File Path project file path parameter (for example, if the project file path is c:\site\cimproj, the
screen file path is c:\site\cimproj\screens.)
If the HMI Graphics without a Project property is set to False, Global Project
Parameters displays in the Tree View and the following properties display in the
Property Editor.

Public Information
15.17.2 Global Parameters
Global parameters can be configured as either system-level or project-level. Both types are user-defined. When the HMI
Config tab is selected, Global System Parameters displays as an item in the Tree View.
Note Global Project Parameters displays as a Tree View item only if the HMI Graphics without a Project property is set to
False.
➢ To add a global system or project parameter: from the Tree View, right-click either Global System or Project
Parameters and select Add.
➢ To edit or delete a global parameter

1. From the Tree View, select either Global System Parameters or Global Project Parameters.
2. In the Summary View, right-click the parameter to edit or delete.
3. Edit the parameter or select Delete Selected Row(s).
HMI screen files are downloaded to the HMI WorkstationST components. The HMI screen files are managed from the System
Editor.
An HMI WorkstationST component may not require all screen files in the system. The use of specific screens for each
component is defined from the System Information Editor. When a screen is added to the system, all HMI WorkstationST
components use that screen by default.
➢ To define the use of HMI screens from the System Editor

2. From the Summary View, select a screen.
3. From the WorkstationST column for the selected screen, select True to enable that screen or select False to disable it.
➢ To download HMI screen files from the Master location to an HMI WorkstationST component
2. From the Summary View, select one or more HMI screen files and right-click to select Download selected HMI
Screens.
Note The most important status property is whether the HMI WorkstationST screen file is current with the Master file.
The System Information Editor can display the status of HMI screen files, including the date and size of the Master HMI
screen file and the WorkstationST component’s screen file.
➢ To update HMI screen file status

2. From either the Tree View or the Summary View, right-click and select Refresh HMI screen data.
Public Information
15.18 OPC DA Server Tab
OPC® is an industrial standard for communication between various platforms using the Microsoft COM and DCOM model.
The DCOM utility allows components to communicate across network boundaries. The OPC Data Access (DA) Server is
configured from the WorkstationST component OPC DA Server tab.
Note Refer to the section General Tab.
The OPC DA Server receives Ethernet Global Data (EGD) from all EGD-referenced devices consumed by the WorkstationST
application. The OPC DA Server provides live, time-stamped data. Write access allows you to write to variables. These writes
are channeled to the EGD devices through EGD Command Message Protocol writes. The OPC DA Server can also own
variables defined in the OPC DA client. The OPC DA Server has various data plug-ins. If enabled, an SDI data plug-in allows
access to named variables from a component that speaks SDI protocol, such as a Mark VIe controller, a Mark VI controller, or
a UC2000 Innovation Series controller. The OPC DA client data plug-in allows the server to obtain variables from an external
OPC DA Server.
Note Refer to the WorkstationST OPC DA Server Installation Guide (GEI-100621) for further details.
➢ To configure the OPC DA Server tab

2. From the Data Grid, select True to enable the OPC DA Server.

Public Information
3. Select the OPC DA Server tab.
From the Property

Editor, configure
the OPC DA Server
Public Information
Properties
If set to True, provides the capability to expose process alarm state and acknowledgment
Enable Process Alarms feedback data in addition to allowing Acknowledgment and Reset commands to the Alarm
Server.
When set to True, enables the server to allow client access based on both the Windows user
Enable Client Security by
under which the client is running and on Users and Roles defined in the System Information
User
Editor.
If set to False (enabled by default), OPC and SDI clients (for example, the ToolboxST
Enable Client Writes
application) cannot write to a variable.
Maximum client data update rate in ms
Maximum Client Rate If five times the exchange period is greater than the minimum, five times the exchange period
will be the timeout used.
Sets the minimum EGD exchange timeout in ms
Minimum Exchange Timeout Consumed EGD exchanges are declared unhealthy if they are not received within this timeout.
The default is 8000 ms. A minimum value of 1000 ms is allowed.
Number of backup log files to keep
The log files are two megabytes in size, and are kept in the application startup directory
Number of Backup Files
(normally C:\Program Files\GE Energy\GeCssOpcServer).
After changing this setting, restart the OPC DA Server Service.
Enables solicited data through the SDI protocol. If enabled, the server contains additional
internal variables for UC2000, Mark VI, and Mark VIe controllers.
SDI Data Enabled These variables are in addition to the public EGD variables. Although the internal variables are
present in the server and available for OPC browsing, they are not updated with live data until
an OPC client assigns them to a group.

Public Information
15.18.1 OPC DA Client
Note DCOM security issues may be encountered when OPC DA client-to-server communications are configured. Refer to
the WorkstationST OPC DA Server Installation Guide (GEI-100621).
The OPC DA client allows you to receive data from other OPC DA Servers. An OPC DA client connection contains one or
more groups that are collections of variables to be updated.
➢ To add a client connection
From the OPC DA

Server tab, right-
click OPC DA
Clients and select
Add Connection
Enter a name for the

host computer, then
from the drop-down
list, select a server
and click OK.
➢ To add an OPC DA group to the connection: from the Tree View, right-click the connection and select Add
Group.
Enter a group
name and
click OK.
Public Information
➢ To add variables to a group
1. From the Tree View, select a group.
From the Data Grid, click the

ellipsis button to display the
➢ To connect all items in the Tree View: select the top level item and click GoOn/Offline or right-click and select
Connect.
If a connection is successful, live values display in the Data Grid.
A connection between the client and the OPC DA Server requires access and launch permissions by the client on the server
computer. Since OPC DA Servers often run as system users (not administrators), the server must be able to access the client
computer to return data values. The client computer must allow access by the system account to the client. Refer to the
WorkstationST OPC DA Server Installation Guide (GEI-100621) for information on DCOM settings.

Public Information
15.18.2 Live Data .csv File Interface
The WorkstationST application allows you to read and save variable live values in a .csv file. The OPC DA server tab
contains a CSV To Live Data option in the Tree View that configures the OPC DA server to read and monitor one or more .
csv files for live variable values.
When the OPC DA server is started, and whenever the specified .csv file is changed, the live values are read and set to the
variables specified in the .csv file. The variables can be any writable variables to which the WorkstationST has access. For
example, a client-driven variable can be defined and put onto an EGD Produced Page. This variable’s value is then updated
from the .csv file values. Any errors display in the Component InfoView Status tab.
If CSV Uses New Format is True, the .csv file format is a variable name with a value on each line, for example:
Var1, 3.7
Var2, true
Var3, 4.5
If CSV Uses New Format is False, the .csv file format is one line of variable names and a second line of data values, for
example:
Var1,Var2,Var3
3.7,true,4.5
The utility LiveVarsToCsv.exe, which is in the GeCssOpcServer installation folder, is used to read a snapshot of live values
and write them to an output .csv file. The command line utility’s syntax is as follows:
LiveVarsToCsv [options] <varCfgFileName |
var1,var2,var3...> <outputFileName>
Public Information
Where options are:
/opcClient - use an OPC client to the WorkstationST live data core, otherwise an SDI connection is used by default.
/host="name" - an optional host name. If not specified, local host is used.
/Horiz - Without this option, the output format has one line of comma separated variables and a second line with comma
separated values. With this option the output format has one line per variable with name, value and optional extended data.
/Extended - Additional information is appended to the variable column or row.
/Header - Includes a column header line. This option is only used when the /Horiz option is used.
/SeparateDateTimeColumns - Creates two columns for the variable's time stamp rather than one combined date/time column.
This is only valid when used with the /Horiz option /AdditionalColumns=col,val which allows the inclusion of a column
header(s) col with value val. For example, if you use:
/AdditionalColumn=Area,Train1, another column with a header text of Area and column values of Train1, would be appended
to the output. Multiple columns/values can be specified (for example Area,Train1,Customer,GE). This is only valid when
used with the /Horiz option /ColumnOrder=list which allows the order of the columns to be specified. The list is a comma
separated list of column header names.
Valid header names are:
Name, Value, Type, Time Stamp,Units,Description, Second Language Description.
If the /SeparateDateTimeColumns options was specified, Date and Time are also valid column headers.
If the /AdditionalColumns option was used, the headers specified are also valid for the ColumnOrder list. This is only valid
when used with the /Horiz option.
If the argument following the options is a valid file path, the file is expected to contain a list of variables, one per line with
optional comma separated columns for scale, offset and a translated output name (see an example below). Otherwise, the
argument following the options can be a list of comma-separated variable names.
Example varCfgFile format:
# Comments are allowed anywhere in the file if preceded by a ‘#’
var,scale,offset,translatedName
G1.Celcius,1.8,32,G1.Farenheit
Example using advanced options:
LiveVarsToCsv /Horiz /Extended /Header /SeparateDateTimeColumns /AdditionalColumns="Plant Area,Train1"
/ColumnOrder="Area,Name,Value,Date,Time,Description,Units,Second Language Description" var1,var2,var3 outputfile.csv
This utility can be used with the WorkstationST Task Scheduler to provide periodic writing of .csv data.

Public Information
15.18.3 Import WindSCADA OPC Data
This feature creates an alias to format but not change the tag names used in legacy OPC clients. This is achieved by importing
an OPC dataset containing OPC tag names (aliases) that consist of aliases and bit-packed digital values. The aliases are
imported from a .csv file, and display in the OPC DA Server tab Summary View.
The bit-packed values are 32-bit entities that consist of Boolean signals. The values of these entities are calculated by the
WorkstationST application. They then display in the Summary View when the WindSCADA Bit-packed Words item is selected
in the Tree View.
The minimum data and column names required in the .csv file include:
SignalName ShortName GroupShortName Offset

WTG001.Variable1 OldSystem.P_ACT N/A N/A
WTG001.Variable10 OldSystem.DI_In_0DegLSAxis1 WTG001.DI_In_A 0
WTG001.Variable11 OldSystem.DI_In_0DegLSAxis2 WTG001.DI_In_A 1
If the alias is part of a bit-packed word, the GroupShortName and Offset columns must be populated. WorkstationST
variables cannot be used as part of a bit-packed word. Additional fields are ignored. The column order does not matter.
Note To use the import WindSCADA feature, the OPC DA Server tab must be enabled. Refer to the section Features.
➢ To import OPC tag aliases
From the File menu,

select Import and
WindSCADA OPC
Data.
From the Open

dialog box, select
the desired .csv file.
Select WindSCADA Aliases to

display aliases in theData Grid
Public Information
From the Tree
View, select
WindSCADA Bit
Packed Words
to display names,
descriptions, and
types in the Data
Grid
From the Data Grid, double-click

the name to display the list of bit-
packed variable offsets
Data displays in Read-only format.
Once the OPC dataset has been imported, perform the Save, Build, and Download commands. This updates the OPC DA
Server without requiring a restart. New OPC tags with the specified alias names are added to the namespace for access by
OPC clients.
Bit-packed Words Properties
Name Full name with the device prefix
Description Existing Boolean variable in the OPC DA Server namespace
Type Offset for the Boolean variable in the packed word

Public Information
Each Import command replaces the existing file. If Import is selected again after the initial import command has been sent, a
message displays:
The data is only configurable from the .csv file. If It becomes necessary to modify or add to the data, the file can be exported
back to the original .csv file from the WorkstationST configuration.
➢ To export the OPC dataset
From the File menu,

select Export and
WindSCADA OPC
Data.
From the Open dialog

box, select the desired
.csv file and click Save
Public Information
15.18.4 Alarm Consumption from Remote Workstation
The following diagram illustrates alarm handling for consumption of alarms directly over a UDH and remotely from another
alarm server(s) from a second UDH.
WorkstationST Multiple UDH Alarm Handling
The WorkstationST Alarm server feature will consume alarms for all Mark VIe, Mark VI, and Mark V product line of
controllers that are configured to be referenced as Yes on the General Tab, Consumed Devices configuration. For example, the
following figure displays a configuration where alarms from the BOP controller will be consumed by the alarm server.

Public Information
The property grid provides the Redundant Alarm Server properties that can be set to define the primary and secondary alarm
servers. The following figure displays the system view containing the above configuration.
Redundant Alarm Server System Properties
Alarm consumption can be configured to consume additional alarms from other remote alarm servers on the Alarm tab. The
primary and secondary alarm servers in the system are intended to be used to consume or aggregate alarms from other remote
alarm servers. Continuing with the example, the following figures illustrate the primary alarm server being additionally
configured to consume alarms from the controllers in Block1 and Block2. Both a primary and a secondary alarm server are
configured.
Public Information
➢ To configure the Remote Alarm Servers: right-click on the Remote Alarm Server node and select the Primary
Workstation and Secondary Workstation from the drop-down menus. Set to True to enable the connection to the
remote alarm server.
Remote Alarm Server Configuration

Public Information
15.18.5 Redundant EGD Produced Pages
Note The period, which is user-configured as an exchange on a page, is the rate at which the exchange is sent.
WorkstationST EGD Produced Pages can be configured with primary or secondary redundancy. A primary redundancy sends
the Produced Page if the page’s data source is healthy. A secondary Produced Page is sent by another WorkstationST
component if the primary Produced Page is not heard for three periods. Typically a consumer of an EGD Produced Page
declares the page unhealthy if the page is not received after five periods. If the secondary redundancy again detects the
production of the primary page, data production is stopped. Like the primary, the secondary producer sends the page if the
data source is healthy.
➢ To show redundancy
1. From the EGD tab, select a Produced Page.
2. From the Property Editor, modify the Redundancy by selecting from the drop-down list.
Public Information
15.18.6 Determine Produced Page Health
Each Produced Page contains WorkstationST variables. A data source for the variable values can be an OPC DA client
connected to the WorkstationST OPC DA Server, an OPC DA Server connected to the WorkstationST OPC DA client, or a .
csv file monitored by the WorkstationST .csv file watcher.
The Health Timeout Multiplier can be configured for each Produced Page. If the health timeout multiplier is greater than 0,
and at least one page variable is written by a data source within the timeout multiplied by the page period, the page is sent by
the primary producer (or the secondary if the primary is not producing). A flag allows the first variable in the page (the one at
offset 0.0) to be the only variable monitored to determine the data source health.
From the EGD tab,

the Health Timeout
Multiplier and the
Period properties
display.

Public Information
15.18.7 Test OPC DA Client
Note DCOM security issues may be encountered when OPC DA client-to-server communications are configured. Refer to
the WorkstationST OPC DA Server Installation Guide (GEI-100621).
The WorkstationST application provides an OPC DA Server that can be configured with an OPC DA client, which consumes
data from other OPC DA Servers. The OPC DA test client allows browsing and live data callback connections (OPC DA 2.0)
to any OPC DA Server. Detailed information displays in the Log window.
➢ To use the Test OPC DA Client feature: from the View menu, select Test OPC DA Client from the drop-down
list. Refer to the section OPC DA Client.
The Logging Level drop-down list allows you to

select how much information displays in the Log
tab.
Verbose displays all available messages .
Info displays informational error and warning
messages.
Warning displays error and warning messages.
Error displays error messages.
Off displays no messages.
From the Tree

View, add
connections to
OPC DA servers.
From here,
groups
containing
variables are
added to a
collection.
The Log tab

displays
connection
information
between the
OPC Test Client
and the OPC
DA server(s).
This information
can be copied
to the clipboard.
Public Information
➢ To add a server connection
From the OPC DA client Tree

View, right-click OPC Server
Connections and select Add
Server Connection
Enter a host name,

select the server
from the OPC DA
Server drop-down
list, and click OK
An OPC connection contains one or more groups that are collections of variables to be updated.
➢ To add an OPC group to the connection: from the Tree View, right-click the created connection and select Add
Group.

Public Information
➢ To add variables to a group
1. From the Tree View, select a Group.
2. From the Summary View, select a Name to browse and add variables from the configured OPC DA Server.
3. To connect all items in the Tree View, select the top level item and click Go On/Offline icon or right-click and select
Connect.
If a connection is successful, live values display in the Summary View.
Note For information on DCOM settings, Refer to the WorkstationST OPC DA Server Installation Guide (GEI-100621).
A connection between the client and the OPC DA Server requires access and launch permissions by the client on the server
computer. Since OPC DA Servers often run as System users (not Administrators), the server must be able to access the client
computer to return data values. The client computer must allow access by the System account to the client.
15.19 OPC UA Server Tab

OPC is an industrial standard for communication between various platforms using HTTP or TCP. The OPC Unified
Architecture (UA) Server is configured from the WorkstationST component.
The OPC UA server receives EGD from all EGD-referenced devices consumed by the WorkstationST application. The OPC
UA server provides live, time-stamped data. Write access allows you to write to variables. These writes are channeled to the
EGD devices through EGD Command Message Protocol writes. The OPC UA server can also own variables defined in the
OPC UA client.
➢ To configure the OPC UA Server Tab

2. From the Data Grid, set OPC UA Server to True.
Public Information
3. Select the OPC UA Server tab.
Properties
Default source for Historical data if a source is not specified by the client.
Default Historian Type
Choices are Historian or Recorder, based on the features being enabled.
Enable High Performance EGD If set to True, enables multiple EGD receive threads to handle EGD activity.
Consumption More CPU is required by the OPC UA Server process, when this is enabled.

Public Information
15.19.1 Security Certificate/User Association
The Security Certificate/User Association item displays in the OPC UA Server tab Tree View and allows you to associate a
security certificate to a user account. Security certificates are obtained from the Windows store. Users and roles are assigned
in the ToolboxST configuration.
The user associates the certificate by name, distinguished name or thumbprint of the certificate. Using either name could
associate any certificate with that name or distinguished name to the SecurityST user. Selecting the thumbprint results in only
one certificate being associated with that SecurityST user. The association grants the privileges of the SecurityST user to the
applications using this certificate. Certificates can only be associated with one SecurityST user.
Public Information
15.19.2 OPC UA Client
Data from other OPC UA servers can be obtained using the OPC UA Client.
➢ To add an OPC UA client connection
From the Tree View,

right-click OPC UA
Clients and select
Add Connection
OPC UA Client Server Connection Configuration
Provide the OPC UA server configuration settings as follows:

Discovery URL: allows the user interface to browse registered OPC UA servers at the selected URL. The default URL opc.
tcp://localhost:4840 allows the Endpoint URL drop-down menu to display registered OPC UA servers on the local computer.
Endpoint URL: defines the OPC UA server’s endpoint and optional security settings. Select one of the servers available from
the Discovery server listed in the drop-down menu, or enter a known URL. Example URLs (provided hyperlinks) are
displayed for known GE OPC UA servers.

Public Information
Security Settings: the client can be configured to use a specific security profile using the Security Policy and Message
Security Mode drop-down menus, or the client can be made to use the most secure endpoint exposed by the server by
selecting the Use Best Security check box. To use no security and avoid exchanging application certificates, select a Security
Policy of None and a Message Security Mode of None (the server must support the None security profile).
Authentication Settings: the client can be configured to use an anonymous user or a user name and password.
Failing to make a secure connection to the server results in data being exchanged over
non-secure or encrypted channels. Some OPC UA servers will not accept non-secure
connections.
Attention
Server Properties
Host Name Host name of the computer where the OPC UA server is running
Server URL URL of the OPC UA server running on the specified host
Endpoint Configuration - Security Mode used for a secure connection. If Use Best Available Security is set to True, this
Security Mode setting will be ignored.
Endpoint Configuration - Security Policy used for a secure connection. If Use Best Available Security is set to True, this
Security Policy setting will be ignored.
Endpoint Configuration - If set to True, the client will attempt to connect to the server’s most secure endpoint, otherwise
Use Best Available Security the security settings defined in the Endpoint Configuration will be used.
User Token Information – User Name when a server implements a user name and password authentication. If blank, the
User Name user will be anonymous.
User Token Information –
Password when a server implements a user name and password authentication policy.
User Password
Public Information
An OPC UA client connection contains one or more subscriptions, which are collections of variables to be updated.
➢ To add an OPC UA subscription to the connection
➢ To add variables to a subscription
➢ To connect all items in the Tree View: select the top level item and click Go On/Offline or right-click and select
Connect.
If a connection is successful, live values display in the Data Grid.

Public Information
15.19.3 External Historian
➢ To add an external Historian
1. From the Tree View, right-click External Historians.
Properties
Name of this external Historian. This name displays in the OPC UA server's namespace, with all
Historian Name
variables from this Historian prefixed by this name.
Host Name Host name or IP address of the Historian WorkstationST running the OPC HDA server
OPC HDA Server Name of this external Historian's OPC HDA server
Public Information
When an external
Historian is selected
in the Tree View,
User Credentials
display in the
Property Editor
Enter a valid
Windows domain
name, username,
and password. The
domain is left blank
for computers using
Windows workgroups

Public Information
15.19.4 Test OPC UA Client
The OPC UA Test client allows browsing and live data callback connection to any OPC UA Server.
➢ To use the Test OPC UA Client feature: from the View menu, select Test OPC UA Client.
The Logging Level drop-down list allows you to

select how much information displays in the Log
tab.
Verbose displays all available messages.
Info displays informational error and warning
messages.
Warning displays error and warning messages.
Error displays error messages.
Off displays no messages.
From the Tree

View, add
connections to
OPC UA servers.
From here,
groups
containing
variables are
added to a
collection.
The Log tab

displays
connection
information
between the
OPC Test
Client and the
OPC UA
server(s). This
information can
be copied to
the clipboard.
Note Refer to the section OPC UA Client for configuration instructions.
Public Information
15.20 Variables Tab
The Variables tab automatically displays when you create or open a WorkstationST component. It allows you to configure and
map WorkstationST-owned variables.
15.20.1 WorkstationST Variables
Note These variables, previously named Client-driven Variables, are defined on the OPC DA Server tab.
WorkstationST-owned variables are written to by WorkstationST clients, such as Modbus and OPC DA and OPC UA clients.
➢ To add variables: from the Variables tab Tree View, select WorkstationST Variables.
Enter a variable
Variables can be edited both in the Data Grid and the 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. When a variable is selected in the Data Grid,
the Property Editor displays all variable properties.

Public Information
WorkstationST Variables Properties
If set to True, enables the variable as an alarm
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 color alarms
Analog alarm conditions represented in separate CSV records for cut and paste with Excel
The format is: Name, Comparison, Comparison Value, Alarm Class, Description, Second language
Alarm Conditions Description. An example of an alarm condition list with two conditions is:
Hi,>,1000,Alarm,Exceed Temperatur Limit, Exceder limite de temperatura,Lo,<,-100, Alarm,
Temperature Limit too Low, Limite de temperatura demasiado baja
If set to True, causes the alarm on a 1-to-0 transition
Alarm On Zero
The Alarm property must be set to True.
Alarm Shelving If enabled, temporarily removes selected alarms from the Alarm Viewer display
Alarm Shelving Max
Period of time during which the selected alarm(s) remains removed from the display
Duration
If Enabled, removes the alarm from the Alarm Viewer display when the alarm transitions to the
Auto Reset normal state
The operator is not required to acknowledge the alarm.
If set to True, enables the variable as an Event
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.
Description Variable description in the primary language
Second Language
Variable description in the secondary language
Description
Active Severity Value assigned to an alarm in the active state (value range is 1 to 1000, where 1 is the least severe)
Normal Severity Value assigned to an alarm in the normal state (valid range is 1 to 1000, where 1 is the least severe)
Second Language
Potential causes of the alarm (in the Description in second language if configured in System Editor)
Potential Causes
Second Language Action the operator should take to avoid defined consequences (in the description in second
Operator Action language if configured in System Editor)
Consequence of Inaction Consequence of inaction
Second Language
Consequence of inaction (in the Description in second language if configured in System Editor)
Consequence of Inaction
Operator Urgency Length of time to perform corrective actions to avoid defined consequences
Second Language Length of time to perform corrective actions to avoid defined consequences (in the Description in
Operator Urgency second language if configured in System Editor)
Default upper limit for displays on the HMI (for example, bar graph or trending displays)
Display High Limit If a Format Spec has been specified and this display-high property is not specified, the Format
Spec Engineering Max is used.
Default lower limit for displays on the HMI (for example, bar-graph or trending displays)
Display Low Limit If a Format Spec has been specified and this display-low property is not specified, the Format Spec
Engineering Min is used.
Entry High Limit Default upper limit for the setpoint entry on the HMI
Public Information
WorkstationST Variables Properties (continued)
Entry Low Limit Default lower limit for the setpoint entry on the HMI
Format Spec System-owned format specifications assigned to a variable
HMI Resource Allows the user to configure access and visibility of variable and alarm data
Determines the number of digits to the right of the decimal point
Precision 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.
Engineering units
If a Format Spec has been specified and Units is not specified, the Format Spec Units is used with
Units
the SDB version of the HMI device. This attribute is not used. Only the format specification's Units
string is used.
Variable tag name that can be customized by the user, and is available to the WorkstationST
Alias
component and the HMI
Array number of elements in this array variable
Enumerations values represented in separate CSV records
Fully qualified name of the variable
Full Name 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.
Name Variable name
Enables the automatic collection by the Historian when Boolean and set to Logged on Change
Historian Deadband
Historian Deadband
Definition
Enables the automatic collection by the Recorder when Boolean and set to Logged Continuous or
Recorder Deadband
Logged on ChangeAnalog and set to 0 or higher
Recorder Deadband
Definition
Has Health Bit If set to True, assigns a health bit to the EGD variable
Initial Health If set to True, causes the initial quality of the OPC DA variable to be good
External Access
If set to True, causes the WorkstationST HMI configuration to import the variable as a virtual point.
Virtual HMI Point
Live values of virtual points are not typically available to the HMI.

Public Information
15.20.2 Variable Mapping
It is possible to send the value of one variable (source) to another variable (destination). Variable mapping allows you to write
the value of the source variable to the destination variable. The variables must be of the same data type, and the destination
variable must be configured to be writeable.
Enter a variable or click the

ellipsis button to display the
Example of Variable Mapping
Public Information
Mapping Update Rate is the rate for the variable mapping task in ms. Source variables are copied to destination variables
at this frequency. The value can range between 200 and 300,000 ms.
15.20.3 Intrinsic Variables

Intrinsic variables are generated by the WorkstationST component rather than by the user. Examples include feature status
(Recorder.StatMessage) and revisions (MajorRevision_R). Intrinsic variables are Read-only unless otherwise specified.
15.21 OPC AE Server Tab

OPC is an industry standard for communication between vendors in an industrial environment. The non-profit OPC
Foundation provides the specification for the standard, as well as programming proxy stubs for OPC. The standard for
real-time alarm and event data is OPC Alarms and Events (AE).
Note Refer to the WorkstationST OPC AE Server Instruction Guide (GEI-100624).
The OPC AE Server is OPC AE version 1.10-compliant. Optional interfaces that are provided allow browsing of published
content, enabling/disabling content by Area or Source, and providing a keep-alive heartbeat to maintain the client connection.
OPC AE Server, configured in a WorkstationST component, requires ToolboxST V 02.02 or later. The server is implemented
as a service with the name GeCssOpcAeServer.
15.21.1 Routing
The OPC AE Server can be connected locally or remotely from another computer.
Alarm and Event Routing

Public Information
15.21.2 Server Attributes
Note Variable is used to describe an entity within the ToolboxST application. Source is the comparable OPC AE term; the
comparable OPC DA term is Item.
When an alarm or event is received by the Alarm Server, it is sent to the OPC AE Server through an internal client
connection. Before connected OPC AE clients are notified, variable name and condition states must be translated.
15.21.3 Variable Translations

Example 1
In the following table, the component name is G1, the Boolean variable name is TooHot, and variable properties are Alarm =
True, Event = True, and Hold = True.
WorkstationST Alarm Viewer

ToolboxST HMI Source Displayed Device Variable Type
Component = G1 G1.Alarm.TooHot G1 TooHot Alarm
Variable = TooHot G1.Event.TooHot G1 TooHot Event

Alarm Property = True G1.Hold.TooHot G1 TooHot Hold
Event Property = True
Hold Property = True
Example 2
In the following table, the component name is G1, the Boolean variable name is TooHot, and the variable properties are Alarm
= True, Event = False, and Hold = False.
WorkstationST Alarm Viewer

ToolboxST HMI Source Displayed Device Variable Type
Component = G1 G1.TooHot G1 TooHot Alarm
Variable = TooHot G1.TooHot

Alarm Property = True G1.TooHot
Event Property = False
Hold Property = False
Public Information
15.21.4 State Translations
Note There is a dot delimiter between condition name and state.
The three alarm and event types that can have a state are Alarm, Diagnostic, and Hold. Event and Sequence of Events (SOE)
are considered simple by OPC AE, and do not have states. The OPC AE Server implements and acknowledges Alarms,
Diagnostics, and Holds as condition-related states. Events and SOEs are simple events, and cannot be acknowledged from any
external OPC AE client.
WorkstationST Alarm Viewer OPC AE Server

Type Condition Condition Name and State
Alarm Alarm Alarm.Active

Alarm Normal Alarm.Normal
Hold Active Hold.Active
Hold Normal Hold.Normal
Hold Override Hold.Override
Diagnostic Alarm Diagnostic.Active
Diagnostic Normal Diagnostic.Normal
15.21.5 Configure the OPC AE Server

ToolboxST V02.02 or higher is used to configure OPC AE Server features. The OPC severity values associated with variables
are defined in the alarm class definition. Both active and normal values are set here. For events and SOEs, the normal value is
used from the alarm class assigned.
➢ To display the alarm class definition: from the System Editor Edit menu, select System Information.
Alarm definitions display in the System Information Editor Data Grid.
System Information Editor Data Grid

Public Information
➢ To display a component diagnostic definition
1. From the Component Editor, select the General tab.
2. From the Tree View, select General to display the Property Editor , the OPC Properties, and the Active
Diagnostics Severity property.
The Diagnostics Severity is edited in the General tab Property Editor for each configured component. For variables, the
severity is based on the alarm class assigned to the variable. If no alarm class is assigned, the default alarm class is based on
the alarm type.
OPC Properties
Public Information
➢ To configure the OPC AE Server
Note The Alarm Server must be enabled for the OPC AE server to be used.

2. From the Data Grid, enable Alarm Server and OPC AE Server by selecting True.
3. From the General tab Tree View , select Consumed Devices. From the Data Grid, select all components from
which the Alarm Server and OPC AE Server will receive alarms and events.
4. Select the Alarms tab to verify that the necessary options have been set. There are no options defined here that affect the
operation of the OPC AE Server.
5. Click the OPC AE Server tab, then from the Tree View, select Publish Settings. All alarm and event types are
published by default. These settings are for each consumed device.
The WorkstationST component can be built and downloaded. Use the WorkstationST Status Monitor to check the running
health of the OPC AE Server. The DCOM configuration settings may need to be modified for the GeCssOpcAeServer
application before external clients can connect.
15.21.6 Data Update Rates

When a client connects to the OPC AE Server, update notifications rates can be specified. The OPC AE Server imposes a
restriction on this rate, which is returned when the subscription is created by the client. The maximum number of events that
will be sent in one notification is 1024.

Public Information
15.22 Recorder Tab
The Recorder collects and saves data values from system components in a Data Collection and Analysis (.dcaST) file format.
Data values are collected through the following sources:
• EGD through the OPC DA Server

• Component capture buffers
• Directly from the component through SDI
Note Refer to the WorkstationST Recorder User Guide (GEI-100627) for further details.
The Recorder tab Tree View displays the Recorder item with an entry for each component in the Consumed Devices
configuration in the General tab. A System item is created to collect data from multiple components. The following table lists
the available Recorder properties.
ToolboxST Recorder Tab
Recorder Properties
Recorder Path Location of the Recorder files being created
When set to True, provides validation of the trip logs by connecting to the controller and uploading the
Validate Trip Logs
configuration of the capture buffers
Within a component, data can be configured to be automatically collected by the Recorder. Signals on the EGD network are
automatically routed to a continuous Live collection if their short-term deadband property contains a value.
For components with an Upload Type property on the capture buffer, setting this property to Automatic creates a collection
for this capture buffer. Setting this property to Trip creates a Trip Log that includes this capture buffer.
Automatic collections allow only storage, scan rate, and description property modifications. All other modifications must be
performed in the component. User-defined collections are configured from the Recorder tab.
Public Information
➢ To add a collection
1. From the Tree View, right-click a component and select Add Collection.
2. From the drop-down list, select the collection type: Live Data, Trip Log, Capture Buffer, EPA Log, or Maintenance Log.
Note Refer to the subsequent document sections, such as Live Data, for more information on the available collection types.
3. From the Collection Name dialog box, provide a name for the collection.
Enter a name
and click OK.
4. The collection is added to the Tree View for the selected component.

Public Information
➢ To delete a collection: from the Tree View, right-click the collection to be deleted and select Delete.
Removing a component from the Tree View causes that component and all of its
collections to be deleted.
Attention
Note An Automatic collection can only be deleted by removing it from the component’s configuration.
➢ To add a variable
1. From the Tree View, right-click the collection name and select Add Variable.
2. From the Select a Variable dialog box, select the Tree View component item, select the appropriate variable(s) from the
data grid, then click OK.
➢ To delete a variable: from the data grid, right-click the row of the variable to be deleted and select Delete Selected
Row(s).
Public Information
15.22.1 Live Data
The Live Data collection collects data samples continuously during or after an event.
Note When the Alarms and Events or the diagnostic alarms are enabled for a collection, they are saved to the file when the
file is closed. This typically occurs at the end of the hour.
Live Data Properties

Source from which data values are received
Network indicates data values obtained over Ethernet through the OPC DA server (example: EGD
data).
Source Direct indicates data values obtained through direct connection to the device with the device sending
the Data to the Recorder (example: data through SDI).
ByProxy allows the Recorder to collect data from devices referenced by proxy in this WorkstationST
(configured as consumed devices).
Configuration Method, either Automatic or Manual, used to configure this collection
Type Type of collection (Live Data)
Disk Usage Amount of disk space, in MB, that this collection is allowed
Storage Time Time, in days, that the files are maintained on disk
If set to True, records the alarms and events that occurred in the collection time frame. The Alarm
Alarms/Events
feature must be enabled in this WorkstationST component.
Description Provides a description of the collection
If set to True, records diagnostic alarms that occurred in the collection time frame. The Alarm feature
Diagnostic Alarms
must be enabled in this WorkstationST component.
Enable If set to True, enables the data collection
If set to True (default), controls whether the Recorder feature uses or ignores all predefined Recorder
Use Component
variables from the controller. If set to False, variables required for collection must be added manually
Configuration
(only when the Configuration property is set to Automatic).
Method Method, either Continuous, Triggered Level, or Triggered Edge, used for data collection
Name Collection name, is used as part of the file name
Scan Rate Rate, in ms, that the data is scanned for changes
Variable Count Number of variables in the collection

Public Information
15.22.2 Trip Log
Trip logs contain data from capture buffers along with data collected for each variable defined in the capture buffers for the
previous 24 hours.
Trip Log Properties

Type Type of collection (Trip Log)
Description Provides the description of the collection
Name Name of the collection that is used as part of the filename
Upload Diagnostics If set to True, uploads the controller and I/O pack diagnostics and writes them to a .txt file.
Variable Count Number of variables in the collection (the last 30 trips are maintained on disk)
15.22.3 Capture Buffer

Capture buffers are high-speed data buffers located in the component. The Capture Buffer collection uploads and writes to a
file the data from the buffer specified by the status variable in the collection.
Capture Buffer Properties

Characters Per Line Number of characters the printer can fit on one line
Create CSV File Creates a Comma Separated Value (.csv) file in addition to the .dcaST file
Print CSV file If set to True, allows you to print the .csv file.
Printer Provides a drop-down list of printers
Type Type of collection (Capture Buffer)
Disk Usage Maximum amount of disk space, in MB, that this collection is allowed
Storage Time Maximum length of time in days that the collection files are maintained on disk
If set to True, records the alarms and events that occurred in the collection time frame. The Alarm
Alarms/Events
feature must be enabled in this WorkstationST component.
Description Description of the collection
If set to True, records diagnostic alarms that occurred in the collection time frame. The Alarm feature
Diagnostic Alarms
must be enabled in this WorkstationST component.
Name Name of the collection that is used as part of the filename
Scan Rate Rate, in ms, at which the data is scanned for changes
Public Information
15.22.4 EPA Log
The EPA log collection uploads and writes to a file that the capture buffer data specified by the status variable in the
collection. The EPA log generates and prints a .csv file.
EPA Log Properties

Characters Per Line Number of characters that can be printed on one line
Create CSV file When set to True, creates a .csv file as well as the .dcaST file
Print CSV file When set to True, allows you to print the .csv file
Printer Provides a drop-down list of printers
Configuration Method used to configure this collection (either Automatic or Manual)
Type Type of collection (EPA Log)
Disk Usage Maximum amount of disk space in MB that this collection is allowed
Storage Time Maximum length of time in days that the collection files are maintained on disk
Enable When set to True, enables the data collection
Name Name of the collection (also used as part of the filename)
Scan Rate Rate at which the data is scanned for changes in milliseconds (ms)
15.22.5 Maintenance Log

The Maintenance Log collection causes the Recorder to create a set of .csv files beneath the Maintenance Log collection
folder. The .csv files can be imported into Trender and the Maintenance Log collection’s data can be read through the
historical data selection using the Trender’s Add Trace Wizard. The Maintenance Log is intended to be a very slow collection
of data (minutes for the scan rate) that can be kept over a long period of time.
Maintenance Log .csv files contain the following columns:
• Name property (editable string property of the collection)

• Time stamp
• Variables that can be configured in the collection (the column heading for each variable contains the variable’s
description)
Maintenance Log Properties

Name Name of the collection (also used as part of file name)
Type Type of collection (Maintenance Log)
Rate at which data is scanned for changes in milliseconds (ms); typically, a maintenance log’s scan
Scan Rate
rate is one minute or larger (default is one minute)
Storage Time Maximum time files are maintained on disk in days
Disk Usage Maximum amount of disk space in MB this collection is allowed
Configuration Method used to configure this collection (Maintenance Logs are always Manual and never Automatic)
Variable Count Number of variables in this collection
Enable Enables or disables the collection for data collection
Maintenance Log Name used as the value for the first column of the .csv file created with a Maintenance Log collection
Name type

Public Information
15.23 Modbus Tab
Modbus is an application layer messaging protocol for client/server communications between components connected on
different types of busses or networks. The WorkstationST application supports both serial and Ethernet communication, and
can operate as both a Master and a Slave.
Note Refer to the WorkstationST Modbus Feature Instruction Guide (GEI-100696).
15.24 Historian Tab

The WorkstationST Historian is the configuration interface between the ToolboxST application and WorkstationST
components and third-party Historian systems used for collecting long-term data from the system components.
Note Refer to the WorkstationST Historian Instruction Guide (GEI-100628).
15.25 GSM Tab

GE Standard Messaging (GSM) provides a consistent external interface regardless of internal protocols and data
representations. Used by a Distributed Control System (DCS) to communicate with the turbine control system, the DCS can
receive alarms, events, and periodic data from turbine controllers as well as support writing periodic data or commands to the
turbine controllers.
Note Refer to the ControlST GSM 3.0 User Guide (GEH-6757).
15.26 Mark V Tab

Each Mark V controller that communicates with an HMI has a unit-specific directory and subdirectory on the HMI hard drive.
Note Refer to the WorkstationST Application Mark V Feature System Guide (GEH-6759).
15.27 Device Manager Gateway Tab

The Device Manager Gateway enables communication between the Asset Management System (AMS) and fieldbus devices
in the Mark VIe controller. It provides access to FOUNDATION Fieldbus™, PROFIBUS ®, and HART® devices connected to
Mark VIe controllers over UDH.
Note Refer to the WorkstationST Device Manager Gateway Instruction Guide (GEI-100757).
Public Information
15.28 Control System Health Tab
The Control System Health feature allows you to display the health of various components on the UDH, the PDH, and IONet.
This includes the following:
• HMI and Historians

• Mark VIe and Mark VIeS controllers
• IONet and UDH switches
• I/O packs
• Power supplies
• NTP synchronization status
Note Refer to the WorkstationST Control System Health Instruction Guide (GEI-100834) for information on parameters and
alarms.
The Control System Health management system consists of a server and a viewer client.
➢ To display the Control System Health alarms

1. From the General tab, select Features and set Control System Health to True.
2. Select the Control System Health tab to display alarm health.

Public Information
15.29 Ethernet Global Data (EGD)Tab


Public Information


page.

Public Information

display.
Mode
Default Page
Layout Mode
Period Multiplier
Skew
Public Information

dialog box.

Public Information
the signature.

15.29.5 Referenced Devices


1. From the Tree View, right-click the Referenced Devices item, then select Select Devices.
2. Select or clear the check boxes next to each component name and click OK.
variable information is used. The configuration is automatically refreshed occurs when a WorkstationST component is
opened, and when a Build command is performed.
➢ To refresh the configuration of a referenced device: from the Tree View right-click the device to be refreshed,
and select Refresh.
Public Information
15.29.6 EGD Diagnostics
Note You must be online to view diagnostic information.
The EGD protocol includes a Command Message Protocol (CMP) to obtain the status of a Class 2 or higher EGD device. The
WorkstationST component is a Class 3 EGD device. When any EGD item in the Tree View other than a referenced device is
selected, the EGD Statistics from [Device] tab displays the statistics from the open component. When a Referenced Devices
item is selected, the statistics are obtained from that device, and the name of the tab page changes accordingly.
Summary View Columns

Column Description
Exchange Exchange identifier <device name> <exchange number>
Configuration Time Time that the exchange was configured
Due Time Time that a consumer data packet must be received for an exchange to remain valid
This length may be the highest variable offset in the exchange or the highest offset of a variable, which
Length 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.
Missed Count 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 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.

Public Information
15.29.7 EGD Packet Logging
The WorkstationST runtime allows EGD messages to be logged to a limited size queue (10000 messages) for a limited time
(two minutes maximum). The EGD tab Summary View contains an EGD Packet Log tab that allows for:
Starting the collection of EGD messages
Stopping the collection and uploading the data
Enabling the translation of the data in the Source Address column to a host name with a Tool Tip. This
translation can take some time, so the feature is only enabled upon request.
Saving the data to csv format
When the collection is started, the runtime begins storing all EGD messages received. When the queue gets full, old messages
are deleted. When the UI stops the collection and uploads the data, all messages display in the grid.
The collection status displays in the status bar.
Public Information
Columns include:
Receive Time is the UTC time when the message was received.
Source Address sources the IP Address.
Producer ID Dotted is a four-byte unsigned integer that uniquely identifies the producer of an exchange in a given network.
This ID is used by the protocol to identify the node (or set of redundant nodes), so even nodes that do not produce any data
must be assigned a unique Producer ID. The Producer ID value is generally assigned by a configuration tool set to the IP
address of the producing node (in network-byte order) by default. Where displayed in dotted decimal form, the Producer ID is
treated as a four-byte field whose data is in network-byte order. Where displayed in any other form, the Producer ID is treated
as a four-byte little-endian unsigned integer value (example: 3.4.5.6 = 0x06050403 = 100992003).Producer IDs of 0 and of
0xFFFFFFFF are reserved and cannot be used. Multiple nodes in a redundant system may use the same producer ID. For the
purposes of this specification, the redundant system may be treated as a single-producer node. Controlling what devices
within the redundant system are producing EGD is a local matter within the redundant system.
Producer ID is a four-byte unsigned integer and unique address of the producing device of an exchange in a given network.
This ID is used by the protocol to identify the node (or set of redundant nodes), so even nodes that do not produce any data
must be assigned a unique Producer ID. The Producer ID value is generally assigned by a configuration tool set to the IP
address of the producing node (in network-byte order) by default. Where displayed in dotted decimal form, the Producer ID is
treated as a four-byte field whose data is in network-byte order. Where displayed in any other form, the Producer ID is treated
as a four-byte little-endian unsigned integer value (example: 3.4.5.6 = 0x06050403 = 100992003). Producer IDs of 0 and of
0xFFFFFFFF are reserved and cannot be used. Multiple nodes in a redundant system may use the same producer ID. For the
purposes of this specification, the redundant system may be treated as a single-producer node. Controlling what devices
within the redundant system are producing EGD is a local matter within the redundant system.
Exchange ID is a four-byte unsigned integer that uniquely identifies a particular exchange definition on a specific producing
node. The most significant two bytes of the Exchange ID must be zero for version 3.04 of the protocol. Pre-defined static
exchanges are assigned a value between 1 and 16383 (0x3fff). The value of bits 14 and 15 (the high order bits in the lower
half of the long word) are normally 0, but may be used to differentiate normal static exchanges from those defined during
runtime.
Bit 15, 14 meaning
0,0 = Static Exchange
0,1 = Reserved
1,0 = Logic Driven Exchanges
1,1 = Reserved

Public Information
Major Signature is the major number reflecting the primary exchange format, and must be equal in both Producer and
Consumer. Truncating or rearranging data within an exchange is not backward-compatible and requires a change in the major
number.
Time Stamp is a time value in POSIX 1003.4 timespec format (32-bit unsigned integer seconds followed by 32-bit
nanoseconds) correlated with the data contained in the message. The nanoseconds field is limited to values greater than or
equal to 0, and less than 1000000000.
Production Status Flags are bit marks that indicate the validity of the data sample produced: Bit 0: Set if production error
or invalid (old) dataBit 1: Set if timestamp is not synchronized on producer node (see Table 5: Consumed Exchange
Conditions) Bit 2: A producer that knows of a pending configuration change may set this to 1 until the configuration change
occurs. Otherwise 0.
Config Time is the timestamp of the configuration.
PDU Type are the data and command messages transmitted using the UDP/IP protocol, defined in terms of Protocol Data
Units (PDUs).
Data_Production 13. / 0x0d
RDS_Query 0
Retrieve_Configuration_Rqst 3. / 0x03
Retrieve_Configuration_Resp 4. / 0x04
Summary_Rqst 7. / 0x07
Summary_Resp 8. / 0x08
Capabilities_Rqst 9. / 0x09
Capabilities_Resp 10. / 0x0A
Statistics_Rqst 15. / 0x0F
Statistics_Resp 16. / 0x10
Command_NAK 18. / 0x12
Read_Rqst 32. / 0x20
Read_Resp 33. / 0x21
Write_Rqst 34. / 0x22
Write_Resp 35. / 0x23
Masked_Rqst 36. / 0x24
Masked_Resp 37. / 0x25
Dynamic_Bind_Status Rqst 40. / 0x28
Dynamic_Bind_Status_Resp 41. / 0x29
ApplicationSpecific_Req 240. / 0xF0
ApplicationSpecific_Resp 241. / 0xF1
Reserved for RDS Statistics_Rqst 254. / 0xFE
Reserved for RDS Statistics_Rqst 255. / 0xFF
PDU Version Number is the Protocol Version Number identifying the PDU format. It must be set to 1.
Message Number is the Request ID or message number maintained by the application layer used to identify unique
messages and associate response messages with their requests.
Message Bytes are the total number of bytes, including header and data.
Data Bytes are data message bytes, excluding header.
Public Information
Number Data Bytes are the number of data bytes in the message. (Total message size minus 32-byte header).
Reserved 1 is reserved.

The EGD Configuration Server tab can be enabled from the System Editor with the root node selected. When enabled, the
Produced Pages shortcut menu displays 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.

Public Information
15.29.9 Global Variables
➢ To display the Global Variables window: from the Component Editor View menu, select Global Variables.
Properties display for Click to toggle between a display

the currently selected of all global variables and just
row in the Data Grid the ones that are modifiable
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 (such as Name or Global Name Prefix).
Public Information
15.30 WorkstationST Reports
WorkstationST reports provide a variety of controller information in a viewable format. Generated reports display in a
Reports can also be sorted, filtered, and searched to quickly locate information:
The following reports can be created and used for troubleshooting and informational reference:
• Alarm
• Event
• Workstation Consumed Device Information
• WorkstationST Feature Configuration
Note The Hold report is not supported for WorkstationST at this time.
15.30.1 Alarm Report

The Alarm report provides a list of all process alarms in the current configuration and the aspects associated with the alarms.
Users can print the report and open the module(s) in the Diagnostic Viewer to get help for alarm troubleshooting.

From the View menu, select Reports, then

select Alarm to generate an Alarm report.
Note The Alarms report will only display alarms that are configured in the Alarm Scanner or Fault Code Scanner.

Public Information
2. Select an alarm to navigate to the alarm definition.

to display the alarm definition details.
Public Information
Column Description
Name Variable name
HHH Enabled High high high alarming state for the variable when it is defined as an analog Alarm
Alias
and all HMIs
If enabled, causes the Alarm to be cleared before the operator acknowledges the Alarm
Auto Reset
If enabled, allows the operator to temporarily remove the Alarm from the Alarm Viewer
Alarm Shelving
display
Alarm Shelving Max
Duration
Second Language
Description
Consequences of Inaction Consequence if operator does not address this alarm
Second Language
Consequence in second language if operator does not address this alarm
Consequences of Inaction
Second Language Operator Indication in second language of how important it is that the operator addresses this
Urgency alarm
Second Language Potential
Causes
Second Language Operator
Action in second language the operator should take to avoid defined consequences
Action

Public Information
15.30.2 Event Report
Note Variables are marked as Events in the Property Editor.
From the View menu, select Reports, then

select Event to generate an Event report.
Public Information
From the Event report, double-click an Event
to display the Alarm definition details.

Column Description
Name Variable name
Second Language
Description

Public Information
15.30.3 Workstation Consumed Device Information
The Workstation Consumed Device Information report provides a report of live data consumption and alarm consumption
viewed by WorkstationST, consumed devices, or as text.
➢ To create a Workstation Consumed Device Information report: from the View menu, select Reports, then
select Workstation Consumed Device Information.
There are several tabs available for the user to view consumption. These report views are detailed in the following sections:
• Live Data Consumption

• Alarm Consumption
• View by Consumed Devices
• View as Text
15.30.3.1 Live Data Consumption View

The default selection is Live Data Consumption. The following figure shows the direct consumption over EGD and the proxy
consumption through another workstation for various controllers in a control system. For example, the Alarm_Primary
workstation consumes the BOP controller directly, G1 and G2 through HMI_Block1, and G3 and G4 through HMI_Block2.
Public Information
Live Data Consumption View

Public Information
15.30.3.2 Alarm Consumption View
By selecting the Alarm Consumption tab, the direct alarm consumption for controllers on the local UDH is displayed, as well
as the remote alarm consumption through other workstations. For example, BOP alarms are consumed directly by Alarm_
Primary, G1 and G2 alarms are consumed through HMI_Block1 as a primary connection and through HMI_Block1b as a
secondary connection. Likewise, alarms for G3 and G4 are consumed by HMI_Block2 primary and HMI_Block2b secondary.
Alarm Consumption View
Public Information
15.30.3.3 View by Consumed Devices
By selecting the View by Consumed Devices tab, the controller devices with child nodes are displayed indicating their
consumers. For example, by selecting the Live Data Consumption tab , G1 is shown consumed by HMI_Block1 and HMI_
Block1b, and additionally consumed indirectly through HMI_Block1 by Alarm_Primary, Alarm_Secondary, and HMI_
Block2.
View by Consumed Devices — Live Data Consumption

Public Information
By selecting the Alarm Consumption tab from this view, G1 is shown consumed by HMI_Block1, and HMI_Block1b, and
indirectly through HMI_Block1 by Alarm_Primary and Alarm_Secondary, and through HMI_Block2 by Alarm_Primary and
Alarm_Secondary.
View by Consumed Devices — Alarm Consumption
Public Information
15.30.3.4 View as Text
Select the View as Text tab to view a text report of consumption that can be saved to a file representing the consumption
configuration.
Live Data Consumption Text Report

Public Information
15.30.4 Workstation Feature Configuration
The Workstation Features Configuration report displays the features that are configured in each WorkstationST component in
a grid view. Users can copy the data in the grid to their clipboard and paste it into an Excel spreadsheet or other applications.
➢ To create a Workstation Feature Configuration report: from the View menu, select Reports, then select
Workstation Feature Configuration.
➢ To copy a Workstation Feature Configuration report: from the Workstation Feature Configuration report File
menu, select Copy all to clipboard, then paste into an Excel spreadsheet or other application.
Public Information
15.30.5 System IP Address Information
The System IP Address Information report provides a report of WorkstationST device names, host name, network name, and
IP address.
➢ To create a System IP Address Information report: from the View menu, select Reports, then select System IP
Address Information to display the report.
Example System IP Address Information Report

Public Information
The GE Rationalization report lists GE Rationalization parameters for the current alarms that have been generated for the
variables. Users can export the GE Rationalization report to Excel, enter specific information to manage plant-specific alarms,
and then import the updated report back into ToolboxST to make the values available from Alarm Help in the Alarm Viewer.
For additional information, refer to the section Alarm Help.
Alarm Help files are generated when a build is performed for the device or when the
device is saved. However, Alarm help files are only generated when the Publish Alarm
Help property is set to True in the system Property Editor.
Attention
Note When a GE Rationalization report is generated from a WorkstationST component, it includes the following:
• WorkstationST owned variables with the Alarm property set to True. For Analog alarms, it will also include a line for each
unique combination of Variable Name and Alarm Condition Name.
• A line for each unique combination of Variable Name and Alarm Type if any External OPC AE Servers on the Alarm tab
are configured.
• A line for each Variable Name if any External OPC UA Servers on the Alarm tab are configured.
Public Information
Example WorkstationST GE Rationalization Report

Column Description

Public Information
GE Rationalization Report Columns (continued)
Column Description
Second Language
Description
Hysteresis
Alarm Shelving
Alarm Shelving Max
Duration
Format Spec
alarm state
alarm condition.
Consequence of
Inaction
Second Language
Consequence of
Inaction
Operator Urgency
consequences
Second Language
Operator Urgency
System Editor)
Combines with Variable Name to create a unique line in the .csv file.
Alarm Condition Name
Only applies to WorkstationST or external device owned Analog alarms
Read-only field to provide comparison information to the user.
Comparison Operator
Only applies to WorkstationST or external device owned Analog alarms.
Read-only field to provide comparison information to the user.
Comparison Value
Only applies to WorkstationST or external device owned Analog alarms.
Public Information
Many reports provide a set of common features located on the View menu toolbar for the operators convenience, as follows:
• Save report
• Export report
• Import report
• Print report
• Filter
• Refresh
• Zoom
• Find text
• Help
Toolbar Icons
Icon Description
Print the report
Zoom in
Zoom out
Refresh the report
Get help


Public Information

report window.
➢ To save, retrieve, or print a report: from the report File menu, select the desired command.

menu, select Zoom
Public Information
➢ To change report columns


Column
names that
display in
blue cannot
be moved.
Or


Public Information
Available Available
columns comparison
to add to an
equation)
Click to add
parentheses
Click OK to
accept the
filter equation
equation to
to delete the
equation.
Click Cancel
to cancel the
equation but
keep the
current
settings.

Expression to the left of the operator must match the wildcard expression
to the right of the operator
When using the LIKE operator, you can prefix or suffix a wildcard
LIKE character, either * or %, to the right-hand value. The wildcard character
can stand for any number of alphanumeric characters, including zero. The
wildcard character can only be present at the beginning or the end of the
right-hand value (for example, *value or value* or *value*).
Public Information
Report Operator Expressions (continued)

display.
➢ To save a filtered report: from the File menu, click Save Report.
15.30.7.2 Find Report Data

The Find feature performs text searches within a report.
➢ To search for text within a report: from the Report menu, click Find to display the Find dialog box.
Click to locate and

highlight the next
If selected,
capitalization
in the test
string must
match the
text in the
report exactly


Public Information
15.30.7.3 Export and Import Reports
The GE Rationalization report is the only report that can be imported or exported.
➢ To export a GE Rationalization report: from the GE Rationalization report File menu, select Save. Save it as a .csv
file to your computer, and modify as needed.
➢ To import a GE Rationalization report for a WorkstationST component


4. Save the file with Encoding set to UTF-8.

Click Save .
Public Information
.csv file from a .xls file.

Used to find the I/O point in the device; should not be modified
Locator String No
externally in the .csv file
Second Language
Description
messages not queued in the controller. When an Event occurs, a
Event Boolean Yes
time-tagged transition message is sent to all HMIs configured for
Events.
Enum
Importable value is a predefined enum; it can be set to None, Full,
Global Name Prefix (GlobalNamePrefix- Yes
Program, Block, and Task
Type)
If set to True, enables the variable as a Hold, which is similar to an
Hold Boolean Yes Alarm. The Hold queue contains a list of time-tagged Hold states in the
turbine startup sequence.
Data Type Enum Data Type Enum Yes Can be set to one of the enum values
Can be set to Alarmed/Not Alarmed. Otherwise, can be set to Not
Alarm String Yes Alarmed or AnalogAlarmDefault, depending on variable type. A Boolean
can be set to Alarmed/NotAlarmed.
Enum Control
Constant
Display High Double Yes Format Spec has been specified and this property has no specification,
Display Low Double Yes Format Spec has been specified and this property has no specification,

Public Information
Determines the number of digits to the right of the decimal point. This is
the default for precision when the number displays on the HMI. If a
Precision Int Yes
Format Spec has been specified and this property has no specification,
the Format Spec Precision is used.
If set to True, prevents modify-variable commands from being written
into the Command and Event Log (CEL) (default is False)
Historian Deadband Enum Deadband Can be set to EngineeringUnits, PercentOfRange,
Yes
changed from Not Logged to a non-negative number for analog
Recorder Deadband Double Yes variables, or changed to Logged on Change or Logged Continuous for
Boolean variables. This value represents the amount that the data value
must change before it is stored.
Recorder Deadband Enum Deadband Can be set to EngineeringUnits, PercentOfRange,
Yes
Auto Reset Enum AutoReset Yes Enabled, Disabled
Enum
AlarmShelving
Alarm Shelving Max
UInt Yes Value should be between 1 and 4294967295
Duration
Public Information
15.31 Alarm Rationalization
Alarm rationalization produces the detail design necessary to manage an alarm lifecycle. During this process, alarm
definitions are systematically compared to criteria (conditions) set forth in the alarm philosophy document for the plant. If an
alarm meets this criteria, the alarm set point, consequence, and operator action are documented, and the alarm is prioritized
and classified according to the philosophy.
The most common uses of Alarm Rationalization are:
• Alarm Rationalization in an external system

• Alarm Rationalization within ControlST, which allows users to export alarms from a controller for external editing, then
import them back into either the controller or a Library Container.
➢ To export GE alarms for Rationalization in an external system
From the View

menu, select
Export Alarms for
Rationalization

Public Information
From the drop-down list, select Exida SILAlarm.
Note: Measurement System and a drop -down list becomes available .
Select from the Available Attributes table using the arrows to add them to or remove them from the
Selected Attribute table. Click Export to export alarms for Rationalization.
Tip: To return to default attributes and aliases in the rationalization application

, click Restore to Defaults.
When the warning message displays, click OK.
GE Rationalization is an available selection for export (as displayed in this figure). However, it is only available for
backwards compatibility.
Public Information
➢ To export GE alarms for Rationalization in ControlST: generate a GE Rationalization report.
Note The GE Rationalization report contains a column for Parent Alarms and for Child Alarms. A large number of
parent/child relationships can cause these two columns in the .csv file to be incompatible with the Excel application. The
application allows a maximum limit of 32,767 characters in a cell.
When a GE Rationalization report is generated, it can be saved as a .csv file, modified, and then imported back into the
ToolboxST application. For the procedures to export and import GE Rationalization reports, refer to the section Export and
Import Reports.

Public Information
15.32 Watch Window
Window.
Enter a Name,
and a Description
(optional), and
click OK.

Variable selected
variable

Public Information
15.32.1 Add Variable
Select the data

source and
click Next.
If you selected
System
Component in the
previous page,
select the desired
component from
the drop-down list
and click Next.

Public Information
Click Add.
When the
Select a
Variable dialog
box displays,
select desired
variables and
click OK.
The variables
will display here.
Click Finish .

well.
Public Information



4. Click Close.



Public Information


15.33 CommandLineST
CommandLineST allows you to perform the following:
• Add and delete variables and their supporting structures to/from a WorkstationST component
• Build and download a WorkstationST component
• Get a .csv file of all variables a WorkstationST component can access
• Get a .csv file of all aliases defined in a WorkstationST component
Note The ToolboxST application must be installed. In addition, a system and a WorkstationST component must already
exist, the OPC DA Server feature must be enabled, and any network adapters must be added to the WorkstationST
configuration.
15.33.1 CommandLineST Syntax

CommandLineST is a console application, and can be run from a batch file by entering a Command file name. It can also be
run in interactive mode, where the user either enters in a command with appropriate arguments, or references a Command file
to be used. The interactive mode is useful when first learning the program. An error log is not written in interactive mode;
however, status information is sent directly to the console.
Public Information
The CommandFile is a .csv file where each line includes command, arg1key, arg1value, arg2key, arg2value, and such. The
hash mark (#) can be used to enter comments in the .csv file.
The command line syntax is:
CommandLineST.exe[options]<CommandFileName|command,arg1key,arg1value,arg2key,arg2value...>
Example:
CommandLineST.exe /SuppressInfos c:\temp\AddTestWk1.csv
15.33.2 Options
The following options are supported:
/ErrorLog=filename Where filename is the name of the error log. If this option isn’t included, the default name is
CommandLineST.log. The error log is written to the directory from which the executable is
run unless a path was included in the filename.
/SuppressWarnings Keeps both warnings and infos from being printed in the error log.
/SuppressInfos Keeps infos from being printed in the error log.

Public Information
15.33.3 Commands
Commands include:
• Select
• Add
• Delete
• Enable
• Report
• Compress
• Save
• Build
• Download
• Download WorkstationST Feature
• Reports
Select opens the .tcw file and selects a WorkstationST component. The appropriate parent item must be selected before an
Add or Delete command can be performed. For example, before adding a new group to an OPC DA client, the client needs to
be selected. The selection for any item type remains until another item of that type is selected. For example, an OPC DA
client is selected and several groups are added. Then several commands perform operations on the Modbus configuration. If
the following command tries to select a group, it searches for it under the OPC DA client that was selected many commands
prior because it had not been superseded by any another OPC DA client. Performing commands in this manner works, but the
command file is more difficult to read unless comments are included.
Add selects an item automatically. If an identical item already exists underneath the current parent, the existing item is
removed before adding the new item (the log file displays a warning). This implies two things. First, any children items are
removed. (For example, any groups under a client are removed, as well.) Second, all desired non-default attributes of the
signal must be included. A separate Modify command does not currently exist that would leave all current definitions in
place, and only replace specified attributes.
Delete searches for the identified item under the currently selected parent and deletes it. If it is not found, the log file
displays a warning.
Enable enables the identified WorkstationST feature. Component features must be enabled before they can be configured. It
is assumed that the OPC DA Server feature is already enabled in the identified WorkstationST component. However, Modbus
can be enabled through the command line interface.
Compress compresses the identified EGD page. If you delete a variable from an EGD Page, a Compress command of all
EGD Pages in that WorkstationST component must be performed before you can build it. Otherwise, a validation error
displays. The Compress command compresses all EGD Pages in the currently selected WorkstationST component. Performing
a Compress command corresponds to a major signature change for that exchange on EGD, and has system implications.
Performing an Add command of an existing variable, which removes the old variable definition and adds the new variable
definition, does not require you to perform a Compress command if you have not removed a variable from an EGD Page. For
example, if a variable was on page1, the new variable definition must be complete enough to include the key/value pair,
egdpage, page1.
Save saves changes made to the currently selected WorkstationST component. No changes are saved unless an explicit Save
or Build command is performed.
Build builds the currently selected WorkstationST component. A validation is run. If the validation does not have any errors
(warnings are permitted), it runs the build. (A successful build automatically saves the configuration.) If any validate errors or
warnings occur during the validation, they are written to the error log. Any errors that occur during the Build command are
also written to the log (other Build messages are not included). Informational messages are also not included.
Download downloads the currently selected WorkstationST component. If this WorkstationST component was successfully
built since its selection, this download occurs. Otherwise, the log file displays an error.
Download WorkstationST Feature adds WorkstationST variables with only the specified feature receiving the download.
Public Information
Reports runs on the currently selected WorkstationST component. Two types of reports can be created: Variable and Alias.
All variables to which the OPC DA Server (running in this WorkstationST component) has access are included in the Variable
report. There is an optional name key/pair that can be used to reduce the scope of the variables or aliases included in the
report. The Search value can include the * wildcard. If either the name key/value pair is not included, or the name value is set
to *, all variables or aliases are included in the report.
If the optional filename key/value pair is included, that name is where the report is written. It may or may not include a path.
If no path is included, the report is written to the directory from which the CommandLineST.exe was run. If no filename
key/value pair is included, the report filename is:
“WorkstationName”_VariableReport.csv or “WorkstationName”_AliasReport.csv
Report Fields
Field WorkstationST Report Controller Report

Name x x
RemoteName (that another OPC DA Server uses when
x —
talking to an OPC client running on this)
Alias (that another OPC client might use) x x
DataType x —
Description x —
Units x —
FormatSpec x —
Note The ToolboxSTCommandLine.exe file performs a completely different function.

Public Information
15.33.4 Arguments
Arguments are always in a key/value pair. Most actions require that an Item argument be specified.
Required Argument Key/Value Pairs
Computer and
Command Item Name Parent AddressType Alias
OPCServerName
System,
System,
WorkstationST,
Workstation,
Group, Client requires both
Select Client, Group1, N/A N/A Select
HWInterface, these arguments
HWInterface,
and Slave
Slave1
require a Name
Client, Group1, Group, Variable, For a Variable, it
Variable, Alias must be either For a
Add
HWInterface, HWInterface, OpcServer or SlavePoint:
Client requires both (Alias
Add2 Slave1, Slave, Group3. HoldingReg;
these arguments requires
SlavePoint1, SlavePoint, and For a HWInterface Input; InputReg;
this)
MasterMes- MasterMessage must be either Coil
sage1 require a Name Masters or Slaves
Client, Group1, Group,
Variable, Alias Variable4, For a
For a Variable, it Delete
HWInterface, HWInterface, SlavePoint:
Client requires both must be either (Alias
Delete Slave1, Slave, HoldingReg;
these arguments OpcServer or requires
SlavePoint1, SlavePoint and Input; InputReg;
Group3. this)
MasterMes- MasterMessage Coil
sage1 require a Name
Enable Modbus N/A N/A N/A Enable
Report4 5 Variable, Alias Name4 optional N/A N/A N/A Report
Com-
Compress6 N/A N/A N/A N/A N/A
press
Save6 N/A N/A N/A N/A N/A Save
Build6 N/A N/A N/A N/A N/A Build
Down-
Download6 N/A N/A N/A N/A N/A
load
Download
WorkstationST OPC DA Server N/A N/A N/A N/A N/A
Feature
Public Information
1When one of these items is selected, added or deleted, it is associated with the last appropriate parent that was selected or
added. (A group’s parent is a client, a Slave’s parent is a HWInterface, a SlavePoint’s parent is a Slave, a MasterMessage’s
parent is a Slave.)
2When an item is added, it is automatically selected. For example, if you add a Client, then add a Group, the
Group becomes a child under the Client that was just added.
3 If the Parent argument value is OpcServer, the variable is added or deleted from the WorkstationST Variables
list. If the Parent argument value is Group, the variable is added or deleted from the last selected or added
Group.
4 When Delete a Variable or make a report, you can use a * wildcard in the Name.
5 The report includes all variables and aliases that the currently selected WorkstationST component has access
to, or a subset of them if a search string is entered in the Name field (using Name, *, or leaving off the optional
name key/value pair reports all variables or aliases that the currently selected WorkstationST component has
access to).
6 Action applies to the last WorkstationST component selected.

Public Information
15.33.5 Command File Examples
# Open the System and enable Modbus
select, item, system, name, c:\temp\test\test.tcw
select, item, workstation, name, wk1
enable, item, modbus
# Add a Modbus Master and its signals; test signal definition in OPCserver space
add, item, hwinterface, parent, masters, name, 3.25.180.202
add, item, slave, name, 18
add, item, Variable, name, ClientSig18, parent, opcserver, description, Client Sig 18 description, externalaccess, readwrite
add, item, slavepoint, name, ClientSig18, addresstype, InputReg, datatype, lreal, address, 2, rawmin, 0, rawmax, 1000, eng
min, 0, engmax, 100
add, item, mastermessage, name, modbusmastermessage0, functioncode, funccode4, periodmultiplier, 6, numberofregisters, 4,
startaddress, 2
# Add a Modbus Slave and its signals; test signal definition in OPCClient group
add, item, hwinterface, parent, slaves, name, 3.25.180.201
add, item, slave, name, 28
add, item, client, computer, npiCAR, opcservername, GeCssOpcServer
add, item, group, name, grp1, deadband, 5, egdpagehealth, Page1, updaterate, 2000, uselocaltime, true
add, item, Variable, name, ClientSig28, parent, group, remotename, RemoteClientSig28, datatype, int, externalaccess,
readwrite
add, item, slavepoint, name, ClientSig28, addresstype, holdingreg, datatype, dint, address, 3
Public Information
# Compress Save, Build and Download
compress
save
build
download
# Run a report
report, item, workstation, name, wk1, search, ClientSig*
# Open the system and add WorkstationST variables to the OPC DA Server
Select Item System Name C:\Systems\Test4.4\Test4.4.Tcw
Select Item Workstation Name TestVar0 N/A N/A N/A

# Add client variable
Add Item Variable Name TestVar1 Parent OPCServer
Add Item Variable Name Test- Parent OPCServer
Var666
Save N/A N/A N/A N/A N/A N/A N/A
Build N/A N/A N/A N/A N/A N/A N/A
DownloadWorkStationFeature Name OPCServer ok N/A N/A N/A
Note Connecting a variable to a Modbus register automatically defines the variable. The variable must have already been
added either to the OPC DA Server or to an OPC Client group as a separate action.
If the key/value pair for a given attribute is not included when adding a variable, the variable is assigned the default value.
Variable Key/Value Pairs

Attribute Default Value / Possible Values
Name Required
RemoteName Defaults to Name value. Only applies to variables under a client/group.
REAL. Possible Values:
DataType BOOL, INT, DINT, REAL, LREAL, UINT, UDINT, STRING, DT, BYTE,
DWORD, LINT, SINT, ULINT, USINT, WORD
Description “”
Units “”
ReadOnly. Possible Values:
ExternalAccess
ReadOnly, ReadWrite
InitialValue “”
InitialHealth False
Array 0
EgdPage “”
HasHealthBit False

Public Information
Variable Key/Value Pairs (continued)
Attribute Default Value / Possible Values
FormatSpec “”
ActiveSeverity “”
Alarm False
AlarmClass “”
AlarmOnZero False
DisplayHighLimit “”
DisplayLowLimit “”
DisplayScreen “”
EntryHighLimit “”
EntryLowLimit “”
Event False
0. Possible Values:
HistorianDeadband 0, 1 for a Boolean variable. 0 or any non-negative number for an analog
variable.
EngineeringUnits. Possible Values:
HistorianDeadbandDefinition
EngineeringUnits, PercentOfRange, RemoveWorkstationOverride
HMIResource “”
NormalSeverity “”
PlantArea “”
Precision “”
0. Possible Values:
RecorderDeadband 0, 1 for a Boolean variable. 0 or any non-negative number for an analog
variable.
EngineeringUnits. Possible Values:EngineeringUnits, PercentOfRange,
RecorderDeadbandDefinition
RemoveWorkstationOverride
SecondLanguageDescription “”
VirtualHMIPoint False
Client Key/Value Pairs

Attribute Default Value
Computer Required
OPCServerName Required
If the key/value pair for a given attribute is not included when adding a group, the group is assigned the default value.
Group Key/Value Pairs

Name Required
DeadBand 0
“”. If more than one page is included, separate the pages with a |. For example, Page1|
EgdPageHealth
Page2.
UpdateRate 1000
UseLocalTime False
Alias Key/Value Pairs

Alias Require This is the alias to be used.
Required for a Add; is the name of the variable to be aliased. Name needs to include the
Name
device name prefix, for example, Wk1.ModbusSig18.
Public Information
Report Key/Value Pairs
Item Required. Possible values include Variables, Alias.
*. Can use to narrow the number of variables or aliases included in the report (for
Name
example: G1*)
WorkstationName_Item Report.csv. Can specify any file name, with or without a path. If
Filename
no path is included, it is written to the directory from which the .exe was run.
If the key/value pair for a given attribute is not included when adding a hardware interface, the HW Interface is assigned the
default value.
HW Interface Key/Value Pairs
Required. The name is either the Com port if it is serial (COM1) or the IP Address if it is
Name
Ethernet.
Parent Required when adding. Value is either Masters or Slaves.
Ethernet. Possible Values:
InterfaceType
Ethernet, serial
IPAddress 0.0.0.0
BR19K2. Possible Values:
BaudRate BR300, BR600, BR1200, BR2400, BR4800, BR9600, BR14K4, BR19K2,

BR38K4, BR57K6, BR115K2, BR128K, BR256K
DataBits 8
None. Possible Values:
Parity
None, Even, Odd
COM1. Possible Values:
Port COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, COM10,
COM11, COM12, COM13, COM14, COM15, COM16.
ResponseDelay 0
StopBits 1
Slave Key/Value Pairs

Name Required. The name is the Slave ID number.

Public Information
If the key/value pair for a given attribute is not included when adding a SlavePoint, the SlavePoint is assigned the default
value.
SlavePoint Key/Value Pairs
Name Required.
HoldingReg. Possible Values:
AddressType
HoldingReg, Input, InputReg, Coil
REAL for a Register, BOOL for a Coil. However, if the variable already exists in the
system, the DataType defaults to the DataType of that variable.
DataType
Possible Values:
BOOL, INT, UINT, DINT, UDINT, REAL, LREAL

Address Next available address
RawMin 0
RawMax 0
EngMin 0
EngMax 0
If the key/value pair for a given attribute is not included when adding a MasterMessage, the MasterMessage is assigned the
default value.
MasterMessage Key/Value Pairs
Required. Format should be:
Name ModbusMasterMessage0, where the number on the end is a unique number

among all the MasterMessages under this given slave.
Defaults to FuncCode3.
Possible Values:
FunctionCode
FuncCode1, FuncCode2, FuncCode3, FuncCode4, FuncCode5, FuncCode6,
FuncCode8, FuncCode15, FuncCode16
NumberOfRegisters 1
PeriodMultiplier 5
StartAddress 1
Public Information
16 WorkstationST — Working Online
The WorkstationST runtime features include Monitoring, Data Collection, Alarm Collection, and Human Machine Interface
(HMI). The WorkstationST Service obtains status and live data, and performs the Download command with the ToolboxST
application.
The ToolboxST configuration is the maintenance software tool for WorkstationST platforms.
16.1 Connect to WorkstationST Computer

➢ To connect to a WorkstationST computer
1. From the System Editor, open a WorkstationST Component Editor.
2. From the Device menu, select Online or click Go Online/Offline.
The WorkstationST Service provides a command for obtaining feature status, and sending download requests. Live Data
Connection provides live data values for WorkstationST-monitored variables. The OPC DA Server Service of WorkstationST
runtime provides the live data connection. When the Component Editor connects to the WorkstationST runtime, both the
command connection and the live connection are established.
The Status tab displays information about the running WorkstationST component.
WorkstationST — Working Online GEH-6703P User Guide 1135

Public Information
16.2 WorkstationST Status
When the ToolboxST application is connected to a WorkstationST computer, operating state and equality information is
available from the ToolboxST Status tab in the Component InfoView window. This view is identical to that of the local
WorkstationST Status Monitor, which provides a tray icon control with status viewed on the local WorkstationST computer.
State information is represented using colored text.
Status Colors
Color Condition
Green All features functioning normally — normal state
Yellow — Minor configuration difference between the tool and runtime
— One or more features has a warning

Red — Minor configuration difference between the tool and runtime
— One or more configured features is not running or has a fault
The following attributes are the maximum number that can display for a configured WorkstationST application (with all
features enabled).

State Description
WorkstationST Service Indicates that all configured features are installed and running
Configuration Equality Major Difference.
If the Configuration Equality status displays Not Equal, perform the Build and Download
commands.
Alarm Server Indicates whether the Alarm Server is running with or without errors
Device Manager
Indicates whether the feature is running without errors
Gateway
EGD Configuration
Indicates whether the EGD Configuration Server is running with or without errors
Server
GSM Indicates whether the standard messaging external interface is running
Historian Indicates whether the feature is running without errors
HMI Provides runtime status information
HMI File Utility Provides runtime status information
Mark V Indicates whether a configured Mark V controller has errors
Modbus Indicates the presence and status of messaging protocol for client/server communication
Network Monitor Indicates the presence and status of all defined system devices
OPC AE Server Indicates whether the OPC AE Server is running with or without errors
OPC DA Server Indicates whether the OPC DA Server is running with or without errors
OPC UA Server Indicates whether the OPC UA Server is running with or without errors
Indicates whether the Recorder feature is running, and displays the number of collections running
Recorder
with or without errors
Time Synchronization
Indicates whether the feature is running
System
Public Information
is restarted after the download is complete. The following modifications cause a Major Difference status in the controller:
• Adding the first I/O pack to a controller
• Changing redundancy type
• Changing the platform type, which changes the number of Ethernets
• Changing any NTP configuration on a controller

Public Information
16.3 Download to WorkstationST Application
The ToolboxST configuration defines the features of the WorkstationST application. The WorkstationST runtime has a
service, which receives the download request. It expands the zipped download file into the computer's configuration folder (c:
\Config by default). After a bind of consumed EGD configuration is performed, all running WorkstationST features are
informed that the download is complete.
The WorkstationST install package installs the WorkstationST Service, as well as any other features (such as the OPC DA
Server and the EGD Configuration Server) required. Once the WorkstationST Service is installed and running, download the
application configuration.
The Download Wizard application is used to configure software for a WorkstationST computer over an Ethernet connection.
Additionally, the Download Wizard can automatically examine the system configuration to locate out-of-date software, or you
can manually select individual items to download.
Note Certain conditions do not allow a download, for example, an incorrect platform type. Check the Component InfoView
for errors that would prohibit a download.

1. From the Device menu, select Download.
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.
Public Information
3. Click Finish.
4. In the Component InfoView, review the Log tab for potential warnings or errors that may have occurred during the
download.

Public Information
Notes
Public Information
17 Finder
The Finder is a separate window in the Component Editor, 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 Find icon . Or from the Edit menu, select Find.
Click to display
Enter search text available wildcards
Click Replace
to display a
field to enter
replacement
text
Select Entire
System to
search every
configured
component
Select Open
Components
to search all
components
open in the
System Editor
Select to search
inside the
currently selected
item (in this case,
the Modbus tab)
Select the
search method
from the drop-
down list
Click Replace and enter

desired text to perform a
search-and-replace function
Finder GEH-6703P User Guide 1141

Public Information
Search parameters include:
• Match Case distinguishes between upper and lowercase letters.

• Include Notes allows you to include such things as variable descriptions.
• Include Second Language Notes allows you to provide Second Language descriptions.
• Include Libraries extends the search to all open libraries.
• Include Diagrams includes block diagram items in the search.
• Search Inside Blocks allows blocks below the current location to be searched.
• Keep Window Open After Search keeps the Find window open between searches.
When a search is completed, the results display on the Find Results tab of the Component InfoView. To go directly to a
location, double-click it in the list.
Find Methods
The following Find methods are available to control how the text entered in the Find box is matched to text in the ToolboxST
application:
• Anywhere
• Begins With
• Ends With
• Match Exactly
• Match Whole Word
• Wildcards
• Regular Expressions
Anywhere finds the specified text anywhere within a searchable text string.
Anywhere
A search for: matches: but does not match:

abc
abdc
abcde
abc ab
xyzabc
bc
zabcz
Begins With finds the specified text only at the beginning of a searchable text string.
Begins With

xyzabc
abc abdc
abc
abcde ab
bc
Ends With finds the specified text only at the end of a searchable text string.
Ends With
abcde
abc
abdc
abc
ab
xyzabc
bc
Match Exactly finds the specified text only when it is exactly equal to an entire searchable text string.
Public Information
Match Exactly

abcde
xyzabc
abc abdc
abc
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.
Match Whole Word

abcde
xyzabc
abc
abdc
abc abc cde
ab
spell your abc's.
bc
spell your abc's.
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.
Wildcards
abdc
bc
abc
a?c abc cde
adc
abcde
xyzabc
abc
adc
abcde bc
a*
abdc cde abc
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.
Finder GEH-6703P User Guide 1143

Public Information
Regular Expressions
cat
cats
sat
[cvrm]at vat
bat
rat
mat
Monday
Tuesday
Saturday
Wednesday
(Mon|Tues|Wednes|Thurs|Fri)day Sunday
Thursday
Fries
Friday
Fridays
var0
varx
var9
var[0-9]+ var7a
var7
var
var48
var
var5
var[a-zA-Z]* variable
var!
varZZZZ
Public Information
18 EGD Editor for External Devices
The EGD Component Editor for external devices allows you to configure Ethernet Global Data (EGD) for an external or
third-party device. The EGD protocol allows controller devices (sometimes known as nodes) to share information in a
networked environment. EGD allows one controller device, referred to as the producer of the data, to simultaneously send
information to any number of peer controller devices (consumers) at a fixed periodic rate. This network supports a large
number of controller devices capable of both producing and consuming.
18.1 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 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.)
3. From the Tree View, right-click the Network Adapters item and select Add Adapter.
➢ To remove a network adapter

Editor Enable property of the component may be set to False. The EGD Component Editor opens).
3. From the Tree View, right-click the network adapter to be removed and select Delete Adapter.
EGD Editor for External Devices GEH-6703P User Guide 1145

Public Information
From the Tree View,
select a Network
Adapter
Properties display in
the Property Editor
Tree View.
Network Adapter Properties
Adapter Settings
IP Address IP address for the selected network adapter
Wire Speed Speed of the connected network
Network Settings
Network Name of the connected network
Subnet Mask Subnet mask associated with the connected network
Public Information
18.2 EGD Configuration
➢ To configure EGD for an external device
Editor Enable property of the component may be set to False.
2. From the EGD 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.
This property is available for configuration when Ethernet Global Data is selected in the Tree View:
Producer ID sets and displays the Unique address of the EGD producing device for this component. This property is
assigned when the component is created. The EGD Producer ID displays in the Property Editor as an unsigned integer. Click
the ellipsis button to display the EGD Producer ID window that includes dotted and hexadecimal representations.

Public Information
18.3 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, select Add Page.
➢ To delete a Produced Page from the Tree View, right-click the page to delete and select Delete.
➢ To configure a Produced Page: from the Tree View, select the EGD tab and expand the Produced Pages.
From the Tree View,

expand Produced
Pages and select the
desired page to
display properties in
the Property Editor
Public Information
Produced Page Properties
Destination IP Sets the IP address to which the exchanges on this page are unicast or multicast.
Address (If the Mode property is set to Broadcast, this property is not available.)
If set to True, broadcasts EGD on Ethernet 0
Ethernet 0 (If more than one Ethernet Adapter has been configured for EGD, additional Ethernet properties
display.)
Can be set to Broadcast, Unicast, or Multicast, depending on the modes supported by the component’s
EGD implementation profile:
Mode Unicast sends the page to a single destination
Indicates the number of exchanges in the selected page. It is updated after selecting the Build
Exchanges
command
Determines whether the exchange numbers and offsets are assigned automatically at build time or are
Layout Mode
entered manually
Name Allows you to rename the selected page
Period Transmission period of the page in ms
Used to prevent exchanges with the same period from being produced at exactly the same instant. The
skew for the first exchange in the page is set to this value, and each additional exchange skew differs
from the previous exchange’s skew by exactly this value (in nanoseconds). For example, if you have
Skew
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.
Starting Exchange ID Sets the Exchange ID used for this page. Each additional exchange is incremental from the number

Public Information
18.4 Page Compression
Double Words, and finally all other variables. A page compression causes an exchange major signature. Consumers can mark
the exchange variables as unhealthy until the consumed configuration can be rebound.
➢ To add a variable to a produced page: from the Tree View, right-click a Produced Page and select Add
Variable to display the Select a Variable window.
➢ To copy variable information from an EGD page to the clipboard: from the Summary View, right-click a
18.5 Edit Exchange Signatures and Configuration Time
the signature.

4. Make desired changes and click OK.
Public Information
18.6 Referenced Devices
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 Referenced Devices and select Select Devices.
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
select Refresh.
18.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, located in the EGD tab Tree View, contains details about
the EGD implementation of a particular device.
Note Properties display in the Summary View.
EGD Implementation Properties

Configuration Support Allows you to edit various configuration features
Data Types Allows you to configure supported data types. Click the ellipsis button to open an editor window
Double Word Alignment Offset of a DWORD length variable, must be evenly divisible by this number
Set to True if the component requires that all WORD length variables be aligned on an even
Word Alignment
boundary
Broadcast Set to True if the component supports broadcast destinations for EGD data or command packets
Masked Write Set to True if the component supports the MaskedWrite command
Returns the maximum size (in bytes) of a variable that still is guaranteed coherent transfer. If the
Max Coherent Data attribute is not present, all data is guaranteed coherent transfer regardless of size. It is optional, and
initialized to 0.
Returns the maximum number of exchanges supported by the device. It is optional, and initialized to
Max Exchanges
0.
Returns the maximum size string supported by the component. If the attribute is not present, the
Max String
component has no set maximum size for strings. It is optional, and initialized to 0.
Multicast Set to True if the component supports multicast destinations for EGD data or command packets
Boolean value representing the capability of the producer to support the skewing of produced
Skew
exchanges with respect to time
Boolean value that is set to True if the component supports unicast destinations for EGD data or
Unicast
command packets

Public Information
EGD Implementation Properties (continued)
Class of the device as defined in the EGD Protocol Specification:
0 supports only the configuration port.
1 supports the data port and the Protocol Data Unit (PDU).
2 supports all class 1 services, plus at least acts as a responder for the command port,
Device Class and the commands associated with that port.
3 supports all class 2 services, plus the configuration port, and the required commands
associated with that port. Such devices support responding to configuration requests
but do not dynamically bind their consumed variables.
4 supports all class 3 services, plus dynamically binding consumed variables.
Device Name Name of the class of device to which this device belongs
18.8 View 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.
Public Information
18.9 EGD Diagnostics
Note You must be online to view diagnostics information.
A CMP can be used to obtain the status of a Class 2 or higher EGD device. When any item from the EGD tab Tree View other
than a Referenced Device is selected, the EGD Statistics from [Device name] tab displays the statistics from the open
component. When Referenced Devices is selected, statistics are obtained from that referenced device, and the name of the tab
page changes accordingly.
Summary View Status Columns

Column Description
Exchange Exchange identifier: <device name>.<exchange number>
Configuration Time Time the exchange was configured
Due Time Time a consumer data packet must be received for an exchange to remain valid
This length may be the highest variable offset in the exchange or the highest offset of a variable,
Length 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.
Missed Count 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 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.

Public Information
18.10 EGD Configuration Server Tab
from that server.
the open component.
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.
Public Information
18.11 External Device Menus
Menu Command Use
Update the EGD configuration files, refreshes consumed exchanges and variables,
Save assigns produced variables to exchanges, and, if an EGD configuration server has been
specified, publishes the configuration to the server
Transfer produced data, consumed data, symbols, implementation profiles, and GUI
device EGD configuration files to and from a variety of file formats
File Import and Export
The GE Rationalization report is the only report that can be imported to an external device.
Print the summary grid view with the column selection, order, and width currently visible in
Print
the view
Close Close the currently opened device

Edit Copy Copy the selected item in the Tree View
Delete Delete the selected item in the Tree View

View
Go Forward Go to the view that immediately follows the current view in the history
Send CMP messages to EGD Class 2 or higher devices to view live values from the
Online
device
Refresh the consumed information for all referenced devices, automatically sets the layout
Device Bind and Build of any unassigned produced variables, and, if no errors occur, publishes the configuration
to the EGD configuration server
Store the current EGD configuration to the System Database (SDB). Only available if the
Put Device to SDB
system has an SDB enabled and configured.
Send Problem
Display the Send Problem Report form to report system issues
Report
Help Release Notes Display the release notes for the current version of the application
How-to Guides Display ControlST Software Suite How-to Guides (GEH-6808) (if available)
About Display version and copyright information about the application
➢ To import a GE Rationalization report for an external device

1. From the File menu, select Import Alarm Info and GE Rationalization report.

Public Information
Notes
Public Information
19 Configuration Management System
(CMS)
19.1 Overview
The ControlST Software Suite includes a Configuration Management System (CMS) that provides revision control and
maintain history for CMS-controlled ToolboxST systems.
The CMS consists of the following components, which are described in this chapter:
• CMS Server (includes CMS Administrator Tool and Repository)

• CMS Client (ToolboxST application)
CMS Quick Start Procedure

The following steps provide the basic process to create a CMS Repository and use the most common CMS features. The
specific procedures are provided throughout this chapter.
1. Install the CMS Server on one machine with the ControlST Software Suite and provide the path to where the repositories
will be stored.
2. Create and configure a Repository using the CMS Administrator Tool.
3. Add a ToolboxST system to the Repository.
4. Get a ToolboxST system from the Repository.
Note Perform a Get System from Repository on any computer that has network connectivity to the computer on which
the Repository resides.
19.2 CMS Server

The CMS Server application provides the following features:
• Establishes a security model for the CMS Server. CMS security uses Windows (Domain and/or Workgroup) security for
user authentication (CMS users must exist as valid domain or workgroup users)
• Creates and deletes master locations known as CMS Repositories in which configuration files and revision history are
stored and maintained
• Adds and deletes CMS usernames and privileges to control access to the systems in the repositories
• Provides a mechanism to back up and restore repositories. Backups include revision history for a ToolboxST system in a
Repository. User information can be included or excluded from the backup copy.
• Starts and stops the CMS Server application
Configuration Management System (CMS) GEH-6703P User Guide 1157

Public Information
19.2.1 CMS Server Installation and Initial Configuration
If you have upgraded from a previous version of the CMS Server, refer to the section
Upgrade from CMS to CMS – SVN.
Attention
The CMS Server is installed on a single computer and configured for the user’s specific location. Local Administrator
privileges are required to install and configure the CMS Server.
The CMS Server uses a Repository to track system changes and control client access. Each Repository contains a list of CMS
users and access permissions. The Repository maintains the revision change history for the ToolboxST systems that are added
to that Repository. A CMS Server can have one or more repositories, and each Repository can contain one or more
ToolboxST systems.
➢ To install the CMS Server
Note The user must be logged on as an Administrator to install and configure the CMS Server.
Typically, the CMS Server is only installed on one computer per site. When the CMS
Server installation option is selected, a Setup dialog box displays to confirm that the
CMS Server is only being installed on a single computer.
Attention
Note The ControlST software release and version numbers displayed in the Setup dialog box may differ from those
displayed during an actual installation.
1. Place the ControlST Software Suite DVD in the DVD-ROM drive and the installation automatically begins.
2. Review the Setup Notes and click Continue.
3. Install the CMS-SVN Server as follows:
a. Select the check box for CMS-SVN Server.
b. Click Yes to proceed with installation.
c. Click Install.
Public Information
CMS-SVN Server Installation Option
4. From the Welcome dialog box, click Next to continue.

5. From the End-User License Agreement dialog box, review the terms and conditions, select I accept the terms in the
License Agreement, then click Next to continue.
6. The first time the CMS Server application is installed on a computer, the user selects the destination folder for the CMS
Server. The default installation location is(C:\Program Files (x86)\GE Energy\). If necessary, click Browse
to change this location. For any subsequent installations, the Destination Folder dialog box displays the installation
location for the product version. Click Next to continue.
7. Click Install to begin installation.
8. Provide the path to where the Repository will be stored.
Enter the folder location for the

repository and click OK.

Public Information
9. If you have a certificate from a Certification Authority (CA), install the certificate in the subversion server.
a. Obtain the necessary certificate files from the Site Administrator.
b. Copy the files to the configuration folder for the subversion folder as follows: C:/program files (x86)\GE Energy
\Apache24\Conf (if installed to the default location).
10. If you do not have a certificate from a CA, create a self-signed certificate.
Click Yes to continue.
Public Information
Enter your client information,
then click Create .
When the certificate is

generated, click Close.
Note The CMS Administrator Tool is automatically installed during CMS Server installation and a shortcut icon is placed on
the computer desktop. This tool is used to configure the CMS Server, including adding users and setting access permissions.
11. Click Finish to complete CMS Server installation, then click Yes to exit setup, or No to install additional ControlST
software installation options.

Public Information
➢ To configure your CMS Repository using the CMS Administrator Tool
1. From your desktop, double-click the CMS Administrator Tool icon.
2. The first time the CMS Administrator Tool is opened, users are automatically prompted to create a Repository.
Public Information
Users are automatically added as a CMS Administrator with Read and Write access to the Repository. The username and
password default to the user’s current Windows username and password.
3. Add additional users to the Repository and set user access privileges.
From the Users menu , select Add…
Enter the domain and username for the user.
Set user access privileges .

HMI \GeAdmin To grant Read-only access, select User has
read -only access.
To grant Read-Write access to repository
contents, leave this selection empty.
Click OK to add the user.
Note The Repository username is used by the user to log in to the CMS. The username and password default to your current
Windows username and password.
4. Copy the Repository URL address. (This address is manually entered during initial CMS Client configuration).
From the Tools menu, select

Copy Repository URL.
HMI\GeMaint
Note: This URL can be distributed
to the users at your site.
Click OK.

Public Information
19.2.2 CMS Server and System Repository Configuration
The CMS Administrator Tool is installed with the CMS Server and allows you to perform administrative tasks and
configuration using the available menu options.
CMS Administrator Tool Menu Items

Menu Command Description
Select Select a Repository to store and maintain files
Create Create a new Repository
Delete an existing Repository
Repository Delete Make sure you create a backup copy of

the Repository before deleting it.
Attention
Backup Create a backup copy of the repository for Repository restore
Restore Restore a Repository from a backup copy
Add users and set user permissions
Add
Users with empty passwords cannot access the Repository.
Users
Delete Remove a user from the system
Edit Edit permissions for a user
Start and stop the server
Server
Stopping the server disables all repository operations.
Create Self-signed
Tools Create a server certificate for each client to accept
Certificate
Copy repository URL to the clipboard for use during configuration to connect clients
Copy Repository URL
to the Repository
File Exit Close the CMS Administrator Tool
Public Information
19.2.2.1 Create New Repository
A Repository is created using the CMS Administrator Tool.
Note The CMS Administrator Tool can only be accessed from the computer on which the server has been installed and
designated as the CMS Server. Administrator permissions are required on your computer to use the CMS Administrator Tool.
➢ To create a Repository
1. From the Start menu, select All Programs, GE ControlST, CMS Server, and CMS Administrator Tool.
2. Enter a Repository Name and click OK.
The CMS Administrator Tool displays a message notifying the user that the Repository was created successfully.

Public Information
19.2.2.2 Repository Backup
A backup of a Repository can be created using the CMS Administrator Tool. A backup can be used to restore the Repository
when the CMS Server is moved from one machine to another or in the event of file corruption.
➢ To back up a CMS Repository

1. From the CMS Administrator Tool Repository menu, select Backup....
2. Click Yes to continue.
3. From the Repository drop-down menu, select the Repository to backup. Click Browse and navigate to and select the
location for the backup file, then click OK.
Public Information
4. When the Repository backup has completed successfully, a dialog box displays the location where the backup copy was
saved. Click OK to complete the process.
19.2.2.3 Repository Restore

A CMS Repository can be restored from a backup copy using the CMS Administrator Tool. This is useful if the CMS Server
needs to be moved from one machine to another or in the event of file corruption.
Note A backup copy of the Repository must have been previously created for use to restore the Repository.
➢ To restore a Repository from a backup copy

1. From the CMS Administrator Tool Repository menu, select Restore....
2. Click Yes to continue.

Public Information
3. Click Browse and navigate to and select the backup copy of the Repository. The Repository Name field automatically
populates with the backup Repository file name, but this name can be changed if necessary. Click OK to continue.
4. When the Repository restore has completed successfully, a dialog box displays the location of the backup file used to
restore the Repository. Click OK.
Public Information
➢ To open the restored Repository
1. From the CMS Administrator Tool Repository menu, select Select....
2. From the drop-down menu, select the Repository and click Open.
The restored Repository displays users and permissions in the CMS Administrator window.

Public Information
19.3 CMS Client (ToolboxST)
Note CMS menu items are disabled until a ToolboxST system is opened.
The CMS Client (in the ToolboxST application) is used to place ToolboxST systems under CMS control, get systems from the
Repository to the local drive, check out individual components in a master configuration, make edits, and check in
components.
The CMS Client provides the following functions:
• Logs a user in and connects to the CMS Server

• Adds system configuration files to the Repository, which enables revision tracking
• Get Latest command updates the CMS status for all system components in the user’s local Working Copy as compared to
the system in the Repository. CMS status icons in the CMS client indicate equal, out-of-date, missing, or checked out
(such as [User xyz] on [computer name]).
• Gets a copy of the most current version of the configuration files from the Repository and copies the current system to
the user’s Working Copy.
• Checks out a configuration file or component from the Repository for changes. The user makes system changes to their
local Working Copy.
• Checks in the configuration file or component to the Repository. The user can add a change description for each
component during check in. Changes and comments are recorded in the Repository history with a revision number.
• Displays a history of changes for a configuration file or component
• Compares and displays the differences between the configuration file or component in the Working Copy and the most
current copy in the Repository
• Gets and reverts to a previous version of the configuration file or component
19.3.1 Working Copy
Note Use the CMS Administrator Tool to assign or remove CMS users to and from the Repository.
The Working Copy is the CMS user’s local copy saved on a particular computer that contains the system .tcw file and all
related files and folders for the system within the CMS Server. A Working Copy is specific to a particular CMS user. Different
users cannot share a Working Copy.
When a user adds a system to the Repository, the current location of the ToolboxST
system .tcw file becomes the local Working Copy on that computer. Place the .tcw file
and configuration files in the desired Working Copy location before adding the
ToolboxST system to the CMS Server.
Attention
To prevent errors during check out and check in, network-shared folders should not
be used as a local Working Copy. Users should maintain the Working Copy on their
hard drive.
Attention
Public Information
19.3.2 Initial CMS Client Configuration
The following diagram provides an overview of the procedures described in this section.
Get System
Add System from Repository
to Repository CMS Server
Get System
From Repository
Computer 1
Computer 3
Computer 2
Initial CMS Configuration Diagram

Public Information
➢ To add a system to a Repository
This operation is performed only once for a system, at initial use.
Attention
1. Open the ToolboxST application system .tcw file.
2. Log in to the CMS Client.
From the CMS menu, select Login.
Enter the Repository URL in the Server URL field,

enter your username and password, then click OK.
The Repository URL address is

available from the CMS
Administrator Tool configuration
and can be provided to site users.
HMI\GeMaint
Public Information
3. If the CMS Server was configured with a self-signed certificate, users are prompted to save and accept the certificate.
Select Save certificate and click Accept.
Note: If you do not select Save certificate , you

will be asked to accept this certificate each time
you log on to the CMS server.
Note If the user has already saved the certificate this dialog box will not display.

Public Information
4. Add the system to the Repository.
From the CMS menu , select Add System to Repository...
Public Information
➢ To get a Working Copy from the CMS Server on other computers
This operation only needs to be performed one time for each computer to get a local
Working Copy of the system on each computer.
Perform a Get System from Repository on any computer that has network connectivity
Attention to the computer on which the Repository resides.
Note Refer to the Initial CMS Configuration Diagram.
1. From the ToolboxST application, get the system from the CMS Server.
From the CMS menu, select

Get System from Repository...
Enter the Repository URL in the Server URL field,

enter your username and password, then click OK.
HMI\GeMaint

Public Information
2. If the CMS server has been configured with a self-signed certificate, users are prompted to save and accept the certificate.
Select Save certificate and click Accept.
Note: If you do not select Save certificate , you

will be asked to accept this certificate each time
you log on to the CMS server.
Note If the user has already saved the certificate this dialog box will not display.
3. Save the Working Copy of the system to a designated location on the computer.
From the drop-down menu, select the system. Enter the folder path or
click Browse and select a location to save the system folder, then click OK.
Note Even if the folder path requires a new folder, the system will automatically create the new folder.
Public Information
➢ To open a system from the CMS Client
1. From the ToolboxST application, open a system.
From the File menu , select Open System...
2. Log in and connect to the CMS Server.
Note You must connect to the correct CMS Server to log on.
Verify that the Repository server URL is correct .

Enter your username and password and click OK.
HMI\GeMaint

Public Information
Example System Open in ToolboxST Application
Public Information
19.3.3 CMS Features and Status Icons
The CMS menu lists the CMS features. The following sections describe these features in detail.
CMS Menu Items

Menu Description
Login Logs the user in to connect to the CMS Server
Logout Logs the user off of the CMS Server
Allows the user to work on a configuration in an offline
mode, such as when they don’t have access to the
Work Disconnected CMS server.
Changes made can be checked in or reverted when
the user is connected to the server.
Refreshes the CMS status icons for the system and
Refresh
components
Creates an initial Working Copy on the user’s
Get System from Repository...
computer
Adds a new system to the Repository in which the user
Add System to Repository...
is working
Detach System from Permanently separates the connection between the
Repository Working Copy and the Repository
Remove System from Removes a system from the Repository in which you
CMS Menu Items Repository... are working
Retrieves the last checked-in version of the
configuration files from the Repository.
Get Latest Version
Components under CMS control will be in Read-Only
mode until the component is checked out.
Checks out a component from the Repository to make
Check Out changes and prevents other users from checking out
the component
Checks the user changes into the Repository, and
Check In allows other users to get the changes and check out
the component
Returns a checked-out component to the Repository
Undo Check Out
without saving changes
Displays the versions/modifications for a selected
component
From the View History window, you can compare a
View History
version in the Repository with the local copy in the
Working Copy. You can also compare two versions in the
Repository.
Displays the differences between the master copy in
Compare... the Repository and the local Working Copy. Users can
also compare two versions of the Working Copy.

Public Information
CMS status icons indicate the state of the components.
CMS Status Icons

Icon State and Description
Device is checked out by the user somewhere else, or by another user
CMS provides device name, username, Working Copy location, and checkout date and time
Device is checked in and Equal
Device is checked out by the user in the current Working copy

CMS provides device name, username, identifies current location as checkout path, and checkout date and time
Local copy is missing
Local copy is out of date
Newly added component that is not yet checked in
Working Copy has been locally modified while working disconnected
Before You Start

• Must have a system .tcw file added to a CMS Repository
Public Information
19.3.3.1 Login and Open a Working Copy
Selecting Login logs the user on to connect to the CMS Server.
➢ To log in and connect to the CMS Server

1. From the ToolboxST application, open a .tcw system.
Browse to the local Working Copy and select the .tcw file (system opens in Read-only mode).
Note You must connect to the correct CMS Server to log on.

HMI\GeMaint

Public Information
19.3.3.2 Logout
Selecting Logout logs the user out of the CMS Server.
➢ To log out of the CMS Server: select Logout.
19.3.3.3 Work Disconnected

Selecting Work Disconnected places the configuration in an offline mode. This is useful if the user does not have access to the
CMS Server but wants to make changes to the system or component. Any changes made while offline can be checked in or
reverted when the user is connected to the CMS Server.
➢ To work disconnected from the CMS Server

1. From the ToolboxST application, open a system.
Browse to the local Working Copy and select the .tcw file (system opens in Read-only mode).
2. From the CMS Login window, click Cancel.
3. Work disconnected from the CMS Server to make all files writable.
From the CMS menu, select Work Disconnected.
4. Make the necessary changes and save them.
Public Information
➢ To update the CMS Server with changes made while working offline
1. Log in and connect to the CMS Server. An exclamation mark icon indicates the local copy has been modified and is
different from the server copy.
Local Copy Identified as Different from CMS Server Copy

2. Check out the component containing the changes you made to your local Working copy while working offline. A green
checked out icon indicates the file is checked out. The changes made to your local copy while working disconnected from
the server will be contained in the checked out file.
Local Working Copy is Checked Out
Note It may be useful to perform a Compare... to verify your changes before checking in the component.
3. Check in the component.
19.3.3.4 Refresh
Selecting Refresh updates the CMS status icons for the system and components.
Note CMS status does not update automatically. The user should periodically perform a Refresh to update the CMS status of
all components in the system.
➢ To refresh systems and components
Note You must be connected to the CMS Server for the Refresh feature to work properly.
From the CMS menu, select Refresh.

Public Information
19.3.3.5 Get System from Repository...
Selecting Get System from Repository creates a local Working Copy on the user’s computer. Refer to the procedure To get a
Working Copy from the CMS Server on other computers.
19.3.3.6 Add System to Repository...

Selecting Add System to Repository adds a system to the users’ Repository.
➢ To add a system to a Repository from the ToolboxST application

1. From the ToolboxST application, open a .tcw system.

HMI\GeMaint
Public Information
3. Add the system to your Repository.
From the CMS menu , select Add System to Repository...
The system name displays with a blue lock icon and the system is in Read-Only mode.

Public Information
19.3.3.7 Detach System from Repository
Selecting Detach System from Repository permanently separates the connection between the local Working Copy and the
Repository.
➢ To detach a system from a Repository

1. From the Tree View, select the system.
2. From the CMS menu, select Detach System from Repository.
3. Confirm the detachment.
Click OK to confirm and

continue the detachment.
19.3.3.8 Remove System from Repository...

Selecting Remove System from Repository removes a system from the Repository in which the user is working.
➢ To remove a system from a Repository

2. From the CMS menu, select Remove system from Repository.
19.3.3.9 Get Latest Version

Selecting Get Latest Version updates the user’s Working copy to the latest revision from the Repository.
Note Components under CMS control will be in Read-Only mode until the component is checked out.
➢ To get the latest version of system

2. From the CMS menu, select Get Latest Version.
Public Information
19.3.3.10 Check Out
Selecting Check Out checks out a component from the Repository for the user to make changes, and prevents other users from
checking out the component.
➢ To check out a system from the Repository

2. From the CMS menu, select Check Out.
Tip � To check out multiple components at one time, press and hold [Shift] on the keyboard and select the components.
Use the View by Type option in the View menu at the system level to quickly select all Libraries and devices before performing
check in, check out and undo check out.
19.3.3.11 Check In
Selecting Check In checks in the user’s changes to the Repository, and allows other users to get the changes and check out the
system or component.
➢ To check in a system to the Repository

1. From the Tree View, select the system or component.
2. From the CMS menu, select Check In.
3. Provide a summary of the changes for revision history.
In the Comments section , enter the changes

made to the component and click OK.
Tip � To check in multiple components at one time, press and hold [Shift] on the keyboard and select the components.

Public Information
19.3.3.12 Undo Check Out
Selecting Undo Check Out returns a checked-out component to the Repository without saving any changes.
➢ To undo checkout of a system

2. From the CMS menu, select Undo Check Out.
Tip � To undo check out of multiple components at one time, press and hold [Shift] on the keyboard and select the
components.
19.3.3.13 View History

Selecting View History displays the versions and modifications for a selected component. Users can compare the most current
copy in the Repository to the Working Copy, replace (get) the current Working Copy with a specific version, and revert the
Working Copy to a previous version.
➢ To view the history
From the CMS menu,

select View History.
Public Information
View History Results
➢ To get a specific version of the Working Copy
From the View History window, select a Version and click Get.
➢ To revert to a previous version of the Working Copy

1. Check out the Working Copy.
Right-click the component , select CMS, then select Check Out.

Public Information
2. View the history.
From the CMS menu,

select View History.
3. Select a version and revert it to the previous version.
Select the version and click Revert.
The component displays the out of date icon with the revision number.
Public Information
4. Make any changes needed, then check in the component.
Right-click the component , select CMS, then select Check In.
Enter the changes made and click OK.
Note Users can compare the current Working Copy to any previous version displayed in the history, including the latest
version in the Repository. Additionally, users can select and compare two versions displayed in the history.

Public Information
19.3.3.14 Compare...
Selecting Compare compares the current Working Copy with the latest version in the Repository to identify differences. Users
can also compare multiple versions of the Working Copy.
Devices must be closed at the System level to perform a Compare.
Attention
➢ To compare the current Working Copy to the last Repository version
From the CMS menu, select Compare

to compare the Working Copy to the
latest Repository version .
Comparison Results
Public Information
Note If there are no differences identified between the current Working Copy and the most recent copy in the Repository, the
system will display a dialog box to notify the user that there are no differences.
➢ To compare two versions of a Working Copy

the component and select CMS,
then select View History to
display history.
To select two versions, press and hold [Ctrl] on the keyboard and select the
appropriate versions , then click Compare to display comparison results.

Public Information
Comparison Results — Two Versions
Public Information
19.3.4 CMS Library Features
Beginning with ControlST V06.02, users can check out and work with the Libraries within a Library Container in a CMS
Repository. This allows multiple users to work on individual Libraries in the Library Container at the same time. The
following table describes features users can perform while working with Libraries in the CMS.
Note To delete Library Containers or individual Libraries, right-click the item and select Delete.
To rename a Library Container, right-click the item, select Rename, and enter the new name.
To rename individual Libraries, enter the new name in the Property Editor.
Menu Item Description

Refreshes the CMS status icons for the system and Library
Refresh
components
Retrieves the last checked-in version of the Library configuration
files from the Repository
Get Latest Version
Components under CMS control will be in Read-Only mode until the
component is checked out.
Checks out Library Container or individual Libraries within a Library
Check Out Container from the CMS Repository for a user to make changes and
prevents other users from checking out the same Library
Checks the user changes back into the Repository, and allows other
Check In
users to get the changes and check out the Library
Returns a checked-out Library or Library Container to the Repository
CMS Library Menu Items Undo Check Out
without saving changes
Displays the versions and modifications for a selected Library
From the View History window, users can compare the current copy
View History in the Repository to the Working Copy, compare two versions of the
Working Copy, replace (Get) the current Working Copy with a
specific version, and revert to a previous version of the Library.
Displays the differences between the master copy in the Repository
Compare and the local Working Copy. Users can also compare two versions
of the Working Copy.
Before You Start

• Must have a system .tcw file added to a CMS Repository

• Must have a Library Container containing libraries
• Must log in and connect to the CMS Server

Public Information
19.3.4.1 Refresh
Selecting Refresh updates the CMS status icons for the system and Library components.
Note CMS status does not update automatically. The user should periodically perform a Refresh to update the CMS status of
all components in the system.
➢ To refresh Systems and Library Components
Note You must be connected to the CMS Server for the Refresh feature to work.
From the CMS menu, select Refresh.
Public Information
19.3.4.2 Check Out
➢ To check out a Library Container
1. From the Library Container Component Editor, make sure the Library Container you want to check out is checked in
(indicated with a blue padlock icon).
2. Check out the Library Container from the CMS Repository.
Right-click the Library Container,

select CMS, then select Check Out.
3. A dialog box displays and ask if you want to check out all elements.

Public Information
a. Click No to only check out the Library Container and add a new library to the library container.
Library Container Only Checked Out

b. Click Yes to check out the Library Container and the individual libraries within that Library Container. This is
useful for a system upgrade.
Library Container Elements Checked Out
➢ To check out individual libraries

1. From the Library Container Component Editor, expand the Library Container and verify that the individual library you
want to check out from a Library Container is checked in (indicated with a blue padlock icon).
2. Check out the individual Library from the Library Container in the CMS Repository.
Public Information
Right-click the Library, select CMS,
then select Check Out.
Individual Library Checked Out
Individual Library Checkout within Library Container
Tip � If the CMS status icons do not update immediately, click Refresh to update the CMS status icons and view checked out
libraries. You must be connected to the CMS Server for the Refresh feature to work.

Public Information
➢ To check out multiple libraries at one time
1. Press and hold [Ctrl] on the keyboard and select each individual Library for checkout.
2. Check out the individual Libraries from the Library Container in the CMS Repository.
With multiple Libraries selected,

right-click select CMS, then
select Check Out.
Multiple Libraries Checked Out
Public Information
19.3.4.3 Check In
➢ To check in a library to the CMS Repository
1. From the Library Container Component Editor, select a library that is checked out (indicated by a green check mark
icon).
2. Check in the library to the CMS Repository.
Right-click the library and select CMS,

then select Check In.
3. Provide a description of the changes you made during check out.
Enter a brief description of the changes you

made in the Comments field, then click OK.
A blue padlock icon for the library indicates it has been checked back in to the CMS Repository.

Public Information
➢ To check in multiple libraries to the CMS Repository at one time
1. From the Library Container Component Editor, press and hold [Ctrl] on the keyboard and select the libraries that are
checked out (indicated by a green check mark icon).
Tip � Use the View by Type option in the View menu at the system level to quickly select all Libraries and devices before
performing check in, check out, and undo check out.
2. Select CMS, then select Check In.

3. Click Yes on the dialog box to confirm you want to check in all of the selected elements.
4. Enter a brief description of the changes you made in the Comments field, then click OK.
A blue padlock icon next to the libraries indicate they have been checked back in to the CMS Repository.
19.3.4.4 Get Latest Version

➢ To get the latest version of the library: right-click the library, select CMS, then select Get Latest Version.
19.3.4.5 Undo Check Out
➢ To undo checkout: right-click the item and select CMS, select Undo checkout, then click Yes.
The changes you made while the item was checked out will not be saved.
Tip � Use the View by Type option in the View menu at the system level to quickly select all Libraries and devices before
performing check in, check out, and undo check out.
Public Information
19.3.4.6 View History
➢ To view the history

then select View History.
History View
➢ To revert to a previous version of the library (Working Copy)

1. Check out the library.
2. View the history.
3. Select a version and revert it to the previous version.

Public Information
➢ To get a specific version of the library: from the View History window, select a version and click Get.
Note If there are no differences identified between the current Working Copy and the most recent copy in the Repository, the
system will display a dialog box to notify the user that there are no differences.
Public Information
19.3.4.7 Compare
Devices must be closed at the System level to perform a Compare.
Attention
➢ To compare Library versions

then select Compare.
OR
From the History results dialog box, select

a library version and select Compare.

Public Information
Comparison Results
Public Information
➢ To compare two versions of a Working Copy

the Library Container and select
CMS, then select View History
to display history.
To select two versions, press and hold [Ctrl] on the keyboard and select the
appropriate versions , then click Compare to display comparison results.

Public Information
Comparison Results — Two Versions
19.4 Upgrade from CMS to CMS – SVN

Beginning with ControlST V06.00, the CMS Server has been updated to improve its responsiveness and reliability. This
change is not backwards compatible; systems must be moved into a new CMS-SVN Repository. These systems will not
include the history from the previous Repository; it will use only the latest version from the previous Repository.
Perform the following procedures to upgrade:
• Get a copy of the system from the current Repository

• Configure the new Repository
• Add a system to the new Repository
➢ To get a copy of the system from the current Repository

1. Make sure no files are checked out.
2. Use the current ToolboxST version (prior to V06.00) to get the latest version of files from the CMS Repository.
➢ To configure the new Repository: add the system to the CMS Server.
Public Information
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
Auto-Reconfiguration A feature that allows an I/O pack to be replaced and its configuration files downloaded when the
I/O pack is replaced
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. Trender can be configured by adding collections.
Configure To select settings for such things as the location of hardware jumpers or loading software parameters into
memory.
Control Constant Control Constant is a signal with an initial value that is read and never written.
Designated controller In a Mark VIe dual controller system, the designated controller is the controller to which the I/O
packs listen for outputs when they have the option to listen to multiple controllers. In a TMR system, the designated controller
initializes the other controllers.
Device A configurable component of a process control system.
Ethernet LAN with a 10/100 MB baud collision avoidance/collision detection system used to link one or more computers
together. Basis for TCP/IP and I/O services layers that conform 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.
Fieldbus is a digital, two-way, multi-drop communication link among intelligent measurement and control devices. It
serves as a local area network (LAN) for advanced process control, remote input/output, and high-speed factory automation
applications.
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 stored in memory chips that hold their content without electrical power, such as
flash memory.
GEH-6703P Glossary of Terms 1209

Public Information
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 that 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), computer, or
mainframe. A gateway can perform protocol and bandwidth conversion.
Gateway A computer that translates another fieldbus-related protocol to FOUNDATION fieldbus protocol, for example,
HART® or Modbus® to FOUNDATION fieldbus protocol.
health A term that defines whether a variable is functioning as expected.
heartbeat A signal emitted at regular intervals by software to demonstrate that it is still active.
hexadecimal (hex) Base 16 numbering system using the digits 0-9 and letters A-F to represent the decimal numbers
0-15. Two hex digits represent 1 byte.
I/O Input/output interfaces that allow the flow of data into and out of a device.
initialize To set values (addresses, counters, registers, and such) to a beginning value prior to the rest of processing.
instance Update an item with a new definition.
linking device Provides a standardized communications and control system for installing components from various
manufacturers.
LanModule GE Energy distributed I/O control module
logical A statement of a true sense, such as a Boolean.
node In a local network, a component connected to other components that communicates 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.
relay ladder diagram (RLD) A ladder diagram has a symbolic power source. Power is considered to flow from the left
rail through a contact to the coil connected to the right.
resources Also known as groups. Resources are systems (devices, machines, or work stations where work is performed)
or areas where several tasks are carried out. Resource configuration plays an important role in the CIMPLICITY system by
routing alarms to specific users and filtering the data users receive.
rubber block A block that can extend to include a variable number of pins.
runtime The period of time that a program or process runs.
1210 GEH-6703 ToolboxST User Guide for Mark Controls Platform

Public Information
Secure Sockets Layer (SSL) A cryptographic protocol used to transmit private data over a network.
Sequential Function Chart (SFC) A graphical programming model that allows you to organize an application by
creating a state machine with three types of components: steps, actions, and transitions.
ToolboxST A Windows-based software package used to configure controllers.
trend A time-based plot to show the history of values.
Trender A subsystem of the ToolboxST application that monitors and graphs signal values from a controller.
validate Makes certain that items or devices do not contain errors and verifies that the configuration is ready to be built
into application code.
variable The basic unit for variable information. Variables are the placeholders for memory locations in the toolbox’s
different platforms.
word A unit of information composed of characters, bits, or bytes. It is treated as an entity, and can be stored in one
location. Also, a measurement of memory length, usually 32 bits in length, but can also be 4, 8, or 16 bits long.
WorkstationST A ControlST application that provides a user interface for configuring various features such as alarm
management, control system health, Historians, and data interfaces.
GEH-6703P Glossary of Terms 1211

Public Information
Notes

Public Information
C
Index Calibratation
valve circuits 691
Capture Buffer 1078
Change Log 88
A client
OPC DA 1042
Access privileges 156 OPC UA 1059
access roles 162 Test OPC DA 1054
add Test OPC UA 1064
HMI screen files 128 CMS 1157
modules 309 Administrator Tool 1165
add a task 781 Client 1170
Add Special Task 784 features 1179
alarm server configuration 1164
printing 1031 server installation 1158
server status 993 Working Copy 1170
status viewer file menu 996 coding practices report 865
tab 1017 Coding Practices report 450
Viewer 1034 Collection Type
Alarm Add Collection 1075
block templates 104 Capture Buffer 1078
definitions 108 Delete Collection 1076
inhibit group 110 EPA Log 1079
report 422, 840, 1093 Live Data 1077
shelving 74 Maintenance Log 1079
shelving privilege 143 Trip Log 1078
symbols 113 Collections 1075
Alarm Help 36 command
Alarm Rationalization 491, 1117 download 528, 917
Alarm Scanner 1022 event history 555
Alarm Shelving 74 command line
Alarms arguments 20
classes 106 CommandLineST 1124
Alias 341 command file examples 1130
Alias mode 98, 172, 341 commands 1126
Aliases 172 options 1125
application syntax 1124
documentation 196 commands 1126
System Design Procedures 197 compare
arguments 1128 devices 288, 752
Assign a Generic Fieldbus Function Block to a parameters 321, 778
Fieldbus Device Placeholder 643 to controller 287, 751
attach variable 508, 895 Component InfoView 269, 738, 977
attribute value editor 758 components
attributes 758 group 40
Auto-Reconfiguration 301 instance 65
move and copy 40
options 743
B upgrade 60
Backup and Restore Computer recommedations 18
UCSB 554, 933 condition-based unshelving 75
backward compatibility 96 configuration server reports
Bar Code 310 referenced devices 369, 802, 1151
batch commands 48 configure
block Dynamic Data Recorder (DDR) tab 352
Diagram Editor 223 external devices 83
find unlinked 81 HART devices 694
rename sheets 225 NTP 1006
shape shortcut menu 240 OPC AE Server 1071
Block Pin report 415, 832 PCNO module 719
border options 227 PIOA for ARCNET support 727
GEH-6703P Index 1213

Public Information
PPRF communications 700 E
PSCA module 725
PUAA/YUAA I/O 729 editor
attribute value 298
connect
attribute value editor 758
to WorkstationST computer 1135
Connect to Controller 907 block diagram 223
combinational logic 260
connecting to a controller 519
property 268, 737, 976
constants
reconcile differences 515, 902 rung 257
undriven 512, 899 system 33
System Information 103
consumed devices 1003
control Editor
add variable 504, 891 Library Container 175
EGD configuration server 147
behavior 505, 892
interaction 149
control constants 55
Control Constants work online 149
EGD configuration server reports 1091
Import and Export 55
EGD Diagnostics 1087
controller
connect 907 EGD Editor for External Devices 1145
setup 917 EGD Packet Logging 1088
EGD Point List report 408, 824
Controller
Device types 169 EPA Log 1079
controls EtherCAT tab 384
Ethernet Global Data (EGD)
animation 503, 890
configuration 361, 796, 1082
general 502, 889
properties 507, 894 configuration server 149
configuration server reports 368, 802, 1091
create
diagnostics 1153
Sequential Function Chart (SFC) 563
system from 69 edit produced pages 363–364, 798–799, 1084
systems 33 packet logging 1088
page compression 365, 800, 1085, 1150
creation wizard 735, 973
customize sheet borders 226 produced pages 362, 797, 1083
referenced devices 369, 802
tab 361, 796, 1082
view differences 150
D Event report 429, 847, 1096
data grids 271, 740, 979 Export table definition 183, 351
copy and move 274, 742, 981 external OPC AE servers 1020
edit 272, 740, 979
organize columns 272, 741, 980
data update rates 1073 F
DDR setup 356
delete features 1004
HMI screen files 128 file
determine produced page health 1053 compatibility 95
diagnostic alarm severity 1072 configuration 94
diagnostic views 934 formats 94
disagreements diagnostic view 936 library help 182
display find methods 1142
current user 158 Find report data 480, 875, 1113
HMI screen file status 131 forced variables 489
download format specifications 124
HMI screen files 130 FOUNDATION Fieldbus Configuration Report 454
to WorkstationST application 1138 FOUNDATION Fieldbus H1 Field Device Report 457
Download Controller Configuration 528, 917 FOUNDATION Fieldbus H1 Parameter
Download to Controller Configuration Report 464
Download Wizard 548, 929 FOUNDATION Fieldbus Parameter Reconcile
download wizard 1138 Report 459
drag and drop 498, 885, 1123
Drag-and-drop of Assigned Fieldbus Function
Blocks to a CIMPLICITY Screen 687 G
Dynamic Data Recorder (DDR) tab 352 GE Rationalization report 425, 843, 1106
configure 352 general

Public Information
tab 756 Library
General add library 178
tab 292 find all uses 181
General tab 1001 help files 182
features 1004 password protection 183
global parameters 1038 property editor 181
Global Variable report 396, 813 references 179
global variables 490, 1092 summary view 181
GSM tab 1080 Library Container Editor 175
licensing 30
manager 32
H Linking Devices
Summary View 665
hardware key Live Data 1077
install 32 Live Data .csv File Interface 1044
hardware tab 306, 760 live values
HART devices 694 force 498, 885, 1123
help modify 245
Alarm 36 LiveView
highway add 500, 886
control data 89 editor features 501, 888
unit data 89 open 500, 886
Historian tab 1080 upgrade 501, 888
history tab 269, 738, 977 log
HMI off 161
Config tab 1035 on 159
resources 127 tab 270, 739, 978
screens 127
HMI screen file
archive 132 M
copy 132
define use 129 Maintenance Log 1079
display status 131 Mark V tab 1080
edit 131 measurement systems 126
locations 127 menus
Hold report 427, 845 component 753
external device 1155
Mark VIe 289
I NTP status viewer 992
System Editor 100
implementation profile 1151 WorkstationST 999
import Modbus Slave
constants 514, 902 register pages 371, 804
installation 23 tab 370, 803
instance all 334, 785 Modbus tab 1080
I/O mode
copy 76 layout 235
diagnostic viewer 778 modify
diagnostics 325 live values 245
diagnostics report 778 modules
report 325 add 762
special functions 691 diagnose 323, 777
view 324 modify 314, 772
I/O Configuration report 420, 838 organize 313, 771
I/O Pack Peer-to-Peer report 435 upgrade 321, 776
I/O Variable report 417, 834 view 314, 772
Instance 189
Instance script 189
N
L network
adapters 759, 1011
library monitor data flow 1014
references 332, 785

Public Information
monitor tab 1014 referenced devices 1086
redundancy 761 rename sheets 225
status display 1016 report
status viewer 1016 apply filter 481, 873, 1112
switches 84 Report Features 476
network adapters 299, 1145 report filter 481, 873, 1112
networks 89 reports
NVRAM report 431, 849 alarm 422, 840, 1093
Auto-reconfiguration 468
block pin 415, 832
O coding practices 450, 865
EGD point list 408, 824
On Site Monitor 1013 Event 429, 847, 1096
OPC export 1114
AE Server tab 1069 force lists 101
DA Server tab 1039 FOUNDATION Fieldbus Configuration 454
UA Server Tab 1056 FOUNDATION Fieldbus H1 Field Device 457
OPC UA 302 FOUNDATION Fieldbus H1 Parameter
Operating Systems 18 Configuration 464
options 1125 FOUNDATION Fieldbus Reconcile 459
organize GE Rationalization 425, 843, 1106
columns 272, 741 global variable 396, 813
modules 313, 771 Hold 427, 845
organize columns 980 import 483, 876
overridable properties 335, 786 I/O configuration 420, 838
I/O Pack Peer-to-Peer 435
I/O variable 417, 834
P NVRAM 431, 849
page compression 365, 800, 1085, 1150 second language 413, 830
parameters system 154
compare 321, 778 variable alias 411, 828
download 321, 778 variable configuration 400, 817
password protection 326, 779 web 403, 820
Password protection Reports
Controller 37 features 476
passwords 277, 745, 983 Unlinked Programs / Userblocks 474, 868
PCNO I/O module 719 Restore
PFFA UCSC 554, 933
PFFA 602 routing 1069
PFFA Schedule Download 680
pins
connect 241 S
wire block 238 safety controller operations 908
PIOA I/O module 727 save
plant areas 142 systems 87
port scheduled tasks 1008
configure switch 86 Second Language
Position special characters 484, 877, 1114
terminal board 310 Second Language report 413, 830
PPRF I/O module 700 Secure State 524, 913
Produced Pages 362, 797, 1083, 1148 security 276, 744, 982
property editor 737, 976 passwords 277, 745, 983
library 181 view protection status 278, 746, 984
Property Editor 268, 338, 789 Sequential Function Chart (SFC) 563
table definition 183 add a transition 570
protected objects 279, 747, 985 server
PSCA I/O module 725 attributes 1070
OPC AE 1020
OPC DA 1039
R OPC UA 1056
Recorder tab 1074 Shape drawing tools 247
redundant EGD Produced Pages 1052 shared IONet 164

Public Information
Shared IONet 165 online data value display and changes 184
software tab 326, 779 software code 185
sound options 111 table definitions 349
state translations 1071 Tabs
status Recorder 1074
control attributes 523, 912 task
monitor 989 add 328, 781
tab 520, 910, 1136 add special task 784
tab attributes 521, 911, 1136 Terminal Board
summary view bar code 310
library 181 theme visualization 46
Summary View 268, 737, 976 time card 1005
system toolbar
database 145 layout 502, 889
options 98 standard 502, 889
properties 41 Totalizer
replication 66 passwords 561
scan and download 51 values 562
System Controller Platforms 169 Totalizers 560
System Editor Tree View 268, 737, 976
Configuration Files 94 Trip Log 1078
menus 100
open and create systems 33
options 98 U
save systems 87
status 50 Universal Analog (PUAA/YUAA) I/O 729
System Information Editor 103 unlink
Alarm classes 106 permanently 337, 788
format specifications 124 property 173
HMI resources 127 Unlinked Programs / Userblocks Report 474, 868
HMI screens 127 upgrade
measurement systems 126 component 282
I/O modules 282
Upgrade
component 749
T I/O modules 749
tab 384 I/O pack firmware 284
Alarms 1017 upload wizard 931
Channel Diagnostics 714 Use Block
Control System Health 1081 find all uses 194
Device Diagnostics 713 instance 189
Dynamic Data Recorder (DDR) 352 instance script 189
EGD configuration server 368, 801 property editor 195
Ethernet Global Data 361, 796, 1082 validate 189
general 756 user block
General 1001 definitions 174
GSM 1080 User Block
hardware 306, 760 add definition 187
Historian 1080 update all uses 189
history 269, 738, 977 variables 188
HMI Config 1035
Identifier Diagnostics 714
log 270, 739, 978 V
Mark V 1080
Modbus 1080 variable
Network Monitor 1014 global 1092
OPC AE Server 1071 rail tool 247
OPC DA Server 1039 translations 1070
OPC UA Server 1056 Variable
software 326, 779 Add variable 1076
Standard Diagnostics 713 Delete variable 1076
Variables 1065 Variable Alias report 411, 828
Table Definition Variable Configuration report 400, 817

Public Information
Variable names 172
variables 172
connect 318
forced 489
global 490
status 355
undriven 512, 899
Variables tab 1065
versions 27
view
differences 150
modules 772
protection status 278, 746, 984
view NTP (time sync) detail option 992
W
Watch Window
add variable wizard 496, 883, 1121
export 499, 886, 1124
open existing 495, 882, 1120
organize columns 498, 885, 1123
Web report 403, 820
wizard
add module 762
controller setup 917
create system 69
creation 735
replication 66
upload 931
Wizard
creation 265, 973
download 1138
upgrade 749
upload 552
Working Copy 1170
Working Online With a WorkstationST
Component 1135
Workstation ST
Alarm Server 42
WorkstationST
Alarm Server 1001, 1017, 1136
Alarm Viewer 1034
connect to 1135
menus 999
Status Monitor 989
Z
zoom and pan tools 239

Public Information
Public Information

Geh 6703 PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Geh 6703 PDF

Uploaded by

Copyright:

Available Formats

GEH-6703P

ToolboxST* User Guide

Revised: Aug 2019

© 2014 - 2019 General Electric Company.

We would appreciate your feedback about our documentation.

GEH-6703P User Guide 3

4 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

GEH-6703P User Guide 5

6 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

User Guide GEH-6703P 7

CDH Control Data Highway

CMS Configuration Management System

CRC Cycle Redundancy Check

CSP Control Sequence Program (application code)

DDR Dynamic Data Recorder

EGD Ethernet Global Data

HMI Human-machine Interface

MSB Most Significant Bit

NVRAM Non-volatile Random Access Memory

NTP Network Time Protocol

SDI System Data Interface

SFC Sequential Function Chart

SOE Sequence of Events

TMR Triple Modular Redundant

UDH Unit Data Highway

XML eXtensible Markup Language

8 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

Indicates a procedure or condition that, if not strictly observed, could result in

Indicates a procedure or condition that should be strictly followed to improve these

GEH-6703P User Guide 9

To prevent personal injury or damage to equipment, follow all equipment safety

To minimize hazard of electrical shock or burn, approved grounding practices and

To prevent personal injury or equipment damage caused by equipment malfunction,

10 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

GEH-6703P User Guide 11

12 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

GEH-6703P User Guide 13

14 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

GEH-6703P User Guide 15

16 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

• Close all Windows® programs.

• Analog I/O (YAIC)

• Universal Analog (YUAA)

• Vibration Input Monitor (YVIB)

• Relay Output (YDOA)

• Power Distribution System Diagnostics (PPDA)

• Serial Modbus Communication (PSCA)

• Mark VIeS Safety Controller (UCSCS2x)

• Mark VIe Controller for Gateway (UCSCH1x)

Application Overview GEH-6703P User Guide 17

18 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

An issue in the Windows OS handling of 32-bit application addresses has been

• Windows Server 2008 R2 64-bit

This results in the following Ethernet connection failures:

• Loss of online connection between ToolboxST and the controller

ToolboxST Windows 10 OS Display Issues

Application Overview GEH-6703P User Guide 19

Standard Action Arguments

/EGDAction:MODIFY /EGDDevice:<producer ID> allows the device-assigned Producer ID to be modified.

Open the ToolboxST Application

Open a ToolboxST Component and Navigate to a Variable

20 GEH-6703P GEH-6703 ToolboxST User Guide for Mark Controls Platform

Application Overview GEH-6703P User Guide 21