Sei sulla pagina 1di 441

Control Builder User Guide for Ovation 3.

5
OW350_80

Version 1
January 2013
Copyright Notice

Since the equipment explained in this document has a variety of uses, the user and those
responsible for applying this equipment must satisfy themselves as to the acceptability of each
application and use of the equipment. Under no circumstances will Emerson Process
Management be responsible or liable for any damage, including indirect or consequential losses
resulting from the use, misuse, or application of this equipment.

The text, illustrations, charts, and examples included in this manual are intended solely to explain
TM
the use and application of the Ovation Unit. Due to the many variables associated with specific
uses or applications, Emerson Process Management cannot assume responsibility or liability for
actual use based upon the data provided in this manual.

No patent liability is assumed by Emerson Process Management with respect to the use of
circuits, information, equipment, or software described in this manual.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any
form or by any means, including electronic, mechanical, photocopying, recording or otherwise
without the prior express written permission of Emerson Process Management.

The document is the property of and contains Proprietary Information owned by Emerson Process
Management and/or its subcontractors and suppliers. It is transmitted in confidence and trust, and
the user agrees to treat this document in strict accordance with the terms and conditions of the
agreement under which it was provided.

This manual is printed in the USA and is subject to change without notice.

Ovation is the mark of Emerson Process Management. Other marks are the property of their
respective holders.

Copyright © Emerson Process Management Power & Water Solutions, Inc. All rights reserved.
Emerson Process Management
Power & Water Solutions
200 Beta Drive
Pittsburgh, PA 15238
USA

E-Mail: Technical.Communications@Emerson.com
Web site: https://www.ovationusers.com
Contents

1 Introduction to Ovation Control Builder 1


1.1 What is Ovation control? ..................................................................................................... 2
1.2 What types of control are supported in Ovation? ................................................................ 3
1.3 What is the Ovation Control Builder? .................................................................................. 4
1.4 What is the role of the Control Builder in Ovation? ............................................................. 5
1.5 What are the software platforms that the Control Builder supports? .................................. 6
1.6 Control Builder terminology ................................................................................................. 6

2 Planning and Designing Ovation Control 9


2.1 What are the best practices for planning control?............................................................... 9
2.2 What is the control planning process? .............................................................................. 10
2.3 Using diagrams in planning control ................................................................................... 11
2.3.1 What are piping and instrumentation diagrams (P&ID)? ..................................... 12
2.3.2 What are oil diagrams? ........................................................................................ 12
2.3.3 What are plant process schematics? ................................................................... 13
2.4 What is storyboarding for control? .................................................................................... 13
2.5 Planning for system expansion ......................................................................................... 14
2.6 What are the best practices for designing control? ........................................................... 15
2.7 Defining the control application ......................................................................................... 16
2.7.1 What is the scope of your control project? ........................................................... 16
2.7.2 Subdividing your control application .................................................................... 16
2.8 Defining the system I/O ..................................................................................................... 17
2.8.1 Creating Ovation cabinets .................................................................................... 17
2.8.2 Defining the I/O modules...................................................................................... 17

3 Understanding basic Control Builder concepts 19


3.1 What are Ovation control functions (control sheets)? ....................................................... 19
3.2 What is a control task area?.............................................................................................. 20
3.2.1 Control tasks cycle time ....................................................................................... 21
3.3 Numbering control sheets ................................................................................................. 22
3.4 What is the Control Builder frame? ................................................................................... 23
3.4.1 To edit the frame.svg file ...................................................................................... 24
3.5 Understanding how the Control Builder searches in Windows-based Ovation systems .. 26

4 Accessing and configuring the Ovation Control Builder 27


4.1 Accessing the Ovation Control Builder ............................................................................. 27
4.1.1 To access the Control Builder in a Windows-based Ovation system .................. 27
4.2 Configuring the Control Builder ......................................................................................... 29
4.2.1 To set Control Builder configuration parameters ................................................. 29

OW350_80 i
Table of Contents

5 Understanding Control Builder windows, menus, and toolbars 33


5.1 What is the Control Builder main window? ....................................................................... 34
5.1.1 Accessing functions from the Control Builder main window ................................ 37
5.2 What are the Control Builder menus? ............................................................................... 37
5.2.1 File menu on the Control Builder main window.................................................... 37
5.2.2 Edit menu on the Control Builder main window ................................................... 38
5.2.3 View menu on the Control Builder main window.................................................. 40
5.2.4 Draw menu on the Control Builder main window ................................................. 40
5.2.5 Tools menu on the Control Builder main window................................................. 42
5.2.6 Window menu on the Control Builder main window ............................................ 43
5.2.7 Help menu on the Control Builder main window .................................................. 43
5.3 What are the Control Builder toolbars? ............................................................................. 44
5.3.1 Standard toolbar on the Control Builder main window ......................................... 45
5.3.2 Drawing toolbar on the Control Builder main window .......................................... 46
5.3.3 Text Attributes toolbar on the Control Builder main window ................................ 46
5.4 Control Builder keyboard shortcuts ................................................................................... 47
5.5 What is the Control Builder Object Browser? .................................................................... 49
5.5.1 What are the Object Browser containers? ........................................................... 50
5.5.2 Object Browser toolbar ......................................................................................... 51
5.5.3 Object Browser right-click menu and item descriptions ....................................... 52
5.5.4 Editing objects in the Object Browser .................................................................. 54
5.5.5 Grouping objects using the Object Browser......................................................... 55
5.6 What is the Control Builder Property Editor window? ....................................................... 56
5.7 What is the Control Builder Style Editor window? ............................................................. 58
5.7.1 Control Builder Style Editor window and field descriptions .................................. 58
5.7.2 To use the Style Editor window ............................................................................ 60
5.7.3 To create a custom style template for control sheets .......................................... 61
5.8 Using the Control Builder online help system ................................................................... 62
5.9 Using the Control Builder What's This function ................................................................. 64
5.9.1 To use the What's This function ........................................................................... 65

6 Linking Control Builder documents 67


6.1 What is a document hierarchy? ......................................................................................... 68
6.2 What are component codes? ............................................................................................ 69
6.3 Component code examples .............................................................................................. 69
6.3.1 KKS code example - 2, 5, 5 pattern ..................................................................... 70
6.3.2 KKS code example -- 2, 3, 2, 2, 3 pattern ............................................................ 71
6.3.3 KKS code example -- 2, 3, -2, 2, 3 pattern (one ignored field) ............................ 72
6.3.4 Emerson code example ....................................................................................... 73
6.4 How do I configure component codes? ............................................................................. 73
6.5 To configure component codes in the Control Builder ...................................................... 73
6.6 To configure component codes for signal diagrams ......................................................... 74
6.7 Defining the ComponentFieldDefinition.txt file .................................................................. 75
6.7.1 To add the txt file to the Control Builder and Signal Diagrams ............................ 77
6.8 Assigning component codes to a document ..................................................................... 78
6.8.1 To assign a component code to a document in the Control Builder .................... 79
6.8.2 To assign component codes to multiple sheets in the Developer Studio ............ 81
6.8.3 To delete a component code from the Developer Studio .................................... 84

ii OW350_80
Table of Contents

6.8.4 To define related component codes ..................................................................... 84


6.9 What are hyperlinks? ........................................................................................................ 86
6.9.1 To add external web hyperlinks ........................................................................... 87
6.9.2 To add supplemental document hyperlinks ......................................................... 88
6.9.3 To create a supplemental document from a link .................................................. 89
6.9.4 To add component code reference hyperlinks ..................................................... 90
6.10 What are supplemental documents? ................................................................................ 91
6.10.1 To edit supplemental documents ......................................................................... 91
6.10.2 To publish supplemental documents ................................................................... 92

7 Building control sheets 95


7.1 What are the best practices for building control sheets? .................................................. 95
7.2 Overview of building sheets for Ovation systems ............................................................. 96
7.3 Creating a new control sheet ............................................................................................ 96
7.3.1 To create a new control sheet in a Windows-based Ovation system .................. 96
7.4 Configuring information in Control Builder title box fields ................................................. 98
7.5 What is control sheet revision control? ............................................................................. 98
7.6 Opening an existing control sheet ..................................................................................... 99
7.6.1 Understanding the Select file to open window ..................................................... 99
7.6.2 To open an existing control sheet using the drop layout ................................... 100
7.6.3 To open an existing document using the component code layout ..................... 102
7.6.4 To open a locked control sheet .......................................................................... 104
7.6.5 To open a recovered version of a file ................................................................. 106
7.7 What is the Control Builder Revert function? .................................................................. 106
7.7.1 To use the Control Builder Revert function ........................................................ 106
7.8 To recover multiple files .................................................................................................. 107
7.9 Saving a control sheet ..................................................................................................... 108
7.10 Using the Control Builder Audit function ......................................................................... 108
7.11 Deleting control sheets in a Windows-based Ovation system ........................................ 108
7.11.1 To delete control sheets in a Windows-based Ovation system ......................... 109
7.12 Storing control sheets in a Windows-based Ovation system .......................................... 110
7.13 Changing control sheet execution order ......................................................................... 112
7.13.1 To change control sheet execution order ........................................................... 112
7.14 Reusing control sheets .................................................................................................... 114
7.14.1 Tag names for internal point names .................................................................. 114
7.15 Printing control sheets ..................................................................................................... 115
7.16 Printing Control Builder reports ....................................................................................... 115
7.16.1 Algorithm Details report example ....................................................................... 116
7.16.2 Connector information report example ............................................................... 117
7.16.3 Execution Order report example ........................................................................ 118
7.16.4 Title Page report ................................................................................................. 119
7.16.5 Print Ladder(s) report ......................................................................................... 119
7.17 What are permissive windows? ....................................................................................... 120
7.17.1 Using the Control Builder to create permissive windows ................................... 120
7.18 Loading sheets in a Windows-based Ovation system .................................................... 121

OW350_80 iii
Table of Contents

8 Understanding algorithms and algorithm components 123


8.1 What are algorithms? ...................................................................................................... 123
8.1.1 What are best practices for using algorithms? ................................................... 124
8.1.2 Add Algorithm window and field descriptions..................................................... 124
8.1.3 To add an algorithm ........................................................................................... 125
8.1.4 To select the size of algorithm icons .................................................................. 127
8.1.5 To edit algorithm parameters ............................................................................. 128
8.1.6 To use the algorithm right-click menu ................................................................ 128
8.1.7 To delete an algorithm from a sheet .................................................................. 130
8.2 What are algorithm anchors? .......................................................................................... 130
8.2.1 Modifying an algorithm anchor location ............................................................. 130
8.2.2 To move an algorithm using anchors ................................................................. 131
8.2.3 To use the algorithm anchor alignment functions .............................................. 131
8.2.4 To use the algorithm anchor spacing functions ................................................. 131
8.2.5 What is signal rerouting when moving algorithm anchors? ............................... 132
8.3 Ordering algorithm execution .......................................................................................... 132
8.3.1 To view the algorithm order................................................................................ 132
8.3.2 To change algorithm ordering from automatic to manual .................................. 133
8.3.3 To change the order of algorithm execution while in view mode ....................... 134
8.3.4 To change algorithm ordering from manual to automatic .................................. 136
8.3.5 To print the algorithm execution order ............................................................... 137
8.4 What is the Control Builder Algorithm Value function? ................................................... 137
8.4.1 What are the best practices for using the Algorithm Value function? ................ 137
8.4.2 To use the Algorithm Value function .................................................................. 137
8.4.3 Using the Property Editor to change algorithm values ....................................... 139
8.5 Organizing and standardizing algorithm values .............................................................. 143
8.5.1 To organize algorithm values in the Object Browser ......................................... 143
8.5.2 To standardize the appearance of algorithm values .......................................... 144
8.6 What is the Control Builder Algorithm Value Indicator function? .................................... 148
8.6.1 To add an algorithm value indicator ................................................................... 148
8.6.2 Using the Property Editor to change an algorithm value indicator ..................... 149
8.7 What is the Control Builder Symbol Browser window? ................................................... 150
8.7.1 To use the Symbol Browser ............................................................................... 150
8.8 What is the Control Builder Favorites window? .............................................................. 154
8.8.1 To access the Favorites window ........................................................................ 154
8.8.2 Favorites Folder toolbar ..................................................................................... 154
8.8.3 Favorites Folder right-click menu ....................................................................... 155
8.8.4 To add symbols to the Favorites window ........................................................... 156
8.8.5 To add a folder to the Favorites window ............................................................ 157
8.8.6 To create a shared folder for favorites ............................................................... 158
8.9 What is the CALCBLOCK algorithm? ............................................................................. 158
8.9.1 To use the CALCBLOCK Editor ......................................................................... 159
8.10 Configuring the BALANCER algorithm with MASTATIONs ............................................ 160
8.10.1 BALANCER algorithm sheet examples .............................................................. 162
8.11 What is the Control Builder Function Generator Graph? ................................................ 164
8.11.1 To add a graph to a FUNCTION algorithm ........................................................ 164
8.12 What are control macros? ............................................................................................... 165
8.12.1 Requirements for macros in the Control Builder ................................................ 166
8.12.2 To create a ControlMacros folder in a Windows-based Ovation system ........... 166
8.12.3 To define a macro in the Control Builder ........................................................... 166
8.12.4 To create a symbol for a control macro ............................................................. 167

iv OW350_80
Table of Contents

8.12.5 To install macros from another system .............................................................. 168


8.12.6 To add a macro to a control sheet ..................................................................... 169
8.12.7 To edit a control macro in the Control Builder.................................................... 170
8.12.8 Replacing a macro reference ............................................................................. 170
8.12.9 To replace a macro reference ............................................................................ 171
8.12.10 To display control macros in signal diagrams .................................................... 173
8.12.11 To modify a control macro.................................................................................. 173
8.13 What is the Macro Interface Editor window? ................................................................... 174
8.13.1 Macro Interface Editor window and field descriptions ........................................ 174
8.13.2 To edit parameters in the Macro Interface Editor window ................................. 175
8.13.3 To use the Find and Replace panel in the Macro Interface Editor window ....... 175
8.13.4 To view errors in the Macro Interface Editor window ......................................... 176

9 Understanding the elements of a control sheet 177


9.1 What are the elements of a control sheet? ..................................................................... 177
9.2 What are control pins? .................................................................................................... 177
9.2.1 To add a control pin ........................................................................................... 177
9.2.2 To delete a control pin ........................................................................................ 179
9.2.3 To move a control pin ......................................................................................... 179
9.3 What are control signals? ................................................................................................ 179
9.3.1 What are the best practices for using control signals? ...................................... 180
9.3.2 To add a control signal ....................................................................................... 180
9.3.3 To connect control signals from the right-click menu ......................................... 181
9.3.4 To delete or break a control signal ..................................................................... 182
9.3.5 To bend a control signal ..................................................................................... 183
9.3.6 To move a control signal .................................................................................... 183
9.3.7 To set tracking between algorithms ................................................................... 183
9.3.8 To set tracking between sheets ......................................................................... 184
9.3.9 To clear all tracking on a sheet .......................................................................... 184
9.4 What are page connectors on control sheets? ............................................................... 185
9.4.1 What are the best practices for using page connectors on control sheets? ...... 185
9.4.2 Page connector descriptions .............................................................................. 186
9.4.3 To use page connectors on control sheets ........................................................ 186
9.4.4 To delete page connectors on control sheets .................................................... 188
9.4.5 To determine where a page connector is used on a control sheet .................... 188
9.4.6 Using output connectors on control sheets ........................................................ 188
9.5 Adding comments (static text) to Control Builder documents ......................................... 188
9.6 What is the Control Builder Document Value function? .................................................. 189
9.6.1 To use the Document Value function ................................................................. 189
9.6.2 Using the Property Editor to change document values ...................................... 190

10 Understanding points in the Control Builder 193


10.1 Using the Control Builder to create points ...................................................................... 193
10.1.1 To create points using the Control Builder ......................................................... 193
10.2 What is the Control Builder Point Editor window? ........................................................... 195
10.2.1 Control Builder Point Editor window fields and descriptions .............................. 195
10.2.2 To modify point names in the Control Builder Point Editor window ................... 196
10.2.3 To use the Control Builder Find and Replace panel on the Point Editor
window ............................................................................................................... 198
10.3 What are Ovation point security groups? ........................................................................ 199
10.3.1 To assign point security groups in the Control Builder ...................................... 199

OW350_80 v
Table of Contents

10.4 What is the Control Builder Find Points function? ........................................................... 200
10.4.1 To use the Control Builder Find Points function................................................. 200
10.5 What is the Control Builder Point Description function? ................................................. 201
10.5.1 To add a point description .................................................................................. 201
10.5.2 Using the Property Editor to change a point description display ....................... 203
10.6 What is the Control Builder Point Reference function? ................................................... 206
10.6.1 To add a point reference .................................................................................... 206
10.6.2 Using the Property Editor to change a point reference ...................................... 208
10.7 What is the Control Builder Point Status Indicator function? .......................................... 210
10.7.1 To add a point status indicator ........................................................................... 211
10.7.2 Using the Property Editor to change a point status indicator ............................. 212

11 Drawing simple graphics 215


11.1 Creating a simple graphic in the Control Builder............................................................. 216
11.1.1 To draw a rectangle in the Control Builder ......................................................... 217
11.1.2 To draw a polygon in the Control Builder ........................................................... 217
11.1.3 To draw an ellipse in the Control Builder ........................................................... 218
11.1.4 To draw a curve in the Control Builder ............................................................... 218
11.1.5 To draw a line in the Control Builder .................................................................. 218
11.1.6 Property Editor fields for simple draw items....................................................... 219
11.1.7 To add text to a simple graphic in the Control Builder ....................................... 219
11.1.8 To find and replace comment text ...................................................................... 221
11.2 Creating a Shape Directory in the Control Builder .......................................................... 222
11.2.1 Best practices for creating shapes for the shape directory ................................ 222
11.2.2 To create a shape for the Shape Directory ........................................................ 222
11.3 Using the Import Tool ...................................................................................................... 225
11.3.1 Best practices for using the Import Tool ............................................................ 225
11.3.2 To import a shape using the Import Tool ........................................................... 225
11.4 What are the Control Builder drawing canvas editing functions? ................................... 227
11.4.1 To select and deselect objects in the Control Builder ........................................ 228
11.4.2 To move objects in the Control Builder .............................................................. 228
11.4.3 To delete objects in the Control Builder ............................................................. 229
11.4.4 To use the Cut, Copy, and Paste functions in the Control Builder..................... 229
11.4.5 To use the Undo/Redo function in the Control Builder ...................................... 230
11.4.6 To use the drawing canvas edit context menu in the Control Builder ................ 230
11.5 What is the Control Builder Zoom function? ................................................................... 231
11.5.1 To use the Zoom Window View function in the Control Builder ......................... 231
11.5.2 Using the Full View option in the Control Builder ............................................... 231
11.5.3 Using the Zoom In and Zoom Out in the Control Builder ................................... 232

vi OW350_80
Table of Contents

12 Creating custom algorithm symbols 233


12.1 Why create algorithm symbols? ...................................................................................... 233
12.2 What are the best practices for creating algorithm symbols? ......................................... 233
12.3 To create a custom algorithm symbol ............................................................................. 233

13 Using control libraries 237


13.1 What is a control library? ................................................................................................. 237
13.2 To create a new control library ........................................................................................ 237
13.3 Importing control logic ..................................................................................................... 237
13.3.1 To import a document into a control sheet ......................................................... 237
13.3.2 To import a library into a control sheet ............................................................... 238
13.4 Exporting control logic to a library ................................................................................... 238
13.4.1 To export control logic to a library ...................................................................... 238

14 Managing your Control Builder operations 241


14.1 What are the Ovation Control Builder operations? ......................................................... 241
14.2 Understanding the Control Builder operations window sequence .................................. 242
14.2.1 To use the Choose files window ........................................................................ 245
14.2.2 To use the Macro Filter option ........................................................................... 247
14.3 What is the Compile operation? ...................................................................................... 250
14.3.1 To use the Compile Operation ........................................................................... 250
14.3.2 To create a new point map file in the Point Translation Editor window ............. 253
14.3.3 To use Find and Replace for a point map file .................................................... 255
14.3.4 To add and delete output point names to a point map file ................................. 255
14.4 What is the Copy operation? ........................................................................................... 256
14.4.1 To use the Copy operation ................................................................................. 256
14.4.2 To use the Copy operation Find and Replace function ...................................... 259
14.4.3 Example of copying control ................................................................................ 260
14.5 What is the Export operation? ......................................................................................... 260
14.5.1 To use the Export operation ............................................................................... 260
14.6 What is the Import operation? ......................................................................................... 262
14.6.1 To use the Import operation ............................................................................... 262
14.7 What is the Print operation? ............................................................................................ 265
14.7.1 To use the Print operation .................................................................................. 265
14.8 What is the Publish operation? ....................................................................................... 266
14.8.1 To use the Publish operation ............................................................................. 266
14.9 What is the Reconcile operation? ................................................................................... 268
14.10 To use the Reconcile operation ...................................................................................... 268
14.11 What is the Standardize Text operation? ........................................................................ 271
14.11.1 To use the Standardize Text operation .............................................................. 271
14.12 What is the Style operation? ........................................................................................... 274
14.12.1 To use the Style operation ................................................................................. 274
14.13 What is the Synchronize Online function? ...................................................................... 277
14.13.1 Understanding the Synchronize Online Directories window .............................. 277
14.13.2 To use the Synchronize Online function ............................................................ 279

OW350_80 vii
Table of Contents

15 Using signal diagrams at the Operator Station 281


15.1 What are signal diagrams? ............................................................................................. 281
15.1.1 What functions are provided by signal diagrams? ............................................. 281
15.1.2 What are the best practices for using signal diagrams? .................................... 282
15.2 Accessing a Signal Diagram ........................................................................................... 282
15.2.1 To access signal diagrams from the Windows-based Ovation Applications
window ............................................................................................................... 283
15.2.2 To access signal diagrams from a Point Menu .................................................. 284
15.2.3 To access signal diagrams from the Control Builder ......................................... 284
15.3 Configuring Signal Diagram colors.................................................................................. 285
15.3.1 To access the Signal Diagram Viewer Configuration window ........................... 285
15.3.2 To change the default Signal Diagram colors .................................................... 287
15.3.3 Configuring General Diagram colors .................................................................. 288
15.3.4 Configuring digital signal and algorithm colors .................................................. 290
15.3.5 Configuring non-digital signal colors .................................................................. 292
15.3.6 Configuring non-digital algorithm colors ............................................................. 293
15.3.7 Configuring signal point value labels ................................................................. 295
15.3.8 Configuring point quality tags ............................................................................. 297
15.3.9 Configuring point scan rates .............................................................................. 298
15.4 Opening a sheet in the Signal Diagram window ............................................................. 299
15.4.1 To open a sheet in the Signal Diagram window................................................. 300
15.4.2 To refresh the Open Document hierarchy tree .................................................. 300
15.4.3 To search for a sheet in the Open Documents window ..................................... 301
15.5 Understanding the Signal Diagram Navigation toolbar and menu .................................. 302
15.5.1 Navigation toolbar .............................................................................................. 302
15.5.2 Navigation menu ................................................................................................ 304
15.6 What is the Signal Diagram display canvas? .................................................................. 305
15.6.1 Viewing algorithm information in a Signal Diagram window .............................. 306
15.6.2 Understanding when online graphics and control are mismatched ................... 307
15.6.3 Understanding colors on the Signal Diagram display canvas ............................ 308
15.6.4 Understanding icons on the Signal Diagram display canvas ............................. 309
15.6.5 To display algorithm and point information using the right-click menu .............. 310
15.6.6 To display an additional Signal Diagram window............................................... 311
15.6.7 To display a specific version of a sheet ............................................................. 313
15.6.8 To explode a macro on a Signal Diagram window ............................................ 313
15.7 What are the Signal Diagram windows? ......................................................................... 314
15.7.1 Using the signal diagram Event Log window ..................................................... 315
15.7.2 Using the signal diagram Algorithm Summary window ...................................... 316
15.7.3 Using the signal diagram Function Summary window ....................................... 317
15.7.4 Using the signal diagram Algorithm Control window ......................................... 319
15.7.5 Using the signal diagram Properties Summary window to tune algorithms ....... 320
15.7.6 Accessing the signal diagram window right-click menus ................................... 321
15.7.7 To use the Event Log right-click menu............................................................... 321
15.7.8 To use the Algorithm Summary window and Function Summary window
right-click menus ................................................................................................ 322
15.8 Tuning algorithms ............................................................................................................ 323
15.8.1 To tune algorithm parameters ............................................................................ 323
15.9 Viewing SIS Tuning windows for SIS algorithms ............................................................ 324
15.9.1 To access the SIS Tuning window for SIS algorithms ....................................... 324
15.9.2 SIS Tuning window for the LSCALC algorithm .................................................. 325
15.9.3 SIS Tuning window for the LSCEM algorithm .................................................... 326

viii OW350_80
Table of Contents

15.9.4 SIS Tuning window for the LSSEQ algorithm .................................................... 328
15.9.5 SIS Tuning window for the LSSTD algorithm..................................................... 330
15.10 Forcing an algorithm input value ..................................................................................... 331
15.10.1 To force an algorithm input value ....................................................................... 332
15.10.2 To set a new forced algorithm input value ......................................................... 336
15.10.3 To clear the force value and leave Debug Mode ............................................... 338
15.11 Reconciling tuning changes in a Windows-based Ovation system ................................. 341
15.11.1 To reconcile tuning changes between the Controller and the database for
Windows-based Ovation systems ...................................................................... 341
15.11.2 To reconcile tuning changes between the database and the Control Builder ... 342
15.12 What is the Ladder Viewer? ............................................................................................ 344
15.12.1 To access the Point Menu from the Ladder Viewer ........................................... 344

16 Viewing sheets on a remote network 345


16.1 What is Ovation multiple networking? ............................................................................. 345
16.1.1 Understanding multiple network terminology ..................................................... 345
16.2 Using the online sync program to synchronize signal diagrams from remote networks . 346
16.2.1 To configure the online sync program to synchronize signal diagrams on remote
networks ............................................................................................................. 347
16.3 Viewing sheets from a remote network on a local Signal Diagram window ................... 348
16.4 Accessing sheets from a remote network from a Point Menu ........................................ 349
16.5 Making configuration changes to view sheets from a remote network ........................... 350
16.5.1 To copy files from a remote network to a local network ..................................... 351
16.5.2 To run the cbLoader program ............................................................................ 353

17 Understanding Safety Instrumented Systems (SIS) 355


17.1 What is a Safety Instrumented System? ......................................................................... 355
17.2 Functions of Ovation SIS ................................................................................................ 356
17.3 What is the role of the Control Builder in a Safety Instrumented System? ..................... 357
17.4 Best practices for using SIS algorithms on a sheet ........................................................ 357
17.5 Creating a new SIS sheet ............................................................................................... 358
17.5.1 To add an SIS control sheet to the SIS Ovation system .................................... 359
17.6 Opening an SIS sheet in the Control Builder .................................................................. 360
17.6.1 To open an SIS sheet in the Control Builder...................................................... 360
17.7 Adding SIS algorithms to a sheet .................................................................................... 361
17.7.1 To add an SIS algorithm to a control sheet........................................................ 361
17.7.2 To add an extended algorithm tag for the LSCALC algorithm ........................... 363
17.8 Understanding SIS algorithms with advanced editor windows ....................................... 365
17.8.1 To access the LSCALC advanced editor window .............................................. 365
17.8.2 To access the LSCEM advanced editor window ............................................... 366
17.8.3 To access the LSSEQ advanced editor window ................................................ 368
17.8.4 To access the LSSTD advanced editor window ................................................ 370
17.9 Using Nonsecure parameter algorithms ......................................................................... 372
17.10 Using Secure parameter algorithms ............................................................................... 372
17.11 Connecting SIS sheets .................................................................................................... 373

OW350_80 ix
Table of Contents

18 Understanding tracking 375


18.1 What is tracking? ............................................................................................................. 376
18.2 What is the purpose of tracking?..................................................................................... 376
18.3 What is the tracking process? ......................................................................................... 377
18.4 What are the best practices for using tracking? .............................................................. 378
18.5 What algorithms support tracking?.................................................................................. 379
18.6 Tracking examples .......................................................................................................... 381
18.7 Setting tracking signals for algorithms ............................................................................ 382

19 Using ladder control logic 385


19.1 What types of ladders does the Control Builder support? .............................................. 385
19.2 What items are used in ladders?..................................................................................... 385
19.3 What are free-form ladders? ........................................................................................... 387
19.3.1 What are the rules for using free-form ladder elements? .................................. 387
19.3.2 To build a free-form ladder using ladder elements ............................................ 387
19.3.3 To extend an orbar or a rail ................................................................................ 388
19.4 What are 7 x 9 ladders? .................................................................................................. 389
19.4.1 Executing a 7 x 9 ladder ..................................................................................... 390
19.4.2 Compressing a 7 x 9 ladder ............................................................................... 391
19.4.3 What are the best practices for designing a 7 x 9 ladder? ................................. 392
19.4.4 To add a 7 x 9 ladder to a control sheet ............................................................ 392
19.4.5 To edit a 7 x 9 ladder ......................................................................................... 393
19.4.6 To add a special function to a 7 x 9 ladder ........................................................ 394
19.4.7 To add contacts, coils, and wires to a 7 x 9 ladder ............................................ 395
19.4.8 To use the check point function for 7 x 9 ladders .............................................. 395
19.4.9 To export a ladder file for 7 x 9 ladders ............................................................. 396
19.4.10 To import a ladder file for 7 x 9 ladders ............................................................. 396
19.4.11 To erase cells in the Ladder window for 7 x 9 ladders ....................................... 396
19.4.12 To use the Select All function on the Ladder window for 7 x 9 ladders ............. 397
19.4.13 To use the Deselect All function on the Ladder window for 7 x 9 ladders ......... 397
19.5 To audit a ladder ............................................................................................................. 397

20 Information and error messages 399


20.1 What is the Control Builder Error List window? ............................................................... 399
20.2 Error List window and field descriptions control builder error messages and descriptions
and more descriptions ..................................................................................................... 399
20.3 Control Builder error message descriptions control builder error messages and
descriptions ..................................................................................................................... 400

x OW350_80
Table of Contents

21 Using the Control Builder Scripting Facility 405


21.1 What is the Control Builder Scripting Facility? ................................................................ 405
21.2 Executing the xml file ...................................................................................................... 406
21.3 Format of the XML file ..................................................................................................... 406
21.4 AddAlgorithm ................................................................................................................... 408
21.5 AddFunction .................................................................................................................... 409
21.6 AddLine ........................................................................................................................... 410
21.7 AddPin ............................................................................................................................. 411
21.8 AddSegment.................................................................................................................... 412
21.9 AddSignal ........................................................................................................................ 413
21.10 AddText ........................................................................................................................... 414
21.11 BreakTracking ................................................................................................................. 415
21.12 OpenFunction .................................................................................................................. 416
21.13 RouteSignal ..................................................................................................................... 417
21.14 SelectAlgorithm ............................................................................................................... 418
21.15 SetValue .......................................................................................................................... 419
21.16 Example 1 of Control Builder Scripting Facility file - AddFunction root element ............. 419
21.17 Example 2 of Control Builder Scripting Facility file - Openfunction root element ........... 420

Index 421

OW350_80 xi
S E C T I O N 1

1 Introduction to Ovation Control Builder

IN THIS SECTION

What is Ovation control? ..................................................................................................... 2


What types of control are supported in Ovation? ................................................................ 3
What is the Ovation Control Builder? .................................................................................. 4
What is the role of the Control Builder in Ovation? ............................................................. 5
What are the software platforms that the Control Builder supports? .................................. 6
Control Builder terminology ................................................................................................. 6

OW350_80 1
1.1 What is Ovation control?

1.1 What is Ovation control?

An Ovation control system is an advanced process control system that controls industrial plant
processes. Ovation control systems are typically used by utility companies and waste water
companies to control the entire processes of the plant in real time with accurate precision.

WARNING! This process management is accomplished by sophisticated hardware and


software working together to provide information and guidance between field devices out in the
plant and an Ovation Controller. Ovation control systems use either discrete logic (digital) or
continuous modulating control (analog) to send the commands from the Controller to the
devices.

The devices in the plant monitor processes and make changes to the process as needed. These
changes might be to open a valve, close a switch, or sound an alarm. Each monitored process is
based on pieces of data (known as process points) that carry information about the process
throughout the Ovation system. These points carry the current value of the process variable (for
example, temperature, pressure, or volume) from the devices to the Controller.

The Controller in the plant is typically a control cabinet that contains Input and Output modules
that connect to the field devices, usually by wires. These modules monitor each device for any
change in the device’s condition. When a change is detected (input), the Controller reads the
change and tells the device (output) to perform an action that the Controller decides is
appropriate.

This action has been programmed into the Controller by control sheets (also known as functional
drawings) that are created in the Ovation Control Builder. The Control Builder sheets consist of
building blocks (algorithms) arranged in a logical pattern that defines in detail what action should
be taken when certain events occur in a device. These algorithms are linked by signals and can
represent a simple two-step process or a complex process made up of many algorithms
contained on many sheets.

The Ovation control systems consist of three elements: input, control logic, and output.
 Input consists of analog or digital signals collected from field devices. These devices control
some physical operation in the field.
 Control logic is created in the Control Builder and processes the input information and
determines which output functions should be activated.
 Output consists of analog or digital signals defined by the control logic and sent out to
activate the appropriate field devices.
These elements of control can be displayed to the user as graphics, instead of complex
programming commands. These graphics provide a user-friendly representation of the strategy.
Control can then be monitored and modified from these diagrams (in real time) by tuning the
constants, logic, and control schemes.

2 OW350_80
1.2 What types of control are supported in Ovation?

1.2 What types of control are supported in Ovation?

Ovation supports various types of control. The control type that you choose to run a process
depends on the device that you want to control and what type of output is required from the
process. You must choose algorithms that are designed to perform the various types of control
carefully before you add them to the control sheet.

The following control types account for most of the possible Ovation control schemes.
 Sequential Control (digital).
Sequential control is “instantaneous” in response time if the proper conditions exist (that is,
when the input occurs, usually the output follows immediately). For example, when an
operator presses the button to start a pump, the pump either starts or it does not. The various
types of sequential control are:
 Boolean - AND, OR, NOR logic. Output = on or off; 1 or 0; yes or no.
 Ladder logic - Similar to Boolean. Simulates electrical relay system.

Note: Ovation supports ladders created in WDPF systems and migrated to Ovation systems;
however, ladders typically are not used in the design and implementation of new control logic in
an Ovation system.

 Continuous Modulating Control (analog).


Modulating control is not “instantaneous” in response time. It occurs over a given time period.
Typically, an operator defines a desired value for a process and the control system works to
attain that value. For example, when the desired level or “set point” for a tank is set by the
operator, the system cannot obtain that level instantaneously. It takes time to either raise or
lower the level until it matches the set point. The various types of modulating control are:
 PID Control - Proportional, integral, and derivative. Output = results of PID equation.
 Lead/Lag functions - Nonlinear lead/lag control. Output = function of old output, old input,
new input, gain, and lead/lag time constants.
 Hi/Low/Medium select - Measures and compares inputs.
 Rate of change limit - Rate of change in input. Output = rate sampled every second.
 Total, average, weighted averages - Measures and calculates inputs. Output = sum or
average of inputs.
 Sample and hold - Mathematical calculations of sample inputs.
 Mathematical functions - Sine, Cosine, Sum, Divide, Log, and so forth.
 Operator Station functions - Keyboard, MA Station.
 Adaptive and auto tuning control - Dynamic functions.
 Advanced Control
Advanced control uses sophisticated algorithms that can “adapt” control strategies to meet
the control process requirements. This type of control is typically used for the following:
 Equipment startup.
 Demineralization.
 Optimal valve settings.
 Plant performance, Opacity, and Low NOx optimization.
 Advanced sootblowing.

OW350_80 3
1.3 What is the Ovation Control Builder?

1.3 What is the Ovation Control Builder?

The Ovation Control Builder is a graphical editor that creates the control logic that runs in the
Ovation Controller. This logic consists of algorithms that are placed on functional drawings (also
known as control sheets) and direct the control strategy for the Ovation system. Typically, there
are many different control sheets linked together to form the complete control structure for an
Ovation system.

The Control Builder application consists of three main areas or windows:


 Main window with the drawing canvas (see page 34).
 Object Browser (see page 49).
 Property Editor (see page 56).
Each window has a different function, but they all work together to give you a complete picture of
your control. In general, items such as inputs, algorithms, signals, and so forth appear on the
drawing canvas, which provides the visual display of the sheet. Any item that you place on the
drawing canvas is put into the hierarchy in the Object Browser. The Object Browser shows the
relationships between the items placed on the drawing canvas. The Property Editor is used for
editing the attributes of the items found on the drawing canvas and in the Object Browser.

Since the three main areas of the Control Builder give you a different perspective on your control
function, there are many ways to perform various tasks. This makes the application flexible and
easy to use since you choose which way is best to perform a certain function.

All Control Builder windows are dockable and floatable. Dockable means it can be attached to
one of the sides of the main window. Floatable means it can be displayed as a pop-up window
with a title and a window close button in the upper right corner.

The following figure shows an example of how the Control Builder may look loaded with a control
function. Since the Control Builder application is flexible and configurable, you may move, resize,
or close windows in order to create more drawing space.

4 OW350_80
1.4 What is the role of the Control Builder in Ovation?

Figure 1: Control Builder main window

The following sections of this document discuss each area of the Control Builder application,
along with its menus and toolbars. Understanding how these main areas work together enables
you to use the Control Builder quickly and efficiently when creating various control functions.

In addition to the three main windows, the Control Builder uses other windows and dialog boxes
to design control functions. These windows are also discussed throughout the document.

1.4 What is the role of the Control Buil der in Ovation?

The Control Builder creates the control logic that runs in the Ovation Controller. In addition to
editing the control sheets containing the logic, the Control Builder facilitates the integration of the
logic into the Controller.

The logic that is created and edited by the Control Builder affects the Ovation database since the
database is modified to reflect the logic changes.

The actual editing by the Control Builder is done at an Ovation Engineering Station. Here, control
sheets, which are SAMA drawings, are created and edited by a control design engineer. These
sheets contain the various algorithms that are used in the control designs.

The drawings that are created at the Engineering Station can be displayed at an Operator Station
through signal diagrams. Here, an Operator can monitor the systems that are displayed and
perform certain tuning functions.

OW350_80 5
1.5 What are the software platforms that the Control Builder supports?

1.5 What are the software platforms that the Control Builder
supports?

The Control Builder is designed to run on both Windows-based and Solaris-based Ovation
systems. In general, functionality remains the same for both platforms. However, where
differences exist between the platforms, information is specifically labeled "for Window-based
systems" or "for Solaris-based systems."

Note that where functionality is the same for both platforms, this document uses Windows-based
graphics.

1.6 Control Builder terminology

The following terms and descriptions are associated to Ovation control systems and may help you
understand the Ovation Control Builder.

Control Builder terminology

TERM DESCRIPTION

Algorithms Set of rules, procedures, and mathematical formulas that define a control strategy.
(See Ovation Algorithms Reference Manual.)
An algorithm does not have a name; it is a collection of points and is identified by
the Algorithm Control Record.
Aperiodic Points These are points whose values are scanned “as needed” or “as requested.” See
also Periodic Points.
Asynchronously Performed at different times. For example, control tasks operate asynchronously.
Batch Processing or Performs same operation on multiple control sheets.
Run Scripts
Component Code Text strings that represent a sheet's or document's location in a folder structure or
hierarchy.
Configuration Tool Software function used to configuration parameters for the Ovation system. For
Ovation Windows systems, the configuration tool is the Developer Studio.

Control Function Drawing that contains a graphical representation of a control scheme.


(also known as a
control sheet or
functional drawing)
Control Task Refers to a specific Controller area where all the control sheets in that area are
scanned at the same frequency. Up to five control tasks can be defined.
(also known as Set
or Area) All the sheets in the Control Task 1 area are scanned every 0.1 second or 100
milliseconds (also known as fast time).
All the sheets in the Control Task 2 area are scanned every 1 second or 1000
milliseconds (also known as slow time).
The scan times for sheets in Control Task 3, 4, and 5 are user-defined.
Points are grouped by control tasks so they can be updated (scanned) at different
rates. The rate is set in the applicable Ovation configuration tool during configuration
for a Controller drop.
It is recommended that third-party points have their own task area and their scan
rate should be no faster than one second because of communication overhead.

6 OW350_80
1.6 Control Builder terminology

TERM DESCRIPTION

Cycle Time interval during which the scanning of inputs, execution of algorithms, and the
transmission of output values to devices occur.
Deadband The range of values through which an input signal may vary without initiating an
action of causing an observable change in the output signal.
Database Contains information about the system configuration, the system points, and control
strategies.
Default Points Points created by OCB that have the following naming convention:
(see also User- OCBssssaaa-pppp, where:
Defined Points)
ssss = Unique sheet identifier (Hex)
aaa = Unique algorithm identifier (Hex)
pppp = Parameter mnemonic (for example, OUT)
Discrete Control Control where inputs, algorithms, and outputs are based on logical values (yes/no,
on/off, or 0/1).
Distributed Database Contains a subset of the information stored on the Master Database and is stored
locally on a drop to allow that drop to operate if the Master Database is unavailable.
A Distributed Database is present on each drop in the system and is continually
updated as point information changes.
Hyperlinks Mechanism for linking sheets and documents to each other.
Interlocks Interlocks are the situations where the status of a device is affected by the status of
another device. For example, if the temperature in a water tank increases, a valve
opens. When the valve opens, a switch closes. Interlocks are often used as safety
precautions when planning a control strategy.
Macro A user-defined control strategy, with clearly defined inputs and outputs. Even though
a macro typically consists of several algorithms, it is represented in a functional
drawing as a single user-defined algorithm.

Master Database Contains the entire process database. It is used for creating, modifying, and
verifying control strategies and process points. At runtime, it supports queries of the
process database, captures changes made to control and point attributes, and
propagates those changes to the distributed databases.
Mode Control block operational condition, such as manual, automatic, or cascade.

Object Browser Control Builder window that shows the relationships between the items placed on
the drawing canvas.
Originated Points Points that were created in the current drop. For example, Drop 202 refers to all
points that were created in Drop 202 as originated points.
Periodic Points These are points whose values are scanned periodically at a defined frequency
such as 0.01 of a second. See also Aperiodic Points.
Plant Area Designated points (inputs, outputs, and calculated values) that belong to a
geographical or functional section of a plant.
Point Process variable derived from an input signal or calculated in a process calculation.
Property Editor Control Builder window that is used for editing the attributes of the items found on
the drawing canvas and in the Object Browser.
Received Points Points that were not created in the current drop. For example, Drop 202 refers to all
points that were created in Drop 210 as received points.
Redundant Pair When Control information between a pair of redundant Controllers is different.
Mismatch

OW350_80 7
1.6 Control Builder terminology

TERM DESCRIPTION

Regulatory Control Functions of control (process measurement, algorithm execution, and final control
device manipulation) that provide closed loop control of a plant process. For
example, an operator defines a value for a process setpoint, and the control process
adjusts until it achieves that setpoint.
Safety Instrumented A set of components that includes sensors, Logic Solvers, and final control elements
System (SIS) whose purpose is to respond to plant conditions, which may be hazardous. A project
must purchase a Safety Instrumented System in order to access the SIS algorithms.
Scratchpad Temporary library file.
Signals Lines connecting algorithms on a sheet. Signals start from an algorithm output pin
and connect to one or more algorithm input pins. They are comprised of one or more
segments.
Signal Diagram Ovation Operator Station application that monitors or tunes a control process.
Signal Doughnut Circle representing multiple downstream connections.
Signal Junction Where two or more signal segments connect. If more than two signal segments
connect, a signal doughnut is visible.
Signal Segment Primary building block of a signal. Straight line with a start point and an end point.
Supervisory Control Higher level control functions that interface with regulatory control functions. For
example, an Advanced Control process outside the control loop defines a value for a
process setpoint, and the control process adjusts until it achieves that setpoint.
Supplemental Any documents that do not have control associated with them. There is no algorithm
Documents folder attached to the document. Examples of supplemental documents include
Microsoft Word files, pdf files, and Control Builder simple graphic .svg files.
Tracking Exchange of information between different control strategies (for example, going
from manual to automatic mode).
User-Defined Points Points created by you through the Ovation Developer Studio (Windows systems).
Do NOT begin these point names with OCB.
(see also Default
Points)
Zoom Changes magnification (larger or smaller) of objects or of complete drawings.

8 OW350_80
S E C T I O N 2

2 Planning and Designing Ovation Control

IN THIS SECTION

What are the best practices for planning control? ............................................................... 9


What is the control planning process? .............................................................................. 10
Using diagrams in planning control ................................................................................... 11
What is storyboarding for control? .................................................................................... 13
Planning for system expansion ......................................................................................... 14
What are the best practices for designing control? ........................................................... 15
Defining the control application ......................................................................................... 16
Defining the system I/O ..................................................................................................... 17

2.1 What are the best practices for planning control?

Before you begin to plan your control strategies, there are some control building best practices
that provide for simpler and more effective implementation of your control logic:
 Organize the control project before you install any system hardware or software.
Collect similar devices into virtual groups and then define the unique devices. For example, all
pumps might be in a group, but the oil pumps would be unique pumps. All pumps could have
the same basic control scheme, but the oil pumps would have special control issues that
would require additional control logic.
 Rework is time consuming. Carefully consider your goals before you commit your control
schemes to a control sheet.
 Identify algorithms correctly from the beginning of your control plans. If algorithms are not
correctly identified, you will need to perform rework to avoid inconsistencies and rework is
always difficult and costly.
 Spend time reviewing the P&ID drawings and determining how you should map the database
points (process points) to the processes that you want to control.
 Determine what types of sensors will be used in the field.
 Define what inputs and outputs need to be monitored. How will interlocks be handled?
Interlocks are the situations where the operation of a device is affected by the status of
another device. For example, if the temperature in a water tank increases, a valve opens.
When the valve opens, a switch closes. Interlocks are often used as safety precautions when
planning a control strategy.
 Plan to use some form of simulator to test the control logic as you create it. Avoid testing the
logic on a running plant whenever possible.
 Minimize signal crossing in your drawings to avoid confusion where lines meet and cross.
 Use tags where ever possible for any dynamic analog values for algorithms. Comments do
not dynamically update.

OW350_80 9
2.2 What is the control planning process?

 Remember the basic concepts of how changes to control sheets are saved to the database
by the Control Builder:
 If a sheet is open when a change is made to the sheet, the sheet is master, and the
changes are saved to the database from the sheet.
 If a sheet is closed when a change is made, the database is master, and the changes are
saved to the sheet from the database.
 The Control Builder configuration file is always the master, and any changes made to it
are saved to the sheet and to the database.

2.2 What is the control planning process?

When you must plan a control procedure, there is a best practice process that helps to ensure
that the final outcome of the process will be a successful control scheme. The following
information lists the steps used in this planning process. Additional information about each step is
provided where indicated:

Note: This process assumes you are a proficient process control engineer or the equivalent.

1. Investigate the contemplated process and determine what functions you need to control and
what would be the best way to accomplish that control.
2. Storyboard the process. This involves breaking the entire control scheme into smaller and
more manageable pieces with each piece containing distinct functionality.
3. Separate the control into the Controller that has the I/O associated with that Controller.
4. Construct any standardized control for the system so that it can be used numerous times
throughout the system.
5. Test the standardized control before reproducing the control for each associated device.
6. Build the control and load the Controller.
7. Test the control sheets in an offline Simulator environment.
8. Commission or tune the sheets in the field to ensure all the control processes work as
planned.

10 OW350_80
2.3 Using diagrams in planning control

2.3 Using diagrams in planning control

You need to plan control carefully before you begin creating control sheets. Planning actually
begins before a plant is even constructed or upgraded. Plant engineers or Architectural Engineers
(AEs) typically meet with Emerson representatives to discuss the control needs of the system and
the best control techniques to meet those needs. For example, how much power must a power
plant produce during peak times and what types of emissions must be controlled during those
times? You must consider and address questions such as these, plus many more complex
questions, before actual control schemes are developed and implemented.

At the beginning of the planning process, you should collect and study diagrams from the plant to
help determine the control schemes that are needed to operate the plant processes. Next, a joint
effort between plant and Emerson engineers is employed to create and populate the system
database.

Since a plant may have hundreds of devices that need to be controlled, many control sheets will
be produced and the more planning that is done before those sheets are created, the more
efficient the control creation process will be.

Planning for good control is based on many factors and includes the understanding and usage of
the following topics:
 Piping and Instrumentation Diagrams.
 Oil Diagrams.
 Plant Schematics:
 Electrical Drawings.
 Control Wiring Drawings (CSDs).

OW350_80 11
2.3 Using diagrams in planning control

2.3.1 What are piping and instrumentation diagrams (P&ID)?

Planning control typically begins when the plant provides P&ID (Piping and Instrumentation
Diagrams) drawings to the engineering staff that will be creating the control. These diagrams are
actual drawings of all the proposed functions in the plant that must be controlled by the control
system.

Sometimes a plant may only provide Process Narratives which are text files that describe in detail
what plant processes need to be implemented and monitored. If there are no P&ID drawings,
Emerson uses the Narratives to create the control schemes.

Along with the P&ID drawings, the plant also provides the database that will be used to identify all
the elements in the system that need to be managed by the Ovation control system. This
database might be in the form of a text file, a DBASE file, or spreadsheets. After the elements on
the P&ID drawings are matched to the database point names, then control design can be started.

The following figure is an example of a section of a P&ID drawing.

Figure 2: Example of P&ID drawing

2.3.2 What are oil diagrams?

Oil diagrams, contain locations of inputs and outputs and other process information for the piece
of equipment being controlled.

Plants often use machinery that must be controlled and managed through a process control
system. This machinery may be equipment such as turbines, grinding mills, pumps and valves.

Some of these products provide diagrams or schematics that can be used to help determine the
requirements for the control process. These diagrams, often referred to as Oil diagrams.

The control design engineer can combine the P&ID diagrams with the Oil diagrams in order to
visualize and better understand the control requirements for the system equipment.

12 OW350_80
2.4 What is storyboarding for control?

2.3.3 What are plant process schematics?

Many types of schematics are created for the processes of a plant. These drawings are used by
the control engineers to plan the control schemes that are represented by the associated
processes. Some of these schematics are the electrical drawings and the Control Wiring
Drawings. Different processes may require additional types of schematics.

The following figure is an example of a section of a schematic drawing.

Figure 3: Example of schematic drawing

2.4 What is storyboarding for control?

Storyboarding (also know as block diagramming or modeling) is commonly done in many


industries, such as advertising, films, literature, and construction. It can also be used in designing
process control. Storyboarding provides a visual method of illustrating a process without the
actual creation of the process. It is during this process that potential mistakes can be identified
and easily corrected.

Storyboarding the control is the practice of designing the control before you create the control
sheets. Each control design engineer has his own approach to storyboarding. Some use sticky
notes, some use paper and pencil, and some use a software package. Whatever is most
comfortable for you is the approach that is best for you.

Some of the concepts that can be illustrated through storyboarding are listed below:
 Determine what types of user interfaces are desired:
 Setpoint control.
 Off/On choices.
 Auto/Manual selection.
 Segment the various control functions:
 Separate self-contained control functions.

OW350_80 13
2.5 Planning for system expansion

 Minimize off-page functions.


 Block out the algorithms that will be used:
 Analog and digital algorithms.
 Analog and digital algorithms can be mixed on a sheet.
 Logically group functions (for example, put all the temperature logic on a sheet).
 Analog signals flow top to bottom.
 Digital signals flow left to right.
 Layout the sheets:
 Allow room for descriptions for top and bottom signals.
 Provide descriptions that allow you to trace logic destinations.
 Implementation will be simpler if the BALANCER algorithm and all the downstream balanced
algorithms are on the same sheet.
 Segregate the control that is used in a specific Controller drop.

2.5 Planning for s ystem expansion

An Ovation Distributed Control System is designed for future expansion. You can expand your
Ovation system by adding the following:
 Hardware cabinets containing I/O modules.
 Input/output points and local/remote I/O.
 Programmable Logic Controllers (PLCs).
 Operator Station, Engineer Station, and Controller drops.
 Peripherals.
 Control loops.
 Sequential control (ladders, Boolean).
 Data acquisition functions.
 Regulatory and supervisory control.
Typically, the future plans for a system are known in advance. This knowledge makes it easier to
add control by following these guidelines:
 Use a modular approach to develop your control logic. This enables you to easily reuse
portions of the logic in future control schemes. It is also easier to troubleshoot logic that is
made up of modules instead of one long extensive function.
 Create blank control sheets between functions so you can easily add to your control plan.
 Make sure that there are enough points created so you can expand your system as needed.
 Remember to consider:
 Memory allocation for control tasks. If a task is filled, the Controller must be downloaded,
cleared, and loaded to extend the space.
 Point limitations.
 Licensing limitations for adding new drops.

14 OW350_80
2.6 What are the best practices for designing control?

2.6 What are the best practices for designing control?

Spending the time to design your control before implementation saves time and frustration for
your current project and enables you to reuse the control in future projects.

By laying out the design for the control, you create a comprehensive and consistent picture of
how the control functions throughout the system. Your control scheme will be better organized
and the inputs and outputs will be clearer.

Using consistency in the design of control sheets helps to ensure that all engineers involved in the
control system can understand any control sheet in the plant. If every designer uses the same
design process, then any changes that need to be made can be done easily with a minimum of
questions and confusion.

Before you begin to design your control strategies, there a few control building best practices that
you should follow:
 Do not force too much control strategy on one sheet. Spread it out so it can be easily read,
understood, and modified.
Troubleshooting a sheet is much easier if the information about the sheet is well organized
with enough space for changes and additions.
 Segment the various control functions.
 Separate self-contained control functions.
 Minimize off-page functions.
 Block out the analog and digital algorithms that will be used:
 Logic is executed in ascending order of the algorithm numbers that are assigned in a
sheet. Typically, build logic from top to bottom and left to right. You need to review the
execution order and override it, as needed.
 Logically group functions (for example, put all the temperature logic on a sheet).
 You can mix analog and digital algorithms on a sheet.
 Analog signals should flow top to bottom. As much as possible, all inputs should be
brought in on the extreme top of the sheet. Outputs should be extended to and shown
on the extreme bottom of the sheet. The logic should be drawn from top to bottom.
 Digital signals should flow left to right. As much as possible, all inputs should be
brought in on the extreme left of the sheet. Outputs should be extended to and shown
on the extreme right of the sheet. The logic should be drawn from left to right.
 Allow room for descriptions for all signals.
 Provide descriptions that allow you to trace logic destinations.
 Implementation will be simpler if the BALANCER algorithm and all the downstream balanced
algorithms are on the same sheet.
 Segregate the control into specific Controllers based on hardware and available points.
 Logic segments that have multiple interlocks should be on different sheets. Segments that do
not have multiple interlocks can be mixed on one sheet.
 Typically, tracking from algorithms that have a single track output is out of the IN1 line.

OW350_80 15
2.7 Defining the control application

2.7 Defining the control application

At the beginning of a control project, the proposed system control must be identified. This is done
by using written descriptions, logic drawings, control drawings, plant personnel, and Emerson
personnel. This information is used to plan the control, the graphics for the Operator interface and
the tuning graphics for the Ovation-to-plant interface.

2.7.1 What is the scope of your control project?

There are many processes in a plant that you need to control. Some possible functions of the
system that you will control are listed below:
 Combustion control.
 Turbine control.
 Burner management.
 Flue gas desulphurization.
 Water treatment.
 Ash handling.
 Coal handling.
 Limestone handling.
 Soot blowing.
 Motor control logic.
 Data acquisition.
 Annunciation.

2.7.2 Subdividing your control application

After the control scheme has been defined, the main control application should be subdivided into
smaller applications. In these smaller applications, the control logic is executed in multiple
Controllers. This approach is easier to troubleshoot and to run the wiring between the cabinets
and the actual field devices.

When dividing the control application, note the following:


 Keep the sub-applications grouped by function.
 Control or logic outputs should be in the Controller where the control is executed.
 Minimize the control signals that must be passed over the network.
 Always keep any fail-safe considerations in mind when planning the design.
 Put the applicable I/O in a cabinet closest to the related field device.

16 OW350_80
2.8 Defining the system I/O

2.8 Defining the s ystem I/O

The Ovation Distributed Control System provides modulating control, sequential control, and data
acquisition for a variety of system applications. This system consists of a configurable mix of
functional Input/Output (I/O) modules that communicate on the I/O bus to the Ovation Controller.

I/O modules provide an interface between the Ovation Controller and the processes in the plant.
Ovation I/O modules are “plug-in” components with built-in fault tolerance and diagnostics. They
are able to operate on a wide range of signals and perform a multitude of functions.

The Ovation I/O modules are locked into base units. These base units are housed in the
Controller cabinets where they are mounted on DIN rails and wired to the appropriate field
devices.

The standard modular components typically consist of the following:


 Electronics module
 Personality module
 Base Unit (containing the field terminations)
The relay output modular components consist of the following:
 Electronics module
 Base Unit (containing the field terminations)

2.8.1 Creating Ovation cabinets

Once the system has been planned and the I/O defined, the actual hardware cabinets can be built
and configured with modules. This process is begun by creating a Bill of Materials (BOM) for the
cabinets and the modules that will be contained in the cabinets. This hardware process is
discussed in detail in several Ovation manuals. (See Planning Your Ovation System and Ovation
I/O Reference Manual.)

The modules contained in the cabinets must be configured through the software in the Ovation
I/O Builder. Until the modules are defined in the I/O Builder, I/O points cannot be assigned to the
modules.

2.8.2 Defining the I/O modules

The following hardware reference information may be useful when defining I/O modules in the
Ovation Developer Studio. The information is for reference purposes only.

The modules are defined and configured through the Ovation Developer Studio hierarchy. (See
Ovation Developer Studio User Guide.)

Before the I/O Devices folder can be used to define the I/O hardware, a plan should be designed
that lists the I/O needed for your Ovation system. After the plan has been designed, this
information is entered into the I/O Devices folder to define the I/O for your Ovation system. I/O
Devices are defined individually for each drop.

During configuration, I/O modules and remote nodes are assigned point names by the system to
identify the elements to the Ovation database. For more information on planning your system I/O,
see Planning Your Ovation System.

OW350_80 17
S E C T I O N 3

3 Understanding basic Control Builder concepts

IN THIS SECTION

What are Ovation control functions (control sheets)? ....................................................... 19


What is a control task area? .............................................................................................. 20
Numbering control sheets ................................................................................................. 21
What is the Control Builder frame? ................................................................................... 23
Understanding how the Control Builder searches in Windows-based Ovation systems .. 26

3.1 What are Ovation control functions (control sheets)?

An Ovation control function (control sheet) is a graphical representation of the control logic that is
used by the Ovation system to control the processes in a plant.

Note: Throughout this manual, control functions are also referred to as control sheets, functional
drawings, or files.

The Control Builder creates control sheets and then sends them, as needed, to the Controller. Up
to 1500 control sheets can be maintained in one Controller. The sheet also exists as a graphic file
and has a file name extension of .svg. An example of a control sheet name would be 2250.svg.

The Controller uses the sheets to control and adjust the system processes as needed. These
sheets consist of building blocks (algorithms) arranged in a logical pattern that defines in detail
what action should be taken when certain events occur in a device.

These algorithms (see page 123) on a sheet are linked together by signals to create a control
scheme. A control scheme can represent a simple two-step process or a complex process made
up of many algorithms contained on many sheets.

After these schemes are compiled and verified, they are loaded into the Ovation Controller. A
service running in the background downloads the sheets to the MMIs on startup and every few
minutes. Once sheets are downloaded, they can be used to execute control strategies in Ovation
systems.

OW350_80 19
3.2 What is a control task area?

3.2 What is a control task area?

One of the major features of the Ovation control system is the ability of the Controller to update or
scan the system’s process points at different intervals. This feature is available since the control
portion of a Controller is divided into five areas which are used to designate different scan times
for points. These areas are known as control tasks, but are sometimes referred to as Sets or
Areas.

A Controller can hold up to 32,000 total points depending on your hardware and software
configuration (including originated and received points), but no more than 2,000 I/O points can be
assigned to a specific task area. This means that points must be carefully assigned to control task
areas in order to ensure that all points are scanned and updated as needed. (See Ovation
Controller User Guide.)

If a point is used in several different sheets, make sure to select the number of the fastest task
area for the point. For example, if point A220 is used in three control sheets, one with a 1 second
scan, one with a 0.1 second scan, and one with a 20 millisecond scan, select the 20 millisecond
task area.

You can set the control task (task index) for the point in the applicable Ovation configuration tool.

The five control tasks consist of the following:


 Control Task 1 contains points that are scanned every 100 milliseconds (0.1 second). This is
a default area and is automatically assigned whenever a Controller drop is added to an
Ovation system. This scan time cannot be changed.
 Control Task 2 contains points that are scanned every 1000 milliseconds (1 second). This is
a default area and is automatically assigned whenever a Controller drop is added to an
Ovation system. This scan time cannot be changed.
 Control Tasks 3, 4, and 5 are user configurable and can be changed as needed.
Most control logic is assigned to the 1 second task area, but it is recommended that you store
safety critical logic in the 0.1 of a second task area.

Since control tasks operate asynchronously, execution orders for control actions can be
sequenced only for control actions for one control task area. Control actions cannot be sequenced
between control areas.

Each task area contains the control sheets that are scanned periodically based on the scan time
that has been configured for the task area. When planning control, it is important to configure the
control task areas so that each area has enough memory to handle all the sheets that are
assigned to it. For example, if Control Task 2 scans every second, it should contain only enough
sheets that can be scanned and updated every second. If too many sheets are inserted into
Control Task 2, then the Controller scanning process will not be able to successfully complete a
control task.

If a control task cannot be successfully scanned once, a warning message is sent to the Error Log
and the System Status Diagram shows the Controller is in alarm. A Fault Code is generated: Fault
Code 66, Fault ID 1, Parameter 1 = C, Parameter 2 = 13, Parameter 3 = number of scans missed.

If a control task cannot be successfully scanned for three consecutive times, the redundant
Controller fails over to its backup drop. A Fault Code is generated: Fault Code 66, Fault ID 1,
Parameter 1 = B, Parameter 2 = 7, Parameter 3 = Control Task Number.

20 OW350_80
3.2 What is a control task area?

Since the backup drop has the same control task settings as the drop in control had, the control
task scan will still not be successful. However, since the Controller now has no other drop to
failover to, the backup struggles to continue processing control, and continues to send messages
to the Error Log; however, it will not try to failover.

3.2.1 Control tasks cycle time

A duty cycle (execution) is the time that a process or task takes to complete. A control task
begins its process by reading the inputs from the field, performing the control as fast as it can,
and writing the outputs to the field. The task resides on control sheets that are located in a control
task. The control task area determines how frequently the task is begun. If the task completes
before the task area time frame is up, it waits until the time frame is completed, and then starts
again.

For example, a process is located in Control Task 2. This means that the task begins every 1000
milliseconds. However, the task completes every 500 milliseconds and so must wait 500
milliseconds until it starts again. So the duty cycle of the task is 500 milliseconds.

If the task in Control Task 2 completes every 1100 milliseconds, the drop goes into alarm and a
message is sent to the Error Log. If this occurred once, a warning message would be sent to the
Error Log, and the System Status Diagram would show the Controller is in alarm. The system
generates a fault code: Fault Code 66, Fault ID 1, Parameter 1 = C, Parameter 2 = 13, Parameter
3 = number of scans missed.

If this occurred for three consecutive times, the redundant Controller would failover to its backup
drop, a message would be sent to the Error Log, and the System Status Diagram would show the
Controller is in alarm. The system generates a fault code: Fault Code 66, Fault ID 1, Parameter 1
= B, Parameter 2 = 7, Parameter 3 = Control Task number (0 based; add one to the number to
determine the actual control task area).

The Ovation fault information tool describes fault codes and suggests possible user actions to
correct the fault. To access the Ovation fault information tool, log on to the Ovation/WDPF Users
site and click Fault Information Tool in the left hand menu. Or, enter the following URL to log on
to the fault information tool directly:

https://www.ovationusers.com/FIT/index.asp

If the problem continues for the backup drop that is now in control, since the backup drop has the
same control task settings as the drop in control had, the control scan would still not be
successful. However, since the Controller now has no other drop to failover to, the backup drop
attempts to continue processing control, and continues to send messages to the Error Log.
However, it does not try to failover.

This task information can be visually displayed in the Controller Diagnostics window using the
Processing Task Information tab. (See Ovation Controller User Guide for information on
Controller Diagnostics.)

OW350_80 21
3.3 Numbering control sheets

3.3 Numbering control sheets

The control sheets are numbered in two ways:


 Provided by the system
The system provides a unique number for each control sheet when it is created. This number
(also known as the Sheet ID) is a four-digit hexadecimal number that is used by the Ovation
database to keep track of all the control sheets in the system.
 Provided by the user
The user enters a number for each control sheet when it is created. This number is entered in
the Sheet number entry field on the Property Editor. Any alphanumeric string can be used.
This number is used to identify the sheet to the user. It is considered a best practice that each
sheet be unique, but that is not required.

22 OW350_80
3.4 What is the Control Builder frame?

3.4 What is the Control Builder frame?

Every control function, control library, and control macro begins with a template or blueprint that
displays on the drawing canvas. This template, called the frame, contains a standard format that
can be used to enforce a consistent look for all the items in a project. The format also contains
information that identifies the item (sheet, library, macro) to the system and to the user. By placing
this information in the frame, you do not have to enter it every time you create a new item.

The Control Builder provides an approved frame or template file, called the frame.svg file, which
is shipped with the standard release of the Ovation system. All of the elements of the frame are
defined in the frame.svg file.

The frame is composed of the following:


 A box around the entire drawing sheet.
 A grid on the drawing canvas. Note that you can toggle the display or removal of the grid by
pressing the keyboard combination of Ctrl + Shift + G.
 A group of smaller boxes in the lower right corner of the drawing sheet. This is known as the
title box (see page 98).
 The Emerson Process Management name and Proprietary Statement. The Proprietary
Statement can only be edited through the frame.svg file.
The following figure shows an example of a standard frame.

Figure 4: Example of standard frame in Control Builder

OW350_80 23
3.4 What is the Control Builder frame?

The larger box serves as a border around the entire drawing. The smaller boxes are used to
make the title box which provides a place to enter information about the drawing (title, drop id,
task id, sheet number, and so forth). Entering information in the title box is discussed in
Configuring information in title box fields (see page 98). The frame.svg file also includes the
information that applies to style, such as line with, font type, font size, etc.

You can view the contents of the frame for your sheet by selecting the Frame container on the
Object Browser window. Frame containers are used for control functions (sheets) and control
libraries. See the following figure:

Figure 5: Object Browser showing expanded Frame container

Notice that the Frame container contains all the elements that comprise the frame (lines for the
large and small boxes, static text and dynamic text). These elements are defined in the
frame.svg file. The contents of the Frame container cannot be modified. You must edit the
frame.svg file (see page 24) in order to change the frame's content. Comments for specific
diagrams should be added to the Comments folder.

3.4.1 To edit the frame.svg file

Sometimes a project may require a change to the frame.svg file. This may occur if a special logo
or a unique Disclosure (Proprietary) statement is desired on every sheet in a project.

1. Find the frame.svg file. Start at the Sheets folder and go up through the directory structure.
The first frame.svg file that you find is the one being used.
2. Make any changes as desired.
3. Save the file.

24 OW350_80
3.4 What is the Control Builder frame?

Another scenario may occur if you want sheets with different frame formats. In this case, you can
create a custom copy of the frame.svg file to use with different sheets. Once you create a new
frame.svg file, move the original frame.svg file to a higher level in the directory structure and
place the custom version at a lower level in the tree. This is done because the Control Builder
starts searching at the lowest level of the directory tree, and the first frame.svg file that it
encounters is the one it uses for the control sheets.

If you want multiple versions of the frame.svg file, place a separate copy of the file in each Unit
directory.

To make an additional copy of the frame.svg file:


1. Find the frame.svg file. Start at the Sheets folder and go up through the directory structure.
The first frame.svg file that you find is the one being used.
2. Copy the file and place it in the directory above the Sheets directory.
3. Rename the copy of the frame.svg file so that it can be distinguished from the original
frame.svg file.
4. Make any changes to the copy of the frame.svg file.
5. Save the file.

Note: If you want to add information to just one sheet, make any desired changes and place it in
the Comments container, not the Frame container. Additions or changes to the Frame container
affect every sheet that is below it in the directory hierarchy.

OW350_80 25
3.5 Understanding how the Control Builder searches in Windows-based Ovation systems

3.5 Understanding how the Control Builder searches in Window s -


based Ovation systems

It is important to understand how the Control Builder performs searches when looking for files in
the Ovation directory structure.

When searching for a file on the disk, the Control Builder search mechanism always starts at the
lowest level, which would be the Control Functions folder. Then it proceeds up the directory
structure until it gets to the top-level or root directory. If the Control Builder does not find the file
when it gets to the top directory, it then searches the Control Builder installation directory, which is
defined by the environment variable, CB_HOME.

By default, control functions are stored in a directory under the Unit directory. Store common
functions such as libraries, macros, and symbols at higher levels, such as the Network or System
level. In this way, these common items can be shared by many units.

Note: The Control Builder search function follows the actual disk storage structure. It does not
follow the system tree structure in the Ovation Developer Studio.

Understanding directory searching is also important when using the frame.svg file. Since
searching starts at the lowest level, the first frame.svg file that is encountered is the one used by
the control sheets. If you want to use a custom version of the frame.svg file for a project, move
the original frame.svg file to a higher level in the directory structure and place the custom version
at a lower level in the tree. If you want multiple versions of the frame.svg file, place a separate
copy in each Unit directory.

An example of the searching hierarchy from bottom to top is:


 Control Functions directory
 Unit -- Unit 0
 Network -- VAL5NT22
 System -- Val55y22

26 OW350_80
S E C T I O N 4

4 Accessing and configuring the Ovation Control


Builder

IN THIS SECTION

Accessing the Ovation Control Builder.............................................................................. 27


Configuring the Control Builder ......................................................................................... 28

4.1 Accessing the Ovation Control Builder

The Ovation Control Builder is a graphical editor that creates the control logic that runs in the
Ovation Controller. The Control Builder application consists of three main areas or windows:
 Main window with the drawing canvas (see page 34)
 Object Browser (see page 49)
 Property Editor (see page 56)
Each area has a different function, but they all work together to give you a complete picture of
your control function. This section discusses each area and how it helps you develop your control
strategy.

You can access the Control Builder from the applicable Ovation configuration tool.

4.1.1 To access the Control Builder in a Windows-based Ovation system


1. Access the Ovation Developer Studio (see Ovation Developer Studio User Guide for more
information).
2. Use the system tree to navigate to the applicable Control Sheets folder:
System folder
Network folder
Unit folder
Drops folder
<Controller drop> folder (applicable to the sheets that you want to delete)
Control Task folder (applicable to the sheets that you want to delete)
Control Sheets folder
3. Select Control Sheets.

OW350_80 27
4.1 Accessing the Ovation Control Builder

4. The existing control sheets appear in the bottom Work Pad window. Right-click a control
sheet and select Open from the pop-up menu, or double-click a control sheet. The selected
sheet opens in the Control Builder window.

Figure 6: Control Builder with sheet displayed on the drawing canvas

5. If you want to create a new control sheet, right-click the Control Sheets folder in the
Developer Studio system tree.
The New Control Sheets window appears. Fill in the following:
 Sheet name -- determine how the sheet is described in the system.
 Sheet Number -- give short reference number.
 Sheet Component -- define the sheet component code.
6. The Control Builder opens with the new sheet (drawing canvas will be blank). The Property
Editor displays the information that was entered in the New Control Sheets dialog box.

28 OW350_80
4.2 Configuring the Control Builder

4.2 Configuring the Control Builder

The Control Builder allows configuration on two levels:


 User
 Project
Changes made under the User Setting apply to a particular user. Changes made under the
Project Setting apply to every sheet in the project directory.

4.2.1 To set Control Builder configuration parameters


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Edit menu and select Configuration.
The Configure Settings window appears.

Figure 7: Control Builder Configure Settings window -- Project Settings (General tab)

3. From the Configure pull-down menu, select either Project Settings or User Preferences.
4. Select one of the following tabs that differentiate the two types of parameters:
 General -- parameters that apply to the project or user in general.
 Signals -- parameters that only apply to signals for the project or user.
5. Click a parameter on the left side of the Configure Settings window. The right side of the
window displays the properties that can be configured for that parameter.
6. Click the Value field for the desired property. A pull-down menu appears providing a list of
choices. Make the desired selection.

OW350_80 29
4.2 Configuring the Control Builder

7. After setting all configuration values, select the OK button. Select the Cancel button to quit
the window without saving any changes. Select the Help button to display online help on the
Configure Settings window.
8. Audit the sheet (see page 108) to incorporate the changes into the sheet.

The following tables list and describe the Configure Settings window tabs and fields.

Configure Settings window -- Project Settings (General tab) fields

PARAME TE R PROPERTY DESCRIPTION

Component Codes Comma Separated List Determines the length of the component code fields. For
of Field Lengths example, entering 2, 5, 5 could mean that the first 2
characters denote the system, the next 5 characters
denote the equipment, and the next 5 characters define
the functionality. The lengths must be separated by
commas.
Component Codes Component Path Defines what symbol will be used to denote the end of
Terminator the hierarchy path. For example, if a colon (:) is entered
here, then the system only reads the component code
until it sees a " : ".
Connection Ellipses Radius Determines the size of the circles that are used at the
intersection of signal lines.
Database CB-Host IP address of the Database Server. This parameter is
only used if the Type parameter is set to Windows.
Database Default settings should not be changed. This parameter
is only used if the Type parameter is set to Solaris.
File Reserved for internal use. This parameter is only used if
the Type parameter is set to DBID.
Oracle Reserved for internal use.
Type Defines the type of database you are connected to. The
choices are: None, DBID, Solaris, Windows, Direct.
Under most circumstances, this will be set to None.
User Default settings should not be changed. This parameter
is only used if the Type parameter is set to Solaris.
Graphic Hit Tolerance Determines how close the cursor can be to a pin for a
signal line to connect (snap). The larger the number, the
further away the cursor can be for a snap to occur.
Pin Vectors Line Color Defines the color for pin vectors.
Enabled Determines whether pin vectors are enabled or disabled.
Line Style Defines the type of line used for pin vectors. The choices
are: solid, dashed, dotted, or dash-dot-dot.
Point Labels Point Description: Determines whether or not to enforce the style class, as
Enforce Style Class defined in the Style Editor, for all point descriptions.
Point Description: Determines whether or not to override the defined font for
Override Font all point descriptions.
Point Description: Defines a new font style (Arial, Times Roman, and so
Override Font Family forth) for all point descriptions.

30 OW350_80
4.2 Configuring the Control Builder

PARAME TE R PROPERTY DESCRIPTION

Point Description: Defines a new font size (12 pt, 14 pt, and so forth) for all
Override Font Size point descriptions.
Point Description: Determines whether or not to display errors for all point
Suppress Error descriptions on the canvas.
Messages
Point Reference: Determines whether or not to display errors for all point
Suppress Error references on the canvas.
Messages
Point Reference: Determines whether or not to enforce the style class, as
Enforce Style Class defined in the Style Editor, for all point references.
Point Reference: Determines whether or not to override the defined font
Override Font style for all point references.
Point Reference: Defines a new font style (Arial, Times Roman, and so
Override Font Family forth) for all point references.
Point Reference: Defines a new font size (12 pt, 14 pt, and so forth) for all
Override Font Size point references.
Project Number Defines the project number.

Title Defines the project title.

Reconcile Enable Determines whether or not to reconcile when the user


opens a control sheet. If enabled, the Reconcile dialog
box prompts the user with the tuning changes to be
reconciled from the database to the control sheet.
Reports Font Name Choose the type of font used in reports.
Font Size Choose the font size used in reports.

Configure Settings window -- Project Settings (Signals tab) fields

PARAME TE R PROPERTY DESCRIPTION

Analog Signals Line Color Defines the color for analog signals.
Line Style Defines the type of line used for analog signals. The
choices are: solid, dashed, dotted, or dash-dot-dot.
Digital Signals Line Color Defines the color for digital signals.
Line Style Defines the type of line used for digital signals. The
choices are: solid, dashed, dotted, or dash-dot-dot.
Packed Signals Line Color Defines the color for packed signals.
Line Style Defines the type of line used for packed signals. The
choices are: solid, dashed, dotted, or dash-dot-dot.
Tracking Signals Line Color Defines the color for tracking signals.
Line Style Defines the type of line used for tracking signals. The
choices are: solid, dashed, dotted, or dash-dot-dot.

OW350_80 31
4.2 Configuring the Control Builder

PARAME TE R PROPERTY DESCRIPTION

Unknown Signals Line Color Defines the color of signals that are not analog, digital, or
packed.
Line Style Defines the type of line used for signals that are not
analog, digital, or packed.

The following table lists and describes the User Settings window.

Configure Settings Window -- User Preferences (General tab) fields

PARAME TE R PROPERTY DESCRIPTION

Dock Windows Font Size Determines the font size for the dockable windows. The
choices are: small, medium, and large.
Editor Background Color Determines the background color of the drawing canvas.
Toolbar Size Defines the font size of the toolbar icons. The choices are
16 pt. or 24 pt.

32 OW350_80
S E C T I O N 5

5 Understanding Control Builder windows, menus,


and toolbars

IN THIS SECTION

What is the Control Builder main window? ....................................................................... 34


What are the Control Builder menus? ............................................................................... 37
What are the Control Builder toolbars? ............................................................................. 44
Control Builder keyboard shortcuts ................................................................................... 47
What is the Control Builder Object Browser? .................................................................... 49
What is the Control Builder Property Editor window? ....................................................... 56
What is the Control Builder Style Editor window? ............................................................. 57
Using the Control Builder online help system ................................................................... 62
Using the Control Builder What's This function ................................................................. 64

OW350_80 33
5.1 What is the Control Builder main window?

5.1 What is the Control Builder main w indow ?

The Control Builder main window consists of a base frame with a pull-down menu panel (see
page 37), three toolbars (see page 44), and a footer that displays informational icons and check
boxes. When you open an existing Control Builder function or create a new one, a drawing
canvas displays and becomes part of the main window. On this drawing canvas, you place your
control and non-control graphic items (algorithms, signals, text, rectangles, etc.). In this way, the
drawing canvas provides a visual view of your control sheet.

All of the items that you place on the drawing canvas also appear in the Object Browser window
(see page 49) which shows a hierarchical relationship between all the elements that appear on
the drawing canvas. Through the Property Editor window (see page 56), you define and modify all
of the properties of the control and graph items that you placed on the drawing canvas and that
appear in the Object Browser.

The following figure shows the Control Builder main window.

Figure 8: Control Builder main window

34 OW350_80
5.1 What is the Control Builder main window?

The actual drawing canvas is not active until you open or create one of the following:
 Simple graphic (see page 216)
 Control function (see page 96)
 Algorithm symbol (see page 233)
 Control library (see page 237)
 Control macro (see page 165)
The drawing canvas contains a template, called the frame (see page 23), which is used to enforce
consistency standards across a project. A frame is part of the standard template for control
functions, control libraries, and control macros. The drawing canvas is blank (no frame template)
when creating a simple graphic or an algorithm symbol.

When displaying a file in the Control Builder, the name of the file that is currently being edited
appears above the menu panel at the top of the window. Note that you can have more than one
file open in the Control Builder at one time. When creating a new control function file, the title
displays, "New Control Function x" until the file is named and saved.

The footer of the Control Builder window provides additional information as it relates to your
control editing session. For example, the footer displays a user prompt for every command. In this
way, you can look at the footer to determine what action the Control Builder expects (such a draw
line, add algorithm, and so forth). The following figure shows an example of the Control Builder
window footer.

Figure 9: Control Builder window footer example

OW350_80 35
5.1 What is the Control Builder main window?

The footer icon descriptions, from left to right, are:

Control Builder foot icon descriptions

ICON DESCRIPTION

Determines whether or not the Control Builder is connected to the Oracle database.
The choices are:
 Colored database icon -- database connect is valid.
 Transluscent (faded) database icon -- database connect is not required. Also,
this icon is always displayed for Control Macros, Control Libraries, Algorithm
Symbols, and Simple Graphics since these document types do not utilize a
database.
 Triangle icon -- indicates that the current editing session is not connected to the
database; and therefore, any changes made and saved to a sheet are not stored
in the database.

Shows whether algorithm ordering is set to automatic or manual.

Shows the x and y coordinates of the cursor on the drawing canvas. As you move
the cursor, the numbers in this icon change. You can use this icon to place an item
(algorithm, signal, graphic) at a specific x, y location on the drawing canvas.

(Function icon) Displays the function that is currently being executed. For example,
when opening a file, the icon displays, "Open File."

Determines whether or not to enable the snap function for the current editing
session.

Determines whether or not to enable orthogonal lines for the current editing session.
This option is used when adding signals. If this box is checked, you can only draw
horizontal and vertical lines; you cannot draw diagonal lines.

Note: The graphics in this manual were created on a machine that was running the Windows
XP operating system. Note that Ovation 3.4 is compatible with Windows XP and Windows 7.
Even though the Control Builder may look slightly diffferent on the different operating systems,
the functionality remains the same.

36 OW350_80
5.2 What are the Control Builder menus?

5.1.1 Accessing functions from the Control Builder main window

You can access all of the Control Builder functions through the menus (see page 37) and toolbars
(see page 44) on the main window. In addition, many functions can also be accessed by
keyboard shortcuts (see page 47) that are listed on the menus. This manual discusses all of the
functions on the menus and toolbars; however, because the Ovation Control Builder is flexible,
there may be more than one way to accomplish a task. For example, when deleting an item on
the drawing canvas, you would first highlight the item. You could then use the Delete menu item,
the Delete icon, or the Delete key on the keyboard. You can use whatever method suits your
preferences best.

In addition to the menus and toolbars located on the main window, certain functions can also be
accomplished through the Object Browser. For example, if you want to delete an item on the
drawing canvas, instead of using the main window delete functions, you could delete the item
using the Object Browser delete icon or right-click menu item. Refer to Using the Object Browser
window (see page 49) for information on using the Object Browser edit functions. See Control
Builder drawing basics (see page 215) for information on using the main window edit functions.

5.2 What are the Control Builder menus?

The following menus are available from the top of the Control Builder window:
 File (see page 37).
 Edit (see page 38).
 View (see page 40).
 Draw (see page 40).
 Tools (see page 42).
 Window (see page 43).
 Help (see page 43).

5.2.1 File menu on the Control Builder main window

You can use the File menu to load, save, and print sheets.

File menu items

MENU ITEM DESCRIPTION

New Create a new Control Builder editing session. The choices are:
 Simple Graphic -- creates a graphic with no control associated with it.
 Control Function -- creates a graphic with control elements (algorithms, signal
lines, etc.). Control functions are also known as control sheets. This is the
primary document loaded to the Controller.
 Algorithm Symbol -- creates a custom symbol for algorithms.
 Control Library -- creates a custom library for storing control strategies that can
be used in other documents.
 Control Macro -- creates a control macro which is a collection of several
algorithms representing a single, custom control algorithm.
Open Displays the Browse for Folder window, which searches for the file you wish to
open.
Save Saves the document.

OW350_80 37
5.2 What are the Control Builder menus?

MENU ITEM DESCRIPTION

Close Closes the active document.


Import and Export Displays a menu with the following items:
 Import Document -- imports a document into the current document.
 Import Library -- imports a library into the current document.
 Export Library -- takes a portion of control out of the current document and
exports it to a library file.
Audit Verifies internal drawing consistencies.
Clear All Tracking Removes all tracking from a sheet.
Reconcile Compares current point records in the database and the values in the algorithms.
The Controller must be reconciled with the database before attempting this
operation.
Revert Accesses the last saved version of a sheet.
Recover Files Recovers documents that were not saved in the event that the Control Builder
unexpectedly exits.
Print Prints the control sheet that is displayed on the drawing canvas.
Print Report Prints the following reports for the current sheet:
 Algorithm Details
 Connector Information
 Execution Order
 Title Page
 Print Ladders
Properties Displays the Property Editor window.
Recent Files Displays a list of sheets that you have opened. There is also a selection on the
menu to clear the Recent Files list.
Exit Quits the Control Builder.

5.2.2 Edit menu on the Control Builder main window

You can use the Edit menu to modify Control Builder items (cut, copy, paste, etc.) and to edit
point information.

Edit menu items

MENU ITEM DESCRIPTION

Undo Reverts back to the last edit. An unlimited number of undo operations are allowed.
Redo Performs the action that occurred before selecting Undo. Redo has the same
affect as undoing an undo function.
Cut Removes the selected item(s) from the drawing and puts it into the system
scratchpad.
Copy Copies the selected item(s) from the drawing and puts it into the system
scratchpad.

38 OW350_80
5.2 What are the Control Builder menus?

MENU ITEM DESCRIPTION

Paste Pastes item(s) stored in the system scratchpad into a drawing. An unlimited
number of paste operations are allowed.
Delete Deletes (removes) selected items.
Move Moves selected item(s) graphically.
Alignment and Spacing Accesses the alignment and spacing functions. The choices are:
 Align Algorithms Horizontally -- Moves the selected algorithm(s) so that the x-
coordinate of the anchors are the same as the x-coordinate of the referenced
algorithms. That is, the selected algorithm(s) are aligned horizontally to a
referenced algorithm.
 Align Algorithms Vertically -- Moves the selected algorithm(s) so that the y-
coordinate of the anchors are the same as the y-coordinate of the referenced
algorithms. That is, the selected algorithm(s) are aligned vertically to a
referenced algorithm.
 Space Algorithms Horizontally -- Evenly spaces adjoining anchors along the
x-axis. The spacing is the average of all the distances between adjoining
anchors in the x-direction.
 Space Algorithms Vertically -- Evenly spaces adjoining anchors along the y-
axis. The spacing is the average of all the distances between adjoining anchors
in the y-direction.
Text Modifies text. (To create text, use the Text option found on the Draw menu.)
Find and Replace Provides a fast and convenient way to find and, if desired, replace comment text
Comment Text with different text.
Points Displays the Point Edit window which is used to map point names after a library
has been imported, locate points on a sheet, or edit points.
Macro Interface Lists all macro interface items and edits the macro parameter descriptions and
values.
Point Security Enables or disables default or user-defined point security groups for the default
points on the sheet.
Create User Points Creates user-defined points in the database from points that are used on a sheet
but do not currently exist in the database.
Find Points Searches for points on a particular sheet.
Styles Accesses the Style Editor window which changes font sizes, colors, and so forth
for the open document.
Configuration Configures on two levels: user and project. Changes made under the user setting
apply to that particular user. Changes made under the project setting apply to
every sheet in that project directory.

OW350_80 39
5.2 What are the Control Builder menus?

5.2.3 View menu on the Control Builder main window

You can use the View menu to display other windows related to the Control Builder. This menu
also displays the zoom functions.

View menu items

MENU ITEM DESCRIPTION

Full View Displays the entire sheet on the Control Builder canvas.
Zoom Window Allows you to draw a “view box” which, when placed over sections of the sheet,
expands that particular area.
Zoom In Zooms in on the current view.
Zoom Out Zooms out on the current view.
Object Browser Displays the Object Browser window.
Property Editor Displays the Property Editor window.
Favorites Folder Provides a means to manage a set of frequently used symbols.
Symbol Browser Provides a quick way of adding algorithms to a sheet through "click and drop"
functionality.
Import Browser Displays the Import Tool Utility.
Refresh Refreshes all open windows.
Algorithm Errors Displays the Error List window. By default, this appears at the bottom of the main
Control Builder window; however, you can move this window to wherever you
choose.
Algorithm Order Displays the algorithm execution order on the drawing canvas.

5.2.4 Draw menu on the Control Builder main window

The Draw menu displays the elements that can be added to a control sheet.

Draw menu items

MENU ITEM DESCRIPTION

Rectangle Draws a rectangle on the sheet.


Polygon Draws a polygon on the sheet.
Ellipse Draws an ellipse on the sheet.
Curve Draws a curve on the sheet.
Line Draws a line on the sheet.
Text Creates text in a document. (To modify text, use the Text option found on
the Edit menu.)
Add Hyper Link Adds a hyperlink to your document.
Add Algorithm Displays the Add Algorithm dialog box which adds algorithms to a control
sheet.

40 OW350_80
5.2 What are the Control Builder menus?

MENU ITEM DESCRIPTION

Add Control Pin Displays the Select Parameter dialog box which chooses which type of
pin to add to the selected algorithm.
Build Control Signal Adds a signal line to a sheet.
Algorithm Value Displays special, dynamic text fields on a control sheet. These text fields
identify algorithm fields such as point names and algorithms parameter
values.
Document Value Displays special dynamic text fields on a control sheet. These text fields
identify general title information that pertains to the sheet such as project
name, engineer, drop ID, task ID, etc.
Point Description Adds descriptions of a point to the control sheet. This information is
obtained from the point's ED (English Description) field.
Point Reference Adds text fields to a control sheet that show where a point originated
from or on what other sheets the point is used.
Point Status Indicator Creates a container in the Object Browser under the selected algorithm.
To this container, you can add an indicator that represents the
configuration of a point for an algorithm parameter.
Algorithm Value Indicator Creates a container in the Object Browser under the selected algorithm.
To this container, you can add an indicator that represents the state of an
algorithm parameter.
Extended Algorithm Tag Provides for function-specific tags.
For the FUNCTION algorithm, it creates a graph on the sheet. This graph
is dynamic so as the algorithm changes, the graph updates as well.
For the LSCALC algorithm, it creates a new object in the Object Browser
called "CalcBlock Program Tag." This object will display the program on
the sheet. See To add an extended algorithm tag for the LSCALC
algorithm (see page 362)

OW350_80 41
5.2 What are the Control Builder menus?

5.2.5 Tools menu on the Control Builder main window

The Tools menu displays items that work with multiple sheets.

Tools menu items

MENU ITEM DESCRIPTION

Operations Displays a menu with the following items:


 Compile Operation -- compiles multiple sheets at one time.
 Copy Operation -- makes multiple copies of existing control sheets.
 Export Operation -- extracts control functions, control symbols, control libraries,
and control macros from an existing Ovation system to a specified directory. This
operation along with the Import Operation is the primary means for moving control
files between systems.
 Import Operation -- copies control functions, control symbols, control libraries,
and control macros from a specified directory to an existing Ovation system. This
operation along with the Export Operation is the primary means for moving control
files between systems.
 Print Operation -- prints multiple sheets at one time.
 Publish Operation -- converts the selected files into PDF documents for easier
verification, archiving of control files, and ease of correspondence.
 Reconcile Operation -- compares current point records in the database and the
values in the algorithms for multiple sheets.
 Standardize Text -- provides a user-friendly interface for standardizing style
options on multiple sheets.
 Style Operation -- changes the styles of one or more sheets. It provides a way to
reference or generate an external style sheet which can be applied or imported to
multiple documents.
Delete Sheets This option is only available for Solaris-based Ovation systems. It is used to delete
sheets from the Ovation system. In Windows-based Ovation systems, deleting
sheets is done at the Developer Studio
Order Sheets Defines the execution order for all the sheets within a task.
Signal Diagrams Accesses a signal diagram which displays sheets in a runtime environment.
Synchronize OnLine Compares what is in the offline Control Functions directory and what is in the online
directory (Signal Diagrams) and allows you to synchronize them so that they have
the same data.
Pack Default Digital Searches for all of the default digital points on a sheet and combines them into one
Points packed point. The is typically done to lower the point count on a sheet. This function
can also be used in macros.
Replace Macro Provides an easy way to interchange macros on a sheet. For more information, see
Reference Replacing a macro reference (see page 170).
Supplemental Displays two supplemental document windows. The choices are:
Documents  Publish Supplemental Documents moves supplemental documents to the online
environment (signal diagrams).
 Edit Supplemental Documents allows you to edit supplemental documents
(change titles, component codes, etc.).

42 OW350_80
5.2 What are the Control Builder menus?

5.2.6 Window menu on the Control Builder main window

The Window menu allows you change the layout of all the currently opened windows on the
drawing canvas in a way that is most appealing to the user.

Window menu items

MENU ITEM DESCRIPTION

Cascade Displays the sheets in a sequence of successive, overlapping windows so that the
title bar of each is visible.
Tile When displaying multiple sheets, the sheets arrange in a tile pattern, resized,
without any overlap.
Tile Horizontally When displaying multiple sheets, the sheets arrange so that they appear one below
the next, horizontally stretched across the canvas, but the title bar of each is
visible.
Close All Windows Closes all open documents in the Control Builder.
Name of document(s) Displays the name(s) of all open documents in the Control Builder.

5.2.7 Help menu on the Control Builder main window

The Help menu accesses online help information about a particular topic. See Using the Control
Builder online help system (see page 62).

Help menu items

MENU ITEM DESCRIPTION

User Guide Displays the Ovation Control Builder User Guide.


Algorithm Guide Displays the Ovation Algorithm Reference Manual.
About Gives you the current software version number of the Control Builder.

OW350_80 43
5.3 What are the Control Builder toolbars?

5.3 What are the Control Builder toolbars?

Toolbars provide quick, easy access to the more frequently used Control Builder windows and
functions. All toolbar button functions can also be accessed from a menu with the exception of the
Text Attributes functions. Text Attribute functions (bold, underline, etc.) are only available through
the toolbar.

There are three toolbars on the main window:


 Standard (see page 45)
 Drawing (see page 46)
 Text Attributes (see page 46)
Toolbar buttons, like their associated menu items, can be active or inactive. If a function is
currently not active, the associated toolbar button and menu item are inactive. If a function is
active, both the toolbar button and the menu item are active.

You can toggle the display of toolbars by right-clicking any empty space on the toolbar. (Click
anywhere but directly on the icon.) A menu displays that toggles the display of the toolbar. If there
is a check to the left of the menu item, that toolbar is currently displayed. If there is no check
beside the menu item, that toolbar is currently not displayed. The menu also lets you toggle the
display of the Property Editor, Object Browser, Style Editor, Favorites Folder (local), Symbol
Browser, Error List, and Import Tool Utility.

Figure 10: Toolbar toggle menu (toggles to display or hide toolbars and windows)

44 OW350_80
5.3 What are the Control Builder toolbars?

The typical position for these toolbars is above the drawing canvas; however, you can move
toolbars to different locations on the screen. Each of the toolbars is dockable. A toolbar is docked
if it is attached to one of the sides of the main Control Builder window. All of the toolbars can be
docked to the left, right, top, or bottom on the main window.

To move a docked toolbar, grab the left end of the toolbar at the dotted vertical line. Notice how
the cursor changes. Press and hold the left mouse button and drag the toolbar to the desired
place/position. Release the mouse button, and the toolbar is docked to that side.

Each toolbar button has an associated “tooltip” for that button. A tooltip is a short descriptive text
string describing the button function. To see the tooltip for a particular button, hover the mouse
pointer over the toolbar button.

5.3.1 Standard toolbar on the Control Builder main window

The Standard toolbar provides access to basic commands for editing and adding control
elements.

Figure 11: Standard toolbar

The icon descriptions, from left to right, are:


 Open file
 Save file
 Open related component documents
 Print current document
 Cut
 Copy
 Paste
 Find point names on sheet
 Delete
 Move selected items
 Full view
 Zoom window view
 Undo
 Redo
 Add control algorithm
 Add control pin
 Build control signal
 Draw algorithm value
 Align algorithms horizontally
 Align algorithms vertically
 Space algorithms horizontally
 Space algorithms vertically

OW350_80 45
5.3 What are the Control Builder toolbars?

5.3.2 Drawing toolbar on the Control Builder main window

The Drawing toolbar displays the graphic elements that you can add to a document.

Figure 12: Drawing toolbar

The icon descriptions, from left to right, are:


 Edit styles
 Select style type pull-down menu
 Draw a line
 Draw a rectangle
 Draw a polygon
 Draw an ellipse
 Draw a curve
 Create new text object in document

5.3.3 Text Attributes toolbar on the Control Builder main window

The Text Attributes toolbar sets the size, color, and style of text.

Figure 13: Text Attributes toolbar

The icon descriptions, from left to right, are:


 Font name pull-down menu
 Font size pull-down menu
 Bold
 Italic
 Underline
 Left
 Center
 Right
 Font color

46 OW350_80
5.4 Control Builder keyboard shortcuts

5.4 Control Builder keyboard shortcuts

Keyboard shortcuts access the Control Builder windows and functions by keystroke combinations
instead of selecting the item with the mouse. All of the keyboard shortcuts have an associated
menu item. The associated menu item must be active at the time you use the keyboard shortcut.
The following table lists the keyboard shortcuts for the menu items on the main Control Builder
window.

Main window menu items and keyboard shortcuts

MENU MENU ITEM KEYBOARD SHORTCUT

File New -> Control Function Ctrl + N

Open Ctrl + O

Save Ctrl + S
Import and Export -> Import Library Ctrl + Shift + I
Import and Export -> Export Library Ctrl + Shift + E
Audit Ctrl + F7
Print Ctrl + P
Edit Undo Ctrl + Z
Redo Ctrl + Y
Cut Ctrl + X
Copy Ctrl + C
Paste Ctrl + V
Delete Delete
Move Ctrl + M
Text Ctrl + T
Find and Replace Comment Text Ctrl + H
Find Points F3
Align Algorithms Horizontally Ctrl + Alt + H
Align Algorithms Vertically Ctrl + Alt + T
Space Algorithms Horizontally Ctrl + Shift + H
Space Algorithms Vertically Ctrl + Shift + T
View Full View Ctrl + Home
Zoom Window Ctrl + E
Zoom In Ctrl + +
Zoom Out Ctrl + -
Object Browser F2
Property Editor F4
Symbol Browser F8

OW350_80 47
5.4 Control Builder keyboard shortcuts

MENU MENU ITEM KEYBOARD SHORTCUT

Refresh F5
Algorithm Errors F6
Algorithm Order F7
Draw Add Algorithm Ctrl + A
Add Control Pin Ctrl + Alt + P
Build Control Signal Ctrl + Alt + S
Algorithm Value Ctrl + Alt + A
Document Value Ctrl + Alt + D
Point Description Ctrl + D
Point Reference Ctrl + Alt + R
Point Status Indicator Ctrl + Alt + I
Algorithm Value Indicator Ctrl + Alt + V

Note: Pressing the F1 key accesses online help information.

48 OW350_80
5.5 What is the Control Builder Object Browser?

5.5 What is the Control Builder Object Brow ser?

The Object Browser shows a hierarchical relationship between all the elements that appear on the
drawing canvas. However, in contrast to the drawing canvas which gives you a visual perspective
of a control function, macro, and so forth, the Object Browser displays how all the items are
related to each other. This is shown in a tree or folder structure.

The Object Browser begins this relationship structure with three main containers: Algorithms,
Comments, and Frame. These containers organize the control and graphic items by type which
allows you to find items in a more efficient manner. Containers are discussed in more detail in
What are the Object Browser containers (see page 50).

Listed within the Algorithms container are all the algorithms shown on the drawing canvas. Within
each individual algorithm folder are all the elements that comprise that particular algorithm, such
as pins, lines, text, etc. To move down the folder structure, you can expand or collapse the
folders. Left-click the plus sign (+) beside the folder name to expand a folder and reveal its
contents. Left-click the minus sign (-) beside the folder name to collapse a folder and hide its
contents. Note that the way an item is listed in the folder structure defines its relationship to the
item one level above it (parent) and to the item one level below it (child).

The order in which the algorithms are listed in the Algorithms container defines the execution
order of the algorithms for the sheet. Since the Object Browser organizes items by relationship,
moving items in the Object Browser is not the same as moving items on the display canvas. For
example, moving algorithms on the drawing canvas only affects their graphic location on the
sheet. However, moving algorithms in the Object Browser would change the execution order.

This same principle is true for graphic items, as well. Moving a line or polygon on the drawing
canvas affects its location on the sheet. Moving a line or polygon within the Object Browser
affects the order in which the item is drawn which could affect how it would display on the drawing
canvas. For example, moving a line in the Object Browser has the effect of moving it in front of or
behind other graphic items.

Note that when you select any folder or any item within a folder in the Object Browser, the
Property Editor (see page 56) updates with that item's property information. The Property Editor
defines and edits all the items found in the Object Browser and shown on the drawing canvas.

The following figure shows an example of the Object Browser window.

Figure 14: Object Browser

OW350_80 49
5.5 What is the Control Builder Object Browser?

5.5.1 What are the Object Browser containers?

The Object Browser containers efficiently separate and manage control and graphic items. There
are three main areas or containers:
 Algorithms
 Comments
 Frame

Note: The Object Browser may display another container called External Hyper Links only if
hyperlinks are used on the sheet. Refer to What are hyperlinks? (see page 86) for more
information.

The Algorithms container holds all algorithms and everything that relates to an algorithm (pins,
signals, text, graphic items, and so forth). You can place non-algorithm items (such as lines, text,
and shapes) in the Algorithm container, but algorithms cannot be placed into any other container
type. Note that how algorithms are listed in the Algorithms container defines the execution order.

The Comments container is a location for various, user-defined supplemental information. This
information pertains to the sheet in general as opposed to one particular algorithm. You can place
items such as shapes and text in the Comments container.

The Frame container holds all the items that are related to the document frame (see page 23).
Emerson does not recommend modifying the Frame container since changes will be overwritten if
the frame.svg file is changed. To make document-specific changes, add items to the Comments
container. To add items to every document in a project, modify the frame.svg file (see page 24).

Not all of these containers are used by every type of Control Builder item. The following table lists
Control Builder item types and which containers are applicable to them.

Containers by Control Builder type

CONTAINER SIMPLE CONTROL ALGORITHM CONTROL CONTROL


GRAPHIC FUNCTION SYMBOL LIBRARY MACRO

Comments x x x x x
Algorithms x x x x
Frame x x x

Containers can be active or inactive. Containers are active when a check mark icon displays to
the left of the folder name. When you add an item to the drawing canvas, it is created in the active
container. Note that only one container can be active at one time. However, when adding
algorithms to the drawing canvas, they are always placed in the Algorithms container whether or
not it is set as the active container. You can make a container active or inactive by using the
Object Browser right-click menu (see page 52).

In addition to the containers, every project folder has a Styles entry in the hierarchy. Click this
entry and the Style Editor appears (see page 57). The Style Editor defines the font sizes, colors,
and so forth for items on your sheet.

50 OW350_80
5.5 What is the Control Builder Object Browser?

5.5.2 Object Browser toolbar

The Object Browser toolbar provides a quick and easy way to manipulate items in the Object
Browser window.

Figure 15: Object Browser toolbar

The icon descriptions, from left to right, are:


 Move up -- Moves the selected item up one level within a container.
 Move down -- Moves the selected item down one level within a container.
 Cut -- Cuts the selected item out of the current container for pasting into another container.
This is the first step in a Move operation.
 Paste -- Pastes the item that was cut into a new container. This completes a Move operation.
 Delete object -- Deletes the selected item.
 Refresh -- Refreshes the Object Browser window.
 Deselect all -- Deselects all selected items in the hierarchy.
 Insert group -- Inserts a group (see page 55). The choices are: Graphic Shape or Group Text.

OW350_80 51
5.5 What is the Control Builder Object Browser?

5.5.3 Object Browser right-click menu and item descriptions

The Object Browser right-click menu provides applicable editing and control operations for the
currently highlighted object. The items on the menu remain the same no matter which folder or
container you select. However, if a menu item is not applicable to a particular folder or container,
it is inactive (grayed out). For example, Auto Order is only active when you select the Algorithm
container.

The following figure shows the Object Browser right-click menu.

Figure 16: Object Browser right-click menu

Object Browser right-click menu items

MENU ITEM DESCRIPTION

Set Active Container Sets the highlighted container as the active container. Only one container can be
active at one time.
Auto Order Sets the algorithm container to order algorithms automatically. See Ordering
algorithm execution (see page 132).
Cut Cuts the selected item out of the current container for pasting into another
container. This is the first step of a Move operation.
Paste Pastes the item that was cut into a new container. This completes a Move
operation.

52 OW350_80
5.5 What is the Control Builder Object Browser?

MENU ITEM DESCRIPTION

Insert Group Adds a folder for grouping graphic items. The following options are available:
 Graphic Shape
 Group Text
Refer to Inserting a group (see page 55) for more information.
Edit Text This menu item is only active when a TEXT entry is highlighted in the Object
Browser. You can edit the text in Object Browser and the changes display on the
drawing canvas.
Delete Object Deletes objects from the Object Browser and the drawing canvas.
Audit Object Performs an audit (see page 108) on the highlighted object and its children.
Open Document Provides a way to open a supplemental document from the Object Browser. This
entry is only active when you select a hyperlink or an external document.
Styles Displays a menu with the following items:
 Export Style Sheet -- copies the document's style sheet into a file (.css). This
file can then be used by other documents to utilize the same style. This
functionality, along with the Reference External Style Sheet option, facilitates
uniformity of styles across the system. This option is only available when the
Style object is selected in the Object Browser.
 Import External Style Sheet -- removes the current style settings and
replaces them with those in the external style sheet. This option is only
available when the Style object is selected in the Object Browser.
 Reference External Style Sheet -- links the document to an external style
sheet. It does not copy the style into the current document, but uses the style
settings in the ex. More than one document can reference an external style
sheet. This option is only available when the Style object is selected in the
Object Browser.
 Reset Object Attributes to Style Class -- removes any local style attributes
(such as fill, line style, or stroke) used by the graphic items (such as lines,
ellipses, and so forth). By doing this, the graphic items will be forced to use
only the style template associated with it (such as algorithm, annotation, and so
forth). This option is only grayed out (unavailable) when the Style object is
selected in the Object Browser.

Note: It is best to use the Style operation (see page 274) when working on
multiple documents.

OW350_80 53
5.5 What is the Control Builder Object Browser?

5.5.4 Editing objects in the Object Browser

The Control Builder provides many different ways to accomplish the same task. Certain editing
functions can be performed in the Object Browser as well as on the drawing canvas (refer to What
are the Control Builder drawing canvas editing functions? (see page 227)). The following editing
functions describe how to use the Object Browser to perform common editing tasks.

Note: Moving items in the Object Browser is not the same as moving items on the drawing
canvas. Moving items on the drawing canvas involves a change in location. Moving items in the
Object Browser involves changing the relationship between items. For example, moving an
algorithm on the drawing canvas involves changing location. Moving an algorithm in the Object
Browser would change algorithm execution order.

To select objects in the Object Browser

It is important to understand the differences in selecting objects in the Object Browser. To


highlight an item in the Object Browser means that when you left-click the item, it appears in
reverse video. You can only highlight one item at a time in the Object Browser hierarchy. When
you access the right-click menu, the edit operation you select only applies to the highlighted item.

When you select one or more items in the Object Browser, a flag icon appears beside the item on
the tree. When you access the right-click menu for flagged items, you must choose whether the
edit operation applies to all of the flagged items or only to the one item that is highlighted.

Algorithms with flag icons appear in the magenta color on the drawing canvas. In this way, you
can use the Object Browser to find an algorithm quickly on the drawing canvas. Conversely, when
you select an algorithm on the drawing canvas, it appears highlighted in the Object Browser tree.
 To select an item in the Object Browser hierarchy, press the Ctrl key and left-click the item. If
the item is already selected, press the Ctrl key and left-click the item again. The item
deselects. The Ctrl key toggles the selection of an item. You can also deselect all items by
using the Deselect All icon on the Object Browser toolbar (see page 51).
 The Shift key works in a similar way as the Ctrl key, but is used for multiple selections.

To delete objects in the Object Browser


 To delete objects, highlight the item in the Object Browser hierarchy, right-click, and select
Delete Object from the menu. You could also use the Delete Object icon on the Object
Browser toolbar. The item is deleted from the Object Browser and on the drawing canvas.
 To delete multiple objects, select items in the hierarchy using the Shift + left-click method.
The icon beside the folder names changes to a flag. Right-click and select Delete Object. A
pop-up window appears:

Figure 17: Delete Objects window

54 OW350_80
5.5 What is the Control Builder Object Browser?

 Current button -- only deletes the item that is highlighted -- not all of the items with the
flag icon.
 Flagged button -- deletes all of the items that have the flag icon.
 Cancel button -- does not delete any of the flagged items and quits the pop-up window.

To edit text in the Object Browser


 To edit text, highlight the text entry in the Object Browser hierarchy, right-click, and select
Edit Text from the menu. An entry field appears above the Object Browser window with the
text ready for editing.
 Make the desired changes to the text. Hit the Enter key on the keyboard to commit the
changes. The changes display on the Object Browser and on the drawing canvas.

5.5.5 Grouping objects using the Object Browser

The Insert Group function creates a folder in the Object Browser for grouping graphic and text
items. Groups allow you to organize your graphic and text items. There is no control associated
with the group.

To insert a group in the Object Browser


 Highlight a folder in the Object Browser, right-click, and select Insert Group from the menu.
Pull right to display the following choices: Graphic Shape or Group Text.

Note: If you highlight an item and the Insert Group option is grayed out, you cannot attach a
group to that particular item.

 Graphic Shape -- adds graphic primitives (simple shapes) to the folder. They will be
treated as a group (single entity).
 Group Text -- adds text to the folder. It will be treated as a group (single entity). In
addition, this function automatically performs word wrap on a block of text for long
comments.
 Make a group selection and it appears in the Object Browser hierarchy. When it first displays
in the Browser, it is set as the active container. Any draw items or text placed on the drawing
canvas are now placed in the group folder.

Note: When performing a move operation, groups are treated as a single entity.

OW350_80 55
5.6 What is the Control Builder Property Editor window?

5.6 What is the Control Builder Property Editor w indow ?

The Property Editor window defines and edits all the elements of a control function, control macro,
algorithm symbol, and so forth. It works with the Object Browser and drawing canvas to give you
a complete picture of your control or graphic. Whereas the drawing canvas gives you a visual
view of your function, and the Object Browser describes the relationships between the items of a
function, the Property Editor is used to define the detailed values for the items in a function.

You can define the following items:


 Algorithm parameter values and points.
 Required sheet information such as drop ID, task ID, title, and sheet number.
 Colors, font sizes, and line widths for text and graphic items.
 Component codes and related component codes.
 Algorithm execution order. You can change ordering from automatic to manual and vice
versa.
When you highlight an item in the Object Browser or on drawing canvas, the properties or
attributes for that item appear in the Property Editor. The Property Editor window is divided into
two columns. The left side of the window displays the property descriptions and the right side of
the window shows the corresponding property value. To define or modify a property, left-click in
the Value column beside the desired property. Depending on the type of property, the Value
column either behaves like an entry field or a drop-down menu. This becomes apparent when you
select the Value field for a particular property.

The Property Editor also alerts you to errors. If a property displays a red circle with an "x" inside,
this indicates an incorrect or missing value. If you hover your mouse over the property with the
red alert, a short help message appears describing the error. Note that you can also get a list of
errors by displaying the Error List window (see page 399).

The following figure shows the Property Editor.

56 OW350_80
5.6 What is the Control Builder Property Editor window?

Figure 18: Property Editor

OW350_80 57
5.7 What is the Control Builder Style Editor window?

5.7 What is the Control Builder Style Editor w indow ?

The Style Editor defines the styles (line patterns, font sizes, colors, and so forth) for the current
document (control function, algorithm symbol, control macro, and so forth) of the Control Builder.

The Control Builder is shipped with predefined style classes or templates. For example, one of
these classes is called "algorithm." This is used to enforce a consistent appearance for all of your
documents in a project. You can also create your own classes (see page 61).

5.7.1 Control Builder Style Editor window and field descriptions

The following figure shows the Style Editor window.

Figure 19: Style Editor

The following table defines the Style Editor window fields.

Style Editor window fields

FIELD DESCRIPTION

Style Editor pull-down menu Chooses a style class or template.


Common Properties
Locked This is provided for future functionality.

58 OW350_80
5.7 What is the Control Builder Style Editor window?

FIELD DESCRIPTION

Visible Either shows or hides any graphic entity on the sheet that has the current
style template.
Line Properties
Line Cap Defines the look of line endcaps. The choices are: round, solid, or flat.
Stroke Color Defines the color used for lines. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option


appears on the menu. Selecting this option displays the Select Color
window, which provides a selection of predefined colors as well as the
ability to create new custom colors.

Stroke Dash Array Defines the line pattern for lines. The choices are: solid line, dotted line,
dashed line, dash-dot line, and dash-dot-dot line.
Stroke Width Defines the line width for lines.
Shape Properties
Fill Color Defines the color used for lines. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option


appears on the menu. Selecting this option displays the Select Color
window, which provides a selection of predefined colors as well as the
ability to create new custom colors.

Line Cap Defines the look of line endcaps for shapes. The choices are: round, solid,
or flat.
Stroke Color Defines the color used for lines. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option


appears on the menu. Selecting this option displays the Select Color
window, which provides a selection of predefined colors as well as the
ability to create new custom colors.

Stroke Dash Array Defines the line pattern for shapes. The choices are: solid line, dotted line,
dashed line, dash-dot line, and dash-dot-dot line.
Stroke Width Defines the line width for the lines that comprise the shape.
Text Properties
Font Family Displays a list of available font types.
Font Size Select a font size.
Font Style Choose the font style. The choices are normal and italic.
Font Weight Choose the font weight. The choices are normal and bold.

OW350_80 59
5.7 What is the Control Builder Style Editor window?

FIELD DESCRIPTION

Text Color Defines the color used for lines. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option


appears on the menu. Selecting this option displays the Select Color
window, which provides a selection of predefined colors as well as the
ability to create new custom colors.

5.7.2 To use the Style Editor window


1. Access the Control Builder (see page 27).
2. Pull down the Edit menu and select Styles. You can also use the Edit Styles icon on the
toolbar. The Style Editor window appears.
The Style Editor works like the Property Editor. The left side of the window displays the
properties and the right side of the window shows the values for those properties.
3. At the top of the Style Editor window, pull down the menu to select one of the predefined
templates. The settings for that template appear in the Property and Value columns.
4. To change any of the style values, highlight the desired property. Then left-click again on the
value defined for that property. A pull-down menu appears.

Figure 20: Style Editor pull-down menu

5. Make the desired selection from the pull-down menu.

60 OW350_80
5.7 What is the Control Builder Style Editor window?

5.7.3 To create a custom style template for control sheets


1. Access the Control Builder (see page 27).
2. Pull down the Edit menu and select Styles. The Style Editor window appears.
3. At the top of the Style Editor window, type a new style name in the pull-down menu.
4. Press the Enter key on the keyboard.
5. A window appears asking if you want to create a new style. Select Yes.
6. Make the desired changes to the properties and values of the new style template.
7. Pull down the File menu on the main Control Builder window and select Save.
You can now use and apply the new template to the control sheet graphic items.

OW350_80 61
5.8 Using the Control Builder online help system

5.8 Using the Control Builder online help system

The Ovation Control Builder has an online help system (QT Assistant) that provides information
on the Control Builder application and on individual algorithms. You can access this help in
several ways:
 By pulling down the Help menu on the main Control Builder window.
 By pressing the F1 key on the keyboard while the cursor is anywhere on the Control Builder
drawing canvas.
 By right-clicking on an algorithm displayed on the Control Builder drawing canvas.
 By pressing a Help button on any of the various Control Builder dialog boxes.
The following figure shows an example of the Control Builder Help window.

Figure 21: Control Builder Help window

62 OW350_80
5.8 Using the Control Builder online help system

The Help window contains four tabs that are used as different search methods:
 Contents
 Index
 Bookmarks
 Search
The Contents tab displays a directory tree structure of the help file content for the current
application. To access the information in the tree, expand the desired folder by clicking on the "+"
sign. Select the desired subject. The right side of the window displays the corresponding help
information.

The Index tab displays a window that has a text entry field to search the index for specific
information. The system searches the index for an entry as you type the information. As you type,
it highlights index help topics that most closely alphabetically match your entry. Double-click a
topic to view help text. The right side of the window displays the corresponding help information.

The Bookmarks tab easily catalogs and accesses help topics that you visit often. In this way, you
do not have to remember the name of the topic or type anything -- just select the Bookmark tab
and a list of your selected topics appears.

The Search tab dialog box (located at the top of the right side of the window) allows you to enter
a keyword into the Find box and click the Search button. Topics then appear that match the
keyword. Double-click a topic to display the topic. The right side of the window populates with the
corresponding help information.

In addition to the tabs that are part of the standard Help window, you can create custom tabs
above the display area that allow you to easily toggle between help topics.

To access functionality not available with tabs, the Help window provides a series of menus that
are described in the following table.

Control Builder Help window menu fields and descriptions

MENU DESCRIPTION

File Page Setup -- selects the page size, orientation, and margins for the page.

Print Preview -- allows you to see what the printed page will look like before
you actually print.
Print -- prints the currently displayed help topic.
New Tab -- creates another tab on the display area.
Close Tab -- closes the current tab on the display area.
Quit -- exits the Control Builder Help window.
Edit Copy Selected Text -- copies any selected text out of the help document so
you can paste it into another document.
Find in Text -- searches the current help topic.
Find Next -- searches the next help topic.
Find Previous -- searches the previous help topic.
Preferences -- defines the settings for the CB Help window.

OW350_80 63
5.9 Using the Control Builder What's This function

MENU DESCRIPTION

View Zoom in -- zooms in on the current view by a defined percentage.


Zoom out -- zooms out of the current view by a defined percentage.
Normal Size -- resets the font size in the current tab to the default size.
Contents -- displays the directory tree structure of the contents of the help file.
Index -- displays a window that has a text entry field to search the index for
specific information.
Bookmarks -- easily catalogs and accesses help topics that you visit often.
Search -- displays a window that allows you to search for topics based on a
defined keyword.
Toolbars -- toggles the display of the toolbars.
Go Home -- goes to the home page of the QT Assistant.
Back -- goes to the previously displayed help topic (search backward).
Forward -- goes to the help topic displayed after the current help topic (search
forward).
Sync w/ Table of Contents -- synchronizes the Contents window with the page
currently shown in the main window.
Next Page -- selects the next tab in the window.
Previous Page -- selects the previous tab in the window.
Bookmarks Add Bookmarks -- creates a bookmark to easily access a frequently used help
topic.
Help About Control Builder Help -- provides the version and copyright information for
the Ovation Control Builder help.

The Control Builder Help window also provides a toolbar that provides quick access to the
frequently used help functions. Each toolbar button has an associated “tooltip” for that button. A
tooltip is a short descriptive text string describing the button function. To see the tooltip for a
particular button, hover the mouse pointer over the toolbar button.

For more information on using the QT Assistant, press the Home icon to access QT online help.

5.9 Using the Control Builder What's This function

The Control Builder "What's This" function provides context-sensitive help for buttons, entry fields,
and parameters on certain Control Builder windows. The "What's This" function is depicted by a
question mark (?) in the upper right-hand corner of the window, next to the "X" icon that quits the
window.

Help buttons or, in some cases, the F1 button provides general online help on a window. The
"What's This" feature provides help on individual window items and typically gives more
information than is presented in a tooltip.

64 OW350_80
5.9 Using the Control Builder What's This function

5.9.1 To use the What's This function


1. Access a Control Builder window.
2. Click the question mark (?) in the upper right-hand corner of the window.

Move the cursor to the item (button, entry field, and so forth) that you want to display help for and
click the item.

Note: If help is available for that item, the cursor changes to a question mark and appears over
the item. The help message appears.

OW350_80 65
S E C T I O N 6

6 Linking Control Builder documents

IN THIS SECTION

What is a document hierarchy? ......................................................................................... 68


What are component codes? ............................................................................................ 69
Component code examples .............................................................................................. 69
How do I configure component codes? ............................................................................. 73
To configure component codes in the Control Builder ...................................................... 73
To configure component codes for signal diagrams ......................................................... 74
Defining the ComponentFieldDefinition.txt file .................................................................. 75
Assigning component codes to a document ..................................................................... 78
What are hyperlinks? ........................................................................................................ 86
What are supplemental documents? ................................................................................ 91

OW350_80 67
6.1 What is a document hierarchy?

6.1 What is a document hierarchy?

The Control Builder provides the option of organizing and grouping documents (control sheets
and simple graphics containing no control scheme) into a folder structure or hierarchical list. This
hierarchy allows you to group related documents together. For example, you may want to have all
of your documents that pertain to turbines grouped together. The hierarchy not only keeps your
documents organized in a logical way, but it also allows for easier navigation between related
documents.

Note: Defining and grouping documents in a hierarchy does not change the way control sheets
are assigned to a drop and a control task area, nor does it affect the execution of control.

You can think of the hierarchy as creating a folder structure, which builds a relationship between
your Control Builder documents. For example, a top-level folder could represent one of the units
of your plant, (such as Unit 1). Under the Unit 1 folder, your could have a folder called Turbines,
which would house the sheets that apply to the turbines for Unit 1. Under the Turbines folder, you
could have another folder called Valves and so forth. This hierarchy may be designed in any way
that you choose.

A hierarchy is defined in multiple levels or tiers. You define each level of the hierarchy by a code
(see page 69). You assign a code to each of your control sheets so that they are organized
according to the hierarchy. As an example, the top level of the hierarchy may be defined as AA,
the second level may be BB and the third level may be XXX. Notice that the assigned code for an
item is based on the codes of the previous items in the hierarchy.

Figure 22: Example hierarchy

68 OW350_80
6.2 What are component codes?

Items in the hierarchy can be:


 Control sheets -- any Control Builder document that has algorithms and a control scheme.
 Supplemental documents -- any .svg document, managed by the Control Builder, that does
not have algorithms or control information. This could be simple graphics built in the Control
Builder. In addition, supplemental documents may refer to miscellaneous documents such as
.pdf or Word documents that can be linked into control sheets through hyperlinks (see page
86). Refer to What are supplemental documents? (see page 91) for more details.
You may also assign a related component code to a sheet or simple graphic. Using related
component codes allows you to link to a document that is outside of your hierarchy or folder
structure. For example, you may have a hierarchy for your Unit 1 Turbines. You may assign a
related component code to a sheet to link it to a boiler sheet in Unit 2.

6.2 What are component codes?

Once you know how you want your sheets to be grouped and organized, you must design a
component code scheme that will represent the document hierarchy. Component codes are text
strings that are assigned to each sheet or supplemental document that represent the sheet's or
document's location in the hierarchy. Component codes can be defined in any way that you
choose, but once defined, they must adhere to the standard as defined by the project.

Note: You do not have to assign component codes to a sheet in order for the control to function
properly. The Ovation Controllers still uses the drop/control task structure to process the
execution of the sheets; however, using component codes will allow you to organize your sheets
in a way that is convenient for your project.

6.3 Component code examples

The following examples show different ways that component codes can be defined. In order to
provide maximum flexibility, the length of the code pattern can vary depending on your needs in
the plant. Spend time designing your component code format in order to best organize your
Control Builder documents.

The first three examples are based on a KKS format. KKS is a European Power Plant
Classification System. In KKS, the code format defines a folder structure based on the system,
equipment, and components. The examples shown here are given in a more simplified way than
what is formally defined for KKS. For more information on the formal KKS standard, refer to the
KKS Coding Scheme documentation.

The fourth example shows an Emerson-designed code structure.

OW350_80 69
6.3 Component code examples

6.3.1 KKS code example - 2, 5, 5 pattern

The following example is based on the KKS standard with a 2, 5, 5 pattern (three levels).

Figure 23: KKS code example -- 2, 5, 5 pattern

70 OW350_80
6.3 Component code examples

6.3.2 KKS code example -- 2, 3, 2, 2, 3 pattern

The following example is based on the KKS standard with a 2, 3, 2, 2, 3 pattern (five levels).

Figure 24: KKS code example -- 2, 3, 2, 2, 3, pattern

OW350_80 71
6.3 Component code examples

6.3.3 KKS code example -- 2, 3, -2, 2, 3 pattern (one ignored field)

The following example is based on the KKS standard with a 2, 3, -2, 2, 3 pattern (five levels), with
field 3 ignored. You may want to use ignored fields to consolidate several files into the same
folder.

Figure 25: KKS code example -- 2, 3, -2, 2, 3 pattern with an ignored field

72 OW350_80
6.4 How do I configure component codes?

6.3.4 Emerson code example

The following Emerson example shows a 1, 3, 3 pattern (three levels).

Figure 26: Emerson code example -- 1, 3, 3 pattern

6.4 How do I configure component codes?

You must do the following to start using component codes to build a document hierarchy:
 Configure the Control Builder to identify the field format and length of the component codes.
 Configure the Signal Diagram application to recognize the field format and length of the
component codes.
 Create a text file, called ComponentFieldDefinition.txt, the defines each field in terms of the
type of system, equipment, and components.
 Assign component codes to your sheets either through the Control Builder Property Editor or
the Ovation Developer Studio.

6.5 To configure component codes in the Control Builder


1. Access the Control Builder (see page 27).
2. Open a control sheet (see page 99).

OW350_80 73
6.6 To configure component codes for signal diagrams

3. From the main Control Builder window, pull down the Edit menu, and select Configuration.
The Configure Settings window appears.

4. By default, Project Settings and the General tab display upon opening. The Component
Codes item should be highlighted.
5. On the right side of the Configure Settings window, go to the entry field called Comma
Separated List of Field Lengths. This is where you define the format and length of the
components codes you will use. The numbers must be separated by commas with no spaces.
Based on the example in the figure, a code pattern of 1, 3, 3 is used. This means there will be
three fields. The first field will be one character long, the second field will be three characters
long, and the third field will be three characters long. See Component code examples (see
page 69).
6. Go to the second entry field called, Component Path Terminator. In this field, enter a
character that will denote the end of the component code. This allows the application to
recognize the end of the code. A colon is used in this example.
7. Select the OK button on the Configure Settings window to save the changes. Select the
Cancel button to quit the window without saving any changes. You do not have to save the
opened sheet in order for the configuration changes to take effect.

6.6 To configure component codes for signal diagrams


1. Open Windows Explorer and navigate to the following folder:
OvPtSvr\System_name\On-line\Unit_name
2. Select an .svg file from the Unit_name folder and double-click the file. The file opens in the
Control Builder.
3. Since this Control Builder was accessed from the online directory, it will allow you to make
configuration changes that affect Signal Diagrams.
4. From the Control Builder, pull down the Edit menu, and select Configuration. The Configure
Settings window appears.
5. Follow the procedures in To configure component codes in the Control Builder (see page 73)
to configure component codes for the Signal Diagrams.

74 OW350_80
6.7 Defining the ComponentFieldDefinition.txt file

6.7 Defining the ComponentFieldDefinition.txt file

Before component codes can be assigned to sheets and simple graphics, you must define the
actual code in a text file called ComponentFieldDefinition.txt. This text file is created once in
any text editor (such as Notepad), then copied to other systems to enforce standards across the
plant. The description used in the file appear in the hierarchy tree (see To open an existing
document using the component code layout (see page 102)).

Based on the field format and length that was defined in the Configure Settings window (see page
73), the ComponentFieldDefinition.txt file defines what each code in each field means.

Refer to the Emerson code example (see page 73). If you defined a field format and length as 1,
3, 3 in the Configure Settings window, the ComponentFieldDefinition.txt file may look like the
following figure.

The number "1s" represent the possible choices for the first field -- B (Boiler), T (Turbine), and H
(Heat Recovery Steam Generator). The number "2s" represent the possible choices for the
second field -- AR1 (Area 1), AR2 (Area 2), and AR3 (Area 3). The number "3s" represent the
possible choices for the third field -- VLV (Valve), PMP (Pump), and DRM (Drum).

Figure 27: Example of ComponentFieldDefinition.txt file

OW350_80 75
6.7 Defining the ComponentFieldDefinition.txt file

Each row in the ComponentFieldDefinition.txt file is a record. The first record in the file shown
above is: 1, B, Boiler. Each record has three fields:
 Record field 1 is the Field Number -- the field number is 1 in the first record.
 Record field 2 is the Field Value -- the field value is B in the first record.
 Record field 3 is the Field Description - the field description is BOILER in the first record.
See the following table.

RECORD IN FILE (AS FIELD FIELD FIELD DESCRIPTIONS


SHOWN IN EX AMP LE ) NUMBER VALUE

1, B, BOILER 1 B BOILER
1, T, TURBINE 1 T TURBINE
1, H, HEAT 1 H HEAT RECOVERY STEAM
RECOVERY STEAM GENERATOR
GENERATOR
2, AR1, AREA 1 2 AR1 AREA 1
2, AR2, AREA 2 2 AR2 AREA 2
2, AR3, AREA 3 2 AR3 AREA 3
3, VLV, VALVE 3 VLV VALVE
3, PMP, PUMP 3 PMP PUMP
3, DRM, DRUM 3 DRM DRUM

To relate the information in the ComponentFieldDefinition.txt file to the 1, 3, 3 pattern that you
defined in the Control Builder Configure Settings window (see page 73), refer to the following:

76 OW350_80
6.7 Defining the ComponentFieldDefinition.txt file

Based on the definitions defined in the example ComponentFieldDefinition.txt file, you could have
sheets with the following component codes:
 BAR2PMP
 BAR3DRM
 TAR1VLV
 TAR2PMP
 HAR3DRM
 HAR1VLV
When creating the ComponentFieldDefinition.txt file, you must define the fields separated by
commas with no spaces between the fields. If you use a code format defined with a "-" which
means a field is ignored, the ignored fields are not defined in the ComponentFieldDefinition.txt
file.

6.7.1 To add the txt file to the Control Builder and Signal Diagrams

Once you create the ComponentFieldDefinition.txt file (see page 75), it must be placed in the
offline directory for use with the Control Builder and the online directory for use with Signal
Diagrams. Perform the following steps:

1. Copy the ComponentFieldDefintion.txt file from the directory where it was created.
2. Paste the text file into both of the following directories:
 OvPtSvr\Systemx\Netx\Unitx\ControlFunctions (offline Control Builder directory)
 OvPtSvr\Systemx\On-line\Unitx (online signal diagram directory)

OW350_80 77
6.8 Assigning component codes to a document

6.8 Assigning component codes to a document

Once you have decided on a document hierarchy, selected how that hierarchy will be defined with
a component code pattern, and defined that pattern in the ComponentFieldDefinition.txt file, you
are ready to add component codes to sheets and simple graphics.

Every sheet should have a component code. Component codes can be added to a sheet through
the Control Builder Property Editor or through the Ovation Developer Studio. Once you add a
component code to a sheet and save it, that sheet is placed in its appropriate place in the
document hierarchy. In addition, the Control Builder enables the Component Menu icon on the
Standard toolbar (see page 45).

When you select the Component Menu icon, you get a list of documents (control sheets and
supplemental documents) that are part of the hierarchy scheme of the document that you
currently have open. The menu shows the sheets in the folder above the current sheet (parent
folder), sheets in the same folder as the current sheet (siblings), and sheets that are in a folder
beneath the current sheet (children).

The following figure shows a sample of the menu that displays when you select the Component
Menu icon.

Documents in the Component Menu have different icons depending on what type of document it
is -- control sheets are depicted by the three colored squares, and simple graphics (documents
with no control) are depicted by plain white rectangles (looks like sheets of paper). Also notice
that for each type of document, the menu displays the icon, followed by the component code, the
sheet number in brackets, and then the title of the sheet. If desired, you can select a document in
the list and it will open in the Control Builder.

78 OW350_80
6.8 Assigning component codes to a document

Documents in a hierarchy may be linked to other documents in another hierarchy by using related
component codes (see page 84). Related component codes define documents related to the
currently opened document but are not part of its hierarchy. You define related component codes
in a field called Related Component Codes in the Property Editor. Documents defined by related
component codes also appear on the Component Menu.

Once you add component codes to all the sheets in your system, you can see a complete list of
the sheets in a document hierarchy in the Select file to open window. You access the Select file
to open window by pulling the File menu on the main Control Builder window and selecting
Open. The Select file to open window appears with two different views. One view lists the
sheets according to drop and control task area, and the other view lists the sheets according to
the component code hierarchy. For sheets that no do not have a component code assigned to
them, the sheets appears under a folder called Undefined Component Tags. Refer to Opening an
existing control sheet (see page 99) for more information.

Figure 28: Select file to open window showing component code layout

6.8.1 To assign a component code to a document in the Control Builder


1. Access the Control Builder (see page 27).
2. Open or create a control sheet or a simple graphic (see page 99).

OW350_80 79
6.8 Assigning component codes to a document

3. Go to the Property Editor and enter a component code in the Component Code field.

Figure 29: Property Editor showing Component Code field

4. From the top of the Control Builder, pull down the File menu and select Save.
5. To view the sheet in the Component Menu, click the Component Menu icon. Select the
Refresh item on the menu. The new code should appear in the list in its proper place in the
hierarchy along with other documents.
6. To assign a related component code, see To define related component codes (see page 84).

80 OW350_80
6.8 Assigning component codes to a document

6.8.2 To assign component codes to multiple sheets in the Developer Studio

You can add components codes to several sheets at one time by adding them through the
Ovation Developer Studio.

1. Access the Developer Studio. (See Ovation Developer Studio User Guide for more
information.)
2. Use the system tree to navigate to the appropriate Control Task that contains the sheets for
which you want to assign component codes.
System
Networks
Units
Drops
Configuration
Controller
Control
Control Task
3. Right-click the desired Control Task and select Search. The Search Options Wizard - (Step
1/2) appears.

Figure 30: Search Options Wizard - (Step 1/2)

4. Select Object: Control Sheets from the Search Options Wizard.


5. Click the Next button and the Search Options Wizard - (Step 2/2) window appears.
6. Select the Find all items radio button on the Search Options Wizard - (Step 2/2) window.
Click the Finish button.

OW350_80 81
6.8 Assigning component codes to a document

The Search: Object: Control Sheets window appears, listing all the sheets in the control task
where you performed the search.

Figure 31: Search: Object: Control Sheets window

7. From the Search: Object: Control Sheets window, select the Add Column(s) button. The Add
Column(s) window appears.

Figure 32: Add Column(s) window

8. From the Add Columns window, select User Documentation: Sheet Component.

82 OW350_80
6.8 Assigning component codes to a document

9. Select the OK button on the Add Columns window, and the Search: Object: Control Sheets
window appears with another column allowing you to add component codes to the sheets in
the control task.

Figure 33: Search: Object: Control Sheets window showing the added column

10. Enter one component code per sheet number.


11. When you are finished entering component codes for all of the desired sheets, select the Ok
button to accept the changes and quit the window.
12. Compile the control sheets using the Control Builder Compile operation (see page 250).

OW350_80 83
6.8 Assigning component codes to a document

6.8.3 To delete a component code from the Developer Studio

Use the following procedure to delete component codes from the Developer Studio.

1. Access the Search: Object: Control Sheets window (see page 80).
2. Find the component code that you want to delete. Enter -DELETE- in the applicable entry
field in the User Documentation: Sheet Component column. See the following figure.

Figure 34: Search: Object: Control Sheets window showing deleted component code

3. Select the Ok or Apply button to save the change.


4. Compile the control sheets using the Control Builder Compile operation (see page 250).

6.8.4 To define related component codes

You can define related component codes to a sheet. A related component code links another
document (control sheet or simple graphic) to the currently opened document. The document is
related to the current sheet, but is not part of its hierarchy. For example, a sheet in a hierarchy
defined as Turbines in Area 5 may be related to a sheet defined as Turbines in Area 7.

1. Access the Control Builder (see page 27).


2. Open or create a control sheet or simple graphic in the Control Builder (see page 99).

84 OW350_80
6.8 Assigning component codes to a document

3. Go to the Property Editor and a component code in the Related Component Codes field. If
you want to show more than one related code, enter the codes separated by a semi-colon.

Figure 35: Property Editor showing Related Component Codes field

4. From the top of the Control Builder, pull down the File menu and select Save.

OW350_80 85
6.9 What are hyperlinks?

5. To view the sheet in the Component Menu, click the Component Menu icon. Select the
Refresh item on the menu. The new code should appear in the list in its proper place in the
hierarchy along with other documents.

Figure 36: Component Menu showing related component codes

6.9 What are hyperlinks?

Hyperlinks are used as a mechanism for linking control sheets and documents (no control) to
each other. By default, each hyperlink appears on the drawing canvas as a box with text (the text
displays blue, italic, and underlined). The look of the hyperlink box may be changed however you
choose -- colors and shapes may be changed, the box and/or text may be deleted, and/or any
other graphic items be be added.

In the Object Browser, hyperlinks are stored in a separate container called External Hyper Links.

There are three types of hyperlinks:


 External Web link (see page 86) - references documentation on the Worldwide Web
(http/https).
 Supplemental Document link (see page 87) - references a document that is edited, stored,
and distributed by the Ovation Database Server. It may be any document type that the
Windows operating system can open (for example, PDF, Word document, html, and so forth).
It may also be a Control Builder simple graphic (that is, an .svg file that does not have any
control/algorithms on the sheet).
 Component Code Reference link (see page 90) - provides a means to link a control sheet to
another control sheet or link a control sheet to a simple graphic. This link provides a menu to
open documents relevant to the component code. Note that if you are in a simple graphic, the
only way to get back to a control sheet is through this type of link.

86 OW350_80
6.9 What are hyperlinks?

6.9.1 To add external web hyperlinks


1. Access the Control Builder (see page 27).
2. On the main Control Builder window, pull down the Draw menu, and select Add Hyper Link.
Notice the cursor changes to the same cursor used when drawing a rectangle.
3. Left-click the drawing canvas and drag a rectangle to the desired size of the hyperlink. A
rectangular box with blue text appears. Notice that the label text currently reads "undefined."
The Object Browser updates with another container called External Hyper Links. Under the
External Hyper Links container, a new item appears, called Link undefined [].
4. Highlight Link undefined [] in the Object Browser, and go to the Property Editor. Pull down
the Link Type drop-down menu and select External Web Link.
5. In the Property Editor, enter the URL path of the web site that you would like to link to in the
File Name entry field. For example, www.emerson.com
6. In the Label entry field, change the label from "undefined" to any label you wish. In the
following figure, the label was changed to "Emerson Site."

7. You can change the font size, style, width, height, and so forth of the hyperlink rectangle and
text. To do this, expand the Link item in the External Hyper Links container by clicking on the
"+" sign.
8. Highlight the item you wish to change in the Object Browser (Rectangle or Text). Go to the
Property Editor and make the desired changes. For more information, see Property Editor
fields for simple draw items (see page 219).

OW350_80 87
6.9 What are hyperlinks?

6.9.2 To add supplemental document hyperlinks


1. Access the Control Builder (see page 27).
2. On the main Control Builder window, pull down the Draw menu, and select Add Hyper Link.
Notice the cursor changes to the same cursor used when drawing a rectangle.
3. Left-click the drawing canvas and drag a rectangle to the desired size of the hyperlink. A
rectangular box with blue text appears. Notice that the label text currently reads "undefined."
The Object Browser updates with another container called External Hyper Links. Under the
External Hyper Links container, a new item appears, called Link undefined [].
4. Highlight Link undefined [] in the Object Browser, and go to the Property Editor. Pull down
the Link Type drop-down menu and select Supplemental Documentation.
5. In the Property Editor, enter the name of the file that you want to link to in the File Name entry
field. Note that whatever document you choose, it must be located in the Supplemental
Documents folder (OvPtSvr\Systemx\Netx\Unitx\ControlFunctions\SupplementalDocuments).

Note: If the supplemental document that you enter in the File Name entry field does not exist,
the Control Builder will prompt you to create it. For more information, see To create a
supplemental document from a link (see page 89).

6. In the Label entry field, change the label from "undefined" to any label you wish. In the
following figure, the label was changed to "Control Test Document."

7. You can change the font size, style, width, height, etc. of the hyperlink rectangle and text. To
do this, expand the Link item in the External Hyper Links container by clicking on the "+" sign.

88 OW350_80
6.9 What are hyperlinks?

8. Highlight the item you wish to change in the Object Browser (Rectangle or Text). Go to the
Property Editor and make the desired changes. For more information, see Property Editor
fields for simple draw items (see page 219).
9. You can also create a simple graphic using the supplemental document hyperlink. For more
information, see To create a supplemental document from a link (see page 89).

6.9.3 To create a supplemental document from a link

When creating a supplemental document link, if you enter a file name in the Property Editor that
does not exist, the Control Builder will prompt you to create a new file, that is a simple graphic.
Note that if you do not provide an extension, the Control Builder will assume that it is an .svg file.

1. Access the Control Builder (see page 27).


2. On the main Control Builder window, pull down the Draw menu, and select Add Hyper Link.
Notice the cursor changes to the same cursor used when drawing a rectangle.
3. Left-click the drawing canvas and drag a rectangle to the desired size of the hyperlink. A
rectangular box with blue text appears. Notice that the label text currently reads "undefined."
The Object Browser updates with another container called External Hyper Links. Under the
External Hyper Links container, a new item appears, called Link undefined [].
4. Highlight Link undefined [] in the Object Browser, and go to the Property Editor. Pull down
the Link Type drop-down menu and select Supplemental Documentation.
5. In the Property Editor, enter the name of the file that you want to link to in the File Name entry
field. Note that whatever document you choose, it must be located in the Supplemental
Documents folder (OvPtSvr\Systemx\Netx\Unitx\ControlFunctions\SupplementalDocuments).
6. In the Property Editor, enter the name of the new supplemental document that you want to
link to in the File Name entry field. If the new document should be in a folder below the
Supplemental Documents folder, be sure to add the complete path along with the directory
name.
7. Since the document does not exist, the following window appears.

Figure 37: Open External Reference window

8. Select the Yes button on the Open External References window and a blank canvas appears
in the Control Builder ready for you to create a simple graphic. Since this is a simple graphic,
you cannot add algorithms to this document. Refer to Creating a simple graphic in the Control
Builder (see page 216) for more information
9. Enter a title, sheet number, and component code in the Property Editor for this new simple
graphic. Once you give the new document a component code, the Open Related Component
Documents icon should appear in the Standard toolbar. If it does not appear, switch to the
original document that you have open and then back to the new supplemental document and
the icon should appear.

OW350_80 89
6.9 What are hyperlinks?

10. To display the new supplemental document in the related component documents list, save
the document. Select the Open Related Component Documents icon and click the Refresh
item at the bottom of the menu. The new supplemental document should appear in the menu.
11. On the new simple graphic, add a Component Code Reference hyperlink (see page 90). Add
the component code of the control sheet from which you started this simple graphic. In this
way, you can link back and forth between the control sheet and the simple graphic.
12. When everything in the simple graphic is complete, save the document. To make this
document available for downloading, you must publish it (see page 92), so that it will be
connected to the control sheets in the Signal Diagrams.

6.9.4 To add component code reference hyperlinks


1. Access the Control Builder (see page 27).
2. On the main Control Builder window, pull down the Draw menu, and select Add Hyper Link.
Notice the cursor changes to the same cursor used when drawing a rectangle.
3. Left-click the drawing canvas and drag a rectangle to the desired size of the hyperlink. A
rectangular box with blue text appears. Notice that the label text currently reads "undefined."
The Object Browser updates with another container called External Hyper Links. Under the
External Hyper Links container, a new item appears, called Link undefined [].
4. Highlight Link undefined [] in the Object Browser, and go to the Property Editor. Pull down
the Link Type drop-down menu and select Component Code Reference.
5. In the Property Editor, enter the component code that you want to link to in the File Name
entry field.
6. In the Label entry field, change the label from "undefined" to any label you wish. In the
following figure, the Label was changed to "Turbine Valves."

90 OW350_80
6.10 What are supplemental documents?

7. Note that when you click this link you get a menu of related component codes. In this way,
you are linked to multiple documents through the sheets on the menu.
8. You can change the font size, style, width, height, and so forth of the hyperlink rectangle and
text. To do this, expand the Link item in the External Hyper Links container by clicking the "+"
sign.
9. Highlight the item you wish to change in the Object Browser (Rectangle or Text). Go to the
Property Editor and make the desired changes. For more information, see Property Editor
fields for simple draw items (see page 219).

6.10 What are supplemental documents?

Supplemental documents are any documents that do not have control associated with them (that
is, there is no algorithm folder attached to it). These documents are edited, stored, and distributed
by the Ovation Database Server. They may be any document type that the Windows operating
system can open (for example, PDF, Word document, html, and so forth).

A supplemental document may also be a Control Builder simple graphic file (that is, an .svg file
that does not have any control/algorithms on the sheet). When linking a simple graphic to a
control sheet in the Control Builder, you must publish that simple graphic file so that it is
transferred to the online directory and will appear with the control sheet in the Signal Diagram
viewer.

6.10.1 To edit supplemental documents

The Edit Supplemental Documents window allows you to modify the title, sheet number, or
component code of a simple graphic (supplemental document).

1. Access the Control Builder (see page 27).


2. From the main Control Builder window, pull down the Tools menu, and select Supplemental
Documents. Slide the cursor to the right and select Edit Supplemental Documents.
The Edit Supplemental Document window appears.

Figure 38: Edit Supplemental Document window

OW350_80 91
6.10 What are supplemental documents?

3. From the Address pull-down menu, select the directory that contains the Supplemental
Documents folder. The full path name displays in the Address field and the sheets contained
in that folder appear in the window.
4. From the Filename column, determine the file that you want to edit. You may edit the
document number, title, or component code of this file. You cannot edit the actual filename
(this field is grayed out). To edit a field, highlight the field, and make the change.
5. Select the OK button to commit the change and quit the window. Click the Cancel button to
quit the window without saving any changes. Select the Help button to display online Help for
the Edit Supplemental Document window.
6. You can search for a file in the Edit Supplemental Document window using the Find button.
Select the Find button and a Search window appears.

Figure 39: Search window

7. Enter a text string that you want to search for in the Find entry field. Select the Ok button.

6.10.2 To publish supplemental documents

Once you save a simple graphic (supplemental document), you need to publish it, in order to
transfer the file to the online directory and make it available to be viewed in Signal Diagrams.
Once published, it will travel with the control sheet that it is linked to. Publishing has the effect of
moving the Supplemental Documents folder from the offline directory (Control Builder - editor) to
the online directory (Signal Diagrams - viewer):

The offline directory (Control Builder editor) is typically:

OvPtSvr\Systemx\Netx\Unitx\ControlFunctions\SupplementalDocuments

The online directory (Signal Diagrams viewer) is typically:

OvPtSvr\Systemx\On-line\Unitx\SupplementalDocuments
1. Access the Control Builder (see page 27).
2. Open a control sheet in the Control Builder (see page 99).

Note: In order to publish supplemental documents, a control sheet must be open in the Control
Builder.

3. From the main Control Builder window, pull down the Tools menu, and select Supplemental
Documents. Pull right and select Publish Supplemental Documents.

92 OW350_80
6.10 What are supplemental documents?

The Publish Supplemental Documents window appears.

Figure 40: Publish Supplemental Documents window

4. Select the sheet(s) that you want to move to the online directory. A check mark appears in the
column beside the filename.

Note: An arrow beside a column name indicates that the column is sortable either alphabetically
or chronologically. For example, an up arrow means that the column is sorted in alphabetical
order. A down arrow means that the column is sorted in reverse alphabetical order.

5. Select the OK button to transfer the sheets and close the window.

The following table lists and describes the menus, columns, and buttons on the Publish
Supplemental Documents window

Publish Supplemental Documents window fields and descriptions

WINDOW FIELD DESCRIPTION

Filter menu Allows you to determine what states are shown on the window.
 Hide Up to Date -- if checked, files that are up to date are not shown in
the window. Up to date files are those files that have the same version in
the offline and online directories.
 Modified -- if checked, files that have been modified will appear in the
window. A modified file indicates that the file has been changed so that
this newer version of the file exists in the offline directory, but not in the
online directory.
 New - if checked, files that are new and have never been published will
appear in the window. Since these files are new, they do not exist in the
online directory.
 Deleted -- if checked, files that have been deleted will appear in the
window. Files that have been deleted no longer exist in the offline
directory.
Find menu Displays a window that allows you to search for a text string in the Publish
Supplemental Documents window. Enter the text string in the Find field on
the Search window and select the Ok button.
Enable Advanced Mode Toggle option that takes the window from Basic Mode to Advanced Mode.
If the field says "Enable Advanced Mode," it means that you are currently
in Basic Mode.
Basic Mode - files are moved from the offline directory to the online
directory.
Advanced Mode - files are moved from the online directory to the offline
directory. If you click Enable Advanced Mode, a warning message
appears asking you to confirm the mode change. If you confirm the
change to Advanced Mode, the item on the window then reads, "Disable
Advanced Mode."

OW350_80 93
6.10 What are supplemental documents?

WINDOW FIELD DESCRIPTION

Check box Indicates that a file should be published. If no check mark appears beside
the filename, it will not be sent to the online directory.
Filename Shows the full path file name of the simple graphic in the offline directory.
State Indicates the state of the file. The choices are New, Modified, and
Deleted. See Filter menu in this table for more information.
Number Sheet number given to the document in the Property Editor when it was
first created.
Title Title given to the document in the Property Editor when it was first
created.
Component Component code given to the document in the Property Editor when it was
first created.
Master Timestamp Timestamp that indicates the last save of the document in the offline
directory.
Active Timestamp Timestamp that indicates the last save of the document in the offline
directory. The Active Timestamp should match the Master Timestamp
after publishing. If these timestamps do not match, the file versions are
out of sync.
OK Executes the publish and closes the window.
Cancel Closes the window without performing a publish.
Help Displays online help about the window.

94 OW350_80
S E C T I O N 7

7 Building control sheets

IN THIS SECTION

What are the best practices for building control sheets? .................................................. 95
Overview of building sheets for Ovation systems ............................................................. 96
Creating a new control sheet ............................................................................................ 96
Configuring information in Control Builder title box fields ................................................. 98
What is control sheet revision control? ............................................................................. 98
Opening an existing control sheet ..................................................................................... 99
What is the Control Builder Revert function? .................................................................. 106
To recover multiple files .................................................................................................. 107
Saving a control sheet ..................................................................................................... 108
Using the Control Builder Audit function ......................................................................... 108
Deleting control sheets in a Windows-based Ovation system ........................................ 108
Storing control sheets in a Windows-based Ovation system .......................................... 110
Changing control sheet execution order ......................................................................... 112
Reusing control sheets .................................................................................................... 114
Printing control sheets ..................................................................................................... 115
Printing Control Builder reports ....................................................................................... 115
What are permissive windows? ....................................................................................... 120
Loading sheets in a Windows-based Ovation system .................................................... 121

7.1 What are the best practices for building control sheets?

Refer to the following practices when building control sheets:


 Plan the use of control task areas carefully. It is time consuming to move control sheets from
one area to another (sheets would have to be libraried, deleted, and re-added to the new
area). Review what is contained in each control task area. (Moving sheets from one task area
to another can be accomplished through the applicable Ovation configuration tool.)
 Place all algorithms on the sheet first. Use a full window to make placement easier, then add
signal lines. It is easier to move a single algorithm than to move many algorithms.
 Use the entire drawing area since it is easier to read.
 Leave plenty of room for editing, connectors, and so forth.
 Test control templates thoroughly before duplicating them.
 Avoid crossing lines.
 Up to 1500 control sheets can be maintained in one Controller, but approximately 800 sheets
allows for the most efficient management of control by one Controller.

OW350_80 95
7.2 Overview of building sheets for Ovation systems

7.2 Overview of building sheets for Ovation s ystems

The following steps provide a brief overview for building and/or modifying control sheets.

1. Plan all control prior to implementation. Planning saves time and money since rework is
expensive.
2. Perform the Reconcile function before you open any existing control sheet to edit. Reconcile
the Controller to the database and then the database to the control sheet. This ensures that
the database, Controller, and control sheet are all at the same revision level.
3. When creating a new sheet, select the appropriate control task (see page 20).
4. Add algorithms, pins, signals, and page connectors. For algorithms, note the following:
 Input connectors must have a named output.
 The final upstream algorithm requires a named output unless a field algorithm is the final
algorithm.
 You only have to change default algorithm point names if the algorithm interfaces to a
graphic.
5. Save the sheet and check for errors.
6. Load the sheet into the Controller that is in control.
7. Wait to see if the new control adversely affects the system.
8. If there are no adverse effects, load the backup Controller.
9. Review signal diagrams and tune the process as necessary.

7.3 Creating a new control sheet

When you create a new control sheet, you select the Controller where you want to create the new
sheet and select the Control Task area (1 - 5) for the new sheet. The Control Task area (see page
20) defines how frequently the sheet is executed.

7.3.1 To create a new control sheet in a Windows-based Ovation system


1. Access the Ovation Developer Studio (see Ovation Developer Studio User Guide for more
information).
2. Use the system tree to navigate to the applicable Control Sheets folder:
System folder
Network folder
Unit folder
Drops folder
<Controller drop> folder (applicable to the sheets that you want to delete)
Control Task folder (applicable to the sheets that you want to delete)
Control Sheets folder
3. Right-click the Control Sheets folder in the system tree.

96 OW350_80
7.3 Creating a new control sheet

The New Control Sheets window appears.

Figure 41: Developer Studio - New Control Sheets window

The following table describes the New Control Sheets dialog box entry fields.

New Control Sheets dialog box fields

FIELD DESCRIPTION

Sheet Name This defines how the sheet is described in the system (for example, DigitalTest).
This name (up to 30 characters) appears in the Control Sheets section of the Studio
hierarchy.
Sheet Number Short reference number (maximum three characters). This number is used to
identify the sheet to the user, but is not the unique internal .svg file number that is
assigned by the Control Builder.
Sheet Component Defines the sheet component code (see page 69).
4. Enter the applicable information in the New Control Sheets dialog box, and select Ok.
5. The Control Builder opens a new sheet. The Property Editor displays the information that was
entered in the New Control Sheets window. Complete the remaining fields in the Property
Editor as it pertains to the new sheet. This information displays in the document title box.
6. Create your sheet using algorithms, pins, signals, etc. Refer to Understanding the elements of
a control sheet (see page 177) for more information.
7. After you finish creating the control sheet, save it. The new control sheet appears in the
Control Sheets list in the Studio.
8. Once you have accessed the Control Builder, you can create additional new sheets by pulling
down the File menu on the main Control Builder window and selecting New -> Control
Function.

OW350_80 97
7.4 Configuring information in Control Builder title box fields

7.4 Configuring information in Control Builder title box fields


Each sheet contains a title box in its lower right corner. The project-specific system frame.svg file
that is provided by Emerson determines how the title box appears. The frame.svg file contains
the frame, title box lines, Emerson company name, and Emerson Proprietary Statement. This
information is typically created for a project and is not changed.

If a project needs to create a custom title box, changes can be made to the frame.svg file. In
addition, a second copy of the frame.svg file can be created and used for sheets that require
special information. This version of the frame.svg file can be used in certain circumstances while
leaving the original frame.svg file for regular sheets. Refer to What is the Control Builder frame?
(see page 23) for more information.

The information that appears in the title box fields is defined in the Property Editor. An example of
a title box appears in the following figure.

Figure 42: Title box

7.5 What is control sheet revision control?

It is important to the integrity of the system control to ensure that the control sheets are kept
current. The three fields in the control sheet that can be used for revision control are the Revision
no. field, the Created field, and the Last modified field. Revision control is typically considered to
be the responsibility of the project engineer(s).

Revision levels are indicated by an alphabetical or numerical character. Revision no. and Last
modified fields should be updated each time a significant event occurs, such as shipment to the
customer or final acceptance by the customer.

The following table illustrates the recommended revision indicators for control sheets:

Revision indicators for control sheets

INDICATOR DESCRIPTION

A, B, C ... X These alphabetical indicators are used to indicate the revision level of a sheet that is
being created and is a work-in-progress. This is known as a drawing submittal.

Rev 0 This is the revision level of the sheet when it is shipped to the customer site. This is
known as the “as-shipped” revision.

Rev 1 This is the revision level of the sheet when the control on the sheet is actually used
online to generate power, process water treatment, or any other actual function. This
is known as the “as-commissioned” revision.
Rev 2 .....n This is the revision level of the sheet when the as-commissioned version (Rev 1) is
updated.

Revision control and updating are handled through the Property Editor.

98 OW350_80
7.6 Opening an existing control sheet

7.6 Opening an existing control sheet

When you open an existing control sheet in the Control Builder, the following functions are
performed automatically:
 Title Block - Title information is reconciled with the database (title, number, and so forth).
 Tuning Reconcile - The algorithms on the sheet are compared with the algorithm records in
the Oracle database. Differences are considered to be tuning changes. It is a good practice to
reconcile after making tuning changes.
 Sheet Audit - The drawing is checked for internal consistency and for syntax errors. If any
errors are detected, a list of errors displays. Refer to Information and error messages (see
page 399) for descriptions of the errors.
Internal consistency is the verifying of graphical signals, dynamic text, and algorithm
connections. Syntax errors are mistakes in the content-based data within an algorithm, data
such as point record types and value ranges.

Sheets are accessed from the Select file to open window (see page 99). The window has two
views that can be used to find sheets:
 Drop layout view (see page 100).
 Component code view (see page 102).

7.6.1 Understanding the Select file to open window

The following figure shows the Select file to open window set to the Drop Layout view. Note that
the window fields and buttons are the same for both the Drop Layout and the Component Code
Layout. Only the hierarchy tree on the left side of the window changes depending on the layout
selected.

Figure 43: Select file to open window - Drop Layout

OW350_80 99
7.6 Opening an existing control sheet

The following table lists and describes the icons and buttons in the Select file to open window.

Select file to open window item descriptions

FIELD OR ICON DESCRIPTION

Address entry field Shows the directory path that contains the sheets that appear in the
hierarchy tree.
Browse Directories icon Displays a Browse for Folder window which allows you to select a
directory and folder from which to display sheets. This path then displays
in the Address entry field.
Refresh Document Tree icon Displays the Refresh Document List window that prompts you to
regenerate the cache file if it becomes outdated. Regenerating this file
updates the Select file to open window so that any newly added sheets
appear in the window.
Layout drop-down menu Presents two different views of the sheet hierarchy tree:
 Drop Layout - sheets are organized by drop and control task.
 Component Layout - sheets are organized by component code.
Search document tree icon Displays a Find window that allows you to enter text strings in the entry
field that represent all or part of a document title.
Document list window pane Displays the sheets in a hierarchical tree for both the drop layout and the
component layout.
Preview window pane Displays a preview image of the sheet that you select in the Document
list window pane.
OK button Selects the sheet to open in the Control Builder and closes the Select file
to open window.
Cancel button Quits the Select file to open window without opening any sheets.
Help button Provides online help on the Select file to open window.

Note: For projects that have a valid SIS license, the hierarchy tree displays SIS sheets under
their applicable Control Module and Logic Solver. See To open an SIS sheet in the Control
Builder (see page 360).

7.6.2 To open an existing control sheet using the drop layout


1. Access the Control Builder (see page 27).

100 OW350_80
7.6 Opening an existing control sheet

2. Pull down the File menu, and select Open. The Select file to open window appears. Note that
when the window appears, the Drop Layout type is the default.

Figure 44: Select file to open window - Drop Layout

3. The Address field at the top of the window shows the directory path that contains the sheets
that appear in the hierarchy tree. Note that you cannot edit the path in the Address entry field.
To change the path, see Step 4; otherwise go to Step 5.
4. To change the path in the Address field, select the Browse icon (first icon next to the Address
entry field). A Browse for Folder window appears. Select the directory that contains the sheets
that you want to appear on the window and click OK.
5. From the Layout drop-down menu, select Drop Layout. The document tree on the left side of
the window displays sheets as they are organized by drop and control task. Click the + and -
signs to expand or collapse the folder contents.
6. Expand a Task folder to view the sheets that belong to a particular control task in that drop. If
you select a sheet, a preview of that sheet appears on the right side of the Select file to open
window.
7. If a sheet does not appear in the directory tree, select the Refresh icon (next to the Browse
icon) to update the sheets in the directory tree. Select Yes on the window that appears.

Figure 45: Refresh Document List window

OW350_80 101
7.6 Opening an existing control sheet

8. To search for a sheet in the hierarchy, select the Search icon (next to the Layout drop-down
menu). The Find window appears.

Figure 46: Find window

9. Enter a text string that represents all or part of the document title that you want to search for.
Select the OK button.
10. Once you find the sheet to open, click the sheet and select the Ok button. The sheet displays
on the Control Builder canvas.

Note: For Windows-based Ovation systems, you can also access sheets from the Ovation
Developer Studio (see page 27); however, every time you open a sheet in the Developer Studio,
you start a new instance of the Control Builder. To open multiple sheets in one Control Builder
instance, use the Open function on the Control Builder File menu.

11. Edit the sheet as desired. Refer to Understanding the elements of a control sheet (see page
177) for more information.

7.6.3 To open an existing document using the component code layout


1. Access the Control Builder (see page 27).
2. Pull down the File menu, and select Open. The Select file to open window appears.
3. The Address field at the top of the window shows the directory path that contains the sheets
that appear in the hierarchy tree. Note that you cannot edit the path in the Address entry field.
To change the path, see Step 4; otherwise go to Step 5.
4. To change the path in the Address field, select the Browse icon (first icon next to the Address
entry field). A Browse for Folder window appears. Select the directory that contains the sheets
that you want to appear on the window and click OK.
5. From the Layout drop-down menu, select Component Layout (see the following figure). The
document tree on the left side of the window displays sheets as they are organized by
component codes (see page 69). Click the + and - signs to expand or collapse the folder
contents.

102 OW350_80
7.6 Opening an existing control sheet

Note: The default view of the Select file to open window is the Drop Layout view since assigning
component codes to sheets is optional. Sheets that have not been coded appear in the window
under a folder called "Undefined Component Tags."

Figure 47: Select file to open window - Component Layout

6. If a sheet does not appear in the directory tree, select the Refresh icon (next to the Browse
icon) to update the sheets in the directory tree. Select Yes on the window that appears.

Figure 48: Refresh Document List window

OW350_80 103
7.6 Opening an existing control sheet

7. To search for a sheet in the hierarchy, select the Search icon (next to the Layout drop-down
menu). The Find window appears.

Figure 49: Find window

8. Enter a text string that represents all or part of the document title that you want to search for.
Select the OK button.
9. Once you find the sheet to open, click the sheet and select the Ok button. The sheet displays
on the Control Builder canvas.

Note: For Windows-based Ovation systems, you can also access sheets from the Ovation
Developer Studio (see page 27); however, every time you open a sheet in the Developer Studio,
you start a new instance of the Control Builder. To open multiple sheets in one Control Builder
instance, use the Open function on the Control Builder File menu.

10. Edit the sheet as desired. Refer to Understanding the elements of a control sheet (see page
177) for more information.

7.6.4 To open a locked control sheet

If you select a sheet that has a lock symbol beside it, you cannot open the sheet because it is
locked. This could happen if another user has the sheet open or if the sheet was open when the
Control Builder exited unexpectedly. When you select a locked sheet, notice that an Unlock
button appears beside the OK button at the bottom of the Select file to open window. At the
bottom left corner of the window, the system displays the name of the user who has the sheet
locked and what drop he is using.

1. Access the Control Builder (see page 27).


2. From the main Control Builder window, pull down the File menu and select Open. The Select
file to open window appears.
3. Select a locked sheet in the folder hierarchy and press the Unlock button. A warning
message displays asking you to verify the unlock process.

104 OW350_80
7.6 Opening an existing control sheet

Note: The Address entry field displays the path where the control functions are found. The
following figure shows a Windows-based path. For Solaris-based systems, a Solaris path would
appear.

Figure 50: Example of a locked file

4. Select the Unlock button on the warning window and the sheet unlocks. You can then select
the sheet to display on the Control Builder canvas.
5. Click the sheet and select the OK button. The sheet displays on the Control Builder canvas.

Note: Emerson recommends that you do not unlock a sheet if you know another user is
working on it. If more than one user is editing a sheet, changes may be lost or overwritten
depending on who saves the sheet first and loads it to the Controller.

OW350_80 105
7.7 What is the Control Builder Revert function?

7.6.5 To open a recovered version of a file

If the Control Builder exits unexpectedly while a sheet is opened, you will have the opportunity to
open the last saved version of the sheet or a recovered version.

1. Open an existing control sheet. If the sheet has a recovered version, a window appears
showing an original version of the file and a recovered version:

Figure 51: Recovering a newer version of a file

2. Choose one of the following buttons:


 Recover -- loads the newer, recovered version of the file. This is the image on the right
side of the window.
 Continue -- loads the original version of the file (image on the left side of the window)
and permanently removes the recovered file and any other temporary files associated
with the original.
3. The selected version of the file appears on the main Control Builder window.

7.7 What is the Control Builder Revert function?

The Revert function returns to the last saved version of a sheet. This function can be used to
return to a previously saved version of a sheet and to discard any current, unsaved changes
made to the sheet.

7.7.1 To use the Control Builder Revert function


1. Access the Control Builder (see page 27).
2. Open a sheet in the Control Builder (see page 100).

106 OW350_80
7.8 To recover multiple files

3. Pull down the File menu on the main Control Builder window and select Revert. The following
message appears.

Figure 52: Revert message

4. Select Yes to discard the unsaved edits and load the last saved version of the file. Select No
to keep the current version of the file.
5. If Yes is selected, the last saved version of the file appears on the Control Builder canvas.

7.8 To recover multiple files

The Recover Files function recovers files that you may have been working on if the Control
Builder exits unexpectedly.

1. Access the Control Builder (see page 27).


2. From the main Control Builder window, pull down the File menu, and select Recover Files.
a) If you currently have a sheet loaded in the Control Builder, the following error message
appears:
Please make sure that all active edits are closed before executing this
command.
b) If there are no sheets loaded in the Control Builder, the following message appears:

3. Close all loaded sheets and then select the Yes button on the Confirm single instance
window. You will not be able to recover files if sheets are loaded or more than one instance of
the Control Builder is running. The Recover Files window appears.
4. Select the files to recover from the scrolling list. A check mark appears by those files that are
selected. When you place a check in the box, the file appears in the preview pane on the right
side of the Recover Files window.
5. Select one of the following buttons:
 Load Selected -- loads the selected files into the Control Builder.
 Ignore -- quits the Recover Files window without performing any action on the files.

OW350_80 107
7.9 Saving a control sheet

 Clean Up -- deletes all of the recovered files -- it does not just delete the ones that have
a check in the box. A warning message appears asking if you are sure that you want to
clean up. After you load and recover the files you want, it is a good practice to delete
unnecessary files since recovered files are large and use considerable disk space.

7.9 Saving a control sheet

When you save a control sheet, the Control Builder performs the following:
 Checks the Syntax - If syntax errors are found, a list of errors display and the Control Builder
does not save the sheet. An error message also appears advising you that Control has not
been saved. Refer to Information and error messages (see page 399).
 Updates Oracle Database - If no errors are found, the control from the sheet is written to the
disk, and the Control Builder loads the sheet number into the Oracle database. In order to
activate the control logic on the sheet, you must load the control sheet into the Controller. For
Windows-based Ovation systems, this is done through the Developer Studio. For Solaris-
based Ovation systems, this is done through the Drop Loader.

7.10 Using the Control Builder Audit function

The Audit function validates a control sheet by performing the following tasks:
 Checks the drawing for internal consistency. Internal consistency is the verifying of graphical
signals, dynamic text, and algorithm connections.
 Checks the drawing for syntax errors. Syntax errors are mistakes in the content-based data
within an algorithm, data such as point record types and value ranges. If syntax errors are
found, the data cannot be saved.
 Updates internal data and dynamic text for a sheet.
If errors are detected, an Error List window updates, listing the errors

Note: To view the errors, the Error List window must already be opened. To open the Error List
window, pull down the View menu and select Algorithm Errors. The Audit function does not
automatically display the Error List window.

The Audit function automatically validates a sheet whenever it is opened or saved in the Control
Builder. You can also run the Audit function manually by pulling down the File menu and selecting
Audit.

7.11 Deleting control sheets in a Windows -based Ovation system

To delete sheets from your Ovation system, you must use the Developer Studio. Once sheets
have been deleted, they cannot be recovered. Be sure to load the Controller (see page 121) after
you have deleted sheets.

108 OW350_80
7.11 Deleting control sheets in a Windows-based Ovation system

7.11.1 To delete control sheets in a Windows-based Ovation system

CAUTION! Be careful when deleting control sheets since removing sheets from the system
could adversely affect your control scheme. Also note that the database item, Control Builder
files, and the default points associated with the sheet are permanently deleted. If a higher level
folder (drop, unit, network, or system) is deleted, all control sheets under that folder are
deleted.

1. Access the Ovation Developer Studio (see Ovation Developer Studio User Guide for more
information).
2. Use the system tree to navigate to the applicable Control Sheets folder:
System folder
Network folder
Unit folder
Drops folder
<Controller drop> folder (applicable to the sheets that you want to delete)
Control Task folder (applicable to the sheets that you want to delete)
Control Sheets folder
3. Select the Control Sheets folder and a list of all the sheets in that folder appears in the
WorkPad area at the bottom of the Ovation Developer Studio.
4. Right-click the sheet you want to delete, and select Delete.
5. A window appears with the following message, "Are you sure you want to delete the selected
item(s)?". Select Yes to confirm the delete.
6. Follow the procedures in Loading sheets in a Windows-based Ovation system (see page 121)
to update the system.

OW350_80 109
7.12 Storing control sheets in a Windows-based Ovation system

7.12 Storing control sheets in a Window s -based Ovation s ystem

After the functional drawings (sheets) are created, they are stored in the Ovation Developer
Studio directory structure. (See Ovation Developer Studio User Guide.)

The path for sheet storage is shown in the following example of a Studio system tree. The figure
depicts the location of the Control Builder sheets for a drop in the system tree. The illustrated
hierarchy from top to bottom is:
 System (Val55y22)
 Network (VAL5NT22)
 Unit (Unit 0)
 Drop (Drop 22/Drop 72, redundant Controllers)
 Control Task 2
 Control Sheets (for Drop 22/Drop 72) in Control Task 2
 List of actual Control Sheets in Control Task 2
Every time you create and save a new drawing in a Unit, the Control Builder gives it a unique
four-digit hexadecimal number, and stores it in the Control Sheets directory where it is location
independent.

The Control Sheets directory is a Master directory for all the sheets in an entire Unit and enables
the Control Builder to display the correct drawing when requested and to avoid duplication of
drawing numbers.

Notice that all the control sheets for one unit are stored in a folder called Control Sheets.

110 OW350_80
7.12 Storing control sheets in a Windows-based Ovation system

Figure 53: Example of Control Sheets folder location in the Studio

OW350_80 111
7.13 Changing control sheet execution order

7.13 Changing control sheet execution order

You can change the order in which control sheets execute. A Control Builder utility provides a
user-friendly interface for defining the execution order for all the sheets within one specific task
area. Since tasks execute asynchronously in the Controller, it is not possible to order the
execution of sheets outside of one task.

For Windows-based Ovation systems only -- When you select the Control Sheets folder from
the Ovation Developer Studio directory hierarchy, a window appears allowing you to select the
drop and task area that you want to order. Once a drop and area are selected, a window appears
showing the sheets that appear in that drop and task area. If the sheet number sequence does
not represent the desired order, you can rearrange the execution order. Note that when ordering
sheets from the Developer Studio, Sheet Order is listed on the Control Builder operations window.
See Ovation Developer Studio User Guide.

Note: You cannot use this utility to add or remove sheets.

7.13.1 To change control sheet execution order


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Order Sheets.
A Browse for Folder window appears.
3. Select the directory where the sheets reside and press the Ok button. The Select Drop and
Control Task window appears.

Figure 54: cbOrder window

4. Expand the drop folder to reveal the task areas for that drop. Select a Control Task area and
select the Ok button.

112 OW350_80
7.13 Changing control sheet execution order

The Sheet Execution Order window appears.

Figure 55: Order control sheets window

The icon and button descriptions, from left to right, are:


 Move up -- Moves the selected sheet(s) one position higher in the execution order.
 Move down -- Moves the selected sheets(s) one position lower in the execution order.
 Undo -- Undoes any changes that have been made.
 Cut -- Removes a sheet from the list so that it can be pasted at a different location on the
window.
 Paste -- Pastes a sheet that was cut into a new area on the list.
 Sort -- Sorts the sheets alphabetically based on filenames.
 Change drop/task -- Accesses another task and/or drop for ordering sheets.
 Ok button -- Saves the changes and exits the window.
 Cancel button -- Quits the window without ordering any sheets.
 Help button -- Provides online help on using the window.
5. Use the toolbar at the top of the window to move sheets.

OW350_80 113
7.14 Reusing control sheets

6. When you finish ordering sheets, select the Ok button to save the new sheet order and exit
the window, or select the Cancel button to quit the window without saving the changes.
7. Since you changed the control sheet execution order, make sure you load the Controllers
(see page 121) so that they have the most update information.

7.14 Reusing control sheets

In order to increase the efficiency of creating control sheets, you should design control sheets that
can be reused. The following are recommendations for creating control sheets that you can easily
reuse:
 Provide a user-defined point name (not a default point name) for all points that will be used in
graphics (for output or for page connectors).
 Add an output symbol for all signals required in graphics or alarms.
 Clearly identify all the variables that are to be displayed on M/A Stations.
 Always use the MAMODE algorithm with M/A stations.
 When testing logic, if execution time is a problem, reorder the drawing execution left to right
for digital control, and top to bottom for analog control.
 When creating a new project, note the layout of the sheet numbers and ensure that all the
drawings of a specific type of control are grouped together. This reduces testing time by being
able to quickly locate the control sheets. For example:
Drop 1
Sheet 01-20 --LDC
Sheet 21-30 -- Air Flow CNTL
Sheet 31-40 --Furnace Pressure
This approach creates the control in a modular form and facilitates the reuse and
development of standard documentation and graphics for a particular application.

7.14.1 Tag names for internal point names

Use standard tag names for internal point names. The recommended format is:

X-YYY-WWWWW00-VV00
Where:
X = Unit number for the system. Typically, this is one (1), if only one unit is in the system.
YYY = Application/Module Type. This code identifies the type of control that this drawing is
being used for. For example,
LDC = Load Demand Computer
FWS = Feedwater System
STM = Steam Temperature Controls
AIR = Secondary Air Controls
MOT = Motor Logic
VLV = Valve
FUE = Fuel System
WWWWW00 = Equipment/Signal Pneumonic. This code describes the equipment and/ or
process that this point belongs to. For example,

114 OW350_80
7.15 Printing control sheets

MILLA = Mill A
FWGT = Feedwater Greater Than
STEAM = Steam
BFPA = Boiler Feed Pump A
00 = These two characters could be used if the Signal Type Portion of the point name has
only two characters.
VV00 = Signal Type. This code describes the type of signal that corresponds to this particular
point name. For example,
HIGH = High
DEM = Demand
OPEN = Opened
CLSD = Closed
ON = Running/On
OFF = Stopped/Off
FLOW = Flow
PRESS = Pressure
TEMP = Temperature
00 = These two characters could be used if the Equipment/Signal Pneumonic has five or
less characters.
Some examples of point names using this convention are:
1FWS-FWGT-DEM = Feedwater greater than demand
1LDC-BFP-RBAK = LDC Boiler Feed pump Runback
1LDC -ADJGGROSS-MW = LDC Adjusted Gross Megawatts
1MOT-IDFANA-ON = ID Fan A running
1VLV-FWREC-OPEN = Feedwater Recirculation Valve Open

7.15 Printing control sheets

The Ovation Control Builder provides for printing different types of information about the control
sheets, as well as the control sheets themselves.

To print the sheet that is currently loaded in the Control Builder, pull down the File menu and
select Print. Printing is performed using the standard Windows Print dialog box.

7.16 Printing Control Builder reports

The Print Reports function prints different types of information about a sheet. To print a report,
pull down the File menu and select Print Report. Pull right to display the report choices. Printing
is performed using the standard Windows Print dialog box.

OW350_80 115
7.16 Printing Control Builder reports

7.16.1 Algorithm Details report example

The Algorithm Details report prints information about the algorithms on a sheet, such as input and
output points and tracking information.

Figure 56: Algorithm Details report

116 OW350_80
7.16 Printing Control Builder reports

7.16.2 Connector information report example

The Connector Information report prints information about the page connectors on the sheet.

Figure 57: Connector Information report

OW350_80 117
7.16 Printing Control Builder reports

7.16.3 Execution Order report example

The Execution Order report prints the execution order of the algorithms on the sheet.

Figure 58: Algorithm Execution Order report

118 OW350_80
7.16 Printing Control Builder reports

7.16.4 Title Page report

The Title Page report prints all the user-defined numbers and sheet titles for a Controller. This can
be used as a Table of Contents for a project.

Figure 59: Title Page report

7.16.5 Print Ladder(s) report

The Print Ladder(s) report prints information about all the ladders on the sheet

OW350_80 119
7.17 What are permissive windows?

7.17 What are permissive w indow s?

The Graphics Display System (also known as the Process Diagram System) allows you to view
graphic diagrams at the Operator Station. These diagrams give an operator direct interaction with
the process flow through system displays. For more information on the Graphics Display System,
see Ovation Operator Station User Guide.

Permissive windows are a special type of graphic diagram. Permissive windows provide a
standard method for displaying feedback on a process or device diagram. For example, if a
device fails to start, a permissive window provides text feedback indicating what the problem is.

To access permissive windows, a poke field can be added to a graphics display diagram for each
area requiring a permissive window. A maximum of 10 permissive conditions are permitted on
each window. For more information on permissive windows and poke fields, see Ovation
Graphics Builder User Guide.

Permissive windows are typically built by Emerson project engineers. Previously, it involved a
time-consuming process. Now the Control Builder provides a way to add a permissive window
algorithm to a control sheet. The permissive algorithm generates information based on the sheet's
logic and translates it to a series of pass/fail conditions for the device. The algorithm is then called
by an application program which is attached to a poke field on a graphics display diagram.
Clicking on the poke field displays the permissive window. (See Ovation Graphics Language
Reference Manual for information on application programs.)

7.17.1 Using the Control Builder to create permissive windows

Since permissive windows are typically built by Emerson project engineers, the permissive
window algorithm is not released in the standard set of Ovation algorithms. Once a project
engineer creates a symbol for the algorithm, it will be available on the Control Builder Add
Algorithm window.

When you add a permissive window algorithm to a sheet, you must define the algorithm's
parameters in the Property Editor. For permissive windows, you must enter a unique device name
and up to eight inputs (called titles on the Property Editor). Note that the Control Builder does not
enforce unique device names; that is, there is no warning message that appears if a device name
is repeated. It is the user's responsibility to monitor the use of unique device names.

After you save the control sheet that has the permissive window algorithm, a file is generated.
This file is in the form <deviceName>.<unitName>. For example, valve1.unit2.

When a project engineer builds a graphic that requires a permissive window, a graphics
application program, EXECUTE_PROCESS (202), is used to call the file that was generated by
the Control Builder. The syntax used in the application program is:

PermissiveWindow.exe -device<deviceName>.<unitName> [-pos:x,y]


The <deviceName> is the name of the file that the permissive window generated and
<unitName> is the unit name for the drop that originates the sheet with the permissive window
algorithm. The x,y give the override location to display the window.

The application program is then attached to a poke field on the graphics diagram. When the poke
field is pressed, the permissive window for that device will appear.

See Ovation Graphics Language Reference Manual for information on poke field and application
program syntax.

120 OW350_80
7.18 Loading sheets in a Windows-based Ovation system

7.18 Loading sheets in a Window s -based Ovation s ystem

When you create a new Control Builder drawing or edit an existing drawing, you must load the
Controllers so you can display the drawing at the Operator Stations.

Note: For Ovation releases 3.2 and later, you no longer have to manually download sheets to
MMIs. A service runs in the background that updates the MMIs on startup and every few
minutes.

1. Access the Control Builder (see page 27).


2. Create or edit a control function (.svg) file in the Control Builder and save it. The file is saved
to the Oracle database.
3. Load the control to the Controller from the Oracle database:
a) Access the Controller Drop folder in the Studio. (See Ovation Developer Studio User
Guide.)
b) Right-click the appropriate Controller Drop folder and select Load.
c) For redundant Controller Drop configurations, the “Select a drop to load” dialog box
appears. Select the Primary Controller Drop. The .svg file is saved to the Controller.

CAUTION! Make sure changes are valid before loading the Partner Drop in redundant
Controller Drop configurations.

Please note the following information:


 When the Controller drop is loaded, the control functions (sheets) are copied to the online
directory under OVPTSVR (Ovation Data Server). This makes them available to the MMIs.
The MMIs will update their local copy within a minute of the load.
 The files under OVPTSVR are displayed by the signal diagrams if they are opened from the
Control Builder main window.
 The local files under C:\Ovation are displayed by the signal diagrams if they are opened from
any mechanism other than the Control Builder main window (such as a Point Menu or the
Ovation Applications window).
 A service runs in the background that updates the MMIs on startup and every few minutes
thereafter.
 After loading the Controller, the engineer may review the diagrams without downloading the
Operator Stations by opening the signal diagrams from the Control Builder Tools menu.
 Control becomes operational when the Controller is loaded. Control execution is completely
independent from downloading the Operator Stations.
 You can view Signal Diagrams before loading the Controller with the Synchronize Online
option (see page 276).

OW350_80 121
S E C T I O N 8

8 Understanding algorithms and algorithm


components

IN THIS SECTION

What are algorithms? ...................................................................................................... 123


What are algorithm anchors? .......................................................................................... 130
Ordering algorithm execution .......................................................................................... 132
What is the Control Builder Algorithm Value function? ................................................... 137
Organizing and standardizing algorithm values .............................................................. 142
What is the Control Builder Algorithm Value Indicator function? .................................... 148
What is the Control Builder Symbol Browser window? ................................................... 150
What is the Control Builder Favorites window? .............................................................. 154
What is the CALCBLOCK algorithm?.............................................................................. 158
Configuring the BALANCER algorithm with MASTATIONs ............................................ 160
What is the Control Builder Function Generator Graph? ................................................ 164
What are control macros? ............................................................................................... 165
What is the Macro Interface Editor window? ................................................................... 174

8.1 What are algorithms?

Algorithms are mathematical formulas that define a specific control strategy. An algorithm may be
thought of as a collection of system points that are controlled by the algorithm. The algorithm
reads values and writes values into points to accomplish certain desired actions in the system.

The Ovation Control Builder places these algorithms on control sheets to tell the Ovation control
system what algorithms to use, what points to associate with the algorithms, and in what order the
algorithms should execute. The Control Builder combines multiple algorithms and even multiple
control sheets to create an entire control strategy for a system process.

The Ovation algorithms are typically provided with the Ovation Controller, and are used to
implement a wide range of functionality for a Controller. Each algorithm is represented in the
Control Builder by a unique symbol.

Algorithms and record types are described in Ovation reference manuals. (See Ovation
Algorithms Reference Manual and Ovation Record Types Reference Manual.) You can access
the Ovation Algorithms Reference Manual from the Control Builder window. To do this, pull down
the Help menu on the main Control Builder window and select Algorithm Guide.

Note: Page connectors (see page 185) are similar to algorithms, but are not used in control, and
are not sent to the Controller. They are graphical representations that depict how signals are
connected between sheets.

OW350_80 123
8.1 What are algorithms?

8.1.1 What are best practices for using algorithms?


 Always use the full potential of an algorithm when planning and creating control. (See Ovation
Algorithms Reference Manual.) This reduces the number of algorithms needed in your control
sheets.
 Wherever possible, reduce the number of algorithms used in your control plan.
 Do not use unnecessary GAINBIAS algorithms.
 Use MAMODE algorithm priority raise/lower instead of external transfers below MASTATION
algorithms.
 You can have a maximum of 143 fast Boolean algorithms on a single sheet.

8.1.2 Add Algorithm window and field descriptions

The Add Algorithm dialog box allows you to select Ovation algorithms (standard and custom) and
add them to a control sheet.

Figure 60: Add Algorithm dialog box

124 OW350_80
8.1 What are algorithms?

The following table discusses the Add Algorithm dialog box fields.

Add Algorithm dialog box fields

FIELD DESCRIPTION

Algorithm Symbols
 Fast Boolean Selects the Boolean logic algorithms.
 Calculation block Adds a CALCBLOCK or a CALCBLOCKD algorithm. These are
standard Ovation algorithms designed to support user-defined
complex mathematical equations.
 External Point Adds an input or an output.
 Foundation Fieldbus Algorithms that are used with Foundation Fieldbus I/O devices.
 7x9 Ladder Adds a 7x9 ladder to the canvas.
 Ladder Element Adds a ladder element to the drawing canvas. The elements are:
coil, contact, orbar, and rail.
 Control Macros If control macros have been created, this adds a macro to the sheet.
 Ladder Special Functions Adds a ladder special function to the drawing canvas. The special
functions are COMPARE and COUNTER.
 Standard Selects from the remaining Ovation algorithms that do not fall into
one of the other categories.
Show All Algorithms (check box) Displays all the Ovation, ladder, and special function algorithms on
the Add Algorithm window, even those that do not have a symbol
associated with them.
Refresh Refreshes the Add Algorithm window to show all the algorithm
symbols. This feature is helpful when adding new algorithm symbols
through the Symbol Builder. Newly added symbols may not initially
appear in the Add Algorithm window. Using the Refresh button
updates the Add Algorithm window to display any newly created
symbols.
Ok Accepts the selection made on the Add Algorithm window and adds
the item to the sheet.
Cancel Quits the Add Algorithm window without accepting any algorithm
selection to add to the sheet.
Help Provides online help on the Add Algorithm window.

8.1.3 To add an algorithm


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, open a control function, control library, or control
macro.
3. From the main Control Builder window, pull down the Draw menu, and select Add Algorithm.
You can also select the Add Control Algorithm icon on the toolbar. The Add Algorithm
dialog box appears.

OW350_80 125
8.1 What are algorithms?

Note: You can also add algorithms to a control sheet using the Symbol Browser (see page 150)
and the Favorites Folder (see page 154).

4. Select the desired algorithm from the list. The algorithm symbols that are currently in the
library display on the right side of the dialog box.

Figure 61: Add Algorithm dialog box -- select algorithm symbol

Note: You can have a maximum of 143 fast Boolean algorithms on a single sheet.

5. Select the symbol that best fits your needs (symbols may vary depending on the number of
pins needed).

Note: Instead of clicking the OK button on the window and using the mouse to add the algorithm
to the sheet, you can use the <Enter> key on the keyboard. Using the mouse only allows you to
add one instance of the algorithm. Using the <Enter> key allows you to add multiple instances
of the algorithm.

6. Select the OK button on the Add Algorithm dialog box.


7. Move the cursor, which has changed to an arrow, to the drawing canvas. Move the algorithm
to the desired location and left-click to position the algorithm on the canvas. Notice that a full-
screen cross-hair icon appears that aligns items on the screen. While moving the algorithm
across the canvas, you can toggle the full-screen cross-hair cursor by pressing the <Shift>
key on the keyboard. This is useful for aligning items on the canvas.

126 OW350_80
8.1 What are algorithms?

Note: When adding an algorithm, notice the algorithm anchor, shown in yellow. Once the
algorithm is added to the canvas, the anchor can be used to align and space the algorithm on
the sheet. If you hover the mouse over the anchor, the icon changes to a hand. If you left-click
the mouse button, the hand "closes" as though it is gripping the anchor (see page 130). You can
then move the algorithm to the desired location.

8. After adding the algorithm using the Add Algorithm dialog box, the algorithm appears in the
Algorithms container in the Object Browser window. The algorithm parameters (see page 128)
appear in the Property Editor window where you can edit them.

8.1.4 To select the size of algorithm icons

You can change the size of the algorithm icons that appear in the Add Algorithm window.
Changing the size of algorithm icons may be useful for those times when you want smaller icons
so that more icons fit on a single "page" of the window.

1. Access the Add Algorithm window (see page 125).


2. Right-click anywhere on the right-side pane of the window to display a menu.

Figure 62: Add Algorithm window - resize icons

3. Select one of the three images sizes: small, medium, or large. The icons on the Add
Algorithm window resize accordingly.

Note: The Help item on the menu displays online help about the selected algorithm.

OW350_80 127
8.1 What are algorithms?

8.1.5 To edit algorithm parameters

The Object Browser and the Property Editor provide a means to edit and change an algorithm's
internal configuration. You can modify any part of the algorithm -- from the individual lines
comprising the algorithm symbol to the algorithm constants and output points.

Use the following procedure to edit algorithm parameters:

1. Access the Control Builder (see page 27).


2. To edit the values and points for the algorithm, highlight the algorithm name in the Object
Browser window. The Property Editor updates with a list of editable parameters.

3. Highlight the field you wish to edit in the Property Editor. If the field requires user entry, an
entry field appears. If it is a menu option of choices, a pull-down menu appears allowing you
to choose the appropriate item.
4. In the Property Editor, an algorithm parameter that displays a red circle with an "x" inside
means that an error exists. For example, the error may indicate that the parameter is missing
a required value. If you hover your mouse over the parameter, a tooltip appears with the error
information. You can also display algorithm errors by pulling down the View menu and
selecting Algorithm Errors (see page 399). The Error List window appears describing the
error. Note that you must correct all errors before you can save the sheet successfully.
5. To edit any part of the algorithm symbol, go to the Object Browser and expand the algorithm
folder by clicking on the + sign in the hierarchy.
6. Select the item you wish to edit (text, lines, pins, etc.) in the Object Browser. Notice that the
Property Editor also updates with fields that can be edited for that item.
7. Make all the desired changes in the Property Editor, and then save the sheet.

8.1.6 To use the algorithm right-click menu

The algorithm right-click menu provides a quick and easy way to access the common algorithm
functions. Use the following procedure to access and use the algorithm right-click menu,

1. Access the Control Builder (see page 27).


2. Open a control sheet (see page 99).
3. On the drawing canvas, hover the mouse over an algorithm and right-click.

128 OW350_80
8.1 What are algorithms?

The algorithm right-click menu appears as shown in the following figure.

Figure 63: Algorithm right-click menu

The following table describes the algorithm right-click menu.

Algorithm right-click menu item descriptions

MENU ITEM DESCRIPTION

Add Control Pin Adds a pin to the algorithm. See To add a control pin (see page 177).
Algorithm Value Adds an algorithm value to the algorithm. See To use the Algorithm
Value function (see page 137).
Point Description Adds a point description to the algorithm. See To add a point description
(see page 201).
Point Reference Adds a point reference to the algorithm. See To add a point reference
(see page 206).
Algorithm Value Indicator Adds an algorithm value indicator to the algorithm. See To add an
algorithm value indicator (see page 148).
Point Status Indicator Adds a point status indicator to the algorithm. See To add a point status
indicator (see page 211). This entry is grayed out (inactive) unless you
hover over an input or an output.
Delete Deletes the algorithm.
Help Displays online help for the algorithm.
<User-defined point name> Shows any user-defined points for the algorithm. Pull right on a user-
defined point and another menu appears listing the sheets that use that
point. An asterisk (*) beside the drop name indicates that this is the drop
that originates the point.
Advanced Edit This menu item only displays for certain algorithms that have advanced
editing functions (such as CALCBLOCK (see page 158)).
Generate New Ladder Row This menu item only displays for ladder elements. It adds another "rung"
on a ladder element.

OW350_80 129
8.2 What are algorithm anchors?

8.1.7 To delete an algorithm from a sheet

There are many ways to delete an algorithm from a sheet:


 Select the algorithm on the drawing canvas.
 Press the Delete key on the keyboard.
 Use the Delete icon on the Standard toolbar.
 Pull down the Edit menu, and select Delete.
 Right-click the algorithm and select Delete from the menu.
 Highlight the algorithm in the Object Browser.
 Use the Delete Object icon on the Object Browser toolbar.
 Right-click the algorithm in the Object Browser window and select Delete Object.

8.2 What are algorithm anchors?

Anchors allow you to quickly move, align, and space algorithms on a control sheet. When you
select an algorithm, an algorithm anchor is attached to the algorithm on the canvas. The following
rules apply:
 By default, the anchor is attached to the first control pin under the algorithm.
 When you select an algorithm on the canvas, it turns magenta. However, the anchor appears
yellow. Also, a unique graphic element (a pin inside a broken square) represents the anchor
on the algorithm.
 If the anchor location was previously modified, the anchor will be attached to the previous
position.
 There is only one active anchor point per algorithm.
 If you have multiple algorithms selected simultaneously, then each selected algorithm can
have one active anchor.
 Deselecting an algorithm detaches and clears its associated algorithm anchor.

8.2.1 Modifying an algorithm anchor location

You can "cycle" the anchor position through the control pins on the selected algorithm.
 Use the "P" key on the keyboard to change the anchor position to the previous control pin. If
no previous pin is found, then it goes to the bottom of the list.
 Use th "N" key on the keyboard to change the anchor position to the next control pin. If no
next pin is found, then it goes to the top of the list.
The selected algorithm is indicated by a gray ellipse drawn in the background of the algorithm. All
existing symbols are pre-processed to sort the control pins into an expected order of precedence
as possible anchor points:
 The order of precedence is not dependent on graphical location
 The order of precedence is listed below, shown from highest to lowest:
 IN pins
 IN1 pins
 OUT pins

130 OW350_80
8.2 What are algorithm anchors?

 Remaining input pins, which are not dual input, follow based on the order in the template
(IN2, IN3, IN4, etc.)
 Remaining output pins follow based on the order in the template (OUT2, OUT3, OUT4,
etc.)
 Remaining pins, which should be only dual input pins, follow based on the order in the
template.
 If you add a new pin to an algorithm using the Add Control Pin option, it will be
automatically sorted based on the sorting order above.

8.2.2 To move an algorithm using anchors


1. Access the Control Builder (see page 27).
2. Open a control sheet (see page 99).
3. Hover the mouse over the selected algorithm's anchor. The cursor changes to an open hand
cursor, which means that left-clicking the mouse will hit on an anchor.
4. Left-click the algorithm anchor, and the hand "closes" as though it is gripping the algorithm.
This allows you to move the algorithm. If more than one algorithm is selected, all the selected
algorithms will move.
5. Move the algorithm to the new location and left-click to commit the move operation.
6. Right-click the mouse button or press the Esc key to cancel the move operation.

8.2.3 To use the algorithm anchor alignment functions


1. Access the Control Builder (see page 27).
2. On the Control Builder drawing canvas, select two or more algorithms. Note that this
procedure will not work if only one algorithm is selected.
3. Pull down the Edit menu and select one of the following items:
 Align Algorithms Horizontally -- moves the selected algorithm(s) so that the y-
coordinate of the anchors are the same as the y coordinate of the referenced algorithms.
That is, the selected algorithm(s) are aligned horizontally to a referenced algorithm.
 Align Algorithms Vertically -- moves the selected algorithm(s) so that the x-coordinate
of the anchors are the same as the x coordinate of the referenced algorithms. That is, the
selected algorithm(s) are aligned vertically to a referenced algorithm.
4. A red pin icon appears. Move the red icon over the algorithm to select a reference anchor.
Once the reference anchor is found, the icon turns green.
5. Left-click the reference anchor. The other selected algorithms move to align appropriately with
the reference anchor.

8.2.4 To use the algorithm anchor spacing functions


1. Access the Control Builder (see page 27).
2. On the Control Builder drawing canvas, select three or more algorithms. Note that this
procedure will not work if only two algorithms are selected.
3. Pull down the Edit menu and select one of the following items:
 Space Algorithms Horizontally -- Evenly spaces adjoining anchors along the x-axis.
The spacing is the average of all the distances between adjoining anchors in the x-
direction.

OW350_80 131
8.3 Ordering algorithm execution

 Space Algorithms Vertically -- Evenly spaces adjoining anchors along the y-axis. The
spacing is the average of all the distances between adjoining anchors in the y-direction.
4. A red pin icon appears. Move the red icon over the algorithm to select a reference anchor.
Once the reference anchor is found, the icon turns green.
5. Left-click the reference anchor. The other selected algorithms move to space appropriately
with the reference anchor.

8.2.5 What is signal rerouting when moving algorithm anchors?

Whenever an algorithm anchor is manipulated (moved, aligned, spaced), upstream and


downstream signals connected to algorithms that are not selected are rerouted. This is done to
preserve orthogonal signals and 45-degree angle signals

8.3 Ordering algorithm execution

Algorithm execution order within a sheet is ordered according to location and connections. By
default, the Control Builder orders algorithms automatically when a sheet is saved, unless
explicitly overridden by you on a per sheet basis.

The Algorithm Execution Order function provides the following:


 Visual numbered sequence of how the algorithms are executed within a control sheet.
 Ability to order algorithms automatically or manually.
 Ability to print a hard copy of the numbered sequence.

Note: You can view the current algorithm ordering method by hovering your mouse over the
Algorithm Ordering icon in the lower left corner of the Control Builder (second icon from the left).

8.3.1 To view the algorithm order


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Pull down the View menu and select Algorithm Order.

132 OW350_80
8.3 Ordering algorithm execution

Notice that the algorithms on the sheet have been replaced by rectangular boxes with
numbers inside. This indicates the numbered sequence of the algorithms.

Note: To cancel the algorithm order view and return to a normal view of the sheet, right-click the
mouse button anywhere on the canvas or press the Esc key on the keyboard.

4. By default, algorithm ordering is done automatically. To perform manual ordering, see To


change algorithm ordering from automatic to manual (see page 133).

8.3.2 To change algorithm ordering from automatic to manual


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).

OW350_80 133
8.3 Ordering algorithm execution

3. Go to the Object Browser and select the Algorithms container. Expand the Algorithms
container to show all the algorithms. Notice that the Property Editor updates showing the
Ordering parameter.

Figure 64: Algorithms container - showing automatic ordering in Property Editor

4. Click in the Value column for the Ordering parameter in the Property Editor, and a pull-down
menu appears. Pull down the menu, and select Manual. Algorithm ordering is now changed to
manual.
5. Return to the Object Browser and highlight the algorithm in the Algorithms container that you
want to move in the execution sequence.
6. Use the up or down arrow icons on the Object Browser to move the algorithm in the list.
7. Refresh the control sheet by selecting the Refresh icon on the Object Browser. The
algorithms reorder according to the change you made in the Object Browser.

8.3.3 To change the order of algorithm execution while in view mode


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Pull down the View menu and select Algorithm Order. The algorithms on the sheet are
replaced by rectangular boxes with numbers inside. These numbers indicate the numbered
sequence of the algorithms
4. Select one of the algorithms on the canvas and it turns magenta.
5. In the Object Browser, the flag icon appears beside the magenta algorithm showing that it is
selected. Use the up or down arrow icons on the Object Browser to move the algorithm in the
list.

134 OW350_80
8.3 Ordering algorithm execution

6. If algorithm order was set to Automatic and it was not changed to Manual in the Property
Editor, the following messages appears when you try to change the algorithm order.

7. Select Yes on the window to change the ordering to Manual and you will be able to change
the order of the algorithms.
8. You can also use the keyboard to change the algorithm order while viewing the algorithm
order.
 Ctrl + Page Up key -- Takes the selected algorithms and moves them to the top of the
execution order. For example, as shown in the following figure, if you highlight algorithms
5 and 6, they become algorithms 1 and 2 in the ordering sequence. The other algorithms
reorder so that algorithms 1, 2, 3, and 4 become algorithms 3, 4, 5, and 6.
 Ctrl + Page Down key -- Takes the selected algorithms and moves them to the bottom of
the execution order. For example, as shown in the following figure, highlight algorithms 1
and 2 and they become algorithms 5 and 6 in the ordering sequence. The other
algorithms reorder so that algorithm 3, 4, 5, and 6 become algorithm 1, 2, 3, and 4.
 Ctrl + Up Arrow key -- Takes the selected algorithms and moves them one up in the
ordering sequence. For example, as shown in the following figure, highlight algorithms 5
and 6, and they become algorithms 4 and 5 in the ordering sequence. One algorithm
reorders - algorithm 4 becomes algorithm 6, but algorithms 1, 2, and 3 remain the same.

OW350_80 135
8.3 Ordering algorithm execution

 Ctrl + Down Arrow key -- Takes the selected algorithms and moves them one down in
the ordering sequence. For example, as shown in the following figure, highlight algorithms
1 and 2 and they become algorithms 2 and 3 in the ordering sequence. One algorithm
reorders - algorithm 3 becomes algorithm 1, but algorithms 4, 5, and 6 remain the same.

8.3.4 To change algorithm ordering from manual to automatic

You can change algorithm execution order from manual to automatic for individual sheets with or
without affecting the ordering configuration.

1. If ordering is set to Manual, go to the Object Browser and highlight the Algorithms container.
2. Right-click and select Auto Order from the menu that appears.
3. A warning message appears stating, "The current setting for algorithm ordering is set to
MANUAL. Do you want to update the configuration to automatic?" Three button choices
appear on the window:
 Yes -- performs the ordering change from manual to automatic and changes the
configuration, which means that from now on, all the ordering will be automatic.
 No -- performs the ordering change from manual to automatic but does not change the
ordering configuration. That is, ordering is changed in this one instance, but is not
changed for subsequent ordering.
 Cancel -- dismisses the window without making any ordering change.

136 OW350_80
8.4 What is the Control Builder Algorithm Value function?

8.3.5 To print the algorithm execution order


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Pull down the File menu, and select Print Report.
4. Pull right to display another menu, and select Execution Order.
5. A standard Windows print window appears. Select Print to send the file to the printer.

Note: You do not have to be in the algorithm order view on the drawing canvas to print the
execution order.

8.4 What is the Control Builder Algorithm Value function ?

The Algorithm Value function displays the value of an algorithm parameter on a control sheet. It
adds additional text fields to the algorithm symbol on the sheet. These fields are dynamic and
change when the parameter updates. For example, you can add a text field that displays the
value for the English description parameter or a text field that shows the output point name.

8.4.1 What are the best practices for using the Algorithm Value function?
 Only analog algorithm values are dynamic and update as algorithm parameters and the
database changes.
 Comments are different from algorithm values because comments are static text displays that
do not change or update.
 Use algorithm values, not static text, for values that are stored in algorithms or points since
algorithm values can change if values change.
 Signal diagrams do not dynamically update algorithm values as functions are tuned.
 You must audit a sheet to ensure that database changes are reflected correctly in the
algorithm values. This can be done through the Audit function (see page 108).
 If you edit an input point, it will not update until you audit the sheet or until you close the sheet
and reopen it.
 Set the default values for algorithm values (alignment, height, and color) through the Property
Editor.
 You may tie an algorithm value to a signal to depict the point name, English description, or
point value.
 You may tie an algorithm value to an algorithm parameter to depict the point value (either
numeric or an enumerated string).

8.4.2 To use the Algorithm Value function


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Draw menu and select Algorithm
Value. You may also use the Algorithm Value icon on the toolbar.
4. On the control sheet, left-click the algorithm for which you want to add an algorithm value.

OW350_80 137
8.4 What is the Control Builder Algorithm Value function?

The Select Parameter window appears displaying the parameters that can be used for that
algorithm.

Figure 65: Select parameter dialog box

Note: If you hover over a parameter listed in the Select Parameter window, the abbreviated
parameter name appears (for example, GAIN).

5. Select the desired parameter and click the Add button.

Note: For the Algorithm Value function only, you can select multiple parameters on the Select
Parameter window. The order in which you select the parameters on the Select Parameter
window is the order they will be inserted on the drawing canvas.

6. If you want to filter the parameter list that appears, go to the Filters list on the side of the
window. By default, all the filters are checked, meaning that type of parameter will be shown.
To remove a parameter type from the list, click the filter and the check mark disappears. This
parameter type will be removed from the list.
 Input -- shows parameters that can be used as inputs
 Output -- shows parameters that can be used as outputs.
 Dual Input -- shows parameters that can take a value or a point name. If the pin is
connected, the point name displays. If the pin is not connected, the value in the algorithm
displays.
 Parameter -- shows parameters that can take constants.
 Tracking -- shows parameters that implement tracking.
7. Move the cursor on the drawing canvas and left-click to place the algorithm value on the
sheet. The desired information appears on the sheet. The Object Browser updates with a
container called "Graphic Shape." Expand the Graphic Shape folder and the algorithm value
is listed as "Dynamic Text."

138 OW350_80
8.4 What is the Control Builder Algorithm Value function?

8. Audit the sheet so that all the changes are verified by the Control Builder and the algorithm
values update.
9. Save the sheet.

Note: To use the Object Browser to delete an algorithm value, expand the Graphic Shape folder
under the applicable algorithm folder and find "Dynamic Text". Highlight the applicable "Dynamic
Text" in the hierarchy list and delete it.

8.4.3 Using the Property Editor to change algorithm values

When the Algorithm Value function is placed on the drawing canvas, the Object Browser and the
Property Editor update to show the additional information added to the sheet. The Object Browser
updates with a folder called "Graphic Shape." Expand the Graphic Shape folder and the algorithm
value is listed as "Dynamic Text."

Select the Dynamic Text entry in the Object Browser and notice the information that displays in
the Property Editor.

Figure 66: Object Browser and Property Editor - Algorithm Value function

OW350_80 139
8.4 What is the Control Builder Algorithm Value function?

Note: If you highlight the "Graphic Shape" entry in the Object Browser, the Property Editor
shows a Tag entry field. This entry field allows you to assign a label to the Graphic Shape folder.

You can modify the algorithm value properties using the Property Editor. To do this, click the
Value field beside the property you wish to change. Depending on the property, either an entry
field or a pull-down menu appears.

The following table describes the fields that display in the Property Editor when you add an
algorithm value to a sheet.

Property Editor -- Algorithm Value fields

FIELD DESCRIPTION

Source Changes the algorithm parameter that is used on the sheet. This pull-down menu
displays the same items that are found in the Select Parameter window.
Labeled Determines whether or not to add a label to the algorithm parameter value. The
choices are True or False. For example, if this is set to True, the algorithm value
would read, "TYPE = RESET" instead of just "RESET."

140 OW350_80
8.4 What is the Control Builder Algorithm Value function?

In the Object Browser, expand the Dynamic Text folder and select the first "Text" entry in the list.
The Property Editor updates to show font attributes for the text. Make the desired changes
according to the descriptions found in the following table. Note that any changes made here affect
all Text entries (if more than one exists) for the Algorithm Value.

Figure 67: Property Editor - Font settings for Algorithm Value

OW350_80 141
8.4 What is the Control Builder Algorithm Value function?

Property Editor -- Font settings for Algorithm Value

FIELD DESCRIPTION

Style class Defines the style template, as defined in the Style Editor, that was set when you
created the Algorithm Value.
Font color Allows you to choose the font color. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option appears on


the menu. Selecting this option displays the Select Color window, which
provides a selection of predefined colors as well as the ability to create new
custom colors.

Font name Displays a list of available fonts for the document value. You can use any font
that is available on the computer on which the Control Builder is running.
Font size Presents a list of available font sizes. The choices range from 6 pt. to 72 pt.
type.
Font style Allows you to choose the font style. The choices are normal or italic.
Font weight Allows you to choose the font weight. The choices are normal or bold.
Decoration Allows you to add special line attributes to the font. The choices are: normal,
underline, overline, and linethrough.
Anchor point - x x-coordinate of the anchor of the description.
Anchor point - y y-coordinate of the anchor of the description.
Alignment - Text anchor Used for horizontal text alignment. This parameter adjusts the text relative to x.
The choices are: Start, Middle, and End.
Alignment - Baseline shift Used for vertical text alignment. This parameter adjusts the text relative to y.
The choices are: Top, Middle, and Bottom.

142 OW350_80
8.5 Organizing and standardizing algorithm values

8.5 Organizing and standardizing algorithm values

When you create an algorithm value, the Object Browser updates with a Graphic Shape folder.
This folder contains the dynamic text entries for every parameter that you selected on the Select
parameter window. If you add another algorithm value to that same algorithm at a later time, the
Object Browser will create an additional Graphic Shape folder with its own dynamic text entries. If
you do this multiple times, you can have several Graphic Shape folders all containing different
dynamic text entries.

To keep information organized in one location, and to be able to standardize the appearance of all
the algorithm entries, it is recommended that for the same algorithm, you consolidate all your
dynamic text entries under one Graphic Shape folder.

8.5.1 To organize algorithm values in the Object Browser


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. In the Object Browser, expand the algorithm that contains the Graphic Shape folders that you
want to consolidate.

Figure 68: Object Browser with multiple Graphic Shape folders

4. Expand the Graphic Shapes folders to reveal the Dynamic Text entries.
5. Select the dynamic text that you want to move into another folder. To do this, press the <Ctrl>
key and click the dynamic text entry that you want to move. The icon changes to a flag.
6. Right-click and select Cut from the menu.

OW350_80 143
8.5 Organizing and standardizing algorithm values

7. Click the Graphic Shape folder that you want to keep. Right-click and select Paste from the
menu. The cut dynamic text entry now appears in the selected Graphic Shape folder.

Figure 69: Graphic Shape folder after Paste function

8. Highlight the empty Graphic Shape folder. Right-click and select Delete Object from the
menu.
9. Repeat Steps 5 through 8 until you only have one Graphic Shape folder per algorithm
complete with all the dynamic text entries.

8.5.2 To standardize the appearance of algorithm values


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu, and select Operations.
Slide the cursor to the right to reveal another menu. Select Standardize Text.

Note: The procedures described here are for standardizing algorithm values. For a complete
description of the Standardize Text function, refer to What is the Standardize Text operation?
(see page 271).

3. From the Choose files screen, select the sheets that contain the algorithm values to be
adjusted.

144 OW350_80
8.5 Organizing and standardizing algorithm values

4. Select the Next button and the Configure operation screen appears.

Figure 70: Standardize Text operation - Configure operation window

OW350_80 145
8.5 Organizing and standardizing algorithm values

5. At the bottom of the window, select the Algorithm Values check box, found under the
heading "Reset Object Font Attributes to Style Class." This changes the name of the check
box to "Reset Algorithm Values."

6. If you want to manually set a font size to be used for all the algorithm values on the selected
sheets, click the Reset Algorithm Values check box. This changes the name of the check
box to "Force Algorithm Values" and displays a font size pull-down menu.

146 OW350_80
8.5 Organizing and standardizing algorithm values

Note: If you do not want to manually set a font size here, the font size for the algorithm values
will be taken from the style class (see page 57) that was defined when the algorithm value was
created.

7. Select a font size from the pull-down menu.


8. Select the Next button and then run the operation.

OW350_80 147
8.6 What is the Control Builder Algorithm Value Indicator function?

8.6 What is the Control Builder Algorithm Value Indicator function?

The Algorithm Value Indicator function is used to organize a group of graphic primitives (simple
graphic items) and to control their visibility based on the current configuration of an algorithm.

When you add an algorithm value indicator to an algorithm, a container is created in the Object
Browser under that algorithm folder. This folder is used to hold whatever symbol (graphic shape,
such as blue rectangle, red ellipse, and so forth) you want to use to represent the algorithm's
indicator type.

You select one of the algorithm's parameters to be assigned to the algorithm value indicator type.
Whether or not the value will display is determined in the Property Editor. For example, you select
a parameter for an algorithm. If that value becomes true, the graphic symbol that is in the folder
displays.

8.6.1 To add an algorithm value indicator


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Draw menu and select Algorithm
Value Indicator.
4. On the control sheet, left-click the algorithm for which you want to add an algorithm value
indicator.
The Select parameter window appears displaying the parameters that can be used for that
algorithm.

Figure 71: Select parameter dialog box -- algorithm value indicator

148 OW350_80
8.6 What is the Control Builder Algorithm Value Indicator function?

Note: If you hover over a parameter listed in the Select Parameter window, the abbreviated
parameter name appears (for example, GAIN).

5. Select the desired parameter and click the Add button.


6. If you want to filter the parameter list that appears, go to the Filters list on the right side of the
window. By default, all the filters are checked, meaning that type of parameter is shown. To
remove a parameter type from the list, click the filter and the check mark disappears. This
parameter type is removed from the list.
 Input -- shows parameters that can be used as inputs
 Output -- shows parameters that can be used as outputs.
 Dual Input -- shows parameters that can take a value or a point name. If the pin is
connected, the point name displays. If the pin is not connected, the value in the algorithm
displays.
 Parameter -- shows parameters that can take constants.
 Tracking -- shows parameters that implement tracking.
7. A new container appears in the Object Browser called "Value Indicator."
8. Audit the sheet so that all the changes are verified by the Control Builder and the algorithm
values update.
9. Save the sheet.

Note: To use the Object Browser to delete an algorithm value indicator, expand the applicable
algorithm folder. Find "Value Indicator" in the hierarchy list and delete it.

8.6.2 Using the Property Editor to change an algorithm value indicator

When an algorithm value indicator is placed on the drawing canvas, the Object Browser and
Property Editor update to show the additional information added to the sheet.

Select the "Value Indicator" entry in the Object Browser and notice the information that displays in
the Property Editor.

Figure 72: Property Editor -- algorithm value indicator

OW350_80 149
8.7 What is the Control Builder Symbol Browser window?

You can modify the algorithm value indicator properties using the Property Editor. To do this, click
the Value field beside the property you wish to change.

The following table describes the fields that display in the Property Editor when you add an
algorithm value to a sheet.

Property Editor -- algorithm value indicator fields

FIELD DESCRIPTION

Source Changes the type of parameter that displays on the sheet. This pull-down menu
displays the same items that are found in the Select Parameter dialog box.
Value Defines the target value. When the algorithm parameter has the target value as its
value, then the graphic defined in the Value Indicator folder displays.

8.7 What is the Control Builder S ymbol Brow ser w indow ?

The Symbol Browser provides a visual list of the algorithms currently used on your sheet as well
as a list of recently used algorithms. The Symbol Browser, as well as the Add Algorithm (see
page 125) window, allow you to select algorithms by type and add them to your control function.

Like all Control Builder windows, the Symbol Browser window is dockable and floatable. Dockable
means it can be attached to one of the sides of the main window, and floatable means that it
becomes a free-floating window if you double-click it. Once it is a free-floating window, it can be
moved anywhere (even to another monitor in a dual-monitor configuration) to create more space
for the primary display.

If you create a new symbol for an algorithm (see page 233), the Symbol Browser updates to
reflect the new symbol. To create a file of commonly used or "favorite" algorithms, see What is the
Control Builder Favorites window? (see page 154).

8.7.1 To use the Symbol Browser


1. Access the main Control Builder window.

150 OW350_80
8.7 What is the Control Builder Symbol Browser window?

2. Pull down the View menu and select Symbol Browser. The Symbol Browser displays.

Figure 73: Symbol Browser

The Symbol Browser initially displays the Currently Used Algorithms list, which shows the
algorithms that are used on the sheet that is open in the Control Builder. If there is no sheet
open in the Control Builder, the Currently Used Algorithms list is blank on the initial display of
the Symbol Browser.

OW350_80 151
8.7 What is the Control Builder Symbol Browser window?

3. To view algorithms other than the ones on the current sheet, pull down the menu at the top of
the browser.

Figure 74: Symbol Browser menu

4. Select another list from the menu to display:


 Recently Used Algorithms -- displays the algorithms that you used on different sheets in
the current editing session.
 List of algorithms by algorithm type (Fast Boolean, Calcblock, Foundation Fieldbus,
and so forth) - this option allows the Symbol Browser to work like the Add Algorithm dialog
box (see page 125). Double-click one of these algorithms and then add the algorithm to
the sheet.
 Commonly Used with Selected Algorithm -- displays the algorithms that are used with
the algorithm that is selected on the sheet. That is, if you select an algorithm on the sheet
and then select this option, the Symbol Browser shows the algorithms that are connected
to the selected algorithm on the sheet. Note that inputs and outputs do not show up in this
list.

152 OW350_80
8.7 What is the Control Builder Symbol Browser window?

This information is stored in a file called CommonlyUsedAlgorithms.xml and is


automatically generated. If you delete this file, and then try to use this option, a message
displays asking if you want to create this file. If you select yes, the file generates. Do not
perform any editing in the Control Building while this file is generating.
5. You can change the size of the icons that appear on the Symbol Browser.
a) To change the icon size, right-click anywhere on the Browser window pane.
b) Select either small, medium, or large from the menu. The icons resize accordingly.

Note: The Symbol Browser right-click menu also allows you to add the selected algorithm to the
Favorites window, access online help on the algorithm, and update (refresh) the Symbol
Browser window.

Figure 75: Symbol Browser right-click menu

6. You can use the Symbol Browser to add algorithms to a sheet. To do this, double-click the
symbol in the Symbol Browser. The symbol is added to the sheet.
7. When you finish using the Symbol Browser, close the window by pressing the "x" in the upper
right corner of the window.

Note: Use the Symbol Browser to add symbols to the Favorites Folder. See To add symbols to
the Favorites Folder (see page 156).

OW350_80 153
8.8 What is the Control Builder Favorites window?

8.8 What is the Control Builder Favorites w indow ?

The Favorites window provides a place to store "favorite" or frequently used symbols. These
favorite symbols can then be accessed quickly and easily. You use the Symbol Browser to
populate the Favorites window. Once you place symbols in the Favorites window, they can be
organized into folders so that common symbols can be found in the same place.

You can create a favorites folder that resides on your local machine for individual use or a shared
folder which is located on the network and can be used by many users for a project. A directory
path displays above the Favorites window that shows the directory location of the stored items in
the folder. Note that when you create a favorites folder, it is automatically placed in your local
directory.

To use a local favorites folder as a shared folder, copy the folder to a location that is above the
control sheet data directory (CSDD). For Windows-based Ovation systems, place the local
favorites folder in the Network folder. For Solaris-based Ovation systems, place the local favorites
folder in the /wdpf/rel/data/cb directory.

8.8.1 To access the Favorites window


1. Access the main Control Builder window.
2. Pull down the View menu and select Favorites Folder. The Favorites window appears.

Figure 76: Favorites Folder

Like most Control Builder windows, the Favorites window is dockable and floatable. Dockable
means it can be attached to one of the sides of the main window, and floatable means that it
becomes a free-floating window when you double-click it. Once it is a free-floating window, it can
be moved anywhere (even to another monitor in a dual-monitor configuration) to create more
space for the primary display.

8.8.2 Favorites Folder toolbar

The Favorites folder has two icons:

Favorites Folder icons

ICON DESCRIPTION

Add Folder (plus sign) Adds a folder to the Favorites window.


Up (up arrow) Navigates to the folder above the current folder. Note that there is no
down arrow. You must double-click the folder icon to open it, which
facilitates the down direction.

154 OW350_80
8.8 What is the Control Builder Favorites window?

8.8.3 Favorites Folder right-click menu

The Favorites Folder right-click menu performs all the editing function associated with the folder.

Figure 77: Favorites Folder right-click menu

Favorites Folder right-click menu descriptions

MENU ITEM DESCRIPTION

Cut Symbol Cuts the symbol for pasting into another folder. Note that no actual operation is
performed until you select the Paste symbol.
Copy Symbol Copies the symbol for pasting into another folder.
Paste Symbol Pastes the cut or copied symbol to the current folder.
Edit Symbol Opens the symbol in the symbols editor so that it can be modified.
Delete Deletes a file or a folder. A message window prompts you to confirm the delete
operation.
New Folder Creates a new folder. This action is also performed by the Plus sign icon on the
toolbar.
Open Folder Opens a folder. This action is also performed by the Up arrow icon on the toolbar.
Switch Base Folder Changes from the local favorites folder to the shared favorites folder and vice versa.
Rename Folder Gives a new name to a folder.
Refresh Updates the Favorites Folder after changes have been made.
Small Images Changes the size of the icons to the small size.
Medium Images Changes the size of the icons to the medium size.

OW350_80 155
8.8 What is the Control Builder Favorites window?

MENU ITEM DESCRIPTION

Large Images Changes the size of the icons to the large size.
Help If you right-click an algorithm symbol, this Help option displays help about the
selected algorithm. If you right-click a folder, this Help option is not active (grayed
out).

8.8.4 To add symbols to the Favorites window


1. Access the Control Builder (see page 27).
2. Select Symbol Browser from the View menu.
3. From the Symbol Browser, right-click an algorithm symbol. A pop-up menu appears.

Figure 78: Symbol Browser right-click menu

156 OW350_80
8.8 What is the Control Builder Favorites window?

4. From the pop-up menu, select Add to Favorites. The symbol appears in the Favorites
window in the directory and folder that is currently displayed. Note that when symbols are
added, they are sorted alphabetically.

Figure 79: Favorites Folder

Note: Once you add a symbol to the Favorites folder, you can move it to another folder by using
the cut/copy and paste options found on the right-click menu.

5. You can use the Favorites Folder to add symbols to a sheet. To do this, double-click the
symbol in the Favorites Folder. The symbol is added to the control sheet.

8.8.5 To add a folder to the Favorites window

The Favorites window allows you to organize your frequently used symbols however you choose.
You can create folders to hold certain symbols. Multiple folders can be created with some folders
nested within other folders. Once folders are created, symbols can be copied or moved into them.

1. Access the Favorites window (see page 154).


2. From the Favorites window, right-click and select New Folder. You can also click the Add
Folder icon (+ sign) on the toolbar. The Favorites Symbols Browser window appears.

Figure 80: Adding a folder to Favorites window

3. Enter the name of the folder in the entry field. Since folder names become directory names,
do not use backslashes or wildcard character symbols in the name. Select the OK button.
4. The new folder appears in the Favorites window. Symbols can now be added to the folder.

OW350_80 157
8.9 What is the CALCBLOCK algorithm?

8.8.6 To create a shared folder for favorites


1. Create the shared folder in a directory location that is above the control sheet data directory
(CSDD).
a) For Windows-based Ovation systems, open a Windows Explorer window and place the
folder in the Network folder: \OVPTSVR\<system_name>\<network_name>.
b) For Solaris-based Ovation systems, open a Shell Tool and place the folder in the same
folder as the ControlMacros folder: /wdpf/rel/data/cb.
2. For both Windows and Solaris Ovation systems, you must name the shared folder, cb-
favorites.
3. Follow the procedures in To add a folder to the Favorites window (see page 157) to create
folders in the shared folder.

8.9 What is the CALCBLOCK algorithm?

CALCBLOCK and CALCBLOCKD are standard Ovation algorithms designed to support user-
defined complex mathematical equations within a single algorithm. Due to the functionality
provided by these algorithms, they are edited through a special CALCBLOCK Editor dialog box
that manipulates free form equations as well as input and output points.

Note: The CALCBLOCK Editor is designed so the actual algorithm record configuration is
transparent to the user.

For simplicity, CALCBLOCK and CALCBLOCKD are treated identically in this section. The only
significant difference between the two is the point type that is managed by each algorithm;
CALCBLOCK manages analog points and CALCBLOCKD manages packed digital points. (See
Ovation Algorithms Reference Manual.)

The following tables list the supported formats for the various CALCBLOCK and CALCBLOCKD
equation operations.

CALCBLOCK operations

MATHEMATICAL STANDARD SCIENTIFIC

Add (a + b) *Square Root (sqrt(a)) *Cosine (Cos (a))

Subtract (a - b) *Reciprocal (recip(a)) *Sine (Sin (a))

Multiply (a * b) Max (max (a,b)) *Tangent (Tan (a))

Divide (a / b) Min (min (a,b)) *Arccos (arccos (a))


Power (a^b) *Negate (neg (a)) *Arcsin (arcsin (a))
*Square (square(a)) Remain (remain (a,b)) *Arctan (arctan (a))
*Cube (cube(a)) *Round (round a) *Natural Log (Ln (a))
*Truncate (trunc a) *Log base 10 (log10(a))
*Absolute value (abs a) *Antilog (antilog (a))
*Exp (exp(a))
(*) = Unary Operator (Takes only one argument.)

158 OW350_80
8.9 What is the CALCBLOCK algorithm?

CALCBLOCKD operations

LOGICAL (BOOLEAN)

And (a && b)

Nand (a ^& b)

Or (a || b)

Nor (a ^| b)
Xor (a xor b)
Not (not a)

8.9.1 To use the CALCBLOCK Editor

CALCBLOCK is added to a control sheet just as any other algorithm is added. After CALCBLOCK
has been added to the sheet, you can access the CALCBLOCK Editor and use this window to
modify the calculations that will be carried out by CALCBLOCK.

1. Add the CALCBLOCK algorithm to a control sheet. See To Add an Algorithm (see page 125).
2. Once CALCBLOCK is added to the drawing canvas, right-click it to display another menu.
Select Advanced Edit. The Calculation Editor window appears.

Figure 81: Calculation Editor window

3. Enter the CALCBLOCK Equation in the Equation editing field. You can type, cut (Ctrl + x),
copy (Ctrl + c), or paste (Ctrl + v) calculations in this field.
4. Press the Compile button. This compiles the equation displayed in the Equation area and
verifies the equation syntax. The results display in the Compiled Equation area.

OW350_80 159
8.10 Configuring the BALANCER algorithm with MASTATIONs

The Compiled Equation area displays the results of a specific compile. If the equation is valid,
the entire equation displays here and a message, "Valid Equation" appears.
If an error is detected in the equation, the equation up to and including the last valid item
display here. An error message displays after the last valid item. An invalid equation is never
saved; you must cancel the operation or correct the errors in the equation.
5. If the equation is valid, select the OK button to accept the calculation.

8.10 Configuring the BAL ANCER algorithm w ith MASTATIONs

The BALANCE algorithm monitors the modes of up to 16 downstream algorithms and performs a
user-defined type of tracking when all the downstream algorithms are requesting the upstream
algorithm to track. The BALANCER algorithm can also be used to balance the outputs of several
downstream Manual/Auto (MASTATION) algorithms. For more information on BALANCE, refer to
Ovation Algorithms Reference Manual.

There are typically four configurations that you can use for the BALANCER and MASTATION
algorithms based on two Boolean conditions. The Boolean conditions are:
 Are the BALANCER algorithm and the MASTATION algorithm on the same sheet?
 Are the BALANCER algorithm and the MASTATION algorithm directly connected?
Based on these two conditions, you can configure four different scenarios.

Note: You must perform these procedures on every sheet that contains a BALANCER
algorithm.

BALANCER and MASTATION configurations

B AL A N C E R B AL A N C E R A N D PERFORM THESE STEPS


AND M A S T AT I O N
M A S T AT I O N DIRECTLY
ON S AM E S HEE T CONNECTED

True True  Open the Control Builder and access a sheet that has a
BALANCER algorithm.
 Add a TRK pin to the BALANCER algorithm. You must add
one TRK pin to the BALANCER algorithm for each
MASTATION that tracks back to the BALANCER algorithm.
 Add a TOUT pin to the MASTATION algorithm
 Connect the TOUT pin on the MASTATION algorithm to the
TRK pin in the BALANCER algorithm.
True False  Open the Control Builder and access a sheet that has a
BALANCER algorithm.
 Add a TRK pin to the BALANCER algorithm. You must add
one TRK pin to the BALANCER algorithm for each
MASTATION that tracks back to the BALANCER algorithm.
 Add a TOUT pin to the MASTATION algorithm
 Connect the TOUT pin on the MASTATION algorithm to the
TRK pin in the BALANCER algorithm.

160 OW350_80
8.10 Configuring the BALANCER algorithm with MASTATIONs

B AL A N C E R B AL A N C E R A N D PERFORM THESE STEPS


AND M A S T AT I O N
M A S T AT I O N DIRECTLY
ON S AM E S HEE T CONNECTED

False True If MASTATION is tracking from another sheet AND


MASTATION is directly connected to an input connector:
 Add an input connector to the sheet that contains the
BALANCER algorithm.
 Add a TRK pin to the BALANCER algorithm. You must add
one TRK pin to the BALANCER algorithm for each
MASTATION that tracks back to the BALANCER algorithm.
 Connect the input connector to the BALANCER TRK pin.
 In the Property Editor, enter the tracking point name from the
MASTATION as the Sheet Input Point in the input connector.
 Connect the MASTATION to the input connector. One and
only one MASTATION can be connected to the input
connector. There must be implicit tracking between the
MASTATION and the input connector.
 In the Property Editor, enter the named tracking output point
into the input connector's Track Output Point parameter.
False False If MASTATION is tracking from another sheet AND
MASTATION is NOT directly connected to an input
connector:
 Add an input connector to the sheet that contains the
BALANCER algorithm.
 Add a TRK pin to the BALANCER algorithm. You must add
one TRK pin to the BALANCER algorithm for each
MASTATION that tracks back to the BALANCER algorithm.
 Connect the input connector to the BALANCER TRK pin.
 Open the sheet that contains the MASTATION algorithm.
 Add a track output (TOUT) pin to the MASTATION algorithm.
 Add an output connector to the sheet that contains the
MASTATION algorithm.
 Connect the TOUT pin on the MASTATION algorithm to the
output connector.
 On the sheet that contains the MASTATION algorithm, go to
the Property Editor and provide a user-defined name for the
TRK point in the Sheet Output Point parameter.
 Save the sheet that contains the MASTATION algorithm.
 Return to the sheet that contains the BALANCER algorithm
and go to the Property Editor. In the Sheet Input Point field,
enter the user-defined TRK point name from the
MASTATION sheet in the input connector.
 Save the sheet that contains the BALANCER algorithm.

OW350_80 161
8.10 Configuring the BALANCER algorithm with MASTATIONs

8.10.1 BALANCER algorithm sheet examples

The following examples show the different configurations for the BALANCER algorithm.

Figure 82: BALANCER and MASTATION algorithms on same sheet - directly and indirectly
connected.

Figure 83: BALANCER and MASTATION algorithms NOT on same sheet

162 OW350_80
8.10 Configuring the BALANCER algorithm with MASTATIONs

Figure 84: BALANCER and MASTATION algorithms NOT on same sheet - directly
connected

OW350_80 163
8.11 What is the Control Builder Function Generator Graph?

Figure 85: BALANCER and MASTATION algorithms NOT on same sheet - not directly
connected

8.11 What is the Control Builder Function Generator Graph?

The Function Generator Graph adds a graphic for the FUNCTION algorithm, which gives you a
visual aid in understanding the FUNCTION algorithm. When you edit the algorithm, the graphic
updates. In addition, the signal diagram window provides a unique dialog box for tuning the
FUNCTION algorithm.

If the graphic appears red, there is an error in the parameter break points.

8.11.1 To add a graph to a FUNCTION algorithm


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Draw menu, and select Add Algorithm.
You can also select the Add Control Algorithm icon on the toolbar. The Add Algorithm
dialog box appears.
4. Expand the STANDARD folder on the left side of the Add Algorithm window. Select the
FUNCTION algorithm from the list.
5. Select the FUNCTION symbol, and the Ok button on the Add Algorithm window.
6. Place the FUNCTION algorithm at the desired location on the drawing canvas.

164 OW350_80
8.12 What are control macros?

7. Pull down the Draw menu and select Extended Algorithm Tag.
8. Click the FUNCTION algorithm symbol on the drawing canvas. Then move the cursor to the
place on the sheet where the graph will be placed.
9. Click to mark the upper left corner of the graph. Without pressing any mouse buttons, move
the cursor to the desired dimensions of the graph. To complete the operation, click again to
mark the lower right corner of the graph. The finished graph appears.

Figure 86: FUNCTION algorithm with function graph

8.12 What are control macros?

A Macro is a user-defined control strategy, with clearly defined inputs and outputs. Even though a
macro typically consists of several algorithms, it is represented in a functional drawing as a single
user-defined algorithm. Each macro can contain an entire sheet of control and you can use
multiple macros on a given sheet. The defined macros are stored in the ControlMacros directory.

To permit standard usage, the symbol of a macro is identical to the symbol of a standard
algorithm, and is visible as one symbol with configurable values and points.

Note: A second set of input/output symbols are provided for macros to allow for macro-specific
information.

OW350_80 165
8.12 What are control macros?

8.12.1 Requirements for macros in the Control Builder

The following components are required in order for a macro to be defined and to work properly:
 Collection of algorithms on a control sheet that form a complete function.
 Macro name.
 Macro description.
 Macro symbol.

8.12.2 To create a ControlMacros folder in a Windows-based Ovation system

You must create a ControlMacros folder under your System folder to store all your macros. This
step is only performed once, but you must complete it before you create any macros.

1. From any system Ovation drop, open Windows Explorer.


2. Find the OVPSvr folder and navigate down to the System folder.
3. Under the System folder, create a folder called ControlMacros. Note that the name of the
folder must be defined as one word, with no spaces, and an uppercase C and M
(ControlMacros). The Control Builder only finds macros in a folder with that exact name.

CAUTION! DO NOT create the ControlMacros directory under a Drop folder. It must be under
the System folder. See Ovation Developer Studio User Guide for information on the system
folder structure.

8.12.3 To define a macro in the Control Builder


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the File menu and select New. Pull right
and choose Control Macro from the menu that displays.
A frame with a title box appears in the drawing canvas. Note that the Object Browser and
Property Editor also appear as if you were starting a new control function (sheet).
3. Create the macro on the drawing canvas (add algorithms, pins, signals, page connectors, and
so forth) and confirm that the control is valid.
4. Click the input connector and go to the Property Editor:
 At the Input Mnemonic field, enter a name for the input. For Windows-based Ovation
systems, the limit is 6 characters. For Solaris-based Ovation systems, the limit is 5
characters.
 At the Function Description field, enter a description for the input.
 Note that you do not define points in macros.
5. Click the output connector and go to the Property Editor:
 At the Output Mnemonic field, enter a name for the output. For Windows-based Ovation
systems, the limit is 6 characters. For Solaris-based Ovation systems, the limit is 5
characters.
 At the Function Description field, enter a description for the output.
 Note that you do not define points in macros.

166 OW350_80
8.12 What are control macros?

6. When you create a function that will later be transformed into a macro, there may be some
internal algorithm parameters that you may want to expose (exposed parameters may be set
to a unique value each time the macro is used). The Add Macro Parameter function provides
the ability to add, delete, or edit parameters. Do the following:
a) Right-click the desired algorithm and select Add Macro Parameter from the pop-up
menu. This causes an object to be created in the Object Browser under the selected
algorithm. The object is called "Parameter I/F.'
b) Go to the Property Editor and define the following fields:
 Source -- original name of the parameter as defined for the algorithm.
 Interface Parameter Name -- new name given to the parameter as displayed when
the macro is used. The interface parameter name should be four to six characters in
length.
 Description -- new description for the parameter. Descriptions should be less than 34
characters in length.
7. Save the macro to the ControlMacros directory (see page 166). When you save the macro, it
is automatically audited. Any errors result in the macro not being saved.
8. You must now create a symbol (see page 167) for the macro.

8.12.4 To create a symbol for a control macro

You must create a symbol to represent your new macro. Once created, this symbol appears in the
Add Algorithms dialog box and the Symbol Browser.

1. Access the Control Builder (see page 27).


2. From the main Control Builder window, pull down the File menu and select New. Pull right
and choose Algorithm Symbol from the menu that displays.

OW350_80 167
8.12 What are control macros?

The New Algorithm dialog box appears. Notice that there is now an entry in the window called
Control Macros.

Figure 87: New Algorithm window showing Control Macros

3. Expand the Control Macros item in the dialog box and select the macro you just created. A
blank canvas appears ready for you to create the symbol.
4. Create the symbol as desired. For more information, refer to Creating Algorithm Symbols (see
page 233). Be sure to add pins for the input, output, and any algorithm parameters that you
added to the macro.

Note: It is recommended that you resize the canvas so that the symbol does not have much
empty space around it. Also, make sure that the Style Editor is set to the "algorithm" template.

5. Save the symbol. The new symbol is saved to a Symbols folder that the Control Builder
automatically created under the System folder. You are now ready to add the macro to a
control function (see page 169).

8.12.5 To install macros from another system

Use the following procedure to install macros from another (remote) system.

Note: The following procedures involve using the compile operation. You should not import or
export macros and their symbols.

1. Copy the macro .svg files from the desired system to a portable storage device (CD, DVD,
USB drive).
2. At a machine on the target system, open a Windows Explorer window.
3. Copy the macro .svg files from the storage device to the ControlMacros directory on the target
system. (See To create a ControlMacros folder in a Windows-based Ovation system (see
page 166) for more information.)

168 OW350_80
8.12 What are control macros?

4. From the command window on the target system, type the following command at the prompt
and then hit the <Enter> key on the keyboard:
%CB_HOME%\CBOperation.exe
5. Compile the macros. Resolve any errors that are generated from the compile
6. Copy the (macro) symbol .svg files to the Symbols directory on the target system.

8.12.6 To add a macro to a control sheet

Once a macro has been defined and the symbol for the macro has been created, you may add
the macro to a control sheet.

1. Access the Control Builder (see page 27).


2. Create a new control function (see page 96) in the Control Builder or open an existing control
sheet (see page 99).
3. To add the macro, pull down the Draw menu and select Add Algorithm. (You can also use
the Add Control Algorithm toolbar icon.)
The Add Algorithm dialog box displays. Notice that there is now a folder called Control
Macros.

Note: If you cannot find the symbol you created, select the Refresh button on the Add Algorithm
dialog box.

4. Expand the Control Macros folder and select the symbol you created for your macro.
5. Place the macro on the sheet, at the desired location.
6. After adding the macro to the drawing canvas, the macro appears in the Algorithms container
in the Object Browser window. The macro parameters appear in the Property Editor window
where you can edit them, if desired.
7. Build any additional control logic into your sheet, if desired.
8. Save the control function.
9. Load the Controllers.

Note: For Ovation releases 3.2 and later, you no longer have to manually download sheets to
MMIs. A service runs in the background that updates the MMIs on startup and every few
minutes.

OW350_80 169
8.12 What are control macros?

8.12.7 To edit a control macro in the Control Builder


1. Access the Control Builder (see page 27).
2. Display a sheet that contains a macro.
3. Right-click the macro. Select Edit Macro from the pop-up menu.

Figure 88: Control Builder showing Explode Macro on right-click menu

4. Another window appears that displays all the internal components of the macro.
5. Edit the macro as desired and save the changes.

8.12.8 Replacing a macro reference

The Replace Macro Reference function provides an easy way to interchange macros on a sheet.
Parameters (pins) on the new macro are mapped to pin names on the original macro. Only the
pins that exist for the original macro will be mapped in the new macro.

Note: If there are extra pins on the new macro that did not exist on the original macro, they will
not initially appear when you replace the macro on the sheet. You must add these pins
manually. See To add a control pin (see page 177).

When a macro is replaced on a sheet, the symbol will look the same as the original macro;
however, the new pin names will be used. After a macro is replaced, the logic from the new macro
is used.

170 OW350_80
8.12 What are control macros?

8.12.9 To replace a macro reference

Use the following procedure to replace a macro.

1. Access the Control Builder (see page 27).


2. Open the control sheet (see page 99) that uses the macro you want to replace.
3. From the main Control Builder window, pull down the Tools menu and select Replace Macro
Reference. In the lower left corner of the Control Builder window notice that footer reads,
"Replace Macro: Select Algorithm."
4. Select the macro on the sheet. The Add Algorithm window appears.
5. On the Add Algorithm window, expand the Control Macros item on the left side of the
window. A list of all the control macros appears.
6. Select the macro that you want to use as the replacement for the macro on the sheet. Press
the OK button on the Add Algorithm window.
7. The Replace Macro window appears. The Replace Macro window lists all the parameters of
the original macro and the new macro. Notice the Pin column. Any parameter that is the same
in both macros has a check mark in the Pin column. If desired, you do not have to map these
pin names.

Figure 89: Replace Macro window

OW350_80 171
8.12 What are control macros?

8. For pin names that you want to replace, click the applicable entry field in the New Pin Name
column. A menu appears listing all the available parameters on the new macro that you can
select from.

Figure 90: Replace Macro window showing New Pin menu

9. Enter descriptions for all the new pin names that you have defined in the New Description
entry field.
10. Select the Commit button on the Replace Macro window to make the changes or the Cancel
button to discard the changes and quit the window. Note that if there are original pin names
that you did not assign a new pin name, the following warning message will appear.

172 OW350_80
8.12 What are control macros?

Figure 91: Replace Macro Warning window

11. Select the OK button to continue with the replace. Note that pins that do not have a new pin
name defined will be deleted from the macro. Press Cancel button to discontinue the replace
action and return to the Replace Macro window.
12. After you select the Commit button, a window appears asking you to confirm the changes to
the macro. Select the OK button to commit the changes or the Cancel button to discard the
changes and quit the window.
The system automatically replaces the macro. The replaced macro that appears on the sheet
will use the same symbol as the original macro, but the new pin names will be used in place
of the original pin names. However, the logic now being used is from the new macro and not
the original macro.

8.12.10 To display control macros in signal diagrams


1. Access a Accessing a Signal Diagram (see page 282).
2. Display a sheet that contains a macro.
3. Right-click the macro. Select Explode Macro from the pop-up menu.
4. Another window appears that displays all the internal components of the macro. In this way
you can observe the macro's performance in the online environment. The signal diagram
allows you to toggle back and forth between a sheet and the macro.

Note: On the second window that appears after exploding a macro, certain buttons are disabled
(up/down, back/forward, Controller pair, Component, and Refresh). If a button is disabled, it
means that the operation is not valid with an exploded macro.

8.12.11 To modify a control macro


1. Find the macro (<macroname>.svg file) in the Control Macro directory, and open it in the
Control Builder.
2. Edit the macro as desired. You can use the Property Editor to edit parameter values or the
drawing canvas to edit graphic entities.
3. Save the macro.

CAUTION! Any modification made to a macro may have adverse effects on the sheets
containing the macro. Reload those sheets into the Controller and test your control before you
add them to your Ovation system.

OW350_80 173
8.13 What is the Macro Interface Editor window?

8.13 What is the Macro Interfa ce Editor window ?

The Macro Interface Editor window provides a central location where all macros can be edited
and verified.

8.13.1 Macro Interface Editor window and field descriptions

Figure 92: Macro Interface Editor window

The following table describes the Macro Interface Editor window fields.

Macro Interface Editor window fields and buttons

ITEM DESCRIPTION

Source Displays the name of the algorithm. Note that any information found in square
brackets beside the algorithm name is the name of the parameter within the
algorithm that you are defining.
Name Defines the new name of the parameter in the macro. This name becomes the
pin name for inputs and outputs.
Description Provides a description of the new macro parameter name.
Show Find and Replace Displays the Find and Replace panel (see page 175). This function replaces
Panel check box text in the Name and Description columns only.
Ok Saves the changes made on the Macro Interface Editor window.
Cancel Quits the Macro Interface Editor window without saving any changes.
Help Displays online help for the window.

Note: To get information on window fields, buttons, or columns, use the "What's This" (?) (see
page 64) function.

174 OW350_80
8.13 What is the Macro Interface Editor window?

8.13.2 To edit parameters in the Macro Interface Editor window


1. Access the Control Builder (see page 27) and open a macro from the ControlMacros
directory.
2. When the macro appears in the drawing canvas, pull down the Edit menu and select Macro
Interface. The Macro Interface Editor window appears.
3. Highlight the desired field on the window. Note that when you select a field, the algorithm
highlights on the sheet.
4. You can only make changes to the Name or the Description columns. To make a change to
these fields, select the information in the column, delete it, and add the new information. If you
would like to perform a global search and replace, see To use in the Find and Replace panel
in the Macro Interface Editor window (see page 175).
5. The columns of the Macro Interface Editor are sortable. Click the header of the column and
either an up arrow or a down arrow appears. The up error indicates that the column is sorted
in alphabetical order. A down error means that the column is sorted in reverse alphabetical
order.
6. Make any desired changes. When you finish, select the OK button to commit the changes.
Press the Cancel button to quit the window without saving the changes. Select the Help
button to access online help on the window.
7. Once you make changes and save them, the header of the Macro Interface Editor window
displays the text, "Edited," and also shows whether or not there are errors. For more
information, see To view errors in the Macro Interface Editor window (see page 176).

8.13.3 To use the Find and Replace panel in the Macro Interface Editor window
1. Access the Control Builder (see page 27) and open a macro from the ControlMacros
directory.
2. When the macro appears in the drawing canvas, pull down the Edit menu and select Macro
Interface. The Macro Interface Editor window appears.
3. From the Macro Interface Editor window, select the Show Find and Replace Panel check
box.
The Macro Interface Editor window updates as shown in the following figure:

Figure 93: Macro Interface Editor window - Find and Replace panel

The Find and Replace panel allows you to search for and replace text in either the Name or
Description columns.

OW350_80 175
8.13 What is the Macro Interface Editor window?

4. To use the Find and Replace panel, enter the text/characters to search for in the Find entry
field. Be specific when entering information because the window fields are case-sensitive.
5. To replace the characters in the Find entry field, enter the new characters in the Replace
entry field.
6. Pull down the Column menu and select the column that you want to search in: Name or
Description.
7. Select the Replace button. The column updates with the new information.
8. To commit the changes and exit the window, select the Ok button. To exit the window without
saving the changes, select the Cancel button.

8.13.4 To view errors in the Macro Interface Editor window

If errors exist in the Macro Interface Editor, the header updates to show the number of errors, and
another column appears on the window showing which algorithms have errors associated with
them. The red "x" depicts the errors. If you hover over the error icon, the tooltip displays a brief
error description. To fix the errors, edit the algorithm parameter in the Property Editor.

Figure 94: Macro Interface Editor window - errors

176 OW350_80
S E C T I O N 9

9 Understanding the elements of a control sheet

IN THIS SECTION

What are the elements of a control sheet? ..................................................................... 177


What are control pins? .................................................................................................... 177
What are control signals? ................................................................................................ 179
What are page connectors on control sheets? ............................................................... 185
Adding comments (static text) to Control Builder documents ......................................... 188
What is the Control Builder Document Value function? .................................................. 189

9.1 What are the elements of a control sheet?

In addition to algorithms (see page 123) and macros (see page 165), you must consider several
elements of control sheets when designing and building control. These elements are placed,
connected, and manipulated on a control sheet in order to create the best possible control
schema for an Ovation system.

These elements are:


 Pins (see page 177) are part of the algorithm symbol and connect to signals.
 Signals (see page 179) are the lines on a sheet that connect the algorithms.
 Page connectors (see page 185) connect control sheets together when more than one sheet
is needed to represent a control plan.
 Static Text (see page 188) adds descriptions to control sheets that do not change.
 Dynamic text (see page 189) adds descriptions to the control sheets that update as the sheet
information updates.

9.2 What are control pins?


Pins are part of the algorithm symbol and connect to signals. (See Ovation Algorithms Reference
Manual.) The Ovation Control Builder adds, deletes, and moves pins. If you cannot add, delete, or
move a pin, the Control Builder displays a message and does not permit the action to be
completed.

9.2.1 To add a control pin

Pins can be added to an algorithm symbol on a control sheet. When Add Control Pin is selected
from the Draw menu, a list of valid pins that can be added to the algorithm appears.

Note: Tracking pins (TOUT AND TRIN) are not visible and cannot be added to an algorithm
symbol.

1. Access the Control Builder (see page 27).

OW350_80 177
9.2 What are control pins?

2. Open a sheet (see page 99).


3. From the main Control Builder window, you can access the Add Control Pin function in one of
the following ways:
 Pull down the Draw menu, and select Add Control Pin.
 Select the Add Control Pin icon on the toolbar.
 Move the cursor over the algorithm, right-click, and select Add Control Pin from the
menu that appears.
4. Left-click the algorithm that is getting the additional pin. (Note that this step is not needed if
you selected Add Control Pin from the right-click menu.)
5. The Ovation Control Builder zooms into the selected algorithm to display an enlarged view of
the algorithm. At the same time, the Select Parameter window appears showing the valid pins
that can be added to this algorithm.

Figure 95: Select parameter window -- adding a pin

6. Select the desired pin from the list.


7. The filters listed on the right side of the window allow you to only show certain types of
parameters on the Select Parameter window. You may check all of the filters to display or only
choose a few.
 Input -- shows parameters that can be used as inputs.
 Output -- shows parameters that can be used as outputs.
 Dual Input -- shows parameters that can take a value or a point name. If the pin is
connected, the point name displays. If the pin is not connected, the value in the algorithm
displays.
 Parameter -- shows parameters that can take constants.
 Tracking -- shows parameters that implement tracking.
8. Select the OK button.

178 OW350_80
9.3 What are control signals?

9. Position the cursor on the algorithm where you want to place the pin. Left-click for the
beginning of the pin and left-click again to mark the end of the pin.
10. After you have placed the pin, the Select Parameter window appears again prompting you to
add another pin, if desired.

Note: The Property Editor initially lists every pin that can be added whether you use it or not;
however, the Object Browser only lists the pins that are currently being used. For example, if
you select an AND algorithm with four pins (four inputs), the Property Editor lists entry fields for
eight inputs, but the Object Browser only shows the four inputs that you initially selected. If you
add a pin (input) to the AND algorithm, the Object Browser updates to show the pin you added.

9.2.2 To delete a control pin

There are many ways to delete a pin from an algorithm:


 Select the pin on the drawing canvas.
 Press the Delete key on the keyboard.
 Use the Delete icon on the Standard toolbar.
 Pull down the Edit menu, and select Delete.
 Right-click the algorithm and select Delete from the menu.
 Highlight the pin in the Object Browser.
 Use the Delete Object icon on the Object Browser toolbar.
 Right-click the pin and select Delete Object from the menu.

9.2.3 To move a control pin

You can move a control pin in the same way you move any other item on the drawing canvas
(see To move objects (see page 228)); however, moving pins in this way can be tedious. In many
cases, it is easier to delete the existing pin (see page 179) and add a new one (see page 177).

9.3 What are control signals?

Signals are the lines on a drawing that connect the algorithms. Signals are drawn in colors and
line types that are defined through the Property Editor. You can set the colors and line types so
that different inputs can be more easily distinguished.

OW350_80 179
9.3 What are control signals?

9.3.1 What are the best practices for using control signals?
 Signals start from a source (an algorithm output pin or a point on an existing line) and then
proceed toward the destination.
 Up to three signals could come from one signal intersection point.
 If a signal is erased, the signals are erased downstream from the selected segment (from
output to input).
 If a signal leaves a sheet, the output point must be user-defined.
 Output signals are single-sourced. The ORIG parameter on an Input connector designates
which control sheet the hardware input point originates from.
 Single-sourcing of packed points is convenient because only one signal diagram number
can be attached to a point. If a packed point originates on multiple sheets, only the last
sheet compiled gets the signal diagram number.
 Minimize signal crossing to avoid confusion where signals meet and cross.
 The following default colors are used to identify signals in the Control Builder drawings:
 Cyan indicates digital signals.
 White indicates analog signals.
 Red indicates the signal is not connected.
 Green indicates a tracking signal.
 Magenta highlights a signal for quick visual tracking.

Note: Signal colors can be changed, but the release default colors are the recommended
colors. If you change the colors, you must use the Audit function to save the changes.

 Refer to Understanding colors in the Signal Diagram display canvas (see page 308) for
information on default signal colors for online graphic displays.

9.3.2 To add a control signal

Note: If you want to add a signal that is not connected to a second algorithm, start the signal at
the algorithm Out pin then put the cursor where you want to end the signal and click the left
mouse button.

1. Access the Control Builder (see page 27).


2. Open a sheet (see page 99).
3. Start a control signal in one of the following ways:
 Pull down the Draw menu, and select Build Control Signal.
 Select the Build Control Signal icon on the Control Builder toolbar.
 Position the cursor at the Out pin of the algorithm, right-click, and select Build Control
Signal from the menu.
 Use Start Signal from the right-click menu. See To connect control signals from the right-
click menu (see page 181).
4. Use the mouse to select an Out pin or an existing segment on an algorithm and left-click it.
(Note that this step is not needed when you select Build Control Signal from the right-click
menu.

180 OW350_80
9.3 What are control signals?

5. Without holding down any mouse buttons, move the cursor to an In pin on the algorithm you
want to connect to the first algorithm and left-click it. A signal is placed between the two
algorithms. (See Tips for adding a signal (see page 181).)

Note: Make sure you have the Enable Ortho check box checked when you add a signal. This
check box is found at the lower right corner of the Control Builder window. Enable Ortho allows
orthogonal lines, meaning that only vertical and horizontal signal lines can be drawn. If you use
this check box, you will not be allowed to draw diagonal signal lines.

6. To exit the Build a Signal mode, right-click or press the Escape key on the keyboard. Notice
that the Signal Segment is also added to the Output pin in the Object Browser.

Tips for adding a control signal

The Control Builder application can assist you in adding signals:


 If an arrow icon appears when starting to build a signal, press the Enter key on the keyboard.
The Control Builder will complete the signal draw process.
 When looking for the starting point of a signal, a red "X" appears showing an invalid starting
point for the signal. When the symbol changes to a green dot, you are hovering over a valid
starting point for the signal.
 To line up a signal, you can access cross-hairs at any time by holding down the Shift key on
the keyboard as you move the mouse.

9.3.3 To connect control signals from the right-click menu


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. To start a control signal, right-click an algorithm. A menu appears. The top of the menu
displays one of the following:
 Name of an unattached output point (up to three names may display).
 The words "Start Signal" if more than three unattached output points are available for
connecting. Pull right from Start Signal and a list of the available pins appears. See the
following figure.

OW350_80 181
9.3 What are control signals?

4. Select a pin from the menu of choices. The signal line appears.
5. Go to the algorithm that has the pin that you want to connect to. Note that if a red "X"
appears, you cannot connect a signal to that pin (the program performs record type checking).
Also, in the footer of the Control Builder window, a message displays stating, "There are no
available pins."
6. To end the signal, right-click the desired algorithm. A menu appears. The top of the menu
displays the words "End Signal" with a list of unattached input points available for connecting.
Attached inputs are omitted form the list. Select the desired point and the signal connects.
Note that you may have to do some re-adjusting of the signal lines for alignment purposes.

9.3.4 To delete or break a control signal

Using the Object Browser


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Go to the Object Browser and find the desired algorithm in the Algorithms container. Expand
the algorithm object to display its contents in the hierarchy.
4. Find the control pin that connects to the signal. Expand the pin object to display its contents.
5. Highlight SignalSegment in the hierarchy.
6. Select the Delete Object icon (shown as an "x") on the Object Browser.
OR
Right-click and select Delete Object from the menu that appears.
7. Save the sheet.

182 OW350_80
9.3 What are control signals?

Using the drawing canvas


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Position the cursor over the control signal you want to delete.
4. Right-click and select Break Control Signal from the menu that appears. The signal deletes.
5. Save the sheet.

9.3.5 To bend a control signal


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Move the cursor to the signal you want to bend.
4. Right-click over the signal, and select Bend Control Signal.
5. Without holding down any mouse buttons, move the cursor to bend the signal to the desired
location.
6. Left-click again to mark the final vertex point of the bent signal.
7. To end the bending session, right-click or press the Esc key on the keyboard.

9.3.6 To move a control signal


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Highlight the signal you want to move. The signal turns magenta.
4. Move the cursor over the grips or vertex points. The grips display as blue squares.
5. As you hover the cursor over the grips and left-click, the cursor icon changes from a cross-
hair to a hand. The hand icon lets you know that you have "grabbed" a grip and can now
move the signal to wherever you choose.
6. Move the signal as desired. Left-click to complete the move process.

9.3.7 To set tracking between algorithms

Tracking is used to align the portion of a control system that is not in control to the portion of the
control system that is in control. Tracking signals are sent between algorithms to tell the upstream
algorithm whether or not to be in tracking mode, and what value is required by the downstream
algorithm to maintain the current output coming from the upstream algorithm. Refer to
Understanding tracking (see page 375) for more information.

1. Access the Control Builder (see page 27).


2. Open a sheet (see page 99).
3. Hover over a signal, right-click, and select Connect Tracking Signal. The signal changes
color to match the "tracking" color option (typically, green).
4. To clear tracking from the signal, hover over the signal, right-click and select Disconnect
Tracking Signal. The signal returns to its original color.

OW350_80 183
9.3 What are control signals?

9.3.8 To set tracking between sheets

You can set tracking across sheet boundaries. As with all points entering or leaving a sheet,
tracking points used on multiple sheets must be user defined. Since the Control Builder manages
the tracking connections, the tracking fields in the Property Editor are typically hidden from the
user.

On the downstream sheet


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Enable the tracking from the downstream algorithm to the input connector.
4. Edit the downstream algorithm using the Property Editor. The tracking field is now visible and
can be edited.
5. Enter a user-defined name in the Property Editor.
6. Save the sheet.

On the upstream sheet


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. Enable the tracking from the output connector to the upstream algorithm.
4. Edit the output connector using the Property Editor.
5. Enter the user-defined name from the downstream algorithm and exit the Property Editor.
6. Save the sheet.

9.3.9 To clear all tracking on a sheet

You can clear all tracking on a sheet with one click of the mouse button.

1. Access the Control Builder (see page 27).


2. Open a sheet (see page 99) that has tracking in the Control Builder.
3. Pull down the File menu, and select Clear All Tracking. The following window appears:

Figure 96: Confirm Operation window

4. Select Yes on the Confirm Operation window. All tracking is removed from the currently
opened sheet.

184 OW350_80
9.4 What are page connectors on control sheets?

9.4 What are page connectors on control sheets?

Page connectors are graphical representations of the input and output between sheets. Page
connectors are similar to algorithms and can be added, deleted, and edited like algorithms;
however, page connectors play no actual role in the control process and are therefore not loaded
into the Controller.

Page connectors are used to connect signals from one sheet to another within a single Controller,
between Controllers, or between a Controller and its I/O.

Note: A second set of input/output symbols are provided for macros to allow for macro-specific
information.

9.4.1 What are the best practices for using page connectors on control she ets?
 A page connector is an input/output point for a sheet.
 Input page connectors graphically accept points into a sheet.
 Output page connectors graphically pass points out of a sheet.
 Page connectors may or may not have a matching page connector on another sheet.
 Page connectors reflect the point's usage and configuration and are automatically updated by
the Control Builder.
 Page connectors are not sensitive to record types. There is neither an analog connector nor a
digital connector.
 You cannot use a page connector to pass default points. By definition, default points are not
meant to be used outside the originating sheet.
 By default, a page connector contains a tag for both the point name and the point’s English
Description.
 Minimize the use of connectors.
 Use only one input connector per point per sheet - this reduces clutter.
There is no reason to bring an input directly to an output connector.
 As hardware inputs are placed on sheets, consider setting originate = true/yes in the input
connector.
 Review all usages for best origination sheet - this will be the default signal diagram
accessed via Point Information.
 Control systems can consist of either discrete logic (digital) or continuous modulating control
(analog).
 Most control systems, whether they are discrete logic or modulating control systems, consist
of three typical elements:
 Input — either digital or analog signals gathered from field sensors. Field devices control
or record some physical operation in the field.
 Control logic — processes the input information and determines which output functions
should be activated.
 Output — either digital or analog signals, determined by the control logic to activate
appropriate field devices.

OW350_80 185
9.4 What are page connectors on control sheets?

9.4.2 Page connector descriptions

Refer to the following figure.

Figure 97: Page connectors

A basic page connector (A) is represented by a circle with an input or an output signal connection
to or from another sheet.

The circle has two boxes attached to it (B) that contain a “G” if the point is used in a custom
graphic, and an “A” if the point is configured for alarming.

If the circle has a box around it (C), then the point is a hardware point with values coming or going
to a device.

If the circle has a diamond in it (D), then an input point is a network point that is originated in
another drop, or an output point that is used in another drop.

If the circle has a diamond in it and a box around it (E), then the point is a hardware point that is
originated in another drop.

9.4.3 To use page connectors on control sheets


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, select the Add Algorithm icon. (You can also pull
down the Draw menu and select Add Algorithm.)
The Add Algorithm dialog box appears.
4. From the list of Algorithm Symbols on the left side of the window, expand the External Point
folder.
5. Select either Input or Output depending on the type of page connector needed.
6. See the following procedures.

For Input connectors


1. If you select Input from the External Point folder, choose from an analog input (horizontal) or
a digital (vertical) input.

186 OW350_80
9.4 What are page connectors on control sheets?

2. Place the input on the sheet at the desired location. Notice that the Object Browser updates
accordingly with the new information. For inputs, the Property Editor displays the following
fields.

Figure 98: Property Editor -- add input page connector

3. Use the Property Editor to define information about the connector (See the Input page
connector table).
4. Connect it to an algorithm.
5. Save the sheet.

Input page connector fields in Property Editor

FIELD DESCRIPTION

Input Mnemonic For macros, this becomes the pin name on the symbol. For other
items, this is the name of the sheet that has the input connector.
Functional Description For macros, this is the description of the macro that is shown in the
Property Editor. For other items, this is the description for the input
sheet.
Sheet Input Point Enter a point name for the input connector. Possible points are:
 Hardware point.
 Point from another sheet but in the same drop.
 Received point (network point) from a sheet in another drop.
Tracking Output Point Defines the tracking output point. This is only valid when the input
tracks the downstream algorithm. This is done to support cross-
sheet tracking.
Originate Point From This Sheet Pull-down menu that defines whether or not this point originates
from this sheet. The choices are Yes or No.

For output connectors


1. Connect the appropriate signal line to the output connector.
2. Use the Property Editor to ensure that the upstream algorithm contains a user-defined point
name.
3. Save the sheet.

OW350_80 187
9.5 Adding comments (static text) to Control Builder documents

9.4.4 To delete page connectors on control sheets

There are many ways to delete a page connector from a sheet:


 Select the page connector on the drawing canvas.
 Press the Delete key on the keyboard.
 Use the Delete icon on the Standard toolbar.
 Pull down the Edit menu, and select Delete.
 Right-click the page connector and select Delete from the menu.
 Highlight the page connector in the Object Browser.
 Use the Delete Object icon on the Object Browser toolbar.
 Right-click the page connector and select Delete Object from the menu.

9.4.5 To determine where a page connector is used on a control sheet

You might need to determine where a page connector is used to ensure that you do not
accidentally delete a connector that is needed in the control scheme.

1. Access the Control Builder (see page 27).


2. Open a sheet (see page 99).
3. Right-click the desired page connector.
4. A menu displays. The bottom of the menu contains a list of all the locations where the
connector is used. Left-click a sheet in the menu and the sheet appears in the Control Builder.

9.4.6 Using output connectors on control sheets

Output page connectors should be used to connect signals that are generated on one sheet and
used on other sheets within the same Controller. The Control Builder automatically assigns an
alpha designator and resolves the sheet numbers across sheets, but only if all connectors are
built on the source sheet and the receiving sheet.

You can have one output connector on a sheet that connects to inputs on multiple sheets (this is
known as the “one to many relationship”).

Input connectors must be designated on sheets; however, output connectors do not have to be
illustrated on a sheet. To avoid confusion, Emerson recommends that you designate output
connectors for signals that go to graphics, alarms, or another sheet.

Avoid “daisy-chaining” output connectors from sheet to sheet; instead, create all output
connectors on one sheet.

9.5 Adding comments (static text) to Control Builder documents

Comments are static text displays that do not change or update. To add text to a control function,
see To Add Text to a Simple Graphic (see page 219).

Once text is added to a control function, it can be deleted or edited either on the drawing canvas
(see page 227) or through the Object Browser (see page 49). Also see To find and replace
comment text (see page 221).

188 OW350_80
9.6 What is the Control Builder Document Value function?

9.6 What is the Control Builder Document Value functi on?

The Document Value function displays text fields on a control sheet. These text fields identify
general title information that pertains to the sheet such as project name, engineer, drop ID, task
ID, and so forth. These fields are dynamic and change when the parameter updates. For
example, you can add a text field that displays the project name or sheet title.

9.6.1 To use the Document Value function


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Draw menu and select Document
Value.
The Select parameter window appears displaying the sheet parameters that can be used.
Notice that these are the same parameters used in the title box.

Figure 99: Select parameter dialog box - Document Value

4. Select the desired parameter and click the Add button.

Note: Notice that the Filters list is grayed out. These filters are not applicable to document
values.

5. Move the cursor on the drawing canvas. Left-click to place the document value on the sheet.
The desired information appears on the sheet. The Object Browser updates with an entry
called "Dynamic Text" under the applicable algorithm.
6. Audit the sheet so that all the changes are verified by the Control Builder and the algorithm
values are updated.
7. Save the sheet.

Note: To use the Object Browser to delete a document value, expand the active container. Find
"Dynamic Text" in the hierarchy list and delete it.

OW350_80 189
9.6 What is the Control Builder Document Value function?

9.6.2 Using the Property Editor to change document values

When the Document Value function is placed on the drawing canvas, the Object Browser and the
Property Editor update to show the additional information added to the sheet. The Document
Value function is listed as "Dynamic Text" in the active container in the Object Browser.

Select the Dynamic Text entry in the Object Browser and notice the information that displays in
the Property Editor.

Figure 100: Object Browser and Property Editor - Document Value function

You can modify the document value properties using the Property Editor. To do this, click the
Value field beside the property you wish to change. Depending on the property, either an entry
field or a pull-down menu appears.

The following table describes the fields that display in the Property Editor when you add a
document value to a sheet.

Property Editor -- Document Value fields

FIELD DESCRIPTION

Source Changes the document parameter that displays on the sheet. This pull-down menu
displays all of the fields that are found in the title box.
Labeled Determines whether or not to add a label to the document parameter you are adding
to the sheet. The choices are True or False. For example, if this is set to True, the
document value would read "DROP ID = 210" instead of just "210."

190 OW350_80
9.6 What is the Control Builder Document Value function?

In the Object Browser, expand the Dynamic Text folder and select the first "Text" entry in the list.
The Property Editor updates to show font attributes for the text. Make the desired changes
according to the descriptions found in the following table. Note that any changes made here affect
all Text entries (if more than one exists) for the Document Value.

Figure 101: Object Browser and Property Editor - font settings for Document Value

Property Editor -- Font settings for Document Value

FIELD DESCRIPTION

Style class Defines the style template, as defined in the Style Editor, that was set when you
created the Document Value.
Font color Allows you to choose the font color. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option appears on


the menu. Selecting this option displays the Select Color window, which
provides a selection of predefined colors as well as the ability to create new
custom colors.

OW350_80 191
9.6 What is the Control Builder Document Value function?

FIELD DESCRIPTION

Font name Displays a list of available fonts for the document value. You can use any font
that is available on the computer on which the Control Builder is running.
Font size Presents a list of available font sizes. The choices range from 6 pt. to 72 pt.
type.
Font style Allows you to choose the font style. The choices are normal or italic.
Font weight Allows you to choose the font weight. The choices are normal or bold.
Decoration Allows you to add special line attributes to the font. The choices are: normal,
underline, overline, and linethrough.
Anchor point - x x-coordinate of the anchor of the description.
Anchor point - y y-coordinate of the anchor of the description.
Alignment - Text anchor Used for horizontal text alignment. This parameter adjusts the text relative to x.
The choices are: Start, Middle, and End.
Alignment - Baseline shift Used for vertical text alignment. This parameter adjusts the text relative to y.
The choices are: Top, Middle, and Bottom.

192 OW350_80
S E C T I O N 10

10 Understanding points in the Control Builder

IN THIS SECTION

Using the Control Builder to create points ...................................................................... 193


What is the Control Builder Point Editor window? ........................................................... 195
What are Ovation point security groups? ........................................................................ 199
What is the Control Builder Find Points function? ........................................................... 200
What is the Control Builder Point Description function? ................................................. 201
What is the Control Builder Point Reference function? ................................................... 206
What is the Control Builder Point Status Indicator function? .......................................... 210

10.1 Using the Control Builder to create points

Typically, you do not create points through the Control Builder; however, if you are in a Control
Builder session, you might want to add points while you are creating control sheets. Being able to
create points from inside the Control Builder saves time while building control sheets.

For example, if you are adding algorithms to a control sheet, an algorithm will be assigned a
default name by the Control Builder.

From this default name, default point names are assigned to default points associated with the
algorithm. For example, if the algorithm is named OCBPID112, then its default output point will be
named OCBPID112-OUT since its name is based on the algorithm’s name.

Default point names can be used during the control sheet building process, and can remain in the
database as default points; however, there are times when these default point names should be
changed to user-defined point names.

The default points that are created in the Control Builder do not contain enough information to be
useful in a control scheme. Therefore, they typically need to become user-defined points.

When a default point is created in OCB, it has no hardware information attached to it. I/O points
need hardware information defined for them so they can be assigned to I/O modules (see page
17).

10.1.1 To create points using the Control Builder

If the point name you use in a renaming procedure does not exist in your database, you will not
be able to save the control sheet and the Error List will appear at the bottom of your screen. This
means you need to create the point. Use the following procedure to create a user-defined point.

Note: Be careful where you build logic because points should originate in the same drop where
the field wiring connects.

1. Access the Control Builder (see page 27).

OW350_80 193
10.1 Using the Control Builder to create points

2. Open a sheet (see page 99).


3. From the main Control Builder window, pull down the Edit menu and select Create User
Points. The Create User Points window appears. Notice that the window lists all the
undefined points that exist on the sheet.

Figure 102: Create User Points window

4. The columns on the Create User Points window are sortable. Click at the top of the column in
the header and an arrow appears. An up arrow indicates that the column is sorted in
alphabetical order. A down arrow means that the column is sorted in reverse alphabetical
order.
5. If desired, select an algorithm from the Algorithm column. The algorithm highlights on the
sheet.
6. Highlight the point or points you want to create in the database. After you highlight the points,
the Create button becomes active (no longer grayed out).

Note: To select every point on the window, press the <Ctrl + A> keys on the keyboard. Every
point on the window highlights.

7. Verify that the record types for the selected points are correct. Note that you cannot edit the
record types on the Create User Points window. You can only modify record types in the
Property Editor.
8. Select the Create button. This adds the points to the database and saves the sheet.
 To quit the window without creating any points, select the Cancel button.
 To get online help on using the window, select the Help button.
9. The newly created point contains only the minimum information needed to be a functional
network point. In order to assign the point to a hardware module, you must use the Point
Builder function of the applicable Ovation configuration tool.
10. In order for the new point to be used in control, you must load it in the Controller where it has
been defined. Load the Controller (see page 121) according to the procedures applicable for
your Ovation system.

194 OW350_80
10.2 What is the Control Builder Point Editor window?

10.2 What is the Control Builder Point Editor w indow ?

The Point Editor window locates points on a sheet, edits points, or maps original point names to
new point names after a library has been imported.

10.2.1 Control Builder Point Editor window fields and descriptions

Figure 103: Point Editor window

The following table describes the Point Editor window fields.

Point Editor window fields

FIELD DESCRIPTION

File menu Displays two options:


 Apply Translation - selects a point translation file from a browse
directory window and enters it into the current sheet.
 Save - saves the information in the Point Editor to a map file.
View menu Toggles the display of two additional columns for the Point Editor window:
 Record Type.
 Point Description.

OW350_80 195
10.2 What is the Control Builder Point Editor window?

FIELD DESCRIPTION

Filter menu Toggle option that defines what points are shown on the Point Editor
window:
 Hide Default Points -- hides default point names.
 Show Unchanged Points -- shows current point names.
 Show Modified Points -- shows mapped point names.
Find/Replace toggle menu Displays the Find and Replace panel at the top of the Point Editor window.
Algorithm column Name of the algorithm on a sheet.
Parameter column Algorithm parameters.
Original Point column Current name of the point on a sheet.
New Point column New name of the point on a sheet.
Type column Displays the record type associated with the point. This column only
displays if you select Record Type from the View menu on the Point
Editor window.
Description column Displays the English description associated with the point. This column
only displays if you select Point Description from the View menu on the
Point Editor window.
Ok button Performs the mapping.
Cancel button Cancels any entered data.
Help button Provides online help for the window.

10.2.2 To modify point names in the Control Builder Point Editor window
1. Access the Control Builder (see page 27).
2. Pull down the Edit menu and select Points. The Point Editor window appears showing all the
points contained on the sheet.
3. Click an algorithm in the Algorithm column. The algorithm highlights on the sheet on the
drawing canvas.
4. To change a point name, click in the New Point entry field for the desired point.

196 OW350_80
10.2 What is the Control Builder Point Editor window?

5. Enter a new point name and hit the <Enter> key on the keyboard. The Point Editor window
updates with another column that displays error information.

Figure 104: Point Editor window showing errors

6. A red circle with an x inside indicates an error. Hover over the error icon and the tooltip
displays the error message. The error message also displays at the bottom of the Point Editor
window.

Note: If there are no errors in the New Point, a check mark icon displays in the column.

7. To restore a point name to the original point name, double-click the name in the Original Point
column. A message window appears asking if you want to restore the original point name.
Select Yes to restore the original name.

Figure 105: Point Editor restore window

8. To sort each column of parameters, click the parameter heading (Algorithm, Parameter,
Original Point, and New Point). An up arrow indicates that the items are sorted in alphabetical
order. A down arrow means that the items in the column are sorted in reverse alphabetical
order.
9. To change multiple point names, use the Find and Replace toggle menu to display the Find
and Replace panel (see page 198) on the Point Editor window.

OW350_80 197
10.2 What is the Control Builder Point Editor window?

10. Select Ok to save the changes and quit the Point Editor window. Use the Cancel button to
quit the window without saving any changes. The Help button displays online help on the
Point Editor window.

10.2.3 To use the Control Builder Find and Replace panel on the Point Editor
window
1. Access the Control Builder (see page 27).
2. Select Points from the Edit menu.
3. Select the Find/Replace toggle menu at the top of the Point Editor window. The Find/Replace
panel appears.

Figure 106: Point Editor window - Find/Replace panel

4. Enter the text or characters you want to search for in the Find entry field.
5. Enter the text or characters you want to use as replacements in the Replace entry field. Note
that if you leave the Replace entry field blank, the characters that are found (from the Find
entry field) will be deleted from the window.
6. Select the Replace button.

198 OW350_80
10.3 What are Ovation point security groups?

10.3 What are Ovation point security groups?

There are 32 possible point security groups in an Ovation system. You must use the applicable
security function for your system to define or label the point security groups before you can use
these groups.

Once a group is defined and activated, you can assign points to the security group. During the
point building process, you should assign every Ovation point to a point security group. Points
assigned to a point security group typically share some common properties. For example, points
that belong to a "boiler22" security group are probably points associated with Boiler 22. (This is a
logical association and is not a hard-coded entity.)

Security access is defined for each security group. If never defined, all security groups are
enabled. Once security is defined for a sheet, you must update the security for each sheet as
groups are added or the security strategy for the system is modified.

Security only affects the default points (including algorithm records) for the current sheet. Tuning
permissions are sensitive to point security groups. If the security is incorrectly configured for a
sheet, none of the algorithms on that sheet can be tuned.

10.3.1 To assign point security groups in the Control Builder


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Edit menu and select Point Security.
The Select Point Security Group window appears.

Figure 107: Select Point Security Group window

4. Select the desired group(s) by placing a check mark in the box beside the group. To select all
the groups, press the Select All button.
5. Select the Enable button to enable the group(s) or the Disable button to disable the group(s).
6. To clear the window, select the Clear All button.
7. Select the Ok button to save the changes. Press the Cancel button to quit the window without
making any changes. Press the Help button to access online help for this window.

OW350_80 199
10.4 What is the Control Builder Find Points function?

10.4 What is the Control Builder Find Points function?

The Find Points function searches for points on a particular sheet.

10.4.1 To use the Control Builder Find Points function


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Edit menu and select Find Points. The
Find Point Name window appears.

Figure 108: Find Point Name window

4. Enter the characters in the entry field that you want to search for and press the Find button.
The search string may include all or part of a point name, and may include wildcard
characters (such as "*"). For example, if you enter "MW," the application searches the sheet
for point names that have "MW" in the name.

Figure 109: Find Point Name window - showing point names and descriptions

200 OW350_80
10.5 What is the Control Builder Point Description function?

The Find Point Name window appears with the following columns:
 Algorithm - name of the algorithm that originated the point.
 Point Name - point name that matches the search criteria.
 Point Description - English description of the point. This column only appears if the
Control Builder is connected to a database. If not, only the Algorithm and Point Name
columns appear.
When multiple point names are found, a message appears at the bottom of the Find Point
Name window, telling you how many points were found. However, if only one match is found,
the window does not appear, but instead, it zooms in on the algorithm and highlights it on the
sheet. If no point names match the search criteria, the message at the bottom of the window
says, "No points found."
5. If you single-click an algorithm in the Algorithm column, the algorithm highlights on the sheet
at the zoom full view setting. If you double-click the algorithm, the Find Point Name window
closes, the algorithm highlights on the sheet, and the magnification increases to zoom in to
that algorithm.
6. To search for more point names, enter characters in the Point Name entry field and select the
Find button. To exit the window, click the Close button. To get online help on the Find Point
Name window, click the Help button.

10.5 What is the Control Builder Point Description function?

The Point Description function adds text fields to the control sheet that show the description of the
point. This information is obtained from the ED (English Description) field for the point. These
fields are dynamic and change when the parameter updates.

10.5.1 To add a point description


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Draw menu and select Point
Description.
4. On the control sheet, left-click the algorithm for which you want to add a point description.

OW350_80 201
10.5 What is the Control Builder Point Description function?

The Select Parameter window appears displaying the parameters that can be used for that
algorithm.

Figure 110: Select parameter dialog box -- point description

Note: If you hover over a parameter listed in the Select Parameter window, the abbreviated
parameter name appears (for example, GAIN).

5. Select the desired parameter and click the Add button.


6. If you want to filter the parameter list that appears, go to the Filters list on the side of the
window. By default, all the filters are checked, which means that type of parameter is shown.
To remove a parameter type from the list, click the filter and the check mark disappears. This
parameter type is removed from the list.
 Input -- shows parameters that can be used as inputs
 Output -- shows parameters that can be used as outputs.
 Dual Input -- shows parameters that can take a value or a point name. If the pin is
connected, the point name displays. If the pin is not connected, the value in the algorithm
displays.
 Parameter -- shows parameters that can take constants.
 Tracking -- shows parameters that implement tracking.
7. Move the cursor on the drawing canvas. Left-click to mark the beginning of the point
description. Without pressing any mouse buttons, move the cursor to the desired length. Left-
click again to mark the end of the box. The desired information appears on the sheet. The
Object Browser updates with an entry called "Description" under the applicable algorithm.
8. Audit the sheet so that all the changes are verified by the Control Builder and the point
descriptions update.
9. Save the sheet.

Note: To use the Object Browser to delete a point description, expand the applicable algorithm
folder. Find "Description" in the hierarchy list and delete it.

202 OW350_80
10.5 What is the Control Builder Point Description function?

10.5.2 Using the Property Editor to change a point description display

When you place a point description on the drawing canvas, the Object Browser and the Property
Editor update to show the additional information added to the sheet. The point description is listed
as "Description" in the Object Browser.

Select the Description entry in the Object Browser and notice the information that displays in the
Property Editor.

Figure 111: Object Browser and Property Editor - point description function

You can modify the point description using the Property Editor. To do this, click the Value field
beside the property you wish to change. Depending on the property, either an entry field or a pull-
down menu appears.

OW350_80 203
10.5 What is the Control Builder Point Description function?

The following table describes the fields that display in the Property Editor when you add an
algorithm value to a sheet.

Property Editor -- Point Description fields

FIELD DESCRIPTION

Source Changes the type of parameter that displays on the sheet. This pull-down menu
displays the same items that are found in the Select Parameter dialog box.
Content Determines whether or not the point description should include supplemental
information. The choices are: Normal (do not include supplemental information) and
Extended (include supplemental information).
For digital points, supplemental information is Set and Reset information. For analog
points, supplemental information is Range and Engineering Units.
Maximum width Defines the maximum number of characters that can be used for the description.
x x-coordinate of the anchor of the description.
y y-coordinate of the anchor of the description.
Text anchor Used for horizontal text alignment. This parameter adjusts the text relative to x. The
choices are: Start, Middle, and End.
Baseline shift Used for vertical text alignment. This parameter adjusts the text relative to y. The
choices are: Top, Middle, and Bottom

204 OW350_80
10.5 What is the Control Builder Point Description function?

In the Object Browser, expand the Description folder and select the first "Text" entry in the list.
The Property Editor updates to show font attributes for the text. Make the desired changes
according to the descriptions found in the following table. Note that any changes made here affect
all Text entries (if more than one exists) for the point description.

Figure 112: Object Browser and Property Editor - font settings for Point Description

Property Editor -- Font settings for Point Description

FIELD DESCRIPTION

Style class Defines the style template, as defined in the Style Editor, that was set when you
created the Document Value.
Font color Allows you to choose the font color. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option appears on


the menu. Selecting this option displays the Select Color window, which
provides a selection of predefined colors as well as the ability to create new
custom colors.

OW350_80 205
10.6 What is the Control Builder Point Reference function?

FIELD DESCRIPTION

Font name Displays a list of available fonts for the document value. You can use any font
that is available on the computer on which the Control Builder is running.
Font size Presents a list of available font sizes. The choices range from 6 pt. to 72 pt.
type.
Font style Allows you to choose the font style. The choices are normal or italic.
Font weight Allows you to choose the font weight. The choices are normal or bold.
Decoration Allows you to add special line attributes to the font. The choices are: normal,
underline, overline, and linethrough.
Anchor point - x x-coordinate of the anchor of the description.
Anchor point - y y-coordinate of the anchor of the description.
Alignment - Text anchor Used for horizontal text alignment. This parameter adjusts the text relative to x.
The choices are: Start, Middle, and End.
Alignment - Baseline shift Used for vertical text alignment. This parameter adjusts the text relative to y.
The choices are: Top, Middle, and Bottom.

10.6 What is the Control Builder Point Reference function?

The Point Reference function adds text fields to the control sheet that show all point references to
a sheet. A point reference shows where the point is used or where it came from. The format for
this information is: drop number/sheet number. This feature is best utilized when used in
conjunction with input/output connectors.

10.6.1 To add a point reference


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Draw menu and select Point
Reference.
4. On the control sheet, left-click the algorithm for which you want to add a point reference.

206 OW350_80
10.6 What is the Control Builder Point Reference function?

The Select parameter window appears displaying the parameters that can be used for that
algorithm.

Figure 113: Select Parameter dialog box -- point reference

Note: If you hover over a parameter listed in the Select Parameter window, the abbreviated
parameter name appears.

5. Select the desired parameter and click the Add button.


6. If you want to filter the parameter list that appears, go to the Filters list on the side of the
window. By default, all the filters are checked, which means that type of parameter is shown.
To remove a parameter type from the list, click the filter and the check mark disappears. This
parameter type is removed from the list.
 Input -- shows parameters that can be used as inputs
 Output -- shows parameters that can be used as outputs.
 Dual Input -- shows parameters that can take a value or a point name. If the pin is
connected, the point name displays. If the pin is not connected, the value in the algorithm
displays.
 Parameter -- shows parameters that can take constants.
 Tracking -- shows parameters that implement tracking.
7. Move the cursor on the drawing canvas. Left-click to mark the beginning of the point
reference. Without pressing any mouse buttons, move the cursor to the desired length. Left-
click again to mark the end of the box. The desired information appears on the sheet. The
Object Browser updates with an entry called "References" under the applicable algorithm.
8. Audit the sheet so that all the changes are verified by the Control Builder and the point
references update.
9. Save the sheet.

Note: To use the Object Browser to delete a point reference, expand the applicable algorithm
folder. Find "Reference" in the hierarchy list and delete it.

OW350_80 207
10.6 What is the Control Builder Point Reference function?

10.6.2 Using the Property Editor to change a point reference

When a point reference is placed on the drawing canvas, the Object Browser and Property Editor
update to show the additional information added to the sheet. The point reference is listed as
"References" in the Object Browser.

Select the References entry in the Object Browser and notice the information that displays in the
Property Editor.

Figure 114: Object Browser and Property Editor - point reference function

You can modify the point reference properties using the Property Editor. To do this, click the
Value field beside the property you wish to change, Depending on the property, either an entry
field or a pull-down menu appears.

The following table describes the fields that display in the Property Editor when you add a point
reference to a sheet.

Property Editor -- point reference fields

FIELD DESCRIPTION

Source Changes the type of parameter that displays on the sheet. This pull-down menu
displays the same items that are found in the Select Parameter dialog box.
Originator Determines whether or not to display the originating sheet or the referencing sheets.

208 OW350_80
10.6 What is the Control Builder Point Reference function?

FIELD DESCRIPTION

Maximum width Defines the wrapping width of the text string in pixels.
x x-coordinate of the anchor of the description.
y y-coordinate of the anchor of the description.
Text anchor Used for horizontal text alignment. This parameter adjusts the text relative to x. The
choices are: Start, Middle, and End.
Baseline shift Used for vertical text alignment. This parameter adjusts the text relative to y. The
choices are: Top, Middle, and Bottom

In the Object Browser, expand the References folder and select the first "Text" entry in the list.
The Property Editor updates to show font attributes for the text. Make the desired changes
according to the descriptions found in the following table. Note that any changes made here affect
all Text entries (if more than one exists) for the point reference.

Figure 115: Object Browser and Property Editor - font settings for point reference

OW350_80 209
10.7 What is the Control Builder Point Status Indicator function?

Property Editor -- Font settings for Point Reference

FIELD DESCRIPTION

Style class Defines the style template, as defined in the Style Editor, that was set when you
created the Document Value.
Font color Allows you to choose the font color. When you click this field, a menu displays
that allows you to choose from 16 standard colors.

Note: For Windows-based Ovation systems only, a Custom option appears on


the menu. Selecting this option displays the Select Color window, which
provides a selection of predefined colors as well as the ability to create new
custom colors.

Font name Displays a list of available fonts for the document value. You can use any font
that is available on the computer on which the Control Builder is running.
Font size Presents a list of available font sizes. The choices range from 6 pt. to 72 pt.
type.
Font style Allows you to choose the font style. The choices are normal or italic.
Font weight Allows you to choose the font weight. The choices are normal or bold.
Decoration Allows you to add special line attributes to the font. The choices are: normal,
underline, overline, and linethrough.
Anchor point - x x-coordinate of the anchor of the description.
Anchor point - y y-coordinate of the anchor of the description.
Alignment - Text anchor Used for horizontal text alignment. This parameter adjusts the text relative to x.
The choices are: Start, Middle, and End.
Alignment - Baseline shift Used for vertical text alignment. This parameter adjusts the text relative to y.
The choices are: Top, Middle, and Bottom.

10.7 What is the Control Builder Point Status Indicator fun ction?

The Point Status Indicator function is used to organize a group of graphic primitives (simple
graphic items) and to control their visibility based on the current configuration of a point. When
used, it should be attached to algorithm symbols.

When you add a point status indicator to an algorithm, a container is created in the Object
Browser under that algorithm folder. This folder is used to hold whatever symbol (graphic shape,
such as blue rectangle, red ellipse, and so forth) you want to use to represent the point's indicator
type.

You select one of the algorithm's parameters to be assigned to the point indicator type. The
indicator type is defined in the Property Editor. For example, you select a parameter for an
algorithm. For that point, you assign an indicator type (such as Alarm). This means that when this
point is configured to be alarmed, the graphic symbol that is in the folder displays.

Note: Under normal usage, most users will not use this functionality.

210 OW350_80
10.7 What is the Control Builder Point Status Indicator function?

10.7.1 To add a point status indicator


1. Access the Control Builder (see page 27).
2. Open a sheet (see page 99).
3. From the main Control Builder window, pull down the Draw menu and select Point Status
Indicator.
4. On the control sheet, left-click the algorithm for which you want to add a point status indicator.
The Select parameter window appears displaying the parameters that can be used for that
algorithm.

Figure 116: Select parameter dialog box -- point status indicator

Note: If you hover over a parameter listed in the Select Parameter window, the abbreviated
parameter name appears (for example, GAIN).

5. Select the desired parameter and click the Add button.


6. If you want to filter the parameter list that appears, go to the Filters list on the side of the
window. By default, all the filters are checked, which means that type of parameter is shown.
To remove a parameter type from the list, click the filter and the check mark disappears. This
parameter type is removed from the list.
 Input -- shows parameters that can be used as inputs
 Output -- shows parameters that can be used as outputs.
 Dual Input -- shows parameters that can take a value or a point name. If the pin is
connected, the point name displays. If the pin is not connected, the value in the algorithm
displays.
 Parameter -- shows parameters that can take constants.
 Tracking -- shows parameters that implement tracking.
7. A new container appears in the Object Browser called "Point Status Indicator."

OW350_80 211
10.7 What is the Control Builder Point Status Indicator function?

8. Audit the sheet so that all the changes are verified by the Control Builder.
9. Save the sheet.

Note: To use the Object Browser to delete a point status indicator, expand the applicable
algorithm folder. Find "Point Status Indicator" in the hierarchy list and delete it.

10.7.2 Using the Property Editor to change a point status indicator

When a point status indicator is placed on the drawing canvas, the Object Browser and Property
Editor update to show the additional information added to the sheet.

Select the "Point Status Indicator" entry in the Object Browser and notice the information that
displays in the Property Editor.

Figure 117: Property Editor -- point status indicator

You can modify the point status indicator properties using the Property Editor. To do this, click the
Value field beside the property you wish to change.

212 OW350_80
10.7 What is the Control Builder Point Status Indicator function?

The following table describes the fields that display in the Property Editor when you add a point
status indicator.

Property Editor -- point status indicator fields

FIELD DESCRIPTION

Source Changes the type of parameter that displays on the sheet. This pull-down menu
displays the same items that are found in the Select Parameter dialog box.
Indicator type Provides a list of indicator types. The choices are:
 Highway -- point is used across the Ovation Network.
 Hardware -- point is a hardware point.
 Alarm -- point has alarm configuration.
 Ingraphic -- point is used in a graphic.
 Incontrol -- point is used in another control function.
These indicator types define the check that is made against the point to determine if
the elements in this group should be visible or hidden. For example, if the type is
ingraphic, and the point defined by Source is referenced by a graphic, then the item
contained in the point status indicator folder is visible.

OW350_80 213
S E C T I O N 11

11 Drawing simple graphics

IN THIS SECTION

Creating a simple graphic in the Control Builder ............................................................. 216


Creating a Shape Directory in the Control Builder .......................................................... 222
Using the Import Tool ...................................................................................................... 225
What are the Control Builder drawing canvas editing functions? ................................... 227
What is the Control Builder Zoom function? ................................................................... 231

OW350_80 215
11.1 Creating a simple graphic in the Control Builder

11.1 Creating a simple graphic in the Control Builder

The Ovation Control Builder can be used to build simple shapes and graphics. A simple graphic
contains no frame, no algorithms, and has no control associated with it. You may want to create a
simple graphic to add to a library or to a control sheet.

The procedures for drawing simple graphic shapes contain many similar features. The following
list describes the similar steps for all simple graphic shapes (rectangle, polygon, ellipse, curve,
and line). For specific instructions on individual items, see the applicable procedures for that item.
 Pull down the File menu on the main Control Builder window and select New. Pull right to
display another menu. Select Simple Graphic.
 A blank canvas appears without a frame. The Object Browser only displays the Styles and
Comments containers.

 Select a simple draw item. As you are drawing an item, notice how the mouse icon changes
to reflect the item you are drawing (that is, the cursor displays a rectangle, polygon, and so
forth). Depending on the draw item, the icon may also change to indicate the direction to
move the mouse to complete the draw process.
 To end a drawing session, hit the Esc key on the keyboard or right-click anywhere on the
drawing canvas. When you finish drawing an item, the cursor still shows the icon of the item
drawn. You can continue to draw the same item as many times as you wish. To completely
exit out of that shape's draw mode, press the Esc key again or right-click the drawing canvas.

216 OW350_80
11.1 Creating a simple graphic in the Control Builder

The following table discusses the Property Editor fields when a new simple graphic is started.

Property Editor fields for a new simple draw item

PROPERTY DESCRIPTION

Sheet Title Title given to the drawing as defined by the user.

Sheet Number Number of the drawing.


Component Code Text string assigned to drawing that represent the drawing's location in the
document hierarchy. See What are component codes? (see page 69).
Related Component Codes Text string (component code) that links the currently open drawing to
another document that is not part of its hierarchy. See To define related
component codes (see page 84).
Height Defines the height dimension for the drawing.
Width Defines the width dimension for the drawing.
Snap grid Defines the unit of snap to use if the Enable Snap check box is checked.
This defaults to 10.

11.1.1 To draw a rectangle in the Control Builder


1. Access the Control Builder (see page 27).
2. Pull down the Draw menu on the Control Builder window, and select Rectangle. You may
also use the rectangle icon on the Draw toolbar.
3. The cursor icon changes to a rectangle. Move the pointer onto the drawing canvas, and left-
click to mark the upper left corner of the rectangle.
4. Without pressing any mouse buttons, move the mouse to the desired size of the rectangle.
Notice how the icon changes to arrows showing the direction you must move the mouse.
5. Left-click again to mark the lower right corner of the rectangle.
6. The rectangle icon returns. You can either draw another rectangle or, to exit the draw
rectangle mode, press the Esc key on the keyboard or right-click anywhere on the drawing
canvas. The cursor changes to the cross-hair icon.
7. Use the Property Editor (see page 219) to edit the rectangle properties, as desired.

11.1.2 To draw a polygon in the Control Builder

Note: A polygon must have at least three points.

1. Access the Control Builder (see page 27).


2. Pull down the Draw menu on the Control Builder window, and select Polygon. You may also
use the polygon icon on the Draw toolbar.
3. The cursor icon changes to a polygon. Move the pointer onto the drawing canvas, and left-
click to mark the start point of the polygon.
4. Move the pointer on the drawing canvas and left-click again to mark the next point for the
polygon.
5. Continue to move and left-click to mark all vertex points of the polygon.

OW350_80 217
11.1 Creating a simple graphic in the Control Builder

6. Right-click to finish drawing the polygon.


7. The polygon icon returns. You can either draw another polygon or, to exit the draw polygon
mode, press the Esc key on the keyboard or right-click anywhere on the drawing canvas. The
cursor changes to the cross-hair icon.
8. Use the Property Editor (see page 219) to edit the polygon properties, as desired.

11.1.3 To draw an ellipse in the Control Builder


1. Access the Control Builder (see page 27).
2. Pull down the Draw menu on the Control Builder window, and select Ellipse. You may also
use the ellipse icon on the Draw toolbar.
3. The cursor icon changes to an ellipse. Move the cursor onto the drawing canvas, and left-click
to mark the center point of the ellipse.
4. Without pressing any mouse buttons, move the mouse to the desired size of the ellipse. The
ellipse expands out from the center. Notice how the icon changes to arrows showing the
direction you must move the mouse.
5. Left-click again to mark the final dimensions of the ellipse.
6. The ellipse icon returns. You can either draw another ellipse or, to exit the draw ellipse mode,
press the Esc key on the keyboard or right-click anywhere on the drawing canvas. The cursor
changes to the cross-hair icon.
7. Use the Property Editor (see page 219) to edit the ellipse properties, as desired.

11.1.4 To draw a curve in the Control Builder


1. Access the Control Builder (see page 27).
2. Pull down the Draw menu on the Control Builder window, and select Curve. You may also
use the curve icon on the Draw toolbar.
3. The cursor icon changes to a curve. Move the cursor onto the drawing canvas, and left-click
to mark the starting point of the curve.
4. Move the pointer on the drawing canvas and left-click again to mark another point for the
curve.
5. Continue to move and left-click to mark all vertex points of the curve.
6. Right-click to finish drawing the curve.
7. The curve icon returns. You can either draw another curve or, to exit the draw curve mode,
press the Esc key on the keyboard or right-click anywhere on the drawing canvas. The cursor
changes to the cross-hair icon.
8. Use the Property Editor (see page 219) to edit the curve properties, as desired.

11.1.5 To draw a line in the Control Builder


1. Access the Control Builder (see page 27).
2. Pull down the Draw menu on the Control Builder window, and select Line. You may also use
the line icon on the Draw toolbar.
3. The cursor icon changes to a line. Move the cursor onto the drawing canvas, and left-click to
mark the starting point of the line.
4. Move the pointer on the drawing canvas and left-click again to mark the end point for the line.

218 OW350_80
11.1 Creating a simple graphic in the Control Builder

5. Right-click to finish drawing the line.


6. The line icon returns. You can either draw another line or, to exit the draw line mode, press
the Esc key on the keyboard or right-click anywhere on the drawing canvas. The cursor
changes to the cross-hair icon.
7. Use the Property Editor (see page 219) to edit the line properties, as desired.

11.1.6 Property Editor fields for simple draw items

The following table lists the possible Property Editor fields for the following simple shapes:
rectangle, polygon, ellipse, curve, and line. These fields will either be an entry field or a pull-down
menu.

Property Editor fields for simple draw items (not text)

PROPERTY VALUE APPLIES TO ...

General Properties
Style Class Lists the style template to use for the draw item. All
Fill Lists a color to use as a fill for the item. All
Line Style Lists a type of line to use (solid, dotted, dashed) All
Stroke Lists the color to use to draw the item. All
Stroke width Enters a number that determines the thickness of the All
stroke. Valid range is 1 - 10.
Visibility Makes the draw item visible or invisible. All
Height Enters a height for the item. Rectangle, Ellipse
Width Enters a width for the item. Rectangle, Ellipse
Round Corner Rounds the corners of a rectangle. Rectangle
Vertices Lists the vertex points of the polygon or curve. Polygon, Curve
Special Properties
Anchor Point (x, y) Gives the starting coordinates of the rectangle. Rectangle
Center (x, y) Shows the coordinates of the center of the ellipse. Ellipse
Start Point (x, y) Shows coordinates of the start point of the line. Line
End Point (x, y) Shows the coordinates of the end point of the line. Line

Note: See To Add Text to a Simple Graphic (see page 219) for information on the Property
Editor fields for text.

11.1.7 To add text to a simple graphic in the Control Builder

The Text function adds text to a diagram. Through the Property Editor, you can specify the font
size, color, and style.

1. Access the Control Builder (see page 27).


2. Pull down the Draw menu on the Control Builder window, and select Text. You may also use
the text icon on the Draw toolbar.

OW350_80 219
11.1 Creating a simple graphic in the Control Builder

3. The cursor icon changes to an arrow with a "T." Move the pointer onto the drawing canvas,
and select the desired location for the starting point of the text. A text entry field appears at
the top of the Control Builder window.

4. Enter the desired text in the entry field. When you finish, left-click to set the text in place or
press the Enter key on the keyboard. Hitting the Enter key puts a new line of text under the
previous one.
5. At the location of the left-click or return, you can enter more text; however, you can also move
the cursor to anywhere on the canvas. Left-click again to mark a new location for text. Enter
the text in the entry field and left-click to set the text.
Once the text is set, notice that the text appears in the Object Browser in the container that is
highlighted. Remember that you can delete text through the Object Browser or drawing
canvas.
6. Right-click to end the text entering mode. The text entry field disappears. The cursor still
displays the text icon (arrow with a T). You can move the cursor freely while looking for a new
location to enter text. To completely end the text entering mode, right-click again or press the
Esc key on the keyboard.

220 OW350_80
11.1 Creating a simple graphic in the Control Builder

11.1.8 To find and replace comment text


1. To find and replace comment text, select Find and Replace Comment Text from the Control
Builder Edit menu. The Find and Replace Text window appears.

Figure 118: Find and Replace (Comment) Text window

2. Enter the text you want to locate in the Find entry field.
3. If you want to change the text you are searching for, you can enter new text in the Replace
entry field.
4. Select the Find Next button. The first occurrence of the text will display and be highlighted.
5. Choose one of the following buttons:
 Replace -- replaces the current occurrence of the text (text that is highlighted after the
Find Next button is pressed) with the text in the Replace entry field.
 Replace All -- replaces the current occurrence of the highlighted text and all other
occurrences of the text within the document with the text in the Replace entry field.
 Find Next -- finds the next occurrence of the text without using the Replace feature.
6. If desired, select the Regular Expressions check box to use the advanced search tool.
7. Select the Close button to quit the window. Select Help to display online help.

OW350_80 221
11.2 Creating a Shape Directory in the Control Builder

11.2 Creating a Shape Directory in the Control Builder

A shape is defined as a set of simple graphic items (lines, rectangles, polygons, ellipses, curves
and text) that are treated as a single entity. Shapes cannot contain points or algorithms.
Therefore, the items making up a shape can have no logic associated with them. You can create
shapes in the Control Builder and then save them in a special directory for later use. In this way,
you can create a common shape once, save it in a directory called cbShapes, and then reuse it
multiple times. This saves time and creates a consistent look across your control documents.

The cbShapes directory should be placed under the OvPtSvr directory; for example,
\OvPtSvr\Ovation\Net1\cbShapes. By storing cbShapes under OvPtSvr, the shapes will be
available from any MMI in the system.

Shapes can also be grouped in subdirectories under the cdShapes directory. For example, you
could create a Valves directory under cbShapes where you would locate all of the valve shapes.
An example of this path would be \OvPtSvr\Ovation\Net1\cbShapes\Valves.

Once you create a shape and save it to the cbShapes directory, you can import it into control
sheets or supplemental documents using the Import Tool (see page 225).

11.2.1 Best practices for creating shapes for the shape directory
 Make multiple sizes and rotations of a shape. (For example, valve_small.svg,
valve_medium.svg, etc.) Once imported, the shape cannot be resized or rotated.
 Use the grid lines to help select an appropriate relative size for a shape. The grid lines are the
same scale as in a control function.
 Keep each shape organized in a graphic shape container in the Object Browser. Give the
shape a meaningful description.
 After you create the shape, move it to the top left corner of the drawing canvas and increase
the zoom. That way, the images in the Import Tool will be more detailed.
 Reset the shapes's document snap for more detailed drawing (5 is reasonable). Also, adjust
the height and width to strip away empty canvas space. This gives a more precise thumbnail
image.

11.2.2 To create a shape for the Shape Directory


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the File menu and select New. Pull right to
display another menu, and select Simple Graphic.
An empty drawing canvas appear, with grid lines.
3. Zoom in to the drawing canvas for easier viewing.
4. Draw the shape with the available graphic items (rectangle, polygon, ellipse, curve, line, and
text). Note that you can also create a shape by importing (see page 225) other existing
shapes. Refer to Creating a simple graphic in the Control Builder (see page 216) for more
information.

222 OW350_80
11.2 Creating a Shape Directory in the Control Builder

5. Use the Property Editor to modify the look of shape items. To do this, highlight the item in the
Object Browser and update the appropriate value in the Property Editor (see the following
figure). You can change fill color, line style, stroke width, and so forth.

6. All of the items that comprise a shape should be organized into a Graphic Shape group. To
create a Graphic Shape group, go to the Object Browser and do the following:
a) Highlight the Comments container.
b) Right-click the Comments container and select the Insert Group from the menu that
appears.
c) Slide the cursor to the right and select Graphic Shape. A Graphic Shape folder appears
in the Comments container.
7. Move all of the shape items into the Graphic Shape folder that you created in the Object
Browser.

OW350_80 223
11.2 Creating a Shape Directory in the Control Builder

8. In the Property Editor, give the Graphic Shape folder a meaningful tag name -- for example
Valve-large. See the following figure.

9. On the Control Builder drawing canvas, move the shape to the upper left corner of the
drawing canvas and zoom in. By doing this, you will get a more detailed image when the
shape appears in the Import Tool (see page 225).
10. Return to the Object Browser and highlight the top folder named UnnamedGraphic-1 (see the
figure above). Go to the Property Editor and in the Sheet Title field, enter a name for the
simple graphic you just created.
11. In the Property Editor, adjust the width and height of the simple graphic to remove excess
canvas space. This will give a better thumbnail image.
12. On the main Control Builder window, pull down the File menu and select Save. Save the
shape to the following directory:
\OvPtSvr\Ovation\<network>\cbShapes

Note: The name "cbShapes" is used as an example name here. You may name the Shape
Directory as you choose. However, the shape directory should be created under OvPtSvr so
that it will available from any MMI in the system. Also note, that multiple directories can be
created under the main Shape Directory. This allows you to further organize your shapes (for
example: cbShapes\Valves or cbShapes\Pumps.

13. Refer to To import a shape using the Import Tool (see page 225) for information on using the
shape in a control function.

224 OW350_80
11.3 Using the Import Tool

11.3 Using the Import Tool

The Import Tool allows you to insert graphic shapes into the current document by graphically
browsing the .svg files within the cbShapes directory (see page 222).

Multiple Import Tools may be open at a time, each pointing to different directories. For example,
you may have a cbShapes\Valves directory open in one Import Tool and a cbShapes\Pumps
directory open in another Import Tool.

11.3.1 Best practices for using the Import Tool


 Import and arrange the shapes at full zoom. Currently, the Import Tool always imports into the
top left corner of the document.
 Once a shape is imported, give the shape a meaningful tag in the Property Editor.
 Multiple Import Tools can be open at one time, each pointing to different directories.

11.3.2 To import a shape using the Import Tool


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, open or create a document (control function, control
macro, simple graphic, control library, or algorithm symbol).
3. Pull down the View menu and select Import Browser. The Import Tool Utility window
appears. (Notice that the Import Tool Utility appears blank. It populates when you select a
directory path.)

Figure 119: Import Tool Utility window

OW350_80 225
11.3 Using the Import Tool

4. Select the first icon (arrow) at the top of the Import Tool Utility window to browse for the
cbShapes directory (or any directory that you want). The Browse For Folder window appears.

Figure 120: Browse For Folder window

5. Find the cbShapes directory on the Browse For Folder window and select the OK button.

226 OW350_80
11.4 What are the Control Builder drawing canvas editing functions?

6. The Import Tool Utility window updates with the shapes that are available in the selected
directory.

Figure 121: Import Tool Utility -- updated with shapes

7. From the Import Tool Utility window, double-click the shape you want to add to the drawing
canvas. The shape appears in the upper left-hand corner of the canvas. The mouse pointer
changes to an arrow so that you can drag the new shape to the desired location.
8. To create a new folder, click the plus sign (+) icon.
9. To navigate up a directory from the current directory, click the up arrow icon.

11.4 What are the Control Builder draw ing canvas editing functions?

The editing functions discussed in this section involve manipulating items on the drawing canvas
by using the Control Builder Edit menu or the standard toolbar. In most cases, these functions do
not involve the Object Browser (except for deleting). For information on using the Object Browser
to move and edit items, refer to Editing objects in the Object Browser (see page 54).

When the cursor is in the drawing canvas, you can use the following keys on the keyboard to
perform various functions:

Control Builder Editor Canvas short cut keys

KEY FUNCTION

Left arrow Pans canvas left.


Right arrow Pans canvas right.
Up arrow Pans canvas up.

OW350_80 227
11.4 What are the Control Builder drawing canvas editing functions?

KEY FUNCTION

Down arrow Pans canvas down.


Shift key Shows full cross-hair cursor. Press and hold shift key to move crosshair cursor
with mouse.
Shift-left arrow Move cursor to the left on snap unit with full cross-hair cursor.
Shift-right arrow Move cursor to the right on snap unit with full cross-hair cursor.
Shift-up arrow Move cursor up on snap unit with full cross-hair cursor.
Shift-down arrow Move cursor down on snap unit with full cross-hair cursor.
M key Displays measurement tool.
N key Moves algorithm anchor on last selected algorithm to the next control pin.
P key Moves algorithm anchor on last selected algorithm to the previous control pin.
Space bar Pans canvas based on cursor location. Press and hold the space bar while
moving the cursor toward the edge of the window. The canvas will move in that
direction.
Mouse wheel Zooms in and out on the display canvas.
F1 key Invokes Help for selected items in the canvas.
Escape key Deselects all items in the canvas and quits the current command.

11.4.1 To select and deselect objects in the Control Builder


1. Access the Control Builder (see page 27).
2. Open a simple graphic.
3. Move the pointer to the drawing canvas. The pointer should display as the cross-hair icon.
4. Find the item you wish to select. Left-click anywhere on the item and it now appears in
magenta. The magenta color indicates that the item is selected.
5. To deselect the item, press the Esc key on the keyboard.

Note: If you select an algorithm on the drawing canvas, it is selected in the Object Browser and
its properties display in the Property Editor. However, when selecting simple draw items
(rectangle, polygon, etc.), these items do not appear selected in the Object Browser.

11.4.2 To move objects in the Control Builder


1. Access the Control Builder (see page 27).
2. Open a simple graphic.
3. Select the desired item on the canvas. The item turns magenta.
4. Pull down the Edit menu and select Move. You can also use the Moved Selected Items icon
on the standard toolbar.
5. The icon changes to an arrow with a box. With this icon, left-click the magenta item. The
cursor icon changes again to the move item (four arrows). Notice that a full-screen cross-hair
icon appears that aligns items on the screen.

228 OW350_80
11.4 What are the Control Builder drawing canvas editing functions?

6. Without pressing any mouse buttons, move the cursor to the desired location on the drawing
canvas.
7. Left-click again to end the move session.

Note: When you move an item on the drawing canvas, this does not move the item to a new
location in the Object Browser hierarchy. Note that moving items in the Object Browser does not
involve a change in location, but a change in relationship between items.

For information on moving algorithms using anchors, refer to Moving an algorithm using anchors
(see page 131).

11.4.3 To delete objects in the Control Builder

You can delete objects in two ways:

From the drawing canvas:


1. Access the Control Builder (see page 27).
2. Open a simple graphic.
3. Select the desired item on the canvas. The item turns magenta.
4. To delete the selected, magenta item, do one of the following:
 Pull down the Edit menu and select Delete.
 Select the Delete icon (red X) on the standard toolbar.
 Press the Delete key on the keyboard.
5. The selected item disappears from the drawing canvas and from the Object Browser
hierarchy.

From the Object Browser:


1. Find the desired item to be deleted in the Object Browser hierarchy and select it.
2. To delete the selected item, do one of the following:
 Right-click the selected item and choose Delete Object from the menu.
 Go to the Object Browser toolbar and select the Delete Object icon (red X).
3. The selected item disappears from the drawing canvas and from the Object Browser
hierarchy.

11.4.4 To use the Cut, Copy, and Paste functions in the Control Builder

The Control Builder Cut, Copy, and Paste functions work together to move or duplicate items.

1. Access the Control Builder (see page 27).


2. Open a simple graphic.
3. Select an item on the drawing canvas.
4. Pull down the Edit menu and select one of the following:
 Cut -- removes the item from the canvas and moves it to the system scratchpad for
pasting somewhere else.

OW350_80 229
11.4 What are the Control Builder drawing canvas editing functions?

 Copy -- makes a duplicate version of the selected item and moves the copy to the system
scratchpad for pasting somewhere else.
5. Pull down the Edit menu again and select Paste. The pasted item appears in the same
location from where it was cut or copied; however, it remains selected (magenta color). When
you move the pasted item, notice that a full-screen cross-hair icon appears that aligns items
on the screen.
Note that if there are point names in the selection that may be duplicated, a dialog box
appears. If you select Yes, a Point Edit (see page 196) dialog box appears prompting you to
make the necessary changes to the point(s). Select Ok on this window to commit the
changes.
6. Left-click the magenta item and the cursor changes to the Move icon (four arrows). Now you
can move the pasted item to wherever you choose. (To move algorithms, refer to Moving an
algorithm using anchors (see page 131)).

Note: To cut or paste items in the Object Browser hierarchy, you must use the Object Browser
toolbar or right-click menu. Note that cutting and pasting items in the Object Browser does not
move items on the drawing canvas, but rather, changes the relationship between items in the
hierarchy. See Using the Object Browser. (see page 49)

11.4.5 To use the Undo/Redo function in the Control Builder


1. To undo the last edit, pull down the Edit menu on the main Control Builder window and select
Undo.
2. To undo the Undo function, pull the Edit menu, and select Redo.

Note: The Undo and Redo functions can also be accessed from the toolbar icons.

11.4.6 To use the drawing canvas edit context menu in the Control Builder

The Control Builder provides a quick way to access the more commonly used editing functions.

1. Access the Control Builder (see page 27).


2. Open a simple graphic.
3. Select a graphic item and right-click anywhere on the drawing canvas.

Note: Right-clicking on an algorithm or on a signal displays a special menu -- not the edit menu.

4. A menu appears displaying the following choices:


 Cut
 Copy
 Paste
 Delete
 Move
 Zoom Window
 Full View
 Align Algorithms Horizontally
 Align Algorithms Vertically

230 OW350_80
11.5 What is the Control Builder Zoom function?

 Space Algorithms Horizontally


 Space Algorithms Vertically
5. Make the desired editing selection. See the description given in Edit menu (see page 38) for
more information on these choices.

Note: You can find information on algorithm anchors and using the alignment and spacing
functions in What are algorithm anchors? (see page 130).

11.5 What is the Control Builder Zoom function?

The Zoom function provides different methods that can be used to magnify all or part of the
drawing canvas.

Once you have zoomed in on the document, use the pan function supported by the drawing
canvas to navigate. Refer to What are the Control Builder drawing canvas editing functions? (see
page 227)

Note: The mouse wheel also supports zooming the drawing canvas.

11.5.1 To use the Zoom Window View function in the Control Builder

The Zoom Window View function draws a “view box” which, when placed over sections of the
drawing canvas, expands that particular area.

1. Access the Control Builder (see page 27).


2. Open a Control Builder document (control sheet, simple graphic, and so forth).
3. Pull down the View menu and select Zoom Window. You can also use the Zoom Window
View icon on the Standard toolbar (see page 45). The cursor changes to an arrow and
magnifying glass.
4. Left-click the top left corner of the area you want to enlarge.
5. Without pressing any mouse buttons, move the pointer to the lower right corner of the area
you want to enlarge and left-click. The area that was selected in the box expands to the zoom
dimensions

11.5.2 Using the Full View option in the Control Builder

Full View displays the entire drawing canvas. This is the view that displays when the diagram is
initially loaded. Any time you want to return to this view, simply select Full View from the Zoom
menu or use the Full View icon.

OW350_80 231
11.5 What is the Control Builder Zoom function?

11.5.3 Using the Zoom In and Zoom Out in the Control Builder

The Zoom In function zooms in on the current view by a defined percentage. The center of the
current view remains constant.

Conversely, the Zoom Out function zooms out on the current view by a defined percentage. The
center of the current view remains constant.

To use these options, pull down the View menu and select either Zoom In or Zoom Out. To
display the full drawing canvas again, select the Full View option.

In addition to using the View menu to zoom in and out, you can also use the mouse and
keyboard. To zoom in, scroll the mouse wheel forward (if a wheel is available on your mouse), or
press the <Ctrl + +> keys on the keyboard. To zoom out, scroll the mouse wheel backward, or
press the <Ctrl + -> keys on the keyboard.

232 OW350_80
S E C T I O N 12

12 Creating custom algorithm symbols

IN THIS SECTION

Why create algorithm symbols? ...................................................................................... 233


What are the best practices for creating algorithm symbols? ......................................... 233
To create a custom algorithm symbol ............................................................................. 233

12.1 Why create algorithm s ymbols?


The Control Builder provides a user-friendly interface for creating custom symbols for algorithms.
Custom symbols for standard Ovation algorithms allow you to define symbol blocks consistent
with standard drawings. Because control strategies take many forms, commonly used pin
configurations can be created as a custom symbol and added to the algorithm library.

Symbol drawings are composed of an algorithm body and input and output connectors (or pins).
The flexible design of the Control Builder allows you to create any type of symbol you choose;
however, to maintain uniformity, follow the best practice guidelines for building symbols (see page
233).

12.2 What are the best practices for creating algorithm s ymbols?

Observe the following guidelines when creating algorithm symbols:


 Construct symbols using the simple shapes found on the Control Builder Draw menu.
 Use only the default selected monotext font for text, with the default justification and
horizontal text.
 Use the default algorithm style text to maintain consistency.
 Build any mathematical characters such as delta, sigma, or the integral sign from line
segments.
 Creating custom symbols does not replace any previous existing symbols.

CAUTION! Do NOT add, modify, or delete the Standard symbols supplied with the Control
Builder.

12.3 To create a custom algorithm s ymbol


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the File menu and select New. Pull right on
the New item to display another menu. Select Algorithm Symbol.

OW350_80 233
12.3 To create a custom algorithm symbol

The New Algorithm dialog box appears.

Figure 122: New Algorithm window

3. Choose an algorithm type from the dialog box. Expand the folder and select the algorithm that
will get the new symbol. Select the Ok button.

Note: You can only create a symbol for an existing algorithm.

A blank canvas appears ready for you to create the symbol.


4. Pull down the Draw menu and use the first six items to create the symbol (see page 216).
The first six items are rectangle, polygon, ellipse, curve, line, and text.
5. Add the desired pins to the symbol:
a) Pull down the Draw menu and select Add Control Pin. (You can also use the Add
Control Pin icon.) The Select Parameter dialog box appears.
b) Select the desired pins from the provided list. Note that these pins are specifically
applicable to the algorithm you selected in Step 2.
c) Select the location where you want to attach the pin(s) to the symbol (see page 177).
d) Continue adding items to your symbol (static text, algorithm values, document values,
and so forth)
6. When the symbol is complete, pull down the File menu and select Save. A Browse For Folder
dialog box appears.
7. In the Browse For Folder dialog box, select either the Network or System folder. By default,
control functions are stored in a directory under the Unit directory. However, symbols should
be stored in a folder that is above the control functions directory, at a higher level folder such
as the Network or System level. In this way, these symbols can be shared by many units.
8. After you select a folder, typically in the Network directory, select the Ok button on the
Browse For Folder dialog box. The system creates the necessary Symbols directory in the
Network directory and saves the symbol.

234 OW350_80
12.3 To create a custom algorithm symbol

9. When you access the Add Algorithm dialog box, the new symbol appears as a choice for the
appropriate algorithm and can be placed on a control sheet. If the new symbol does not
appear in the dialog box, hit the Refresh button on the Add Algorithms dialog box. The new
symbol also appears in the Symbol Builder.
10. You can modify the symbol by going to the Symbols directory and finding the .svg file for the
symbol. Open the symbol in the Control Builder and edit as desired.

Note: If you open a symbol in which the contents were deleted, an invalid file format message
appears. You will not be able to add any pins to that symbol. An empty symbol cannot be edited.

OW350_80 235
S E C T I O N 13

13 Using control libraries

IN THIS SECTION

What is a control library? ................................................................................................. 237


To create a new control library ........................................................................................ 237
Importing control logic ..................................................................................................... 237
Exporting control logic to a library ................................................................................... 238

13.1 What is a control library?

The Control Library contains entire control sheets or sections of control sheets that have been
exported (saved) to files and stored in a library. These files can then be imported from the
libraries into other control sheets.

13.2 To create a new control library


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the File menu and select New. Pull right to
display another menu and select Control Library. A blank Control Builder canvas appears.
3. Add to the drawing canvas any items you wish to be part of the library file. You can add
algorithms, pins, signals, text, and so forth. If you desire, you can create an entire sheet of
control and save it to the library file.
4. When you have finished creating the control, pull down the File menu and select Save. The
Save dialog box appears.
5. Define the path where you want to store the library file in the "Save in" entry field. Enter a
name for the file in the "File name" entry field, and define the file as a *.svg file type in the
"Save as type" entry field.

Note: Place all library files in a directory called "Library" in order to keep control items
organized. Do not mix these files into your "Sheets" directory.

13.3 Importing control logic

You can use the Import function to bring existing control logic that is stored in a library file or in
another control sheet, into your current drawing sheet.

13.3.1 To import a document into a control sheet

Importing a document into a control sheet involves importing an item that does not have control
associated with it.

1. Access the Control Builder (see page 27).

OW350_80 237
13.4 Exporting control logic to a library

2. Open a control sheet (see page 99) that already exists or create a new drawing (see page
96).
3. Pull down the File menu and select Import and Export. Pull right to display another menu.
Select Import Document. The Select File to Import dialog box appears.
4. Find the desired file in the window.
5. Once you have found the file, select it, and press the Open button.
6. Use the cursor to position the control elements saved in the file onto the current drawing.
Click to mark the position of the control items on the drawing canvas.
7. Save the control sheet.

13.3.2 To import a library into a control sheet


1. Access the Control Builder (see page 27).
2. Open a control sheet (see page 99) that already exists or create a new drawing (see page
96).
3. Pull down the File menu and select Import and Export. Pull right to display another menu.
Select Import Library. The Choose a file to open dialog box appears.
4. Find the desired library file in the window.
5. Once you have found the file, select it, and press the Open button.
Note that if there are point names in the selection that may be duplicated, a dialog box
appears. If you select Yes, a Point Edit (see page 196) dialog box appears prompting you to
make the necessary changes to the point(s). Select Ok on this window to commit the
changes.
6. Use the cursor to position the control elements saved in the file onto the current drawing.
Click to mark the position of the control items on the drawing canvas.
7. Save the control sheet.

13.4 Exporting control logic to a library

If you want to reuse existing portions of control logic in a control sheet, you can export these
portions to a library file. These files can then be accessed and reused in another drawing.

13.4.1 To export control logic to a library


1. Access the Control Builder (see page 27).
2. Open a control sheet (see page 99) that already exists or create a new drawing (see page
96).
3. Use the cursor to select the portion of the drawing that you want to export to a library.

238 OW350_80
13.4 Exporting control logic to a library

4. Pull down the File menu and select Import and Export. Pull right to display another menu.
Select Export Library. A save dialog box appears.

5. If you want to save the selected portion of control to an existing library, find the name of the
library in the window, and select the Save button.
OR
To save the selected portion of control to a new library, define the path where you want to
store the file in the "Save in" entry field. Enter a name for the file in the "File name" entry field,
and define the file as a *.svg file type in the "Save as type" entry field. Select the Save button.
The portion of control that you selected is now saved to a library file and can be used in
another drawing by using the Import function.

OW350_80 239
S E C T I O N 14

14 Managing your Control Builder operations

IN THIS SECTION

What are the Ovation Control Builder operations? ......................................................... 241


Understanding the Control Builder operations window sequence .................................. 242
What is the Compile operation? ...................................................................................... 250
What is the Copy operation? ........................................................................................... 256
What is the Export operation? ......................................................................................... 260
What is the Import operation? ......................................................................................... 262
What is the Print operation? ............................................................................................ 264
What is the Publish operation? ....................................................................................... 266
What is the Reconcile operation? ................................................................................... 268
To use the Reconcile operation ...................................................................................... 268
What is the Standardize Text operation? ........................................................................ 271
What is the Style operation? ........................................................................................... 274
What is the Synchronize Online function? ...................................................................... 276

14.1 What are the Ovation Control Builder operations?

There are nine operations that perform various Ovation Control Builder functions. Typically, these
functions operate on multiple control sheets.
 Compile Operation (see page 250) -- compiles multiple control sheets.
 Copy Operation (see page 256) -- makes multiple copies of control sheets.
 Export Operation (see page 260) -- extracts sheets, symbols, or libraries out of the
database.
 Import Operation (see page 262) -- inserts sheets, symbols, or libraries into the database.
 Print Operation (see page 264) -- prints multiple sheets at one time.
 Publish Operation (see page 266) -- converts the selected files into PDF documents for
easier verification and archiving of control files
 Reconcile Operation (see page 268) -- compares current point records in the database and
the values in the algorithms for multiple sheets.
 Standardize Text Operation (see page 271) -- provides a user-friendly interface for
standardizing style options on multiple sheets.
 Style Operation (see page 274) -- changes the styles of one or more sheets.

Note: These Control Builder operations are also available from the Ovation Developer Studio
right-click menus for Windows-based Ovation systems only. Also, when ordering sheets from
the Developer Studio, Order Sheets is shown as a Control Builder operation.

Even though it is not part of the Operations menu, the Synchronize Online function is discussed
in this section since it is also considered a Control Builder operation.

OW350_80 241
14.2 Understanding the Control Builder operations window sequence

14.2 Understanding the Control Builder operations w indow sequence

The Control Builder operations provide common, user-friendly interfaces for performing a selected
task. All of the operations behave in a similar way. The information outlined here provides an
overview of the basic windows that apply to all the operations. Each specific operation is
discussed in its own section.

Note: The following numbered list provides an overview of the window sequence for the Control
Builder operations. The list is not designed to be a step-by-step procedure, but rather, just a
general sequence of what window appears and in what order. Step-by-step procedures are
provided in each operation's section.

1. Access the Control Builder (see page 27).


2. Pull down the Tools menu on the main Control Builder window and select Operations. Pull
right and another menu appears showing the list of operations.

Note: For Solaris-based Ovation systems, the Control Builder Tools menu also lists an option
for Delete Sheets. For Windows-based Ovation systems, deleting sheets is handled through the
Developer Studio.

Figure 123: Tools -> Operations menu

3. For all operations, the first window that appears is a Browse for Folder window. This window
allows you to select which folder contains the sheets to use for your operation. By default, the
ControlFunctions directory will be highlighted when the Browse for Folder window displays.
4. After you choose a folder, the Choose files window appears. The Choose files window is the
same for every Control Builder operation. In this window, you select the sheet(s) that will be
used in the operation. You can also filter out sheets that contain a certain macro. For more
information, see To use the Choose files window (see page 245) and To use the Macro Filter
option (see page 247) respectively.

242 OW350_80
14.2 Understanding the Control Builder operations window sequence

5. After you select Next on the Choose files window, the Configure operation window appears.
This window is different for every operation, and it sets the parameters for the operation. For
some operations, there are many other windows that are accessed from the Configure
operation window. The following figure shows an example of the Configure operation window
for the Compile Operation.

Figure 124: Configure operation window

OW350_80 243
14.2 Understanding the Control Builder operations window sequence

6. After you select Next on the Configure operation window, another window appears. Typically,
it is a Confirmation window. The Confirmation window shows the sheets that have been
selected and verifies all the settings that were defined on the Configure operation window.

Figure 125: Confirmation window

7. To execute the operation, press the Run button on the Confirmation window. To make
changes in a previous window, select the Back button. To quit the window without completing
the operation, select Cancel.
8. A window appears showing the process running. When complete, another window displays
showing the status of the operation. On the Completed window, a green check mark indicates
that the operation was successful for that sheet. A red X means that an error exists and the
operation did not execute for that sheet. To remove all successful results from the list, select
the Filter out successful results check box. A check mark appears in the box.

244 OW350_80
14.2 Understanding the Control Builder operations window sequence

9. If errors are found, go to the "X" and expand the tree by clicking on the + symbol. This
displays the errors that were found. Double clicking on a sheet in the list displays the sheet in
the Control Builder.

Figure 126: Completed window

Note: The icons at the bottom of the Completed window allow you to save the compiled file as
an .html file or to send the file to the printer.

14.2.1 To use the Choose files window

The Choose files window is the same for every operation. In this window, you select the sheet(s)
that will be processed in the operation. Use the following procedure to use the Choose files
window:

1. Access the Control Builder (see page 27).


2. Pull down the Tools menu on the main Control Builder window and select Operations. Pull
right and another menu appears showing the list of operations.

OW350_80 245
14.2 Understanding the Control Builder operations window sequence

3. Select the desired operation.


4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted.
5. The Choose files window appears. The full path of the folder you selected in the Browse for
folder window displays in the Data Directory field. To look for sheets in a different directory,
use the Browse icon beside the Layout drop-down menu.
6. The Layout drop-down menu presents two different views of the sheet hierarchy tree. Select
one of the following options:
 Drop Layout - sheets are organized by drop and control task.
 Component Layout - sheets are organized by component code.
7. To select sheets for your operation, go to the directory tree. Click the + or - sign to expand or
collapse the folder. To make a selection, select the check box beside the drop (s) or sheet(s).
Note that when you select a folder in the directory, all of the items beneath it are also
selected.
8. The Macro Filter button allows you to search for sheets that contain a certain macro. If
desired, you can perform the desired operation only on those selected sheets. For more
information on this function, see To use the Macro Filter option (see page 247).
9. Select one of the following buttons:
 Next -- Advances to the next window in the sequence, which is the Configure operation
window. Since the Configure operation window is different for every operation, procedures
for using this window are defined in each operation's specific section.
 Cancel -- Prompts you with a message asking if you want to abort the operation.
 Refresh -- updates the sheets in the directory tree.

246 OW350_80
14.2 Understanding the Control Builder operations window sequence

The following figure shows a "Choose files" window for the Compile Operation.

Figure 127: Choose files window

14.2.2 To use the Macro Filter option

The Macro Filter option shows all of the sheets that contain a certain macro. If desired, you can
perform the desired operation only on those selected sheets.

Use the following procedure to use the Macro Filter option:

1. Access the Control Builder (see page 27).

OW350_80 247
14.2 Understanding the Control Builder operations window sequence

2. Pull down the Tools menu on the main Control Builder window and select Operations. Pull
right and another menu appears showing the list of operations.
3. Select the desired operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears. Select the Macro Filter button at the bottom of the
window. A list of all the macros in the ControlMacros directory appears in the list.

Figure 128: Macro Filter list

248 OW350_80
14.2 Understanding the Control Builder operations window sequence

6. Select a macro from the list. A processing window appears stating that it is searching for
sheets. When processing completes, the Choose files window updates to show check marks
beside the sheets that contain that macro.

Figure 129: Macro Filter option -- showing selected sheets

7. Select one of the following buttons:


 Next -- advance you to the Configure operation window. You will perform the operation
with the selected sheets.
 Back -- quits the macro filter function and returns the directory tree to how it first
appeared in the Choose files window.
 Cancel -- prompts you with a message asking if you would like to abort the operation.
 Refresh -- updates the sheets in the directory tree.

OW350_80 249
14.3 What is the Compile operation?

14.3 What is the Compile operation?

The Compile operation provides a user-friendly interface for compiling multiple sheets at one time
by performing audit functions on objects within the sheet. Once the Compile operation is
complete, a summary of the compilation displays.

Note: Compiling control sheets will overwrite tuning changes. You must reconcile tuning
changes before compiling.

14.3.1 To use the Compile Operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Compile Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to be compiled.

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

a) If you attempt to compile when sheets are open in the Control Builder, a warning
message displays:

Figure 130: Warning message -- sheets are open during a compile/reconcile

250 OW350_80
14.3 What is the Compile operation?

b) You must acknowledge the Warning window before proceeding with the compile.
Compiling while sheets are open in the Control Builder could result in data loss in the
compile after the open sheets are saved. Take one of the following actions:
- Close the sheets before you continue with the compile.
OR
- Select the check box at the bottom of the window which states "I acknowledge that
proceeding may result in loss of data."

Note: The lock files may be outdated (that is, the sheets are no longer being edited). To clear
the lock files, access the Control Builder's Open File dialog box. Navigate to the sheets in the
hierarchy and unlock them.

c) Select the Ok button.


6. Select the Next button on the Choose files window. The Configure operation window appears.

Figure 131: Configure operation window

OW350_80 251
14.3 What is the Compile operation?

In the Configure operation window, the Data Directory section at the top of the window shows
the location of the sheets that are to be compiled. The Selected Files section shows all the
sheets that were selected to be compiled.
7. In the Frame Attributes section, enter the following information:
 Engineer -- name of the engineer who created the drawing.
 Revision Date -- last date of revision of the drawing.
 Revision -- revision number of the drawing.
 Approved -- name of the engineer who approved the drawing.
8. In the Point Options section, if desired, enter the full path name of the point map file to use.
The point map file contains a list of point names, mapping the original point name to a new
point name.
The three icons beside the Point map file entry field are:
 Browse for Point Map File (magnifying glass icon) - displays a Browse window that
searches in other directories for a point map file.
 Edit Point Map File (pencil icon) - edits an existing point map file. When you select this
icon, the Point Translation Editor window (see page 253) appears loaded with the point
map file that was defined in the Point map file entry field. From this window, you can
change any of the existing new point names in the file.
 Create New Point Map File (page icon) - creates a new point map file. When you select
this icon, the Point Translation Editor window (see page 253) appears with only the
original point names. You define the new point names and create a new point map file.
9. If desired, select the Create undefined points check box to create all undefined user points
that are found on the compiled sheet. Note that if this box is checked, it will create all
undefined user points, including algorithm points (see Step 10).
10. If desired, select the Create user defined algorithm points check box to create all of the
user defined algorithm points that are found on the compiled sheet and that are not currently
defined in the database.
11. If desired, select the Force Reload of Selected Sheet(s) on Next Controller Load check
box to force a load of the Controller.
12. If desired, select the Configure point security group check box if you want to assign point
security groups for the points in this compile.
 Select the check box and click the Next button. The Configure Point Security Group
window appears as the next window. (If you do not select this check box and then hit the
Next button, the Confirmation window appears; see Step 13.)
 Select the desired group(s). To select all the groups, press the Select All button. To clear
the window, select the Clear All button.
 Select the Enable button to enable the group(s) or the Disable button to disable the
group(s).
 Select the Next button to save the changes and advance to the Confirmation window.
Press the Back button to return to the previous window.
13. The Confirmation window shows the sheets to be compiled. To compile the sheets, press the
Run button in the Confirmation window. To make changes in a previous window, select the
Back button. To quit the window without compiling, select Cancel.

252 OW350_80
14.3 What is the Compile operation?

14. A window appears showing the compile process running. When complete, another window
displays showing the status of the compile. On the Completed window, a green check mark
indicates that the sheet compiled. A red X means that an error exists and the sheet did not
compile.
15. If errors are found, go to the X and expand the tree by clicking on the + symbol. This displays
the errors that were found. Double-click a sheet in the list to display the sheet in the Control
Builder.

14.3.2 To create a new point map file in the Point Translation Editor window
1. Access the Compile Operation - Configure Operation window (see page 250).
2. At the Configure Operation window, go to the "Point map file" entry field. At the end of the
entry field, select the Create New Point Map File icon (third icon) at the end of the entry field.

Figure 132: Configure operation window

OW350_80 253
14.3 What is the Compile operation?

The Point Translation Editor window appears.

Figure 133: Point Translation Editor window

The Point Translation Editor window is used to map the original point names within a control
sheet to new point names. The three icons at the top of the window are (from left to right):
 Find and Replace (magnifying glass icon) (see page 255).
 New Output Point Name (plus sign (+) icon) (see page 255).
 Delete (letter "X" icon).
3. To enter a new point name, click the entry field beside the original point name and type the
new name.
4. Continue entering new point names as desired.
5. When you finish, select the Ok button.

254 OW350_80
14.3 What is the Compile operation?

14.3.3 To use Find and Replace for a point map file


1. To perform a global find-and-replace action for point names, select the Find and Replace icon
(shown as a magnifying glass) at the top of the Point Translation Editor window. The Find and
Replace window appears.

Figure 134: Find and Replace window -- point map

2. Enter the point name in the "Find" field and the point name that should replace it in the
"Replace" field.
3. If desired, select the Regular Expressions check box to use the advanced search tool.
4. Select the Ok button.

14.3.4 To add and delete output point names to a point map file
1. At the top of the Point Translation Editor window, select the New Point Name icon (shown as
a plus (+) sign). The New Point Name dialog box appears.

Figure 135: New Point Name window

2. Enter a new point name in the "New Output Point" entry field.
3. Select the Ok button. The new point name appears as the last entry in the Point Translation
Editor window.
4. To delete a point name from the Point Translation Editor window, select the point name and
click the delete (X) icon.

OW350_80 255
14.4 What is the Copy operation?

14.4 What is the Copy operation?

The Copy operation makes multiple copies of existing control sheets. A flexible, user-friendly
interface copies control sheets from multiple locations to one specific location per each session.

You can also define a point mapping table to replace original point names with new point names.

14.4.1 To use the Copy operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Copy Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to be copied.

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

6. Select the Next button. The Configure operation window appears.

256 OW350_80
14.4 What is the Copy operation?

7. The appearance of the Configure operation window varies depending on the type of sheets
that were selected in the Choose files window. If your project has a valid SIS license and you
selected SIS sheets to copy, they will appear under the Embedded Sheet(s) section. If you
only selected standard Ovation sheets to copy, they will appear under the Selected Files
heading.

Figure 136: Copy Operation window -- Configure operation

8. Enter the path that is the destination of the copy in the Destination entry field. This is typically
the Control Functions directory under OvPtSvr.
9. Enter a drop number (drop destination of the copy). The sheets are copy to this drop ID. Note
that if you are only copying SIS sheets, this field will be grayed out.
10. Enter a task number (task destination of the copy). The sheets are copied to this task ID. Note
that if you are only copying SIS sheets, this field will be grayed out.

OW350_80 257
14.4 What is the Copy operation?

11. Enter a Base sheet number. This is the number you give the first sheet that is being copied. If
you do not assign a number here, the program uses the actual sheet number.
12. For SIS sheets only -- In the Embedded Device entry field, enter the name of the Logic
Solver that you want to copy the sheets into.
13. For SIS sheets only -- In the Control Module entry field, enter the number of the control
module (1 - 4) that the sheets will be copied to.
14. Select the Next button. The Configure point translation window appears.

Figure 137: Copy Operation window - Configure point translation

15. The Configure Point Translation window maps the original point name to a new point. Click
the entry field beside the original point name that you want to map and enter the new point
name. Do this for as many points as you want to map.
16. The Configure Point Translation window also has a right-click menu. To access this menu,
right-click anywhere on the window. The following choices appear:
 Insert column - inserts a column in the window. Inserting columns provides a quick and
efficient way to copy control strategies. See What are the best practices for copying
control? (see page 260) for more information.
 Delete column - deletes a column from the window.
 Find/Replace - accesses the Find/Replace window (see page 259).

258 OW350_80
14.4 What is the Copy operation?

 Save -- saves the point map file.


 Load -- loads a point map file.
17. If desired, select the Create undefined points check box to create points that are not defined
in the Ovation database.
18. Select the Next button. A confirmation window appears.
19. Verify that the information in the Confirmation window is correct. To change any information,
use the Back button to return to a previous window and make any desired changes. To quit
the window without making copies, click the Cancel button.
20. When you are ready to make copies, select the Run button in the Confirmation window.
21. A window appears showing the Copy process running. When complete, another window
displays showing the status of the copy. On the Completed window, a green check mark
indicates that the sheet copied. A red X means that errors exist and the sheet did not copy.
22. If errors are found, go to the "X" and expand the tree by clicking on the + symbol. This
displays the errors that were found. Double clicking on a sheet in the list displays the sheet in
the Control Builder.

14.4.2 To use the Copy operation Find and Replace function


1. To perform a global find-and-replace action for point names, select Find/Replace from the
right-click menu on Copy operation - Configure Point Translation window. The Find/Replace
window appears.

Figure 138: Find/Replace window for Copy operation

2. Enter a point name in the "Find what" field and the point name that should replace it in the
"Replace with" field.
3. If desired, select the Use regular expressions check box to use the advanced search tool.
4. Select the Replace All button.

OW350_80 259
14.5 What is the Export operation?

14.4.3 Example of copying control

Inserting columns in the Configure point translation window provides a quick and efficient way to
copy control strategies. Inserting columns saves time by allowing you to make multiple copies of
the same control. Each column represents a unique copy.

For example, you want nine copies of two sheets. To do this, initiate the Copy operation and
select the two sheets to copy from the Choose files window. On the Configure point translation
window, add eight columns to the window (one Mapping column is given when the window first
appears). Change the point names in each column accordingly. Each column with a different point
name represents a new copy of the control.

Once you define the point names, select the Next button and then run the copies. The result is
nine copies of the same control strategy with unique point names.

14.5 What is the Export operation?

The Export operation extracts control functions, control symbols, control libraries, and control
macros from an existing Ovation system to a specified directory.

Export stores the files with easily recognizable file names by allowing you to include either the
drop number, task number, or sheet number in the file name for distinction. In addition, you can
also specify the output format and size of the file to be exported.

The Export operation along with the Import operation (see page 262) is the primary means for
moving control files between systems.

14.5.1 To use the Export operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Export Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to be exported.

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

260 OW350_80
14.5 What is the Export operation?

6. Select the Next button. The Configure operation window appears.

Figure 139: Export Operation window -- Configure operation

7. Enter the path that is the destination of the export in the Destination entry field. You can use
the Browse button beside the entry field to search for directories.
8. Select the check box if you wish to overwrite existing files.
9. You can append extra information to the exported file by selecting one of the following export
options:
 Drop Number
 Task Number
 Sheet Number
10. Select the type of file format of the exported file. The choices are: SVG, BMP, JPG, PNG, and
DXF.
11. Enter a width and height for the exported file in the Width and Height entry fields. The values
for width and height are only used for the BMP, JPG, and PNG file formats. The width and
height fields are ignored for SVG and DXF.
12. Select the Next button. A Confirmation window appears.

OW350_80 261
14.6 What is the Import operation?

13. Verify that the information in the Confirmation window is correct. To change any information,
use the Back button to return to a previous window and make any desired changes. To quit
the window without exporting, click the Cancel button.
14. When you are ready to export, select the Run button in the Confirmation window.
15. A window appears showing the Export process running. When complete, another window
displays showing the status of the export. On the Completed window, a green check mark
indicates that the sheet exported. A red X means that errors exist and the sheets did not
export.
16. If errors are found, go to the "X" and expand the tree by clicking on the + symbol. This
displays the errors that were found. Double-clicking on a sheet in the list displays the sheet in
the Control Builder.

14.6 What is the Import operation?

The Import operation copies control functions, control symbols, and control libraries from a
directory to an existing Ovation system.

It stores the files with a hex-formatted filename to distinguish it from other files in the specified
location. In addition, you can also specify a point mapping file to replace original point names with
new point names.

The Import operation along with the Export Operation are the primary means for moving control
files between systems.

Note: Be sure to define your directory structure before performing the import. You must have a
ControlMacros directory and a Custom Symbols directory at the same level as your
ControlFunctions directory in order for the import to be successful. Also, the ControlMacros and
Custom Symbols directories must contain any referenced macros and symbols.

14.6.1 To use the Import operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Import Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to be imported.

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

If your project has a valid SIS license, SIS sheets can be imported by checking the Logic Solver
entry in the tree that the sheets below to.

6. Select the Next button. The Configure operation window appears.

262 OW350_80
14.6 What is the Import operation?

7. The appearance of the Configure operation window varies depending on the type of sheets
that were selected in the Choose files window. If your project has a valid SIS license and you
selected SIS sheets to import, they will appear under the Embedded Sheet(s) section. If you
only selected standard Ovation sheets to import, they will appear under the Selected Files
heading.

Figure 140: Import Operation window -- Configure operation window showing standard and
SIS sheets

8. Enter the path that is the destination of the import in the "Destination" entry field. This is
typically the Control Functions directory under OvPtSvr. If necessary, use the button beside
the entry field to search for directories.
9. Enter a drop number (drop destination of the import). The sheets are imported to this drop ID.
Note that if you are only importing SIS sheets, this field will be grayed out.

OW350_80 263
14.6 What is the Import operation?

10. Enter a task number (task destination of the import). The sheets are imported to this task ID.
Note that if you are only importing SIS sheets, this field will be grayed out.
11. Enter a Base sheet number. This is the number you give the first sheet that is being imported.
If you do not assign a number here, the program uses the actual sheet number.
12. For SIS sheets only -- In the Embedded Device entry field, enter the name of the Logic
Solver that you want to import the sheets into.
13. For SIS sheets only -- In the Control Module entry field, enter the number of the control
module (1 - 4) that the sheets will be imported to.
14. If desired, enter the full path name of the point map file to use. The point map files contains a
list of point names, mapping the original point name to a new point name.
The three icons beside the Point map file entry field are:
 Browse for Point Map File - displays a Browse window used to search in other
directories for a point map file.
 Edit Point Map File - edits an existing point map file. When you select this icon, the Point
Translation Editor window (see page 253) appears loaded with the point map file that was
defined in the Point map file entry field. From this window, you can change any of the
existing new point names in the file.
 Create New Point Map File - creates a new point map file. When you select this icon, the
Point Translation Editor window (see page 253) appears with only the original point
names. You define the new point names and create a new point map file.
15. If desired, select the Create undefined points check box to create all undefined user points
that are found on the compiled sheet. Note that if this box is checked, it will create all
undefined user points, including algorithm points (see Step 16).
16. If desired, select the Create user defined algorithm points check box to create all of the
user defined algorithm points that are found on the compiled sheet and that are not currently
defined in the database.
17. Select the Next button. A Confirmation window appears.
18. Verify that the information in the Confirmation window is correct. To change any information,
use the Back button to return to a previous window and make any desired changes. To quit
the window without importing, click the Cancel button.
19. When you are ready to import, select the Run button in the Confirmation window.
20. A window appears showing the import process running. When complete, another window
displays showing the status of the import. On the Completed window, a green check mark
indicates that the sheet imported. A red X means that errors exist and the sheets did not
import.
21. If errors are found, go to the "X" and expand the tree by clicking on the + symbol. This
displays the errors that were found. Double-click a sheet in the list to display the sheet in the
Control Builder.

264 OW350_80
14.7 What is the Print operation?

14.7 What is the Print operation?

The Print operation provides a user-friendly interface for printing multiple sheets at one time.

It provides you with the option to print the functional drawing, connector information, and detailed
information. You can define a specific printing configuration using the default system print dialog.

14.7.1 To use the Print operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Print Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to be printed.

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

6. Select the Next button. The Configure Operation window appears.

Figure 141: Print Operation window -- Configure operation

OW350_80 265
14.8 What is the Publish operation?

7. Select the type of information to print for the sheets displayed in the scrolling list. The choices
are:
 Functional drawing.
 Algorithm detailed information.
 Connector information.
 Title sheet.
 Algorithm execution order.
 Ladders.
8. Select the Next button. A Confirmation window appears.
9. Verify that the information in the Confirmation window is correct. To change any information,
use the Back button to return to a previous window and make any desired changes. To quit
the window without printing, click the Cancel button.
10. When you are ready to print, select the Run button in the Confirmation window.
11. A standard operating system Print dialog box appears. Make the appropriate selections on
the Print dialog box (printer, page range, and so forth) and select the Print button.
12. A window appears showing the Print process running. When complete, another window
displays showing the status of the print. On the Completed window, a green check mark
indicates that the sheet printed. A red X means that an error exists and the sheets did not
print.
13. If errors are found, go to the "X" and expand the tree by clicking on the + symbol. This
displays the errors that were found. Double-clicking on a sheet in the list displays the sheet in
the Control Builder.

14.8 What is the Publish operation?

The Publish operation converts the selected files into PDF documents for easier verification,
archiving of control files, and ease of correspondence.

You can generate separate copies of the documents or a single merged copy of the PDF.

Note: The pdf documents will contain the contents of macros (if applicable) that are displayed
on a sheet.

14.8.1 To use the Publish operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Publish Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to be
published.

266 OW350_80
14.8 What is the Publish operation?

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

6. Select the Next button. The Configure Operation window appears.

Figure 142: Publish Operation window - Configure operation

7. Select a layout for the PDF file. The choices are Drop Layout (sheet will be organized by drop
and control task) or Component Layout (sheets will be organized by component code
hierarchy (see page 69)).
8. In the Destination section, select how you want to output the sheets:
 Output to file -- merges the files into one PDF document.
 Output to directory -- generates the file into separate PDF documents.
 Use original filenames -- use the original filename for the .pdf documents.
 Auto-generated -- the Control Builder assigns names to the .pdf documents.
9. Select the Next button. A Confirmation window appears.

OW350_80 267
14.9 What is the Reconcile operation?

10. Verify that the information in the Confirmation window is correct. To change any information,
use the Back button to return to a previous window and make any desired changes. To quit
the window without publishing, click the Cancel button.
11. When you are ready to publish, select the Run button in the Confirmation window.
12. A window appears showing the Publish process running. When complete, another window
displays showing the status of the publish. On the Completed window, a green check mark
indicates that the sheet published. A red X means that an error exists and the sheets did not
publish.
13. If errors are found, go to the "X" and expand the tree by clicking on the + symbol. This
displays the errors that were found. Double-clicking on a sheet in the list displays the sheet in
the Control Builder.

Note: When the PDF file is generated, the Points listing for a signal will have sheet entries. The
"*" character indicates the originating sheet. The "T" character indicates that this is the sheet
generating the track signal.

14.9 What is the Reconcile operation?

The Reconcile operation provides a user friendly interface for reconciling multiple sheets. It
compares current point records in the database and the values in the algorithms. The Controller
must be reconciled with the database before attempting this operation (using the Ovation system
reconcile function). All changes will be accepted, but only documents will be updated. The
database will not be changed.

14.10 To use the Reconcile operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Reconcile Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to be
reconciled.

268 OW350_80
14.10 To use the Reconcile operation

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

a) If attempt to reconcile when sheets are open in the Control Builder, a warning message
displays:

Figure 143: Warning message -- sheets are open during a compile/reconcile

b) You must acknowledge the Warning window before proceeding with the reconcile.
Reconciling while sheets are open in the Control Builder will likely result in data
loss in the reconcile after the open sheets are saved. Take one of the following
actions:
- Close the sheets before you continue with the reconcile.
OR
- Select the check box at the bottom of the window which states "I acknowledge that
proceeding may result in loss of data."
c) Select the Ok button.

Note: The lock files may be outdated (that is, the sheets are no longer being edited). To clear
the lock files, access the Control Builder's Open File dialog box. Navigate to the sheets in the
hierarchy and unlock them.

OW350_80 269
14.10 To use the Reconcile operation

6. Select the Next button. The Configure Operation window appears.

Figure 144: Reconcile Operation window -- Configure operation

7. The Configure operation window shows you the selected sheet(s) and any tuning changes
that must be reconciled.
8. To save the tuning changes to a file before they are reconciled, select the Save icon at the
bottom of the Configure operation window.
9. Select the Next button. A Confirmation window appears.
10. Verify that the information in the Confirmation window is correct. To change any information,
use the Back button to return to a previous window and make any desired changes. To quit
the window without printing, click the Cancel button.
11. When you are ready to print, select the Run button in the Confirmation window.
12. A window appears showing the Reconcile process running. When complete, another window
displays showing the status of the reconcile. On the Completed window, a green check mark
indicates that the sheet was reconciled. A red X means that an error exists and the sheets did
not reconcile.
13. If errors are found, go to the "X" and expand the tree by clicking on the + symbol. This
displays the errors that were found. Double-clicking on a sheet in the list displays the sheet in
the Control Builder.

270 OW350_80
14.11 What is the Standardize Text operation?

14.11 What is the Standardize Text operation?

The Standardize Text operation provides a user-friendly interface for standardizing style options
on multiple sheets via one of the following options:
 Enforce Text Attributes for Style Classes - enforces the font family and font size of the
style class for algorithms and signals.
 Reset Object Font Attributes to Style Class - resets the object attributes to the default style
class for point descriptions, algorithm values, point names, and point references. It also
resizes graphic shapes accordingly.
 Enforce Point Status Indicator Text - sets the point status indicator text to the chosen
values.
 Comment Text Sizing - resizes the comment text according to threshold values. If the
current font size of the object is equal to or less than the small threshold, or it is equal to or
greater than the large threshold, the value will be set to the corresponding default value.
Otherwise, the value is set to the middle default value.

14.11.1 To use the Standardize Text operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Standardize Text Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to apply style
options.

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

OW350_80 271
14.11 What is the Standardize Text operation?

6. Select the Next button. The Configure operation window appears.

Figure 145: Standardize Text operation - Configure operation window

The top of the Configure operation window shows the data directory and the selected files.
The bottom of the window, labeled as Font Options, is divided into four sections that each
have a different function.
7. Select the check box next to Enforce Text Attributes for Style Classes to set the font family
and font size that is defined by the style class (see page 57) (style template) for algorithms
and signals. When you select this check box, you are changing the style class in the Style
Editor to the settings you define in the table. Note that it does not clear out the previous styles
used to build algorithms and signals. Rather, it resets the settings so that, moving forward,
all algorithms and signals will use the font family and size you define in the table. To change
the Style Editor settings:
a) Pull down the desired menu (for either algorithms or signals) in the Font column and
select a different font style.
b) Double-click the size entry field to change the font size.

272 OW350_80
14.11 What is the Standardize Text operation?

8. At the Reset Object Font Attributes to Style Class section, select the applicable check box
to remove any miscellaneous styles and reset the style to what is defined in the Style Editor
(see page 57). Different font styles and sizes may have been used when creating Point
Descriptions, Algorithm Values, Point Names, and Point References. By checking the
applicable check box, local or non-standardized styles are removed and every instance of the
item is reset to what is defined in the Style Editor. This allows you to standardize the
appearance of these items on your sheets.
For Algorithm Values and Point Names, you can manually override the defined font size and
define new settings for these items. To do this:
a) Select the desired check box beside either Algorithm Values or Point Names. The box fills
in and the labels change to Reset Algorithm Values or Reset Point Names.
b) Select the desired check box again, and a check mark appears in the box and the labels
change to Force Algorithm Values and Force Point Names. Also, a drop-down menu
appears allowing you to manually change a font size. Select or enter the desired font
size.

OW350_80 273
14.12 What is the Style operation?

9. Select the Enforce Point Status Indicator Text check box to clear out miscellaneous font
styles and sizes and reset all point status indicator text to use the font style and size defined
in the table. (Note that it also resizes graphic shapes accordingly.)
a) Pull down the menu in the Font column and select a new font style.
b) Double-click the font size and enter in the desired size.
10. Select the Comment Text Sizing check box to resize comment text according to threshold
values. You can change the threshold values and the default values by double-clicking in the
entry field and entering the new value.
Consider the following example: you have sheets that have comment text sizes of 14, 16, and
20 in various places. If you define a Small threshold to be 20 and the default to be 18, that
means that for those comment text items (14, 16, and 20 pt size), all the font sizes will be set
to the default of 18 since they were less than or equal to 20. If you define a Large threshold
to be 32 and the default to be 36, that means that all comment text size equal to or greater
than 32, will be standardized to a font size of 36. The Medium default size is used for anything
that falls between the small and large range.
11. Select the Next button. A Confirmation window appears.
12. The Confirmation window shows the sheets that will be standardized. To apply the settings,
press the Run button in the Confirmation window. To make changes in a previous window,
select the Back button. To quit the window without applying any styles, select Cancel.
13. A window appears showing the process running. When complete, another window displays
showing the status of the operation. On the Completed window, a green check mark indicates
that the standardize settings were successfully incorporated or applied to the sheet(s). A red
X means that errors exist and the operation was not successful.
14. If errors are found, go the "X" and expand the folder by clicking on the + symbol. This displays
the errors that were found. Double-clicking on a sheet in the list displays the sheet in the
Control Builder.

14.12 What is the Style operation?

The Style operation provides visual consistency to documents across a system by allowing you to
change the styles of one or more sheets. It provides a way to reference or generate an external
style sheet (.css file) which you can apply or import to multiple documents.

14.12.1 To use the Style operation


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu and select Operations.
Pull right to display another menu listing all the Control Builder operations.
3. Select Style Operation.
4. A Browse for folder window appears. Select the folder that contains the sheets to use for your
operation and then click the Ok button. By default, the ControlFunctions directory will be
highlighted. To look for sheets in a different directory, use the Browse icon beside the Layout
drop-down menu.
5. The Choose files window appears (see page 245). Select the desired sheet(s) to apply style
options.

274 OW350_80
14.12 What is the Style operation?

Note: If desired, you can search for sheets that contain a certain macro. See To use the Macro
Filter option (see page 247).

6. Select the Next button. The Configure operation window appears.

Figure 146: Style Operation window - Configure operation

In the Configure Operation window, the Data Directory section at the top of the window shows
the location of the sheets that are shown in the Selected Files section. The Selected Files
section shows all the sheets that were selected to receive the cascading style sheet (.css file).
Style sheets are used to enforce a standard document appearance across a project. Style
sheets can be incorporated into a document or referenced from another sheet.
7. The External Cascading Style Sheet (CSS) section allows you to select a .css file that will be
used as the template to apply styles on the selected sheets. You can select this style sheet in
one of the following ways:
 Enter the full path name of the .css file you want to use in the entry field.
 Use the Browse for style sheet icon - displays a Browse window that allows you to
select a style sheet from a different directory in the directory tree.

OW350_80 275
14.12 What is the Style operation?

 Select a sheet from the Selected Files list and click the Export cascading style sheet
(CSS) from selected document icon (this icon is next to the Browse for style sheet icon).
This allows you to generate a .css file from one of your existing sheets and use it as the
template style sheet for all of your selected files.
8. Once you select an external cascading style sheet, go to the Reference/Import Cascading
Style Sheet (CSS) section on the window to determine how you want to use the style sheet:
 Reference CSS into document(s) -- the selected files will reference or link to the
external cascading style sheet, but it will not be copied into the files.
 Import CSS into document(s) -- the external cascading style sheet will be imported or
copied into the selected files.
9. Select the Next button. A Confirmation window appears.
10. The Confirmation window shows the sheets that will get the new style sheet. To apply the
style sheet, press the Run button in the Confirmation window. To make changes in a previous
window, select the Back button. To quit the window without applying any styles, select
Cancel.
11. A window appears showing the process running. When complete, another window displays
showing the status of the operation. On the Completed window, a green check mark indicates
that the style was successfully incorporated or applied to the sheet. A red X means that errors
exist and the operation was not successful.
12. If errors are found, go the "X" and expand the folder by clicking on the + symbol. This displays
the errors that were found. Double-clicking on a sheet in the list displays the sheet in the
Control Builder.

276 OW350_80
14.13 What is the Synchronize Online function?

14.13 What is the S ynchronize Online function?

The Synchronize Online function allows you to view control sheets in the Signal Diagram viewer
without loading those sheets in the Controller first. This function saves time, since it can be used
to view sheets in Signal Diagrams for accuracy before they are loaded to the Controller.

14.13.1 Understanding the Synchronize Online Directories window

The Synchronize Online Directories window displays the sheets that you can view in Signal
Diagrams that have not yet been loaded into the Controller. Through various view and filter
options, you can customize the window to show different types of information about the sheets.

See To use the Synchronize Online function (see page 279) for information on using the
Synchronize Online Directories window.

Figure 147: Synchronize Online Directories window

OW350_80 277
14.13 What is the Synchronize Online function?

The following table lists and describes the menus, columns, and buttons of the Synchronize
Online Directories window.

Synchronize Online Directories window -- menus, columns, and buttons

ITEM DESCRIPTION

View menu Displays a menu of additional columns that can be displayed on the window.
(Note that the default columns display when the window is accessed.) The
choices are:
 ID - shows the four-digit hex number that the Control Builder assigns to a
sheet.
 Master - displays the timestamp of the last edit of the sheet in the
ControlFunctions directory.
 MSize - displays the size of the file in the offline directory.
 Active - displays the timestamp of the last edit of the sheet in the online
directory.
 ASize - shows the size of the file in the online directory.
 Control - shows the timestamp of the last control change made to the sheet.
A control change is any change dealing with algorithms, pins, segment lines,
and so forth. Note that a simple change to text (that does not affect control)
would not be listed in this column, but instead, would be timestamped as an
edit under the Master column.
Filter menu Allows you to determine the States that shown on the window.
 Hide Up to Date -- if checked, sheets that are up to date are not shown in
the window. Up to date sheets are those that have the same version in the
offline and online directories.
 Modified -- if checked, sheets that have been modified will appear in the
window. A modified sheet indicates that a change was made to the sheet so
that a newer version of the sheet exists in the offline directory, but not in the
online directory.
 New - if checked, sheets that are new will appear in the window. Since these
sheets are new, they do not exist in Signal Diagrams.
 Deleted -- if checked, sheets that have been deleted will appear in the
window. Sheets that have been deleted no longer exist in the offline
directory; however, they may still exist in the online directory.
 Overwritten - if checked, sheets that have been overwritten will appear in
the window. This indicates a mismatch between the online and offline
directories.
 Drops - displays a list of drop numbers by which to filter on.
Find menu Displays a window that allows you to search for a text string in the Publish
Supplemental Documents window. Enter the text string in the Find field on the
Search window and select the Ok button.
Enable Advanced Mode Toggle option that takes the window from Basic Mode to Advanced Mode. If
the field says "Enable Advanced Mode," it means that you are currently in
Basic Mode.
Basic Mode - sheets are moved from the offline directory to the online
directory.
Advanced Mode - sheets are moved from the online directory to the offline
directory. If you click Enable Advanced Mode, a warning message appears
asking you to confirm the mode change. If you confirm the change to
Advanced Mode, the item on the window then reads, "Disable Advanced
Mode."

278 OW350_80
14.13 What is the Synchronize Online function?

ITEM DESCRIPTION

Check box field Indicates that a file should be synchronized. If no check mark appears beside
the Drop column, it will not be sent to the online directory.

Drop field Number of the drop where the sheet resides.

Task field Control task area assigned to the sheet. See What is a control task area? (see
page 20) for more information.
Number field Number given to the sheet in the Property Editor when it was first created.

Title field Title given to the sheet in the Property Editor when it was first created.

State field Displays the sheet's state. The choices are: Modified, New, Deleted, and
Overwritten. See Filter menu in this table for more information.
Ok button Completes the synchronize action and closes the window.

Cancel button Closes the window without performing the synchronization.

Help button Displays online help about the window.

14.13.2 To use the Synchronize Online function


1. Access the Control Builder (see page 27).
2. From the main Control Builder window, pull down the Tools menu, and select Synchronize
Online. The Synchronize Online Directories window appears.

Figure 148: Synchronize Online Directories window

OW350_80 279
14.13 What is the Synchronize Online function?

3. Click to place a check mark beside the sheet(s) that you want to send to Signal Diagrams for
viewing. Refer to Understanding the Synchronize Online Directories window (see page 277)
for information on determining the State of a sheet and whether the sheet should be sent to
Signal Diagrams.
4. Select the OK button to send the sheets and close the window.

280 OW350_80
S E C T I O N 15

15 Using signal diagrams at the Operator Station

IN THIS SECTION

What are signal diagrams? ............................................................................................. 281


Accessing a Signal Diagram ........................................................................................... 282
Configuring Signal Diagram colors .................................................................................. 285
Opening a sheet in the Signal Diagram window ............................................................. 299
Understanding the Signal Diagram Navigation toolbar and menu .................................. 301
What is the Signal Diagram display canvas? .................................................................. 305
What are the Signal Diagram windows? ......................................................................... 314
Tuning algorithms ............................................................................................................ 323
Viewing SIS Tuning windows for SIS algorithms ............................................................ 324
Forcing an algorithm input value ..................................................................................... 331
Reconciling tuning changes in a Windows-based Ovation system ................................. 341
What is the Ladder Viewer? ............................................................................................ 344

15.1 What are signal diagrams?

A signal diagram is an Ovation Operator Station application that monitors and tunes a control
process. Once you create and save a control function (sheet) in the Control Builder, you can view
it online through a signal diagram.

In order to use a signal diagram to monitor or tune a process, you must first load the control
function (.svg file) into the Controller and then the system downloads it to an Operator Station in
your system. (Refer to the Loading sheets in a Windows-based Ovation system (see page 121)
section of Ovation Control Builder User Guide for more information.)

15.1.1 What functions are provided by signal diagrams?

The following functions are provided by the signal diagrams:


 Monitoring analog and digital values.
 Monitoring algorithm mode, tracking and limit status.
 Tuning algorithms parameters.
 Manipulating Set Point and MA Station algorithms.
 Using points through page connectors.
 Navigation for control subsystems.

OW350_80 281
15.2 Accessing a Signal Diagram

15.1.2 What are the best practices for using signal diagrams?

Implementation of your control will be easier if adequate time is spent planning your control
system before implementing the control. This saves time and frustration for your current project
and enables you to reuse the control in future projects. The following guidelines will help you in
planning your system control graphics:
 Make your drawings neat and efficient. Experience will enable you to create drawings that are
esthetically pleasing as well as functional.
 Name all algorithms that will be used in custom graphics.
 Name all points that will be used on custom graphics, alarm points, or points that leave a
sheet (output page connectors). Default point names cannot be used in output page
connectors.
 When creating internal point names, only create point names for generated (output) points. If
you need a point name for an undefined input point, create and use ADUMMY (for analogs)
and DDUMMY (for digitals). This approach helps to avoid the scenario where two different
points get created for the same signal and then the logic will not work.
 Use dynamic text to specify tuning parameters on sheets.
 Always use the MAMODE algorithm with MASTATIONs. The MAMODE algorithm provides a
“mode word” which provides consistent indication of the status of the associated M/A Station
on all graphics.
 Use comments on the sheets to identify the logic path and the functionality between sheets.
 Try to use a linear approach when designing a sheet. This keeps the logic organized and
makes the graphics easier to follow.
 Use the Synchronize Online function (see page 276) to view control sheets in the Signal
Diagram viewer without loading those sheets in the Controller first. This function saves time,
since it can be used to view sheets in Signal Diagrams for accuracy before they are loaded to
the Controller.

15.2 Accessing a Signal Diagram

You can access a signal diagram in many ways:


 From the Operator Station Ovation Applications icons (Windows-based Ovation systems
only).
 From the Data Analysis and Maintenance menu (Solaris-based Ovation systems only).
 From a Point Menu.
 From the Control Builder.

Note: Signal diagrams are designed to run on both Windows-based and Solaris-based Ovation
systems. In general, functionality remains the same for both platforms; however, where
differences exist between the platforms, information is specifically labeled "for Window-based
systems" or "for Solaris-based systems." Note that where functionality is the same for both
platforms, this document uses Windows-based graphics.

282 OW350_80
15.2 Accessing a Signal Diagram

15.2.1 To access signal diagrams from the Windows-based Ovation Applications


window
1. From the Ovation Operator Station, choose Start -> Ovation -> Ovation Applications. The
Ovation Application icons appear.
2. Double-click the Signal Diagram icon. The Open Document window appears.

Figure 149: Signal Diagrams -- Open Document window

3. From the Open Document window, navigate to the sheet you want to display. To do this,
expand the unit, drop, and control task folders until you find the desired sheet. For more
information on using the Open Document window, see Opening a sheet in the Signal Diagram
window (see page 299).
4. Double-click the sheet and the Signal Diagram window appears with the sheet displayed on
the canvas.

OW350_80 283
15.2 Accessing a Signal Diagram

15.2.2 To access signal diagrams from a Point Menu

You can access a signal diagram from a Point Menu. You can access the Point Menu from any of
the following Operator Station windows that displays a point name or a point value:
 Point Information window.
 Alarm window.
 Trend window.
 Point Review window.
 Graphics Display window.
 Historical Alarm Review window.
 Historical Point Review window.
 Historical Trend window.
 Historical SOE Review window.
Use the following procedure to access a signal diagram from a Point Menu. This procedure uses
the Point Information window as an example.

1. Double-click the Point Information icon from the Ovation Applications menu at the Operator
Station. (Note that you can access any other Operator Station window that displays a point
name or a point value.)
2. The Point Information (PI) window displays. Enter the desired point name in the Point Name
entry field or use the Browse for Points icon (magnifying glass) to find the point name.
3. Select a point name or a point value on the PI window.
4. Right-click the selection to display the Point Menu. Select Signal Diagram.
5. The Signal Diagram displays containing the control sheet that is directly associated with that
point. This is the sheet where the point originates. This is not applicable for points in a remote
network.

15.2.3 To access signal diagrams from the Control Builder


1. From the Control Builder main window, pull down the Tools menu and select Signal
Diagrams. The Open Document window appears (see page 299).
2. Drill down the hierarchy tree to find the sheet you want. Highlight the sheet.

284 OW350_80
15.3 Configuring Signal Diagram colors

3. Press the Ok button. The signal diagram window appears showing the sheet that you
selected.

Figure 150: Signal Diagram window

Note: When the Signal Diagram window is accessed from the Control Builder Tools menu, any
changes loaded to the Controller are available immediately.

15.3 Configuring Signal Diagram colors


You can configure certain point, signal, and text colors on the Signal Diagram Viewer. The Signal
Diagram Viewer Configuration window is accessed from a command line on your PC.

15.3.1 To access the Signal Diagram Viewer Configuration window

Use the following procedure to access the Signal Diagram Viewer Configuration window.

1. Open a command (cmd) window.


2. Type the follow command at the prompt:
Cd %CB_HOME%
3. Once you are in the CB_HOME directory, type the following command at the prompt:
C:\Ovation\CtrlBldr>cbViewer –CONFIGURE

OW350_80 285
15.3 Configuring Signal Diagram colors

4. A Browse for Folder window appears. Pick the on-line directory under OVPTSVR and click
OK.

Figure 151: Browse For Folder -- select "on-line" for Viewer configuration window

286 OW350_80
15.3 Configuring Signal Diagram colors

The Signal Diagram Viewer Configuration window appears.

Figure 152: Signal Diagram Viewer Configuration window

15.3.2 To change the default Signal Diagram colors

The Signal Diagram Viewer comes with factory-set default colors. Use the following procedure to
change the default Signal Diagram colors.

1. Access the Signal Diagram Viewer Configuration window (see page 285).
2. Select the button for the items you want to configure. The choices are:
 General Diagram Colors (see page 288).
 Digital Signal and Algorithm Colors (see page 290).
 Non-Digital Signal Colors (see page 292).
 Non-Digital Algorithm Colors (see page 293).
 Signal Point Value Labels (see page 295).
 Point Quality Tags (see page 297).
 Point Scan Rates (see page 298).

OW350_80 287
15.3 Configuring Signal Diagram colors

3. Depending on your selection, the Signal Diagram Viewer Configuration window changes to
reflect the configurable parameters for the selected item.
4. Make the changes as desired.
5. Select the Ok button to save the changes and quit the window. The On-
line\SignalDiagramViewerConfig.xml file will be modified.
6. Open a command (cmd) window and type the follow command at the prompt to regenerate
the catalog (note that the catalog should be regenerated after every change):
C:\Ovation\CtrlBldr>cbLoader catalog C:\OvPtSvr\SystemName\on-
line
7. Wait 20 seconds for distribution and start a new Signal Diagram Viewer.

15.3.3 Configuring General Diagram colors

The General Diagram Colors bar on the configuration window sets the default colors for the
Signal Diagram window and for algorithms and signals that are operating normally.

Figure 153: Signal Diagram Viewer Configuration window -- General Diagram Colors

288 OW350_80
15.3 Configuring Signal Diagram colors

General Diagram Colors -- Items and Descriptions

ITEM DESCRIPTION

Background Color Background color of the display canvas.


Foreground Color Foreground color of the display canvas.
Highlight Outline Default outline color used for the selected algorithm.
Highlight Fill Default fill color used for the selected algorithm.

OW350_80 289
15.3 Configuring Signal Diagram colors

15.3.4 Configuring digital signal and algorithm colors

The Digital Signal and Algorithm Colors bar on the configuration window allows you to select
the colors for digital signal lines and digital algorithms.

Figure 154: Signal Diagram Viewer Configuration window -- Digital Signal and Algorithm
Colors

290 OW350_80
15.3 Configuring Signal Diagram colors

Digital Signal and Algorithm Colors -- Items and Descriptions

ITEM DESCRIPTION

Default Colors Value True - color that indicates the digital signal/algorithm is true and
running normally.
Value False -- color that indicates the digital signal/algorithm is false
and running normally.
Point in Alarm Value True -- color that indicates the digital signal/algorithm is true and
in alarm.
Value False -- color that indicates the digital signal/algorithm is false
and in alarm.
Point Off Scan Value True -- color that indicates the digital signal/algorithm is true and
off scan.
Value False -- color that indicates the signal/algorithm is false and off
scan.

OW350_80 291
15.3 Configuring Signal Diagram colors

15.3.5 Configuring non-digital signal colors

The Non-Digital Signal Colors bar on the configuration window allows you to select the colors
for signal lines that are not digital.

Figure 155: Signal Diagram Viewer Configuration window -- Non-Digital Signal Colors

Non-Digital Signal Colors -- Items and descriptions

ITEM DESCRIPTION

Default Color Color that indicates the signal is not in any of the following conditions (in
alarm, not good quality, timed out, off scan).
Point in Alarm Color that indicates the point for the signal is in alarm.
Point Not Good Quality Color that indicates the point for the signal does not have good quality.
Point Timed Out Color that indicates the point for the signal is timed out.
Point Off Scan Color that indicates the point for the signal is off scan.

292 OW350_80
15.3 Configuring Signal Diagram colors

15.3.6 Configuring non-digital algorithm colors

The Non-Digital Algorithm Colors bar on the configuration window allows you to select the
colors for algorithms that are not digital.

Figure 156: Signal Diagram Viewer Configuration window -- Non-Digital Algorithm Colors

OW350_80 293
15.3 Configuring Signal Diagram colors

Non-Digital Algorithm Colors -- Items and descriptions

ITEM DESCRIPTION

Default Color (including Automatic) Color that indicates the algorithm is operating in a normal manner.
Output Point in Alarm Color that indicates the output point is in alarm.
Output Point Not Good Quality Color that indicates the output point does not have good quality.
Algorithm Tracking Color that indicates that the algorithm is currently tracking a
downstream algorithm.
Algorithm in Manual Mode Color that indicates the algorithm is in manual mode.
Algorithm in Local Mode Color that indicates the algorithm is in local mode.
Output Reached Top of Scale Color that indicates the algorithm has reached its high limit and is
currently unable to increase.
Output Reached Bottom of Scale Color that indicates the algorithm has reached its low limit and is
currently unable to decrease.

294 OW350_80
15.3 Configuring Signal Diagram colors

15.3.7 Configuring signal point value labels

The Signal Point Value Labels bar on the configuration window allows you to select the font type
and size for algorithm value indicators (see page 148) and point status indicators (see page 210).

Figure 157: Signal Diagram Viewer Configuration window -- Signal Point Value Labels

Signal Point Value Labels -- Items and descriptions

ITEM DESCRIPTION

Font Family Select the font type used for the dynamic values on the signals.
Point Size Select the font size used for the dynamic values on the signals.

OW350_80 295
15.3 Configuring Signal Diagram colors

ITEM DESCRIPTION

List of Set Descriptions Allows you to define the words that will be filtered out on the Signal Diagram
when the value of the digital point is true. This option works with the Show
Default True/False Labels icon on the Navigation toolbar. This option
functions as a toggle option so the text is either seen or hidden.
In this entry field, you enter all of the words, separated by a semicolon,
which you want to filter out when you press the Show Default True/False
Labels icon. For example, if you enter "TRUE;on;set," those words will not
be shown on the signal diagram when the value is true and you press the
Show Default True/False Labels icon to hide the text.
List of Reset Descriptions Allows you to define the words that will be filtered out on the Signal Diagram
when the value of the digital point is false. This option works with the Show
Default True/False Labels icon on the Navigation toolbar. This option
functions as a toggle option so the text is either seen or hidden.
In this entry field, you enter all of the words, separated by a semicolon,
which you want to filter out when you press the Show Default True/False
Labels icon. For example, if you enter "FALSE;off;reset," those words will
not be shown on the signal diagram when the value is false and you press
the Show Default True/False Labels icon to hide the text.

296 OW350_80
15.3 Configuring Signal Diagram colors

15.3.8 Configuring point quality tags

The Point Quality Tags bar on the configuration window allows you to select what item (letter or
number) will be used to indicate the type of quality for a point.

Figure 158: Signal Diagram Viewer Configuration window -- Point Quality Tags

Point Quality Tags -- Items and descriptions

ITEM DESCRIPTION

Default (Quality Good) Designator used for the tag when the point has good quality (operating
normally). One or more characters may be used.
Fair Quality Designator used for the tag when the point has fair quality. One or more
characters may be used.
Poor Quality Designator used for the tag when the point has poor quality. One or
more characters may be used.
Bad Quality Designator used for the tag when the point has bad quality. One or
more characters may be used.

OW350_80 297
15.3 Configuring Signal Diagram colors

ITEM DESCRIPTION

Point Timed Out Designator used for the tag when the point times out. One or more
characters may be used.
Point Off Scan Designator used for the tag when the point is off scan. One or more
characters may be used.
Point in Alarm Designator used for the tag when the point is in alarm. One or more
characters may be used.

15.3.9 Configuring point scan rates

The Point Scan Rates bar on the configuration window allows you to set a fast scan rate and a
slow scan rate (in milliseconds).

Figure 159: Signal Diagram Viewer Configuration window -- Point Scan Rates

298 OW350_80
15.4 Opening a sheet in the Signal Diagram window

Point Scan Rates -- Items and descriptions

ITEM DESCRIPTION

Fast Scan Rate (msec) Defines the fast scan rate which determines the rate at which points are
being updated. This option is used with the Enable Fast Point Update
icon on the Navigation toolbar. Valid range is 50 msec or greater. This
icon operates as a toggle button and goes between the fast and slow
scan rate.
Slow Scan Rate (msec) Defines the slow scan rate which determines the rate at which points
are being updated. This option is used with the Enable Fast Point
Update icon on the Navigation toolbar. Valid range is 500 msec or
greater. This icon operates as a toggle button and goes between the
fast and slow scan rate.

15.4 Opening a sheet in the Signal Diagram w indow

The Open Document window displays sheets in a hierarchical tree that can be sorted by drop and
control task or by component code. Navigate to the desired sheet by expanding the folders in the
tree. Note that only one sheet can be displayed on the Signal Diagram window at one time.

The Open Documents window is the first window that displays when you access a Signal Diagram
(see page 282). It also appears when you press the Open icon on the Signal Diagram window.
The exception is when a signal diagram is accessed from a Point Menu. When you right-click a
point and select Point Menu, a signal diagram appears loaded with the sheet that originates that
point. See To access signal diagrams from a Point Menu (see page 284).

Figure 160: Signal Diagrams -- Open Document window

OW350_80 299
15.4 Opening a sheet in the Signal Diagram window

Open Document window item descriptions

FIELD OR ICON DESCRIPTION

Tree drop-down menu Presents two different options of the sheet hierarchy tree:
 Drop Layout - sheets are organized by drop and control task.
 Component Layout - sheets are organized by component code.
Refresh Document Tree icon Displays the Refresh Document List window that prompts you to
regenerate the cache file if it becomes outdated. Regenerating this file
updates the Open Document window so that any newly added sheets
appear in the window.
Search document tree icon Displays a Find window that allows you to enter text strings in the entry
field that represent all or part of a document title.
Document list window pane Displays the sheets in a hierarchical tree that is sorted either by drop
layout or component layout.
Ok button Opens the sheet in the Signal Diagram window and closes the Open
Document window.
Cancel button Quits the Open Document window without displaying any sheets in the
Signal Diagram window.

Note: For projects that have a valid SIS license, the Open Document window tree displays SIS
sheets under their applicable Control Module and Logic Solver.

15.4.1 To open a sheet in the Signal Diagram window


1. Access a Signal Diagram (see page 282). Typically, the Open Document window appears.
2. If a Signal Diagram window is already open, click the Open icon on the Signal Diagrams
Navigation toolbar (see page 302). The Open icon is the seventh icon from the left. The Open
Document window appears.
3. From the Tree drop-down menu, select a layout for the hierarchy tree.
 Drop Layout - sheets are organized by drop and control task.
 Component Layout - sheets are organized by component code.
4. Navigate through the hierarchy to find the sheet you want.
5. Click the sheet and then press the Ok button. The sheet appears on the Signal Diagram
display canvas.

Note: Only one sheet can be opened at a time in a Signal Diagram window.

15.4.2 To refresh the Open Document hierarchy tree

The Refresh Document List window allows you to update the sheets that appear in the Open
Documents window hierarchy tree.

1. Access a Signal Diagram (see page 282). Typically, the Open Document window appears.
2. From the Open Document window, select the Refresh Document Tree icon (found next to
the Tree drop-down menu).

300 OW350_80
15.4 Opening a sheet in the Signal Diagram window

The Refresh Document List window appears.

Figure 161: Refresh Document List window

3. Select Yes to regenerate the cache file which will update the sheets in the tree. Select No to
quit the window without updating the cache file.

15.4.3 To search for a sheet in the Open Documents window

The Find window allows you to search for sheets in the Open Documents window hierarchy tree.

1. Access a Signal Diagram (see page 282). Typically, the Open Document window appears.
2. From the Open Document window, select the Search Document Tree icon (found next to the
Refresh Document Tree icon).
The Find window appears.

Figure 162: Find window

3. Enter all or part of the sheet name. You can also use the wildcard (*) character to search for
sheets (for example, D* means find all sheet names that begin with D).
4. Select the OK button to start the search process. Select Cancel to quit the Find window
without searching for any sheets.

OW350_80 301
15.5 Understanding the Signal Diagram Navigation toolbar and menu

15.5 Understanding the Signal Diagram Navigation toolbar and menu

The Navigation toolbar provides a quick way to open, access, and print sheets. The Navigation
menu allows you to select what windows appear on the Signal Diagram main window.

15.5.1 Navigation toolbar

The Signal Diagram Navigation toolbar appears at the top of the Signal Diagram window.

Figure 163: Navigation toolbar

Navigation toolbar icons and descriptions

ICON DESCRIPTION

Open Previous Document -- Moves to the previously viewed or loaded sheet (not
defined by page connectors or execution order).

Open Next Document -- Moves to the next currently loaded sheet (not defined by
page connectors or execution order).

Previous Document in Table of Contents -- Moves to the sheet above the current
sheet, based on execution order.

Next Document in Table of Contents -- Moves to the sheet below the current
sheet, based on execution order.

Open Related Component Documents -- Provides a list of documents (control


sheets and supplemental documents) that are part of the component code hierarchy
scheme as the document that you currently have open. (See What are component
codes? (see page 69) section of Ovation Control Builder User Guide.)
Open Primary/Partner Specific Document -- Displays a menu that lists the
Controllers that have a copy of the sheet you have open in the Signal Diagram. It
also shows you which Controller has the most recent copy of that sheet. See To
display the last loaded version of a sheet (see page 312).
Open Document -- Opens a new sheet by activating the Open Document window.

Refresh Current Document -- Refreshes the currently viewed sheet.

Print Document -- Prints the sheet using the standard Windows Print dialog box.

302 OW350_80
15.5 Understanding the Signal Diagram Navigation toolbar and menu

ICON DESCRIPTION

Pointname entry field and Open Reference Document icon -- Enter a point name
in the entry field and select the icon. A list appears showing all the names of sheets
that use that point. The sheet with a yellow * beside the name is the sheet where the
point originates. If the point is on the loaded sheet, it highlights on the display
canvas.
Enable Fast Point Update -- Determines how fast points are being updated. If the
clock on the icon is one quarter full, points are being updated at 50 milliseconds. If
you click it, the clock becomes three quarters full meaning that points are being
updated every 500 milliseconds. This icon operates as a toggle button.
Show Icon Indicators on Algorithms -- Displays algorithm value indicators on
algorithms. This icon functions as a toggle option. Therefore, if values are currently
displayed, pressing the icon will hide the point values.
Show Dynamic Values on Signals -- Displays point values on signal lines. This
icon functions as a toggle option. Therefore, if point values are currently displayed,
pressing the icon will hide the point values.

Show Default True/False Labels -- Removes the Boolean logic where values are
true or false. This icon functions as a toggle option. Therefore, if True/False text is
currently displayed, pressing the icon will hide the True/False text. It is
recommended that you display True/False text before you print.
Change Dynamic Value Font Size -- Allows you to change the font size of dynamic
values displayed on the sheet. Click the icon to cycle through three choices: small,
medium, and large.

Show Algorithm Order -- Provides a visual numbered sequence of how the


algorithms are executed within a control sheet. When you select this icon, the
algorithms on the sheet are replaced by rectangular boxes with numbers inside. This
indicates the sequence of the algorithms.
Open Help Document -- Provides online help on the signal diagram application.

Note: Holding down the <Shift> key while selecting any of these options will start a new
instance of the Signal Diagram Viewer.

OW350_80 303
15.5 Understanding the Signal Diagram Navigation toolbar and menu

15.5.2 Navigation menu

You can toggle the display of the Navigation toolbar and the Signal Diagram windows by right-
clicking on any empty space on the toolbar. (Click anywhere but directly on an icon.) A menu
displays that toggles the display of the toolbar and windows. If there is a check to the left of the
menu item, that toolbar or window is currently displayed. If there is no check beside the menu
item, that toolbar or window is currently not displayed.

Figure 164: Navigation menu

304 OW350_80
15.6 What is the Signal Diagram display canvas?

15.6 What is the Signal Diagram displa y canvas?

The display canvas is where you view your running control after a sheet has been selected from
the Open Document window.

Figure 165: Signal Diagram window

The top of the signal diagram window shows the name of the sheet. From this sheet, you can
monitor your control based on signal and algorithm colors and updating point names and values.
When you select an algorithm, the information that pertains to that algorithm displays in the
Algorithm Summary and the Properties Summary windows. The Properties Summary window
allows you to tune the algorithm.

Note: Press the F2 key on the keyboard to toggle between viewing the display canvas as part of
the signal diagram and viewing it as the entire screen.

OW350_80 305
15.6 What is the Signal Diagram display canvas?

15.6.1 Viewing algorithm information in a Signal Diagram window

Detailed algorithm, point feedback, and mode information appear as flyover data at the bottom
status bar of the Signal Diagram window (lower left corner). For Foundation Fieldbus algorithms,
the values for the STAT and AMODE parameters display. If you hover over a signal line, the
signal line value displays.

If an algorithm supports tracking, the track value and mode bits appear at the bottom of the Signal
Diagram window. If the algorithm you selected does not support tracking, no tracking information
will appear at the bottom of the window. Refer to the Understanding tracking (see page 375)
section of the Control Builder User Guide for more information.

Figure 166: Algorithm information displayed at the bottom of Signal Diagram window

306 OW350_80
15.6 What is the Signal Diagram display canvas?

15.6.2 Understanding when online graphics and control are mismatched

The Ovation system is designed to report discrepancies between the signal diagram loaded in the
Operator Station and the control running in the Controller.

A special icon appears at the lower right-hand corner of the signal diagram window to indicate if
there is a mismatch. Typically, a check mark inside a green circle appears at the lower right-hand
corner of the signal diagram window, indicating that there is no mismatch between the signal
diagram and the control sheet in the Controller. However, if a mismatch does exist, a yellow
triangle icon displays, indicating that the diagram is obsolete.

Signal Diagram mismatch icon indicators

ICON DESCRIPTION

No mismatch between the signal diagram and the control sheet in the Controller.

Mismatch exists between the signal diagram and the control sheet in the Controller.

OW350_80 307
15.6 What is the Signal Diagram display canvas?

15.6.3 Understanding colors on the Signal Diagram display canvas

The online sheet uses various colors to indicate the conditions that are occurring in the control
scheme. From the Display canvas, the operator views these colors and notes any changes so he
can take appropriate actions.

The following colors are the Emerson default colors that are initially configured with the shipment
of your system. These colors are defined by the standard html color codes, which are given in
hexadecimal numbers. These numbers reside in an .xml file on your system. You may modify the
.xml file using the standard html color code to change these colors per project requirements.

Non-Digital Algorithms Colors

The following colors are used for an algorithm body to indicate the condition of a non-digital
algorithm. The hexadecimal color code number is also given:
 Pastel Green (00FF00) - algorithm is tracking.
 Red (FF0000) - algorithm is in manual mode.
 Turquoise (00FFFF) - algorithm is in local mode.
 Dark Gray (606060) - algorithm has reached bottom of scale.
 Dark Gray (606060) - algorithm has reached top of scale.
 White (FFFFFF) - algorithm is in automatic mode.
 White (FFFFFF) - default/normal color for non-digital algorithm.
 Magenta (E000E0) - algorithm is in alarm.
 Light Purple (pink) (FF0080) - output point is Not Good quality.

Non-Digital Signal Colors

Signals are the lines connecting algorithms on a control drawing. The following colors are used for
non-digital signals to indicate the value of the point of the originating algorithm. The hexadecimal
color code number is also given:
 White (FFFFFF) - default color for point. No action needed.
 Magenta (E000E0) - point is in alarm.
 Light Purple (pink) (FF0080) - output point is Not Good quality.
 Dark Gray (606060) - point is timed out.
 Light Gray (707070) - point is off scan.

Digital Signal/Algorithm Colors

The following colors are used for digital signals and digital algorithms. The hexadecimal color
code number is also given:
 Red (FF0000) - Value - True.
 White (FFFFFF) - Value - False.
 Magenta (E000E0) - point is in Alarm - True.
 Yellow (FFFF00) - point is in Alarm - False.
 Light Blue (0000FF) - point is off scan - True.
 Turquoise (00FFFF) - point is off scan - False.

308 OW350_80
15.6 What is the Signal Diagram display canvas?

15.6.4 Understanding icons on the Signal Diagram display canvas

The sheet may display various icons to indicate certain conditions that are occurring in a point or
an algorithm. From the display canvas, the operator views these icons and notes any changes so
he can take appropriate actions.

Signal Diagram display canvas icons

ICON DESCRIPTION

Point is in alarm.

Algorithm has reached its high limit.

Algorithm has reached its low limit.

Algorithm is off scan.

Output point has quality other than Good.

Algorithm is timed out.

OW350_80 309
15.6 What is the Signal Diagram display canvas?

15.6.5 To display algorithm and point information using the right -click menu
1. Access a Signal Diagram (see page 282).
2. From the display canvas, right-click an algorithm or a page connector symbol. A menu
appears. See the following figure.

Figure 167: Right-clicking an algorithm

The menu has the following format:


 Top of the menu shows the algorithm name.
 Middle section of the menu lists the user-defined points.
 Bottom of the menu allows you to access online help for that algorithm.

310 OW350_80
15.6 What is the Signal Diagram display canvas?

3. Pull-right on one of the user-defined point names to display another menu. See the following
figure:

Figure 168: Pull-right menu

4. The pull-right menu has the following format:


 Top of the menu shows the point name.
 Middle section of the menu displays a Point menu. Refer to Ovation Operator Station
User Guide for more information on Point menus.
 Bottom portion of the menu displays the names of sheets where this point is used. A
yellow asterisk (*) beside the name is the sheet where the point originates. If you click a
sheet in the list, it opens in the Signal Diagram window. Note that only one sheet can be
opened at a time in the Signal Diagram window.

15.6.6 To display an additional Signal Diagram window

Only one sheet can be displayed at a time in a single Signal Diagram window. However, if you
need to display two sheets at the same time (possibly for the purpose of comparing sheets), you
can access a second Signal Diagram window.

1. Access a Signal Diagram (see page 282).


2. From the display canvas, right-click an algorithm or a page connector symbol. A menu
appears.

OW350_80 311
15.6 What is the Signal Diagram display canvas?

3. From the menu, pull-right on one of the user-defined point names to display another menu.
See the following figure:

The bottom portion of the menu displays the names of sheets where this point is used. A
yellow asterisk (*) beside the name is the sheet where the point originates.
4. Hold down the <Shift> key and click a sheet name in the list. The sheet opens in a new
Signal Diagram window. The first Signal Diagram window also remains open.

Note: An additional Signal Diagram window can also be opened by pressing the <Shift> key
with the page connector context menus, the first six Navigation toolbar icons (see page 302),
and the OK button on the Open Document window (see page 299).

312 OW350_80
15.6 What is the Signal Diagram display canvas?

15.6.7 To display a specific version of a sheet

You can choose to display a sheet from either the primary or the partner Controller.

1. Access a Signal Diagram (see page 282). Typically, the Open Document window appears.
2. From the Open Document window, select the Open PrimaryPartner Specific Document
icon on the Navigation toolbar. A menu appears.

Figure 169: Display Loaded Versions menu

The menu that appears shows which Controller drops have a copy of the currently open
sheet. A triangle beside the Controller name means that the sheet that is displayed on the
canvas is different than what is in that Controller. If no triangle appears beside the Controller
name, the sheet that is displayed on the canvas is the same version as what is in that
Controller.
3. From the menu, select the Controller that has the version of the sheet you want to view in the
Signal Diagram window.

15.6.8 To explode a macro on a Signal Diagram window

You can show the contents of a macro on a Signal Diagram window. To do this, use the following
procedure:

1. Access a Signal Diagram (see page 282). Typically, the Open Document window appears.
OR
If a Signal Diagram window is already open, click the Open icon on the Signal Diagram
Navigation toolbar (see page 302). The Open icon is the seventh icon from the left. The Open
Document window appears.
2. From the Open Document window, open a sheet that contains a macro.
3. When the sheet with the macro displays on the Signal Diagram display canvas, right-click the
macro.
4. Select the Explode Macro option from the right-click menu. The components of that macro
display.

Note: Signal lines for optional points, which are not defined in this instance, are not shown.

OW350_80 313
15.7 What are the Signal Diagram windows?

15.7 What are the Signal Diagram w indows?


When you are first accessing a Signal Diagram (see page 282) and displaying a diagram, it
appears on the display canvas. By default, the Function Summary window also initially displays.
You can access other windows from the Navigation menu (see page 304) that give you detailed
information about a selected algorithm. Like the Control Builder windows, the signal diagram
windows work together to give you a complete picture of your control process. Also like the
Control Builder, all signal diagram windows are dockable and floatable.

Note: When you select an algorithm on a sheet, only windows that relate to the selected
algorithm will open.

From the Navigation menu, you can access the following windows:
 Event Log (see page 315) -- shows a list of actions taken in the Signal Diagram window.
 Algorithm Summary (see page 316) -- displays information on a selected algorithm.
 Algorithm Control (see page 319) -- used for certain algorithms that support user input in the
form of keyboard buttons or set point values.
 Properties Summary (see page 320) -- performs tuning on a selected algorithm.
 Ladder Viewer (see page 344) -- only used for Ladders. This will only appear when a ladder is
displayed on the canvas. Note that the Navigation menu will display a Ladder Viewer menu
item if a Ladder is displayed on the canvas.
 Function Summary (see page 317) -- similar to the Algorithm Summary window, but only
displays information on page connectors (inputs and outputs).
Notice that for most of these windows, when you access and dock them, they appear as tabs at
the bottom of the Signal Diagram window (except for the Ladder Viewer which does not appear as
a tab at the bottom of the window). See the following figure:

314 OW350_80
15.7 What are the Signal Diagram windows?

Figure 170: Signal Diagram windows minimized as tabs at the bottom of the screen

15.7.1 Using the signal diagram Event Log window

The Event Log window provides a list of activities or events (system-initiated and user-initiated)
that occurred on the Signal Diagram main window and the supporting windows.

Figure 171: Event Log window

The following table briefly explains the Event Log window fields.

Event Log window fields and descriptions

FIELD DESCRIPTION

Message number Shows the number of the message.


Time Provides the time that the event occurred.

OW350_80 315
15.7 What are the Signal Diagram windows?

FIELD DESCRIPTION

Severity Gives a rating of the importance of the message. The choices are:
 Info -- Informational message. Appears when sheet is opened. No action
required. Shown in green.
 Warning -- A problem occurred with the network or database (for example,
point not found). Shown in yellow.
 Error -- Unable to commit tuning changes. File not found. Shown in red.
Source Shows the window where the event occurred.
Message Lists the actual message along with the name and location of the sheet.

The Event Log window contains a right-click menu that allows you to manage the contents of the
window. See To use the Event Log right-click menu (see page 321) for more information.

15.7.2 Using the signal diagram Algorithm Summary window

The Algorithm Summary window displays information for a selected algorithm on the sheet. From
this window, you also have an overview of all the parameters for that algorithm and their
associated points. In addition, if you right-click any of the window fields, a Point menu displays
where you can access the Point Information window or a Trend Display (see To use the Algorithm
Summary window and Function Summary window right-click menus (see page 322)).

The following figure shows the Algorithm Summary window.

Figure 172: Algorithm Summary window

The following table briefly explains the Algorithm Summary window fields.

Algorithm Summary window fields

FIELD DESCRIPTION

Name Shows the abbreviated name of the algorithm parameter. See Ovation
Algorithms Reference Manual.
Parameter Description Provides a description of the parameter. See Ovation Algorithms Reference
Manual.
Point Gives the name of the point associated with the parameter.
Bit For packed points, gives the bit associated with the point. See Ovation Record
Types Reference Manual.
Point Description Gives a description of the point. This is defined in the Control Builder Property
Editor (see page 56).

316 OW350_80
15.7 What are the Signal Diagram windows?

FIELD DESCRIPTION

Type Displays the record type for the point. See Ovation Record Types Reference
Manual.
Bottom Gives the point's defined low value.
Top Gives the point's defined high value.
Value Displays the current value for the point. Note that when the value is a
hexadecimal number, the decimal version of the number displays next to it in
parentheses. If the value is text (True/False), the value displays next to the text
in parentheses (1 for True, 0 for False).

The Algorithm Summary window contains a right-click menu that allows you to determine which
columns display on the window. In this way, you can customize what information appears on the
window. See To use the Algorithm Summary window and Function Summary window right-click
menus (see page 322) for more information.

15.7.3 Using the signal diagram Function Summary window

The Function Summary window is similar to the Algorithm Summary window, but only shows
information for page connectors (input and output points). In addition, if you right-click any of the
window fields, a Point menu displays where you can access the Point Information window or a
Trend Display (see To use the Algorithm Summary window and Function Summary window right-
click menus (see page 322)).

The following figure shows the Function Summary window.

Figure 173: Function Summary window

Note: In order for the Parameter Description column to appear on the Function Summary
window, you must enter a description in the Functional Description field in the Control Builder
Property Editor. Also, if you enter information in the Input Mnemonic field in the Property Editor,
a Name column will appear in the Function Summary window. For more information on Property
Editor parameters for page connectors, see the To use page connectors on control sheets (see
page 186) section of Ovation Control Builder User Guide.

OW350_80 317
15.7 What are the Signal Diagram windows?

The following table briefly explains the Function Summary window fields.

Function Summary window fields

FIELD DESCRIPTION

Parameter Description Provides a description of the parameter. See Ovation Algorithms Reference
Manual.
Point Gives the name of the input or output point.
Bit For packed points, gives the bit associated with the point. See Ovation Record
Types Reference Manual.
Point Description Gives a description of the point. This is defined in the Control Builder Property
Editor (see page 56).
Type Displays the record type for the point. See Ovation Record Types Reference
Manual.
Bottom Gives the point's defined low value.
Top Gives the point's defined high value.
Value Displays the current value for the point. Note that when the value is a
hexadecimal number, the decimal version of the number displays next to it in
parentheses. If the value is text (True/False), the value displays next to the text
in parentheses (1 for True, 0 for False).

The Function Summary window contains a right-click menu that allows you to determine which
columns display on the window. In this way, you can customize what information appears on the
window. See To use the Algorithm Summary window and Function Summary window right-click
menus (see page 322) for more information.

318 OW350_80
15.7 What are the Signal Diagram windows?

15.7.4 Using the signal diagram Algorithm Control window

The Algorithm Control window is used for certain algorithms that support user input in the form of
keyboard buttons or set point values. The buttons and entry fields that display depend on what
parameters are applicable to the algorithm that is selected. Refer to Ovation Algorithms
Reference Manual for more information.

Typically, a check mark inside a green circle appears at the upper left-hand corner of the
Algorithm Control window, indicating that there is no mismatch between the algorithm on the
signal diagram and the algorithm on the control sheet in the Controller. However, if a mismatch
does exist, a yellow triangle icon displays, indicating that the algorithms do not match.

Figure 174: Algorithm Control window for an MASTATION algorithm showing no mismatch

Figure 175: Algorithm Control window for a KEYBOARD algorithm showing a mismatch

Note: When an algorithm is mismatched, it cannot be modified.

OW350_80 319
15.7 What are the Signal Diagram windows?

15.7.5 Using the signal diagram Properties Summary window to tune algorithms

The Properties Summary window performs tuning on one algorithm. See Tuning Algorithms (see
page 323) for information on using this window to tune.

Note: If you do not have security permissions to modify the selected point or to tune, a message
appears stating that you are unable to perform the desired function.

The following figure shows the Properties Summary window. You can only access this window if
the algorithm you selected is tunable.

Figure 176: Properties Summary window

Note: If you right-click anywhere on the Properties Summary window, you get a Point Menu
which can display various Ovation applications.

The following table describes the Properties Summary window fields and buttons.

Properties Summary window fields

FIELD DESCRIPTION

Algorithm Parameter Abbreviated name of the algorithm parameter. See Ovation Algorithms
Reference Manual.
Name Full name of the algorithm parameter.
Current Value Current value of the parameter.
Tuned Value Tuned value of the parameter.
Commit Button Changes the value of the algorithm record.
Reset Button Clears any user-defined tuned values that were entered in the window.

Note: When the Properties Summary window is docked, the Name parameter is hidden to save
space.

320 OW350_80
15.7 What are the Signal Diagram windows?

15.7.6 Accessing the signal diagram window right-click menus

The Event Log, Algorithm Summary, and Function Summary windows have right-click menus that
provide additional window options.

15.7.7 To use the Event Log right-click menu

The Event Log window contains a right-click menu that allows you to manage the contents of the
window.

1. Access a Signal Diagram (see page 282).


2. If the Event Log window is not already displayed, go to the Navigation menu (see page 304)
and select Event Log. The Event Log window appears.
3. Right-click any of the window table cells. A menu appears.

Figure 177: Event Log window -- right-click menu

4. Select one of the following items on the right-click menu:


 Copy to Clipboard -- copies the entire contents of the Event Log and puts it in a file.
 Clear Contents -- clears all of the information out of the Event Log.
 Refresh Contents -- reformats the size of the window cells.

OW350_80 321
15.7 What are the Signal Diagram windows?

15.7.8 To use the Algorithm Summary window and Function Summary window
right-click menus

You can access two different right-click menus from the Algorithm Summary and Function
Summary windows.

1. Right-click any field on the Algorithm Summary window or the Function Summary window and
a menu displays allowing you to access a Point Menu for that point.

Figure 178: Algorithm Summary right-click menu showing Point Info and Trend

2. Right-click anywhere on empty white space on the Algorithm Summary window or the
Function Summary window and a different menu appears. This menu lists the fields that you
can display on the window. In this way, you can customize what information appears on the
window.

Figure 179: Algorithm Summary right-click menu showing available fields to display

3. Select the field you want to display. A check mark appears beside the name. If no check mark
appears beside a name, that field will not display on the window.

322 OW350_80
15.8 Tuning algorithms

15.8 Tuning algorithms

The Tuning function in Ovation refers to the changing of point values in an algorithm while it is
displayed in a signal diagram. This modifying or tuning is performed online at an Operator Station
while the system is running. As the tuning is done, the values are sent to the Controller and the
value of the point changes accordingly.

Note: In order for you to select an algorithm for control, you must set the security item
CONTROL FUNCTIONS. In order for you to tune an algorithm, you must set the security item
TUNING FUNCTIONS. For Windows Ovation systems, these functions are enabled through the
Developer Studio. For Solaris Ovation systems, these functions are enabled through the
Security Builder.

15.8.1 To tune algorithm parameters


1. Access the Signal Diagram window (see page 282).
2. Select a sheet from the Open Document window (see page 299).
3. Left-click the algorithm you want to tune.
4. Go to the Properties Summary window and select the parameter(s) to tune. Enter a new value
for the parameter in the Tuned Value field.

Figure 180: Properties Summary window

5. Select the Commit button to save the setting and change the value in the algorithm record.
6. To perform advanced tuning functions on special algorithms, go to the display canvas, right-
click the algorithm, and select Advanced Tuning. An advanced tuning window appears. For
information on the advanced tuning window for special algorithms, see APC Toolkit User
Guide. For information on the advanced tuning window (SIS Tuning) for SIS algorithms, see
Viewing SIS Tuning windows for SIS algorithms (see page 324).

Note: When an algorithm is mismatched, it cannot be modified.

OW350_80 323
15.9 Viewing SIS Tuning windows for SIS algorithms

15.9 View ing SIS Tuning w indow s for SIS algorithms

SIS algorithms can be viewed and tuned through an SIS Tuning window in the Signal Diagram
application.

All of the SIS algorithms have SIS Tuning windows. If the SIS algorithm has tunable parameters,
they are tuned through the SIS Tuning window -- not through the Property Summary window. If
the SIS algorithm does not have tunable parameters, the tunable column in the SIS Tuning
window appears blank.

For certain SIS algorithms, the SIS Tuning window has an extra tab. The information in this tab is
read-only, and contains the information that was entered in the advanced editing window in the
Control Builder (see page 365). The algorithms that have the extra tab are:
 LSCALC (see page 325).
 LSCEM (see page 326).
 LSSEQ (see page 328).
 LSSTD (see page 330).

Note: For more information on the SIS algorithms, refer to Ovation Algorithms Reference
Manual.

15.9.1 To access the SIS Tuning window for SIS algorithms

To access the SIS Tuning window for SIS algorithms, follow the steps below:

1. Access the Signal Diagram window (see page 282).


2. Select a sheet from the Open Document window (see page 299).
3. The sheet appears on the display canvas. Right-click the desired SIS algorithm on the sheet.
Select Advanced Tuning from the menu that appears.
The SIS Tuning window applicable to that algorithm displays. See Ovation Algorithms
Reference Manual for information on SIS algorithms.

324 OW350_80
15.9 Viewing SIS Tuning windows for SIS algorithms

15.9.2 SIS Tuning window for the LSCALC algorithm

Figure 181: LSCALC SIS Tuning window (Properties Summary tab)

Figure 182: LSCALC SIS Tuning window - (Program tab)

OW350_80 325
15.9 Viewing SIS Tuning windows for SIS algorithms

15.9.3 SIS Tuning window for the LSCEM algorithm

Figure 183: LSCEM SIS Tuning window (Properties Summary tab)

326 OW350_80
15.9 Viewing SIS Tuning windows for SIS algorithms

Figure 184: LSCEM SIS Tuning window (Cause and Effect Table tab)

OW350_80 327
15.9 Viewing SIS Tuning windows for SIS algorithms

15.9.4 SIS Tuning window for the LSSEQ algorithm

Figure 185: LSSEQ SIS Tuning window -- Properties Summary tab

328 OW350_80
15.9 Viewing SIS Tuning windows for SIS algorithms

Figure 186: LSSEQ SIS Tuning window -- Sequence Table tab

OW350_80 329
15.9 Viewing SIS Tuning windows for SIS algorithms

15.9.5 SIS Tuning window for the LSSTD algorithm

Figure 187: LSSTD SIS Tuning window -- Properties Summary tab

330 OW350_80
15.10 Forcing an algorithm input value

Figure 188: LSSTD SIS Tuning window -- State Transition Table tab

15.10 Forcing an algorithm input value

A SIS Force operation occurs when you manually change a value for an algorithm input
parameter. This means the value is "forced."

For example, you might want to see the behavior of an algorithm when it has a certain input
value; however, the algorithm might not currently have the input value you need. You can use a
Signal Diagram (see page 332) to temporarily force the input value of the algorithm in order to
observe the behavior.

You cannot force the output of an algorithm to a particular value; you can only force the input to a
particular value. Before you can force an input value for a SIS algorithm, you must turn on Debug
Mode.

Debug Mode is where you can perform functional testing of safety logic by forcing input values for
algorithms (see page 332).

After you have forced an input value, a blocking icon will appear at the end of the forced input pin
of the algorithm in the Signal Diagram. This icon also appears next to the current value in the
Algorithm Summary window. This icon illustrates that the value for the input signal is currently
forced and cannot be updated by the system.

Note: Remember to remove the forced input value when you want the algorithm to execute
normally.

OW350_80 331
15.10 Forcing an algorithm input value

15.10.1 To force an algorithm input value

Prerequisites
 Make sure the applicable control sheet has been successfully loaded into the Controller and
the Logic Solver.

Procedure
1. Access the Signal Diagram window:
 From the Operator Station Ovation Applications icons or from a Point Menu.
OR
 From the Control Builder (see Ovation Control Builder User Guide for details).
2. Navigate to a sheet in the Open Document window. See Ovation Control Builder User Guide
for more information.
3. Double-click the sheet and the sheet appears on the display canvas of the Signal Diagram
window.
4. Right-click the desired algorithm on the sheet and select Advanced Tuning from the menu.
The SIS Tuning window appears with the selected algorithm name at the top of the window.
The following steps provide an example of how to use the SIS force function.

Figure 189: Example of an SIS Tuning window

332 OW350_80
15.10 Forcing an algorithm input value

5. Select the Force button. The Force Value window for the selected algorithm appears. The
following window displays when the Control Module with selected algorithm is not in Debug
mode

Figure 190: Force Value window in Normal mode

6. If Control Mode is in Normal mode, press the Debug ON button and continue to Step 7. If the
Control Mode is in Debug mode, skip to Step 9.

Note: When you turn on the Debug Mode, you set the Debug Mode for the entire Control
Module and all of the SIS control sheets in that module.

If bit 9 of the RN record is set, it indicates that the Logic Solver is in debug mode.

7. A window appears asking you to confirm that you want to enter Debug Mode. Select Confirm.
(The SIS Write function checks to verify that the process is valid.)

Figure 191: SIS Write window

OW350_80 333
15.10 Forcing an algorithm input value

8. The Force Value window now displays that the Control Module for the selected algorithm is in
Debug Mode.

Figure 192: Force Value window in Debug mode

9. Once in Debug mode, select the input pin you want to force from the list on the left side of
the Force Value window and click the Set button. See the following figure.

Figure 193: Force Value window -- select input pin

334 OW350_80
15.10 Forcing an algorithm input value

Force Value window fields and buttons

FIELD DESCRIPTION

Debug ON Use to enter the Debug Mode.


Debug OFF Use to leave the Debug Mode.
Force Inputs
Algorithm Input Pin Lists all of the algorithm pins whose values can be forced with their actual states.
List Forced pins are marked with a warning icon in the left column of the list.
Forced Value Displays the value to which the pin, if forced, is applicable.
Pin Name of pin whose value is being forced.
Set button Sets a new forced value for the pin (appears only when one of the algorithm input pins
is selected).
Clear button Clears or removes the forced value from the pin (appears only when one of the
algorithm input pins is selected).
Change value to Enter the value to which you want to force the pin (appears only when one of the
entry field algorithm input pins is selected).
Force button Use this button to change the value of an already forced value for a pin.
10. A window appears asking you to confirm that you want to force the selected pin. Select
Confirm. (The SIS Write function checks to verify that the process is valid.)

Figure 194: SIS Write window showing forced pin

OW350_80 335
15.10 Forcing an algorithm input value

11. The Force Value window now shows the forced pin with the warning icon in the Algorithm
Input Pins list.

Figure 195: Force Value window showing forced pin and warning icon

Note: A blocking icon appears at the end of the forced input pin of the algorithm in the Signal
Diagram window. This icon also appears next to the current value in the Algorithm Summary
window. This icon illustrates that the value for the input signal is currently forced and cannot be
updated by the system.

12. After you have forced the pin value, do one of the following:
 Set a new forced value for the pin (see page 336).
 Clear the forced value and leave Debug Mode (see page 338).
See Ovation Safety Instrumented System (SIS) User Guide for information on setting and
clearing forced values.

15.10.2 To set a new forced algorithm input value


1. If you decide to set a new forced value for a pin whose value is already forced, do the
following in the Force Value window:
a) Select one of the forced pins from the Algorithm Input Pins list.

336 OW350_80
15.10 Forcing an algorithm input value

b) Enter a new value in the Change value to field. The "i" icon which appears between the
"Change value to" field and the "Force" button shows the user that the entered value is a
valid floating point number.

Figure 196: Force Value window -- change value

c) Select the Force button.


2. A window appears asking you to confirm that you want to force the value of the selected pin.
Select Confirm. (The SIS Write function checks to verify that the process is valid.)

Figure 197: SIS Write window showing changed forced value

OW350_80 337
15.10 Forcing an algorithm input value

3. The Force Value window now appears showing the new forced value in the Algorithm Input
Pin list.
You can now clear the force (see page 338) or set a new forced value again.

Figure 198: Force Value window updated with new forced value

15.10.3 To clear the force value and leave Debug Mode


1. If you decide to clear the forced value for a pin, do the following in the Force Value window:
a) Select the pin name.
b) Select the Clear button.

338 OW350_80
15.10 Forcing an algorithm input value

2. A window appears asking you to confirm that you want to clear the forced value of the
selected pin. Select Confirm. (SIS Write function checks to verify that the process is valid.)

Figure 199: SIS Write window showing cleared forced value

3. Emerson recommends that you leave Debug Mode when you are finished with your forcing
tasks. To do this:
a) Select the Debug OFF button in the Force Value window.

Figure 200: Force Value window -- select Debug OFF

OW350_80 339
15.10 Forcing an algorithm input value

b) A window appears asking you to confirm that you want to leave Debug Mode. Select
Confirm. (The SIS Write function checks to verify that the process if valid.)

Figure 201: SIS Write window

c) The Force Value window shows that the Control Module is in Normal mode.

WARNING! Be sure to leave Debug mode before closing the signal diagram. Failure to do so
may result in unsafe conditions.

340 OW350_80
15.11 Reconciling tuning changes in a Windows-based Ovation system

15.11 Reconciling tuning changes in a Window s -based Ovation s ystem

After you have created a control sheet and saved it, you must load the control to the Controller
and then the system downloads the file to an MMI in your system. Then you can monitor and tune
the control process using a signal diagram at any MMI.

During the monitoring process, you might want to make online tuning changes to an algorithm
(only algorithm parameter values can be tuned, not point values). These tuning changes are sent
to the Controller as you make them. After you complete the changes, you will need to use the
Reconcile function in the Ovation Developer Studio if you want to put those changes into the
database.

When you begin the Reconciliation process in the Studio, you will be prompted to accept the
changes or reject them. If you accept the changes, they will be sent to the database. If you do not
accept the changes, the algorithm parameter values will not be sent to the database.

Finally, in order for the tuning changes to become permanent, you must use the Reconcile
function in the Control Builder to put the changes into the .svg file.

This process is illustrated in the following figure:

15.11.1 To reconcile tuning changes between the Controller and the


database for Windows-based Ovation systems
1. Access the Signal Diagram window (see page 282).
2. Select a sheet from the Open Document window (see page 299).
3. Make any desired changes and save them. The changes are sent to the Controller. In order
for the changes to be sent to the database, you must reconcile the Controller and the
database.
4. Access the Ovation Developer Studio and select the Controller where the sheet resides.
5. Right-click the Controller and select Reconcile.
6. If the drop is redundant, the “Select a drop to reconcile” dialog box appears. Select the
appropriate target drop and then select Ok. Communications are established at the target
drop and the Reconcile dialog box appears

OW350_80 341
15.11 Reconciling tuning changes in a Windows-based Ovation system

7. Check for files listed in the "Items not compared" field in the top section of the dialog box.
Items that cannot be reconciled and the reasons they cannot be reconciled are listed in this
field.
8. Check for items that have differences and that can be reconciled in the "Difference(s) found"
field in the bottom section of the dialog box.
9. Select the changes that you want to upload to the database. They now appear highlighted. If
you do not select them, the changes will not be uploaded.
10. Select Ok to copy the algorithm changes to the database. Note that if nothing is selected in
the lower window pane, nothing will be copied even if you select the Ok button.
The selected Controller and the database are reconciled. Refer to To reconcile tuning
changes between the database and the Control Builder (see page 342) to reconcile the
database and the control sheet.

15.11.2 To reconcile tuning changes between the database and the Control
Builder
1. Perform the reconciliation process between the Controller and the database (see page 341).
Once that reconcile is complete, the tuning changes must be put into the .svg file (control
sheet) at the Control Builder. This prevents the changes from being overwritten and lost.

Note: Compiling control sheets will overwrite tuning changes. You must reconcile tuning
changes before compiling.

2. Access the Control Builder and open the control sheet that has been modified.
3. If the Update Tuning Parameters window appears, select the changes you want to put into the
control function. Select the Reconcile button. Note that you must have the Reconcile
parameter (see page 29) on the Configure Settings window set to "Enable" for this to occur.
OR

342 OW350_80
15.11 Reconciling tuning changes in a Windows-based Ovation system

If the sheet is already open in the Control Builder window, you can pull down the File menu
and select Reconcile. If there are changes, the Reconcile Tuning Parameters window
appears (see the following figure). Select the changes on the window and press the
Reconcile button.

Figure 202: Reconcile Tuning Parameters window

OR
If tuning changes have been made across multiple sheets, use the Reconcile operation (see
page 268) found on the Control Builder Tools -> Operations menu.

The changes are saved from the database to the .svg file and the tuning changes that were made
are incorporated into the control sheet.

OW350_80 343
15.12 What is the Ladder Viewer?

15.12 What is the Ladder View er?

A ladder is treated like any other sheet in the signal diagrams, and is accessed in the same way
as other sheets. For information on accessing sheets, refer to Accessing a Signal Diagram (see
page 282).

When you select a ladder, the Ladder Viewer appears. Note that this window is read-only and
cannot be edited.

Figure 203: Ladder Viewer

15.12.1 To access the Point Menu from the Ladder Viewer


1. Access a Signal Diagram (see page 282).
2. From the Open Document window, select a ladder. The ladder displays in the Ladder Viewer.
3. Right-click a cell. The Point Menu for that point appears.

344 OW350_80
S E C T I O N 16

16 Viewing sheets on a remote network

IN THIS SECTION

What is Ovation multiple networking? ............................................................................. 345


Using the online sync program to synchronize signal diagrams from remote networks . 346
Viewing sheets from a remote network on a local Signal Diagram window ................... 348
Accessing sheets from a remote network from a Point Menu ........................................ 349
Making configuration changes to view sheets from a remote network ........................... 350

16.1 What is Ovation multiple netw orking?

The Ovation Multiple Network feature enables separate Ovation networks to communicate with
each other, making it possible to gather and retrieve data and implement control from one
network to another. An Ovation system configured for multi-network functionality supports
monitoring, control, and engineering functions across networks.

For more information on remote networks, refer to Ovation Multiple Networks User Guide.

16.1.1 Understanding multiple network terminology

Before making any configuration changes to view sheets from a remote network, it is important to
understand the following multiple network terms:

Local and remote refer to networks in a multiple network configuration. The terms local and
remote are completely relative to your position. If you are a plant technician working on Unit 2,
Unit 2 is your local network. But for the operator who is monitoring control in Unit 1’s control room,
Unit 1 is his local network. If, as the local technician on Unit 2, you initiate a control change on
Unit 1, you are working on a remote network. Conversely, the operator on Unit 1 sees the control
change on his local network.

The network name alias is a basic concept associated with multi-network functionality. An alias
is a second name assigned to a network. Because networks in a plant could have the same
primary name, a local network looks for a remote network’s alias, not its primary name.

An example of network name alias might be something like this: Unit 1 has configured its network
alias to be Durham. The alias Durham makes Unit 1 available to other networks by that name.

To retrieve information from Unit 1, Unit 2 must define a remote network using the Durham alias.
The technician working on Unit 2 now has the ability to view all information about remote network
Durham. All dialog boxes and information refer to the remote network by its alias, not its network
name. In other words, any reference to Durham actually refers to Unit 1.

Before assigning a network alias, you should establish or consult your plant’s naming policy for
multiple networks. The alias is how engineers, technicians, and operators will recognize your
network in a remote connection.

OW350_80 345
16.2 Using the online sync program to synchronize signal diagrams from remote networks

16.2 Using the online sync program to s ynchronize signal diagrams


from remote networks

In order to view signal diagrams from a remote network on an Operator Station on a local
network, folders must be copied from the remote Database Server to the local Database Server
(see To copy files from a remote network to a local network (see page 351) ).

However, instead of manually copying files, the Operator Station online sync program (see page
350) can be used to automatically synchronize signal diagrams from remote networks to local
networks. The online sync program is available with Ovation releases 3.3.1 and later. The
synchronization is performed between the local Database Server and the remote Database
Server. Once configured, the local Database Server will check the remote Database Server
periodically and update the local copy of the files as necessary. Once the remote files are copied
to the local database server, running the cbLoader program (see page 352) will move the files to
the local Operator Stations.

Note: Using the online sync program, as opposed to manually copying files, is the automatic
and preferred method to synchronizing signal diagrams from remote networks to local networks.

Figure 204: Synchronize Database Servers and view remote sheets on Operator Stations

346 OW350_80
16.2 Using the online sync program to synchronize signal diagrams from remote networks

16.2.1 To configure the online sync program to synchronize signal diagrams on


remote networks

From the Database Server on the local network, open a command window and type the following
command at the prompt:

C:\Ovation\CtrlBldr>onlineSync.exe -RemoteNetwork Configure


[NetworkName] [ServerName] [SystemName]

where:
[NetworkName] = remote alias of the network.
[ServerName] = remote network Database Server name or IP address.
[SystemName] = Ovation system name of the remote server. (Note that if the remote server is a Solaris
Ovation system, this parameter must be SOLARIS. Solaris servers must export the
online directory with SAMBA.

CAUTION! The remote network and the local network must be on the same domain.

The command line above uses the -RemoteNetwork option. The following table lists and
describes other options that can be used in this command as well as suboptions used with -
RemoteNetwork:

Online sync program command line options

OPTION DESCRIPTION

-Help Shows the following message: Ovation Control Builder On-Line


Synchronization Service.
-Install Installs the online synchronization service.
-Uninstall Uninstalls the online synchronization service.
-Interval [Seconds]. Sets the Operator Station update interval. The default is 20 seconds. If the
seconds are omitted, the current interval setting displays.
-RemoteNetwork [Suboption] Used to keep the remote network signal diagrams up-to-date on the local
server.
The following suboptions are used with -RemoteNetwork. These
suboptions should only be used on the Database Server.
Configure [NetworkName] [ServerName] [SystemName] -- configures
the synchronization service to pull data from a remote network (as defined
by NetworkName, ServerName, and SystemName).
Show -- shows the currently configured remote networks.
Enable [NetworkName] or [ALL] -- allows the networks to be enabled
without deleting the configuration. This may be useful if the remote server
is not available to do a shut down.
If the network name is provided, only that network is enabled.
If the network name is omitted or ALL is used, all networks will be
enabled.

OW350_80 347
16.3 Viewing sheets from a remote network on a local Signal Diagram window

OPTION DESCRIPTION

Disable [NetworkName] or [ALL] -- allows the networks to be disabled


without deleting the configuration. This may be useful if the remote server
is not available to do a shut down.
If the network name is provided, only that network is disabled.
If the network name is omitted or ALL is used, all networks will be
disabled.
Delete [NetworkName] -- deletes the remote networks configuration.
Interval [Seconds] -- sets the server's update interval in seconds. The
default is 90 seconds.

16.3 View ing sheets from a remote netw ork on a local Signal Diagram
window

Once files have been copied and updated on the local network, you are able to view sheets from
a remote network on your local Signal Diagram viewer.

Refer to the following figure. The Open Document window displays all the sheets on the local and
remote networks in a hierarchical structure. To find the sheet you want, expand the desired
network (local or remote) and navigate through the hierarchy. Once you find the desired sheet,
double-click it. The sheet displays on the signal diagram canvas.

Once a sheet displays, the complete path and name of the sheet appears at the top of the Signal
Diagram window.

Figure 205: Open Document window showing hierarchy for remote and local networks

348 OW350_80
16.4 Accessing sheets from a remote network from a Point Menu

16.4 Accessing sheets from a remote netw ork from a Point Menu

You can access a signal diagram from a Point Menu. You can access the Point Menu from any of
the following Operator Station windows that displays a point name or a point value:
 Point Information window.
 Alarm window.
 Trend window.
 Point Review window.
 Graphics Display window.
 Historical Alarm Review window.
 Historical Point Review window.
 Historical Trend window.
 Historical SOE Review window.
To access a Point Menu for a point on a remote network, you must first change the default
configuration settings for the MMI.

From the Developer Studio, access the MMI Config window and select Enable Point Menu
Option for Remote Points for the Summary and Signal Diagrams attribute. See the following
figure.

Figure 206: MMI Config window

OW350_80 349
16.5 Making configuration changes to view sheets from a remote network

For more information on setting parameters on the MMI Config window, refer to Ovation Operator
Station Configuration Guide.

Once you set the configuration parameter, if you access a Point Menu by clicking on a point that
originates on a sheet from a remote network, the remote network path appears at the top of the
Point Menu.

Figure 207: Point Menu showing a point originated from a sheet on a remote network

16.5 Making configuration changes to view sheets from a remote


netw ork

For Ovation releases prior to 3.3.1, you must manually make some configuration changes in order
to view sheets from a remote network on a local network. (For Ovation 3.3.1 and later, the online
sync program (see page 346) is used.) These procedures would also be used if the online sync
program is affecting performance on your machine.

The configuration change involves the following two-step process:


 You must copy files from the remote network's Database Server to the local network's
Database Server (see page 351). -- you must copy the following folders and all contents from
the \OvPtSvr\<SYSTEM>\on-line directory: ControlMacros, References, and all unit folders
(UNIT1, UNIT2, and so forth).
 You must run the cbLoader program on the local network Database Server (see page
352). -- the cbLoader program on the local Database Server allows the online sync program
on each Operator Station to perform the following tasks:
 Each Operator Station has an online sync program. This program compares the existing
catalog.txt file that is on the Operator Station with the updated catalog.txt file that is on the
local Database Server. The program identifies which files are in the Database Server and
not on its own local Operator Station (these are the remote files that were copied to the
local network Database Server).
 Transfers the new files (sheets) from the local Database Server to the Operator Stations
so that they can be viewed on the Signal Diagram viewer.

350 OW350_80
16.5 Making configuration changes to view sheets from a remote network

CAUTION! In order to view sheets from a remote network on a local network, both
networks must be on the same domain.

Figure 208: Process to view sheets from remote networks

16.5.1 To copy files from a remote network to a local network

In order to provide clear instructions, the following steps use ficticious network alias names as
examples. In the following steps, the system name on the local server is Ovation and the
system name on the remote server FE221. Be sure to use your plant's correct local and remote
system names where specified.

Note: The copying of files must be performed on each network's Database Server.

1. Determine how you will transfer files from the remote network to the local network. You can
copy files to some type of removable storage media (CD, DVD, USB flash drive). You can
also map to the remote network from your local Database Server machine (Windows Explorer
-> Tools -> Map Network Drive).
2. From the Database Server on the remote network, navigate to the following folder:
\OvPtSvr\<SYSTEM>\on-line.
Example: D:\OvPtSvr\FE221\on-line
3. Highlight the following folders from the on-line directory: ControlMacros, Reference, and all
unit folders (UNIT1, UNIT2, and so forth).
4. Right-click and select Copy.

OW350_80 351
16.5 Making configuration changes to view sheets from a remote network

5. From the Database Server on the local network, navigate to the following folder:
\OvPtSvr\<SYSTEM>\on-line.
Example: D:\OvPtSvr\Ovation\on-line
6. Create a remote network folder in the local on-line directory. Use the remote network alias
name and use the "@" symbol in front of it. The remote directory is identified by the
@<alias_name> designation. For example, create a folder called @FE221 in the
\OvPtSvr\Ovation\on-line folder.
7. Paste the files from the remote network folders (ControlMacros, Reference, all unit folders) in
the on-line folder you created. The following figure shows an example of what the directory
structure may look like.

Figure 209: Example directory structure of local network with remote network files

352 OW350_80
16.5 Making configuration changes to view sheets from a remote network

16.5.2 To run the cbLoader program

The cbLoader program, run from the local Database Server, works in conjunction with an online
sync program that is on each Operator Station. When you run cbLoader, it allows online sync to
recognize a change in its catalog.txt file (compared to the catalog.txt file that is on the local
Database Server), and update the file. It then downloads the files (sheets) that are on the local
Database Server to its own Operator Station.

1. From the local Database Server, type the following command in an Explorer window:
\Ovation\CtrlBldr\cbLoader catalog \OvPtSvr\<local remote alias name>\on-line
Example: C:\Ovation\CtrlBldr\cbLoader catalog D:\OvPtSvr\Ovation\on-
line

The sheets will be distributed via the background online sync service to all the Operator Stations.
The inital time may take a few minutes depending on the number of Operator Stations and the
size of the remote system.

If desired, go to a catalog.txt file on a local Operator Station. You should notice that the timestamp
of the file updates to the current time.

OW350_80 353
S E C T I O N 17

17 Understanding Safety Instrumented Systems (SIS)

IN THIS SECTION

What is a Safety Instrumented System? ......................................................................... 355


Functions of Ovation SIS ................................................................................................ 356
What is the role of the Control Builder in a Safety Instrumented System? ..................... 357
Best practices for using SIS algorithms on a sheet ........................................................ 357
Creating a new SIS sheet ............................................................................................... 358
Opening an SIS sheet in the Control Builder .................................................................. 360
Adding SIS algorithms to a sheet .................................................................................... 361
Understanding SIS algorithms with advanced editor windows ....................................... 365
Using Nonsecure parameter algorithms.......................................................................... 372
Using Secure parameter algorithms................................................................................ 372
Connecting SIS sheets .................................................................................................... 373

17.1 What is a Safety Instrumented S ystem?

A Safety Instrumented System (SIS) is a set of components that includes sensors, Logic Solvers,
and final control elements whose purpose is to respond to dangerous plant conditions, which may
be hazardous. The Safety Instrumented System must generate the correct outputs to prevent the
hazard or reduce the consequences of the hazard.

A Safety Instrumented System (SIS) is a form of process control typically used in industrial
processes, such as those of Power Generation and Waste Water. The SIS performs specified
functions in order to maintain a safe state of a control process when any unacceptable process
conditions are detected.

A safe state is a state of the process operation where the hazardous event cannot occur. The
safe state should be achieved within one-half of the process safety time.

International standard IEC 61508 is a standard of rules applied to all types of industry. This
standard covers the complete safety life cycle, and has its origins in the process control industry
sector.

International standard IEC 61511 was published in 2003 to provide guidance to end-users on the
application of Safety Instrumented Systems in the process industries.

Refer to the Ovation Safety Instrumented System (SIS) User Guide for information about using
SIS with Ovation.

OW350_80 355
17.2 Functions of Ovation SIS

17.2 Functions of Ovation SIS

The Safety Instrumented System performs the following functions:


 Implements a risk reduction strategy which is intended to reduce the likelihood of a hazardous
event causing a catastrophe in a plant.
 Validates messages that are sent from Ovation workstations to the safety system. This
reduces the risk of sending invalid and perhaps unsafe messages to the SIS. This function is
known as SIS Write.
 Manages the safety instrumented functions (SIFs) to provide a risk reduction strategy which is
intended to reduce the likelihood of a hazardous event. Each SIF defines:
 Measurement sensors to use.
 Actions to take.
 When to apply the actions.
 How fast to measure and react.

356 OW350_80
17.3 What is the role of the Control Builder in a Safety Instrumented System?

17.3 What is the role of the Control Builder in a Safety Instrumented


System?

The Control Builder creates the control logic that runs in the Ovation Controller. In addition to
editing the control sheets containing the logic, the Control Builder facilitates the integration of the
logic into the Controller (refer to What is the role of the Control Builder in Ovation? (see page 5)).

If your project has a valid SIS license, special SIS algorithms will be available in the Control
Builder. For SIS, the Control Builder provides the same functionality as it does for standard
Ovation systems. However, when building a SIS sheet, only SIS algorithms and SIS page
connectors can be placed on that control sheet.

Note: In this manual, SIS page connectors refer to a set of of four secure and nonsecure
parameter algorithms: NONSECPARAM, SECPARAM, SECPARAMREF, AND
GSECPARAMREF.Refer to Ovation Algorithms Reference Manual for information on the SIS
algorithms and secure and nonsecure parameter algorithms.

When SIS algorithm and SIS page connectors are added to a sheet, the Object Browser is used
to show the relationship between the items placed on the drawing canvas, and the Property Editor
is used for editing the attributes of the items. Four SIS algorithms provide an advanced editor
window for adding/editing information for those algorithms:
 LSCALC (see page 365)
 LSCEM (see page 366)
 LSSEQ (see page 368)
 LSSTD (see page 370)
If your project has a valid SIS license to implement SIS algorithms, the Add Algorithm window
(see page 124) updates to show the SIS algorithms in the window hierarchy. From the Add
Algorithm window, you select the SIS algorithms and SIS page connectors that you want to
appear on the sheet. After the SIS algorithms are placed on the sheet, use all of the Control
Builder functionality as you would in designing any Ovation logic.

After you create the SIS sheets in the Control Builder, they can be viewed in Signal Diagrams
(see page 281).

Note that this manual only deals with SIS algorithms as they pertain to the Control Builder.
Detailed information on the SIS algorithm parameters and their uses can be found in Ovation
Algorithms Reference Manual.

To learn more about SIS installation, configuration, and use, refer to Ovation Safety Instrumented
System (SIS) User Guide.

17.4 Best practices for using SIS algorithms on a sheet

Refer to the following best practices for using SIS algorithms on control sheets:

1. Use the Add Algorithm window or the Symbol Browser to add SIS algorithms to a control
sheet.
2. Note that the symbols for SIS algorithms are graphically different from standard Ovation
algorithms, and they have yellow backgrounds.
3. Only use SIS algorithms on SIS control sheets.

OW350_80 357
17.5 Creating a new SIS sheet

4. Use the Logic Solver to define execution time for SIS sheets.
5. Assign each SIS sheet to a Control Module within a Logic Solver.
6. Do not use SIS algorithms in Control Macros or standard Ovation Control Functions.
7. Refer to the Ovation Algorithms Reference Manual for information on how to use the SIS
algorithms.
8. Use the advanced editors in the Control Builder to edit the following algorithms:
 LSCALC
 LSCEM
 LSSEQ
 LSSTD
9. Logic Solvers use algorithms to support I/O, some SIS algorithms have an I/O channel field in
the Property Editor. Use the following guidelines:
 When you edit an I/O channel, select from a pull-down list of available channels.
 Do not use the same output channel more than once.
 Do not use an Analog channel for a digital algorithm (or vice-versa).
 Do not use an input channel with an output algorithm.
 You can use an output channel with an input algorithm.
10. In addition to the Logic Solver SIS algorithms, there are four algorithms to support secure and
nonnsecure parameters in the SIS control functions. Use the following algorithms to support
passing Secure Parameters between SIS control functions:
 NONSECPARAM -- Nonsecure parameter input.
 SECPARAM -- Secure parameter output
 SECPARAMREF -- Secure parameter reference
 GSECPARAM -- Global secure parameter reference
11. Store SIS control sheets in the ControlFunctions directory.
12. Refer to Ovation Safety Instrumented System (SIS) User Guide for more about SIS
installation, configuration, and use.

17.5 Creating a new SIS sheet


Creating SIS sheets involves configuring additional components such as Data Servers and Logic
Solvers. Therefore, the path used to create SIS sheets in Ovation Developer Studio hierarchy
differs from that used to create standard Ovation sheets.

For information on the configuration required for SIS, refer to Ovation Safety Instrumented
System (SIS) User Guide.

358 OW350_80
17.5 Creating a new SIS sheet

17.5.1 To add an SIS control sheet to the SIS Ovation system

Prerequisites
 Make sure you have added and configured an SIS network.
 Make sure you have added and configured an SIS Data Server.
 Make sure you have added and configured a Network switch.
 Make sure you have added an I/O device number.
 Make sure you have added and configured an SIS I/O device.
 Make sure you have assigned a Data Server to the SIS I/O device.
 Make sure you have added and configured an SIS Logic Solver.

Procedure
1. Access the Ovation Developer Studio.
2. Use the system tree to navigate through the following folders and their subfolders to the
Control Sheets folder:
System
Networks
Drops (appropriate Controller drop)
I/O Devices
SIS I/O Device
Data Servers
Logic Solvers
Control Modules
Control Sheets
3. Right-click Control Sheets and select Insert New. The Insert New Control Sheets window
appears.

Figure 210: Insert New Control Sheets window

4. Enter the following attributes for the new control sheet.

OW350_80 359
17.6 Opening an SIS sheet in the Control Builder

Insert New Control Sheets attributes

ATTRIBUTE DESCRIPTION

Algorithm Count Keeps track of the number of algorithms on a sheet.


Sheet Name Defines how the sheet is described in the system. This name (up to 30 characters)
appears in the Control Sheets section of the Studio hierarchy.
Sheet Number Short reference number (maximum of three characters). This number is used to
identify the sheet to the user, but is not the unique internal .svg file number that is
assigned by the Control Builder.
Sheet Component Defines the sheet component code (see page 69). Component codes are text strings
that are assigned to each sheet or supplemental document that represent the sheet's
or document's location in the hierarchy.
5. Select OK. The Ovation Control Builder opens.
6. Draw the desired control scheme and save the sheet. (Refer to the Ovation Control Builder
User Guide for more information.)

17.6 Opening an SIS sheet in the Control Builder

The Open function (see page 99) in the Control Builder works the same for SIS sheets as it does
for standard Ovation sheets; however, you must navigate the hierarchy tree in a different manner.

17.6.1 To open an SIS sheet in the Control Builder


1. Access the Control Builder (see page 27).
2. Pull down the File menu, and select Open. The Select file to open window appears. Note that
when the window appears, the Drop Layout type is the default.
3. The Address field at the top of the window shows the directory path that contains the sheets
that appear in the hierarchy tree. Note that you cannot edit the path in the Address entry field.
To change the path, see Step 4; otherwise go to Step 5.
4. To change the path in the Address field, select the Browse icon (first icon next to the Address
entry field). A Browse for Folder window appears. Select the directory that contains the sheets
that you want to appear on the window and click OK.

360 OW350_80
17.7 Adding SIS algorithms to a sheet

5. From the Layout drop-down menu, select Drop Layout. The document tree on the left side of
the window displays sheets as they are organized by drop and control task. Click the + and -
signs to expand or collapse the folder contents.

Figure 211: Select file to open window -- Drop Layout showing SIS sheets in the hierarchy

6. Expand a Logic Solver folder and then a Control Module folder to view the SIS sheets that
belong to that particular Logic Solver/Control Module in that drop. If you select a sheet, a
preview of that sheet appears on the right side of the Select file to open window.
7. See To open an existing control sheet using the drop layout (see page 100) for more
information on using the Select file to open window to open a sheet in the Control Builder.

17.7 Adding SIS algorithms to a sheet

If a project has a valid license to implement SIS algorithms, the Add Algorithm window (see page
124) updates to show the SIS algorithms in the window hierarchy.

17.7.1 To add an SIS algorithm to a control sheet


1. Access the Control Builder (see page 27).
2. Create a new SIS sheet from the Ovation Developer Studio. See To add an SIS control sheet
to the SIS Ovation system (see page 359).
3. From the main Control Builder window, pull down the Draw menu, and select Add Algorithm.
You can also select the Add Control Algorithm icon on the toolbar. The Add Algorithm
window appears.
4. Open the SAFETY INSTRUMENTED SYSTEM folder on the left side of the Add Algorithm
window.

OW350_80 361
17.7 Adding SIS algorithms to a sheet

5. Select the desired SIS algorithm from the list. The algorithm symbols that are currently in the
library display on the right side of the window. Note that the SIS symbols appear with a yellow
background.

Figure 212: Add Algorithm window -- showing SIS algorithms

6. Select the desired SIS symbol, and press the OK button.


7. Move the cursor, which has changed to an arrow, to the drawing canvas. Move the algorithm
to the desired location and left-click to position the algorithm on the canvas. Notice that a full-
screen cross-hair icon appears that aligns items on the screen. While moving the algorithm
across the canvas, you can toggle the full-screen cross-hair cursor by pressing the <Shift>
key on the keyboard. This is useful for aligning items on the canvas.
8. After adding the algorithm using the Add Algorithm dialog box, the algorithm appears in the
Algorithms container in the Object Browser window. The algorithm parameters (see page 128)
appear in the Property Editor window where you can edit them.

362 OW350_80
17.7 Adding SIS algorithms to a sheet

17.7.2 To add an extended algorithm tag for the LSCALC algorithm

The Extended Tag Algorithm function, referred to as "CalcBlock Program Tag" when used with
the LSCALC algorithm, displays the CALCBLOCK program on the sheet. it is updated as the
program changes.

Use the following procedure to add an extended algorithm tag:

1. Access the Control Builder (see page 27).


2. Create a new SIS sheet from the Ovation Developer Studio. See To add an SIS control sheet
to the SIS Ovation system (see page 359).
3. From the main Control Builder window, pull down the Draw menu, and select Add Algorithm.
You can also select the Add Control Algorithm icon on the toolbar. The Add Algorithm
window appears.
4. Open the SAFETY INSTRUMENTED SYSTEM folder on the left side of the Add Algorithm
window.
5. Select the LSCALC algorithm from the list. Then select the LSCALC symbol, and press the
OK button.
6. Move the cursor, which has changed to an arrow, to the drawing canvas. Move the algorithm
to the desired location and left-click to position the algorithm on the canvas.
7. Pull down the Draw menu and select Extended Algorithm Tag. (If the LSCALC algorithm is
not still selected (highlighted), select it now.

OW350_80 363
17.7 Adding SIS algorithms to a sheet

8. The Object Browser updates to show CalcBlock Program Tag under the LSCALC algorithm.
The Property Editor updates with the Content field for the CalcBlock Program Tag. See the
following figure.

Figure 213: Extended Algorithm Tag entries for LSCALC algorithm

9. Select the CalcBlock Program Tag entry in the Object Browser. Go to the Property Editor
and select one of the following choices for the Content parameter:
 Program -- the entire LSCALC program displays on the sheet.
 Header -- only the remark lines that start with "REM" display on the sheet.
Note that, like all tags, this tag may be incorporated into the symbol.

364 OW350_80
17.8 Understanding SIS algorithms with advanced editor windows

17.8 Understanding SIS algorithms w ith advan ced editor window s

There are four SIS algorithms that have an advanced editor window that must be configured:
 LSCALC (see page 365)
 LSCEM (see page 366)
 LSSEQ (see page 368)
 LSSTD (see page 370)
For all algorithms (standard Ovation and SIS), algorithm parameters are still defined in the Control
Builder Property Editor. For these four SIS algorithms, an advanced edit window displays custom
information that is specific to the algorithm. These dialogs make the programming and
configuration easier by providing a user-friendly graphical interface.

When you add one of these algorithms to the Control Builder drawing canvas, access the
advanced editor window by right-clicking on the algorithm. Select Advanced Edit from the menu
that displays.

17.8.1 To access the LSCALC advanced editor window


1. Access the Control Builder (see page 27).
2. Create a new SIS sheet or open an existing one.
3. Access the Add Algorithm window (see page 361). On the left side of the window, find the
LSCALC algorithm in the Safety Instrumented System list.
4. Select LSCALC on the Add Algorithm window and add it to the Control Builder drawing
canvas.
5. Go to the Property Editor and enter the values as they pertain to the LSCALC algorithm. (See
Ovation Algorithms Reference Manual for more information.)
6. Return to the Control Builder drawing canvas, right-click the LSCALC algorithm, and select
Advanced Edit from the menu that displays.

OW350_80 365
17.8 Understanding SIS algorithms with advanced editor windows

The LSCALC editor window appears.

Figure 214: LSCALC advanced editor window -- accessed from the Control Builder

7. Enter the desired calculation. Refer to Ovation Algorithm Reference Manual for information on
using the LSCALC algorithm.
8. When you have completed the calculation, press the Compile button. Any errors will appear
at the bottom of the window.
9. If there are no errors, Press the OK button to save the calculation and close the window.

17.8.2 To access the LSCEM advanced editor window


1. Access the Control Builder (see page 27).
2. Create a new SIS sheet or open an existing one.
3. Access the Add Algorithm window (see page 361). On the left side of the window, find the
LSCEM algorithm in the Safety Instrumented System list.
4. Select LSCEM on the Add Algorithm window and add it to the Control Builder drawing
canvas.
5. Go to the Property Editor and enter the values as they pertain to the LSCEM algorithm. (See
Ovation Algorithms Reference Manual for more information.)

366 OW350_80
17.8 Understanding SIS algorithms with advanced editor windows

Notice the Number of Causes and the Number of Effects fields in the Property Editor. The
number that you enter here determines the number of causes and effects that will appear in
the advanced editor window.

Figure 215: LSCEM parameters shown in the Property Editor

6. Return to the Control Builder drawing canvas, right-click the LSCEM algorithm, and select
Advanced Edit from the menu that displays.

OW350_80 367
17.8 Understanding SIS algorithms with advanced editor windows

The LSCEM editor window appears.

Figure 216: LSCEM advanced editor window -- accessed from the Control Builder

7. Enter the cause(s) and effect(s). Refer to Ovation Algorithm Reference Manual for information
on using the LSCEM algorithm.
8. Press the OK button to save the information and close the window. Press the Clear button to
clear the entry fields. Press the Cancel button to discard the information and quit the window.

17.8.3 To access the LSSEQ advanced editor window


1. Access the Control Builder (see page 27).
2. Create a new SIS sheet or open an existing one.
3. Access the Add Algorithm window (see page 361). On the left side of the window, find the
LSSEQ algorithm in the Safety Instrumented System list.
4. Select LSSEQ on the Add Algorithm window and add it to the Control Builder drawing canvas.
5. Go to the Property Editor and enter the values as they pertain to the LSSEQ algorithm. (See
Ovation Algorithms Reference Manual for more information.)
Notice the Number of Outputs and the Number of Valid States fields in the Property Editor.
The number that you enter here determines the number of outputs and states that will appear
in the advanced editor window.

368 OW350_80
17.8 Understanding SIS algorithms with advanced editor windows

Notice the Description State(n) and Description Output(n) fields in the Property Editor. The
names that you enter in these entry fields determine the state and output names that will
appear in the advanced editor window.

Figure 217: LSSEQ parameters shown in the Property Editor

6. Return to the Control Builder drawing canvas, right-click the LSSEQ algorithm, and select
Advanced Edit from the menu that displays.

OW350_80 369
17.8 Understanding SIS algorithms with advanced editor windows

The LSSEQ editor window appears.

Figure 218: LSSEQ advanced editor window -- accessed from the Control Builder

7. Enter the states for each output defined. Refer to Ovation Algorithm Reference Manual for
information on using the LSSEQ algorithm. The states and outputs on this window represent
the MATRIX parameter.
8. Press the OK button to save the information and close the window. Press the Clear button to
clear the entry fields. Press the Cancel button to discard the information and quit the window.

17.8.4 To access the LSSTD advanced editor window


1. Access the Control Builder (see page 27).
2. Create a new SIS sheet or open an existing one.
3. Access the Add Algorithm window (see page 361). On the left side of the window, find the
LSSTD algorithm in the Safety Instrumented System list.
4. Select LSSTD on the Add Algorithm window and add it to the Control Builder drawing canvas.
5. Go to the Property Editor and enter the values as they pertain to the LSSTD algorithm. (See
Ovation Algorithms Reference Manual for more information.)
Notice the Number of States and the Number of Transitions fields in the Property Editor.
The number that you enter here determines the number of states and transitions that will
appear in the advanced editor window.

370 OW350_80
17.8 Understanding SIS algorithms with advanced editor windows

Notice the Description State(n) and Description Input(n) fields in the Property Editor. The
names that you enter in these entry fields determine the state and transition input names that
will appear in the advanced editor window.

Figure 219: LSSTD parameters shown in the Property Editor

6. Return to the Control Builder drawing canvas, right-click the LSSTD algorithm, and select
Advanced Edit from the menu that displays.
The LSSTD editor window appears.

Figure 220: LSSTD advanced editor window -- accessed from the Control Builder

OW350_80 371
17.9 Using Nonsecure parameter algorithms

Note: On the Property Editor, you can enter any name you choose for the states and transition
inputs.

7. Using the drop-down menu, select a state for each transition input. Refer to Ovation Algorithm
Reference Manual for information on using the LSSTD algorithm. The states and transition
inputs on this window represent the MATRIX parameter.
8. Press the OK button to save the information and close the window. Press the Clear button to
clear the entry fields. Press the Cancel button to discard the information and quit the window.

17.9 Using Nonsecure parameter algorithms

Nonsecure parameters are passed to sheets via the nonsecure parameter algorithm:
NONSECPARAM. This algorithm is used as a connector to accept sheets from outside the SIS
network. Consider the following rules:

1. The NONSECPARAM algorithm has one output where you may enter the point name.
2. You can use the NONSECPARAM algorithm as an input connector.
3. Like a connector, the right-click context menu on the drawing canvas for a NONSECPARAM
algorithm will list the sheets that use the point.
4. The default symbol contains the point description.
5. The default symbol contains a point reference that depicts the originating sheet.
6. Only 24 nonsecure parameters are valid for a Logic Solver.

For more information on these algorithms, refer to Ovation Algorithms Reference Manual.

To learn more about SIS installation, configuration, and use, refer to Ovation Safety Instrumented
System (SIS) User Guide.

17.10 Using Secure parameter algorithms

Secure parameters are passed to sheets via the secure parameter algorithms: SECPARAM,
SECPARAMREF, and GSECPARMREF. These algorithm are used as connectors with sheets
that belong to the same Data Server. Consider the following rules:

1. The SECPARAM function has one input that is connected to a downstream output.
2. The downstream point name is used to reference the secure parameter on other SIS sheets.
3. The SECPARAM algorithm will not allow default point names for its input.
4. You may use a SECPARAM algorithm as an input connector.
5. Like a connector, the right-click context menu on the Control Builder drawing canvas for a
SECPARAM lists the SIS sheets that use the point.
6. The default symbol contains the point description.
7. The default symbol contains a point reference that depicts the referencing SIS sheets.
8. Only 16 secure parameters are valid for a Logic Solver.
9. The Secure Parameter Reference (SECPARAMREF) and Global Secure Parameter
Reference (GSECPARAMREF) algorithms allow you to access the Logic Solver method of
passing digital values into Control Modules in the Logic Solvers.

372 OW350_80
17.11 Connecting SIS sheets

10. Both SECPARAMREF and GSECPARAMREF have one output that must be a valid secure
parameter originated by a SECPARAM algorithm.
 When you edit this output, you select from a pull-down list of available secure parameters
in the Property Editor.
 The SECPARAMREF algorithm list includes all of the secure parameters for the Logic
Solvers attached to the SIS Data Server.
 The GSECPARAMREF algorithm list includes all the secure parameters for Logic Solvers
that are Global Publishers on the Fiber-Optic SIS ring.
11. You may use SECPARAMREF or GSECPARAMREF as an input connector.

For more information on these algorithms, refer to Ovation Algorithms Reference Manual.

To learn more about SIS installation, configuration, and use, refer to Ovation Safety Instrumented
System (SIS) User Guide.

17.11 Connecting SIS sheets

Ovation page connectors are similar to algorithms, but are not used in control, and are not sent to
the Controller. They are graphical representations that depict how signals are connected between
sheets.

You can use standard Ovation page connectors to connect SIS sheets. The choices are:
 Input page connectors graphically accept points into a sheet.
 Output page connectors graphically pass points out of a sheet.
Refer to the Ovation Control Builder User Guide for details about using Ovation page connectors.

You can use SIS connectors to connect data between control modules and between Logic
Solvers. The choices are listed below and their usage is described in the following table:
 Secure parameter (SECPARAM) accepts points into a sheet from inside the SIS network
and transfers data to SECPARAMREF on another sheet.
 Secure parameter reference (SECPARAMREF) accepts points into a sheet from inside the
SIS network and accepts data from a SECPARAM on another sheet.
 Global Secure parameter reference (GSECPARAMREF) accepts points into a sheet from
another Logic Solver inside the SIS network. (In order to use this connector, the applicable
Logic Solver must be configured as a Global Publisher.)
 Non-Secure parameter (NONSECPARAM) accepts points into a SIS sheet from a sheet
outside the SIS network.
INORDER TO CONNECT THE FOLLOWING SIS ELEMENTS USE THIS CONNECTOR
ON DIFFERENT SHEETS

Ovation sheet to an SIS sheet NONSECPARAM


SIS sheet to an Ovation sheet Ovation page connector
SIS sheets in the same control module Ovation page connector
SIS sheets in different control modules SECPARAM to SECPARAMREF
SIS sheets in the same Logic Solver SECPARAM to SECPARAMREF
SIS sheets in different Logic Solvers belonging to the same SECPARAM to SECPARAMREF
Data Server

OW350_80 373
17.11 Connecting SIS sheets

INORDER TO CONNECT THE FOLLOWING SIS ELEMENTS USE THIS CONNECTOR


ON DIFFERENT SHEETS

Logic Solvers belonging to the same Data Server SECPARAM to SECPARAMREF


Logic Solvers belonging to different Data Servers and SECPARAM to GSECPARAMREF
communicating using SISNet Repeaters

374 OW350_80
S E C T I O N 18

18 Understanding tracking

IN THIS SECTION

What is tracking? ............................................................................................................. 376


What is the purpose of tracking? ..................................................................................... 376
What is the tracking process? ......................................................................................... 377
What are the best practices for using tracking? .............................................................. 378
What algorithms support tracking? .................................................................................. 379
Tracking examples .......................................................................................................... 381
Setting tracking signals for algorithms ............................................................................ 382

OW350_80 375
18.1 What is tracking?

18.1 What is tracking?

The tracking function is a sophisticated control feature that is unique to Ovation systems. Tracking
is implemented through the signals that connect the algorithms. Tracking may be defined as
aligning a portion of a control system which is not in control to the portion of the control system
which is in control.

To implement tracking in the Ovation system, tracking signals are sent between algorithms.
These signals tell the upstream algorithm whether or not to be in the tracking mode and what
value is required by the downstream algorithm to achieve the present output.

Typically, multiple control strategies (or “modes”) are defined to control a process. For example,
both manual and automatic control modes may be available. Multiple types of automatic control
may be available, such as flow control, level control, element control, and cascade control modes.
During the transition from one control mode to another, tracking is needed.

When transferring between control strategies (for instance, from manual to automatic control
modes), information is required by the newly selected control strategy to ensure a smooth
transition. These required values are obtained from the active control strategy and are provided to
the other available strategies. This exchange of information between control strategies is referred
to as tracking.

Tracking signals are automatically generated by the Control Builder. The Control Builder assigns
points to carry the tracking mode and value information. The insertion of tracking logic is
transparent to the user (requires no user input to implement). You have the option of turning
tracking off.

Tracking should be turned off for the following situations:


 Tracking from a mathematical calculation.
 When using PID to a setpoint to keep from winding up a PID, priority lower/raise. Typically, do
not allow tracking to change a setpoint.
Tracking can be blocked in the following ways:
 Place the algorithms on a separate sheet. Since automatic tracking only occurs within a
sheet, tracking is effectively blocked.
 Use Control Builder to remove tracking points from the TRIN entry fields.

18.2 What is the purpose of tracking?

There are two purposes for tracking:


 Prevent bumps.
Changes in the mode of a process have the potential to disrupt the process. For example,
consider a situation where a control element is manually set to a low level, even though the
automatic control scheme is calculating a high level. If the control mode is changed to
automatic, a “bump” occurs as this control element’s setting goes from low to high. If the
change is extreme, equipment damage could result. Methods used to avoid this type of rapid
adjustment are referred to as “bumpless transfer.”

376 OW350_80
18.3 What is the tracking process?

 Reduce process upsets.


A process upset may be defined as a condition in which the control system causes the
process to temporarily move to an operating point which differs from the desired point. Often
the process upset is caused by failing to hold the integral action of a PID Controller in check;
this condition is called reset windup.
For example, a PID control scheme sums a Proportional component and an Integral
component. In certain situations, the value of the output may reach its limit (100%) while one
of the components is still increasing. Although the output cannot be driven past 100%, it takes
time for the component value to return to the appropriate range. During this time, if it is
necessary to lower the output, the artificially high component value can cause a delay. In
order to keep the control scheme components within the appropriate range, an approach
called Anti-reset windup limiting is used.
To ensure bumpless transfer (during the transition from one control mode to another) and to
avoid reset windup, tracking is needed.

18.3 What is the tracking process?


Tracking works by reverse calculation of the normal control functions. Control may be thought of
as proceeding from “top to bottom,” with inputs on the top, computations in the middle, and
outputs on the bottom. On the other hand, tracking may be thought of as proceeding from “bottom
to top,” with the output values on the bottom being used to calculate values for the computational
elements in the middle. Effectively, tracking calculates a value for an upstream control function,
so that the upstream objectives are satisfied.

One output point that is used for tracking is created for each algorithm that has an IN1 input. The
output is listed in the algorithm definitions as TOUT. TOUT contains the track output value, mode
and status output signals for the cascade IN1 variable.

Some algorithms have two to four additional tracking outputs for the Input 2, Input 3, and Input 4
as well. These are TRK2, TRK3, and TRK4.

The tracking output is input by the upstream algorithm as TRIN (Tracking Input Point) according
to the tracking rules outlined in the following sections. TRIN contains the tracking analog input
value and the tracking and limiting mode input signals.

Tracking values are generated by a reverse calculation of the normal algorithm function. That is,
when the algorithm is actively controlling the process, it uses one or more inputs to calculate an
output. When in the tracking mode, the algorithm is provided with the output value, and must
calculate the input value required to obtain that output. This value is sent to the upstream
algorithm which is generating the algorithm’s input. When there is more than one input, the value
is sent to the IN1 input.

Not all algorithms initiate tracking. All algorithms do not process the signals the same way. Refer
to the individual algorithm descriptions to determine how the signals are processed for a particular
algorithm.

OW350_80 377
18.4 What are the best practices for using tracking?

18.4 What are the best practices for using tracking?

Refer to the following guidelines when using tracking:


 Tracking is typically done upstream.
 Do not unnecessarily use the GAINBIAS algorithm.
 Use MAMODE priority raise/lower instead of external transfers below MASTATION
algorithms.
 Tracking signals are always visible (except for BALANCER signals) and are typically shown in
green.
 If downstream tracking can come from more than one source, then the initial building order
determines the source unless manually changed. The exception to this is the BALANCER
algorithm, which can accept tracking from up to 16 downstream algorithms.
 Tracking may be broken after the signal wires are drawn. On the Solaris platform, this may be
done by clearing the TRIN entry in the algorithm’s EDIT window. On the Windows platform,
this may be done with the Clear Tracking icon.
 If non-tracking algorithms are inserted between tracking algorithms, then the designer is
responsible for tracking across the “gaps.” Typically, the TRANSFER algorithm is used above
the gap to insert the user-computed tracking.
 Reset Windup limiting is performed by tracking algorithms if:
 They are properly configured for tracking.
 The scale limits (TPSC and BTSC) are set to reflect the accepted signal range.
 In addition, the PID and PIDFF algorithms provide for enhanced windup limiting in the
cascade configuration.
 Cross sheet tracking is implemented by passing a tracking point “upstream” through the same
page connectors which pass control signals downstream. On the Solaris platform, this is done
by filling in the optional tracking point name in the cross page connector’s EDIT window. On
the Windows platform, this is done by using the Set Tracking icon with the signal wires.
 Tracking points are fully managed by OCB except when tracking crosses between sheets,
and when tracking from a downstream algorithm into a BALANCER algorithm.
Since the BALANCER algorithm tracks from many downstream algorithms, tracking
connections between a BALANCER algorithm and any downstream algorithms are not
graphically visible.
 Typically, there is only one tracking input (IN1) to an algorithm, except for TRANSFER and
SELECTOR algorithms.
 Before you implement tracking, consider the following:
 What are scaling factors, voltage, percentage, temperature?
 Where is the I/O located?
 What is the frequency of the point?
 The Track Ramp Rate (TRAT) referred to in the algorithm descriptions is used by the
algorithm when tracking action is terminated and normal control begins. It is the time in units
per second for the output to decay or ramp to the value dictated by the inputs under normal
(non-tracking) operation. The default Track Ramp Rate value is 2.5 units

378 OW350_80
18.5 What algorithms support tracking?

18.5 What algorithms support tracking?

Only these algorithms support tracking through dual-purpose analog inputs and outputs (that is,
track value in AV field, mode status bits in 3W field) (See Ovation Algorithms Reference Manual
and Ovation Record Types Reference Manual.):

Tracking algorithm summary

ALGORITHM T R AT TOUT TRK1 TRK2 TRK3 TRK4 ACCEPT CAS CADE


RAMP TO TO TO TO TO TRIN TRACK
IN1 IN1 IN2 IN3 IN4 OPTIMIZE

ANALOG x x
DEVICE

BALANCER x x TRK01-
TRK16
DIVIDE x x x

FIELD x
FFAI x
FFAO x
FFDI x
FFDO x
FFMAI x
FFPID 1 x
x
FUNCTION x x x
GAINBIAS x x x
GASFLOW x x
HISELECT x x x x x x
LEADLAG x x x
LOSELECT x x x x x x
MASTATION x x x
MULTIPLY x x x
PID x 1 x x
x
PIDFF x 1 x x
x
QSRMA x x x
RATELIMIT x x
SETPOINT 2 x
x

SETSTATES x

SQUARE- x x x
ROOT

SUM x x x

OW350_80 379
18.5 What algorithms support tracking?

ALGORITHM T R AT TOUT TRK1 TRK2 TRK3 TRK4 ACCEPT CAS CADE


RAMP TO TO TO TO TO TRIN TRACK
IN1 IN1 IN2 IN3 IN4 OPTIMIZE

3 4 x x x
TRANSFER x
XMA2 x x x
XML2 2 x
x
X3STEP x x
1
Through S (setpoint) pin
2
Information Only
3
Supports switchable slewing and switchable tracking
4
Ramps supported on both TRR1 and TRR2 pins

380 OW350_80
18.6 Tracking examples

18.6 Tracking examples


Tracking: Mode Transition

One of the most common uses of tracking is during the transition between manual mode and auto
mode. In this case, the control algorithm upstream of the MASTATION algorithm must be tracked
to the current output of the MASTATION algorithm. The input to the MASTATION station is the
same as the output from the MASTATION station at the moment of the mode change, and
bumping is prevented.

Tracking: SUM Algorithm

Another common use of tracking is for one input into a SUM algorithm. A two-input SUM algorithm
normally adds two inputs, A and B, to produce an output, C. That is, A + B = C. When the
algorithm is in tracking mode, C is dictated by downstream tracking requirements and one of the
inputs which may be continually varying as process conditions change. Therefore, a value for the
other input must be calculated by the algorithm such that the sum of the inputs is equal to the
required output. Simple algebraic manipulation of the SUM equation reveals that the dependent
input must be tracked to the difference between required C and independent B. That is, A = C - B.

Tracking: PID Algorithm

Still another common tracking use involves one of the inputs to a PID algorithm’s error calculation.
As in the SUM example, the output of the PID is dictated by downstream tracking requirements
and the process variable acts as an independent variable. However, because integral action is
involved in this control algorithm, the concept for tracking changes. Here, the appropriate
technique is to cause a zero error to be presented to the PID during tracking periods to provide no
error-related movement of the PID output when tracking is initially released.

Therefore, the dependent input to the PID error function, the set point, should be tracked to the
value of the process variable input so that a zero-error condition is produced. Also, the PID output
must be tracked when the associated portion of the system is not in control so that integral action
does not cause process upsets by following set point errors. As described previously, this
condition is called reset windup.

Typically, an MASTATION algorithm is placed below the PID algorithm on a control sheet.

In summary, there might be a change in your plant's process values (for example, the
temperature rose in a feedwater system). The applicable process control sheet contains the logic
that defines the desired value for the process. The algorithm PID looks at the difference between
the actual process value and the desired process value and reacts based on this difference. It
performs the necessary action (for example, add cold water to lower the water temperature) to
bring the process back to the desired value.

Tracking: Reset Windup

The concept of reset windup applies to normal control modes as well as to tracking modes. It is
undesirable to allow the integral action in a control algorithm to move any further in a direction
which tends to drive a control element past its limits of travel. Once the integrator winds past
where it should be, it takes time to wind back to the control region when the time comes. Control
delays result and process upsets may occur. The solution is to compute an integrator output
which keeps the downstream demand to the control element at the limit until it becomes time to
drive the control element into the control range. This approach is called anti-reset windup limiting.

OW350_80 381
18.7 Setting tracking signals for algorithms

Tracking: Anti-Reset Windup

The Ovation tracking functions performs the anti-reset windup limiting function if the following two
conditions are met:
 The sheets must be configured using the Ovation sheet tracking rules.
 The Scale Top and Scale Bottom parameters of the algorithms must be set to reflect the
actual control element ranges, usable controller ranges, and so forth.
The fact that an algorithm is at its top or bottom of scale is used to produce signals which inhibit
the upstream algorithm from moving too far in the wrong direction. If algorithms are properly
configured, reset windup is prevented. Reset windup is technically more of a concern in control
mode than in tracking mode.

18.7 Setting tracking signals for algorithms

The digital tracking signals are set and used as described in the following table.

SIGNAL ACTION OF THE ALGORITHM IMPLEMENTATION BY THE


INITIATING THE TRACKING ALGORITHM BEING TOLD TO
TRACK

Track PID and PIDFF set the Track output signal The output value is set equal to the
TRUE. Track input value. An internal track
buffer is set up to provide a bumpless
TRANSFER sets the Track output signal transfer when the Track input signal is
TRUE for the value that is not selected. removed.
MASTATION set the Track output signal
TRUE for one loop after it reads the
hardware value on the first pass.
MASTATION sets the Track output signal
TRUE when the algorithm is not in Auto
mode.
All algorithms set the Track output signal
TRUE when the Track input signal is
TRUE.
Track-if-Lower HISELECT sets the Track-if-Lower output If the output value of the PID or
signal TRUE for the value that is not PIDFF is less than the Track input
selected only when there are no Track, value, then a negative error causes
Track-if_Higher, or Track-if-Lower input the Controller to take action from the
signals and the gain on the input value is previous output value, and a positive
positive. error causes the Controller to take
action from the Track input value.
LOSELECT sets the Track-if-Lower output
signal TRUE for the value that is not
selected only when there are not Track,
Track-if-Higher, or Track-if-Lower input
signals and the gain on the input value is
negative.

382 OW350_80
18.7 Setting tracking signals for algorithms

SIGNAL ACTION OF THE ALGORITHM IMPLEMENTATION BY THE


INITIATING THE TRACKING ALGORITHM BEING TOLD TO
TRACK

All algorithms set the Tack-if-Lower output


signal TRUE when there is no Track input
signal and either:
 The Track-if-Lower signal is TRUE and
the gain on the input value is positive, or
 The Track-if-Higher input signal is TRUE
and the gain on the input value is
negative.
Track-if-Higher LOSELECT sets the Track-if-Higher output If the output value of PID or PIDFF is
signal TRUE for the value that is not greater than the Track input value,
selected only when there are no Track, then a positive error causes the
Track-if-Higher, or Track-if-Lower input Controller to take action from the
signals and the gain on the input value is previous output value, and a negative
positive. error causes the Controller to take
action from the Track input value.
HISELECT sets the Track-if-Higher output
signal TRUE for the value that is not
selected only when there are no Track,
Track-if-Higher, or Track-if-Lower input
signals and the gain on the input value is
negative.
All algorithms set the Track-if-Higher output
signal TRUE when there is no Track input
signal and :
 The Track-if-Higher input signal is TRUE
and the gain on the input value is
positive, or
 The Track-if-Lower input signal is TRUE
and the gain on the input value is
negative.
Lower Inhibit PID and PIDFF set the Lower Inhibit output The output is prevented from
signal TRUE when the algorithm is in decreasing its value, but it is
Cascade mode, no Track input signal permitted to increase.
exists, and:
 The Track-if-Lower input signal is TRUE
and either the gain on the setpoint is
positive with INDIRECT action on the
error or the gain on the setpoint is
negative with DIRECT action on the error,
or
 The Track-if-Higher input signal is TRUE
and either the gain on the setpoint is
negative with INDIRECT action on the
error, or the gain on the setpoint is
positive with DIRECT action on the error.

OW350_80 383
18.7 Setting tracking signals for algorithms

SIGNAL ACTION OF THE ALGORITHM IMPLEMENTATION BY THE


INITIATING THE TRACKING ALGORITHM BEING TOLD TO
TRACK

All algorithms set the Lower Inhibit output


signal TRUE when there is no Track input
signal and:
 The output value is at the low limit
specified and the gain on the output value
is positive, or
 The output value is at the high limit
specified and the gain on the input value
is negative, or
 The Lower Inhibit input signal is TRUE
and the gain on the input value is
positive, or
 The Raise Inhibit input signal is TRUE
and the gain on the input value is
negative.
Raise Inhibit PID and PIDFF set the Raise Inhibit output The output is prevented from
signal TRUE when the algorithm is in increasing its value, but it is permitted
Cascade mode, no Track input signal to decrease.
exists, and:
 The Track-if-Higher input signal is TRUE
and either the gain on the setpoint is
positive with INDIRECT action on the
error, or the gain on the setpoint is
negative with DIRECT action on the error,
or
 The Track-if-Lower input signal is TRUE
and either the gain on the setpoint is
negative with INDIRECT action on the
error, or the gain on the setpoint is
positive with DIRECT action on the error.l
All algorithms set the Raise Inhibit output
signal TRUE when there is no Track input
signal, and:
 The output value is at the high limit
specified and the gain on the input value
is positive, or
 The output value is at the low limit
specified and the gain on the input value
is negative, or
 The Raise Inhibit input signal is TRUE
and the gain on the input value is
positive, or
 The Lower Inhibit input signal is TRUE
and the gain on the input value is
negative.

384 OW350_80
S E C T I O N 19

19 Using ladder control logic

IN THIS SECTION

What types of ladders does the Control Builder support? .............................................. 385
What items are used in ladders?..................................................................................... 385
What are free-form ladders? ........................................................................................... 387
What are 7 x 9 ladders? .................................................................................................. 389
To audit a ladder ............................................................................................................. 397

19.1 What types of ladders does the Control Builder support?

The Ovation Control Builder supports two types of ladders:


 Free-form ladders that adhere to the IEC 61131-3 specification (see page 387).
 7 x 9 ladders that are used for migration from WDPF to Ovation (see page 389).

19.2 What items are used in ladders?

The following figure describes input contacts, contact colors, and output coils typically used in
ladder logic.

OW350_80 385
19.2 What items are used in ladders?

The following figure describes some basic logic notation used by Scientific Apparatus Makers
Association (SAMA) and Ovation.

386 OW350_80
19.3 What are free-form ladders?

19.3 What are free -form ladders?

You can build free-form ladders using the Control Builder's Ladder Elements function. By using
ladder elements, you do not adhere to the standard 7 x 9 ladder concept. You build free-form
ladders in the same way that you build any other type of control sheet. These ladders adhere to
the IEC 61131-3 specification. To understand these specifications, refer to the IEC 61131-3
document Second Edition, Section 4-2.

The Control Builder provides four elements to build free-form ladders. These elements connect
with signal lines and then operate as a standard ladder that is built on a control sheet and read by
the Controller. You can use all of the features of the Control Builder application when you build
ladders. Each ladder element represents an algorithm:
 Contact -- represents an AND algorithm.
 Coil -- represents an OR or a NOT algorithm.
 Orbar -- represents an OR algorithm where each of the inputs is one of the inputs of the
algorithm. An orbar can have multiple output pins, but each pin represents the same value.
 Rail -- represents a DVALGEN algorithm. This is the starting point of a ladder.

19.3.1 What are the rules for using free-form ladder elements?

Adhere to the following rules when you use ladder elements to create a ladder:

1. You should begin a free-form ladder with a rail.


2. A contact requires a digital input point and a local digital point and may generate a digital
output point. Ladder elements are implemented as fast boolean algorithms so the same
output point rules apply.
3. A coil requires a digital input point and a digital output point.
4. An orbar requires one or more digital input points and may have one digital output point. This
point may be represented by multiple pins (that is, one on each rung).
5. A rail requires a digital output that is always true that may be used to start a ladder sequence.
6. A rail or an orbar may be extended to span multiple rungs using the Generate New Ladder
Row item on the Algorithm right-click menu (see page 128). Each rung will have one pin on it.
As such, multiple pins represent the same algorithm output point.
7. Connect rails, contacts, orbars, and coils with normal signal lines to other ladder elements,
algorithms, or to special function algorithms.
8. To adhere to standard ladder concepts, connect each output pin to one and only one input
pin. Use orbars to span multiple rungs.
9. You may intersperse standard algorithms and special function algorithms with any ladder
element.
10. You may invert both contacts and coils through the Property Editor.

19.3.2 To build a free-form ladder using ladder elements


1. Start a new control sheet (see page 96) or open an existing control sheet (see page 99).
2. Once you have opened control sheet, pull down the Draw menu and select Add Algorithm.
The Add Algorithm window appears.
3. From the Add Algorithm window, expand the Ladder Elements folder.
4. Choose a rail. You should always start with a rail.

OW350_80 387
19.3 What are free-form ladders?

5. Continue building the free-form ladder by selecting from one of the other ladder elements:
coil, contact, and orbar. Remember that free-form ladders adhere to the IEC 61131-3
specification. To understand these specifications, refer to the IEC 61131-3 document
Second Edition, Section 4-2.

Note: The Control Builder does not support positive and negative transition-sensing contacts.
The Control Builder supports set/reset coils with the FLIPFLOP algorithm symbol.

6. Build the ladder according to the guidelines in Rules for using ladder elements (see page
387).

19.3.3 To extend an orbar or a rail

You may want to add more logic from a rail or from an orbar. You can do this by selecting the
ladder element on the sheet, and then right-clicking to select Generate New Ladder Row at the
bottom of the menu. Another rung is added, equally spaced from the previous rung.

388 OW350_80
19.4 What are 7 x 9 ladders?

19.4 What are 7 x 9 ladders?

A ladder is represented on a control function as a single algorithm. A ladder internally contains a


seven row by nine (7 x 9) column array of cells. Each cell can be edited to display a shape (such
as a coil, contact, or special function) and to store information about that shape.

Note: Ladders are supported by Ovation; however, 7 x 9 ladders were implemented for
migration from WDPF to Ovation and are not intended to be used for implementing new control
systems.

These shapes or functions form a relay diagram that depicts the types of inputs, controls, and
outputs. The diagram illustrates how these user-selected inputs are configured to cause an
assigned device to operate in a desired manner.

Ladder control can be edited or built with the Control Builder. The ladder control application
contains a set of functions which simulates relay-type circuits, devices, and the operation
sequence of a conventional, electrical relay system.

Ladders that adhere to a 7 x 9 standard are applications built on control sheets that are then read
by the Controller.

The Controller implements an application, which is comprised of inputs, control logic, and outputs.
How frequently the application runs depends on the rate selected by the application designer.
Every completed cycle is called loop time and is set in the Controller configuration.

The Controller begins by reading the first ladder, performing the logic, and then moving to the
next ladder. When a Controller reads ladder logic, it is “executing” the ladder.

The ladder is divided into areas known as cells. Each cell can contain one piece of ladder logic, a
contact, a coil, or a portion of a special function. To process the ladder, the functional processor
starts with the ladder’s first cell. If logic appears in the cell, the cell is conducting or not conducting
power depending on the states of any associated inputs, These contacts may be controlled by
coils or hard-wired inputs elsewhere in the control application.

Typically, ladders are used only by Migration projects. Migration refers to the process of
upgrading a system from WDPF to Ovation, while still using the original logic. After a system has
been migrated, any ladder logic that was used in the original system will be preserved in the new
Ovation system, and may need to be edited; however, 7 x 9 ladders should typically not be used
in the design and implementation of new control logic in an Ovation system.

CAUTION! Ladders may not be used in a control function that contains fast boolean
algorithms (AND, OR, NOT, XOR, FLIPFLOP). Doing so may result in the Controller failing
after the load completes. Because of this limitation, do not use ladders in macros and do not
use macros on sheets with ladders. The use of macros obscures the ladder/fast boolean
condition.

OW350_80 389
19.4 What are 7 x 9 ladders?

19.4.1 Executing a 7 x 9 ladder

Contacts, special functions, and coils are connected together by power flow paths to form rungs
within the ladder. The ladder is divided into 63 areas, known as cells. Each cell can contain one
piece of ladder logic: a contact, a coil, or a special function. There are seven rows and nine
columns.

To process the ladder, the functional processor starts with the ladder’s first cell. If logic appears in
the cell, the cell is conducting or not conducting power depending on the states of any associated
inputs. The ladder solves from top to bottom, one column at a time, starting with column one
moving right to column nine.

Figure 221: Ladder execution

390 OW350_80
19.4 What are 7 x 9 ladders?

19.4.2 Compressing a 7 x 9 ladder

When downloaded into the Controller memory, the ladder is compressed automatically (whenever
possible) to reduce execution time and increase storage capacity. This compression affects the
way the ladder is executed. Contacts and special functions do not shift position when the ladder is
compressed; however, coils may shift their effective cell position.

When a ladder is created, the ninth column can only contain coils; however, when the ladder is
downloaded into the Controller memory, the coil may be effectively shifted to the left. The number
of cells it shifts depends on the individual ladder. As a general rule, the coil shifts to the left until it
encounters another ladder logic element or a blank cell.

An example that illustrates this execution strategy is shown in the following figure. The top ladder
represents a ladder as it was designed. The bottom ladder represents the same ladder as it will
be executed by the Controller.

Notice that coils C, E, and J shifted to the left, moving into the cell to the right of the last contact in
each ladder rung. Ladders solve down each column, one at a time. Notice that the apparent
execution order of the ladder and the true execution order are much different. This difference
sometimes become very important when coils are acting as contacts in the same ladder.

Observe the best practices for designing ladders (see page 392).

Note: A PD record is automatically initialized for any ladder which contains one or more special
functions. The name format is OCBSSSSNNN-PD (where OCB is generated by the Control
Builder, SSSS is the unique sheet identifier assigned by Ovation, and NNN is the order that the
algorithm was placed on the sheet).

OW350_80 391
19.4 What are 7 x 9 ladders?

19.4.3 What are the best practices for designing a 7 x 9 ladd er?
1. Place contacts along horizontal power path branches. They cannot be part of vertical
branches. The Ladder function does not allow entry of vertical contacts.
2. One ladder can normally accommodate a maximum of eight contacts per row, and up to
seven rows (for a maximum of 56 contacts).
3. Remember power flows from left to right. It never flows right to left.
4. Special function blocks reduce the number of contacts that can fit in a ladder. Special
functions can only be placed in even-numbered columns (columns 2, 4, 6, and 8). The
Ladder function does not allow entry of special functions in odd-numbered columns.
5. Ladders may not be used in a control function that contains fast boolean algorithms (AND,
OR, NOT, XOR, FLIPFLOP). Doing so may result in the Controller failing after the load
completes. Because of this limitation, do not use ladders in macros and do not use macros on
sheets with ladders. The use of macros obscures the ladder/fast boolean condition.

19.4.4 To add a 7 x 9 ladder to a control sheet

Use the Ladder dialog box to edit and audit ladders and to add special functions. A ladder is
treated as an algorithm in the Control Builder.

1. From the main Control Builder window, pull down the Draw menu, and select Add Algorithm.
You can also select the Add Control Algorithm icon on the toolbar. The Add Algorithm
dialog box appears.
2. Expand the 7 x 9 Ladder folder from the list of algorithm symbols on the left side of the
window.
3. Select Ladder. The algorithm symbols that are currently in the library for that type display on
the right side of the dialog box.
4. Select the symbol that best fits your needs (symbols may vary depending on the number of
pins needed).
5. Select the OK button on the Add Algorithm dialog box.
6. Move the cursor to the drawing canvas. Notice how the cursor icon changes. Without
pressing any mouse buttons, move the ladder to the desired location on the canvas.
7. Click the drawing canvas to position the ladder on the sheet. Notice that the cursor changes
back into a cross-hair symbol.
8. After selecting the ladder on the Add Algorithm dialog box, the ladder appears in the
Algorithms container in the Object Browser window. The ladder parameters appear in the
Property Editor window where they can be edited.

Note: For 7 x 9 ladders, the Control Builder does not fully support the Create Points or Point
Edit functions.

392 OW350_80
19.4 What are 7 x 9 ladders?

19.4.5 To edit a 7 x 9 ladder

After you have added a ladder to a sheet (see page 392), use the following procedure to edit the
ladder:

1. Add a 7 x 9 ladder to the drawing canvas. Right-click it to display another menu. Select
Advanced Edit from the menu. The Ladder window appears. This window can be used to edit
or create a ladder.

Figure 222: Ladder window

2. Edit the ladder as desired. The following table describes the menus and functions for the
Ladder window.

OW350_80 393
19.4 What are 7 x 9 ladders?

Ladder window menus and functions

MENU OR FUNCTION DESCRIPTION

File Menu Import - Brings an existing ladder text file into the current Ladder window.
See To import a ladder file (see page 396).
Export - Creates a text file of the current ladder that is in the Ladder
window. See To export a ladder file (see page 396).

Edit Menu Erase Selection - Deletes the selected item or items in the Ladder
window.
Select All - Selects everything in the Ladder window.
Deselect All - Deselects everything in the Ladder window.
Check Point Menu Capture - Creates a check point (snapshot) of the current ladder. It is
stored, not saved, to the drawing.
Revert - Returns to the last check point that was captured.

Special Functions Inserts Special Functions algorithms. (See WDPF Special Functions.)

Contacts Places a contact into a cell (click the contact to toggle between Normally
Open and Normally Closed).
To add a coil, you must select one of the cells in the ninth column.

Note: The asterisks (*) around the Contact, Thru Line, or Erase menu
items indicate the currently active function.

Thru Line Places a horizontal line (AND) or a vertical line (OR) in a cell.

Erase Erases the contents of the selected cell(s).

Ok Saves the changes and closes the Ladder window.


Close Quits the Ladder window without saving edits. Before the window closes,
you are prompted with the following message, "Discard outstanding edits?"
Select Yes to close the window without saving or select No to undo the
cancel operation.

19.4.6 To add a special function to a 7 x 9 ladder

A Special Function is a special algorithm that was used in WDPF systems and can now be used
in migrated Ovation systems. Use the following procedure to add a Special Function algorithm to
the Edit Ladder box (See WDPF Special Functions.)

1. Add a ladder to a sheet (see page 392).


2. From the Ladder dialog box, pull down the Edit menu and select Deselect All.
3. Determine where you want to place a Special Function algorithm on the Ladder dialog box.
Right-click in the top cell to select the location. The cell will turn black.
4. Pull down the Special Functions menu. A list of the available Special Functions appears.

394 OW350_80
19.4 What are 7 x 9 ladders?

Note: You can only put special functions in even-numbered columns (such as 2, 4, 6, 8) starting
from the left.

5. Left-click the desired Special Function, and it appears in the selected cell(s).
6. The parameter name, value, and type (R for register, C for constant, or P for point) display in
the Special Function cell. You can add a bit value by enclosing it in square brackets and
inserting it after a point name. The value is typed inside the box.
7. Pull down the Edit menu and select Audit Ladder. If any errors display, correct them, and
audit the ladder again.

Note: If you want to change the parameter types, you can toggle through the parameter types
by left-clicking on the parameter type initial. If you select an invalid parameter type, error
messages display when you audit or save the sheet.

19.4.7 To add contacts, coils, and wires to a 7 x 9 ladder

You can add contacts, functions, and coils to a ladder diagram. They are connected together by
power flow paths (Thru-Lines) that form rungs within the ladder diagram.

1. Add a ladder to a sheet (see page 392).


2. Determine where you want to place a contact, coil, or wire on the Ladder dialog box. Select
the power flow paths (Thru-Lines) that form rungs within the ladder diagram.
a) Add a contact by left-clicking on any desired cell, except for those in the ninth column. In
order to add a contact to a cell, display the Contact item on the Ladder dialog box
menu bar as follows: <Contact>. If it is not displayed in brackets, click it to make the
Contact option active instead of Thru-Line option.

Note: The Contact and Thru-Line items are toggle options. Only one can be available to add to
the dialog box at one time. The option that is active is the one currently displayed in <>
(<Contact> or <Thru Line>).

b) Add a coil by left-clicking on any desired cell in the ninth column.


c) Add a wire by selecting the Thru Line item. To add a Thru-Line, go to the Ladder dialog
box menu bar and make sure that Thru-Line is enclosed in brackets: <Thru-Line>. If it is
not displayed in brackets, click it to make the Thru Line option active instead of the
Contact option.

Note: Once you have selected the item type that you want to add to the ladder (contact, coil, or
wire), you can continue to add multiple items of the same type until you select another type.

3. Use any desired combination of Special Functions, contacts, coils, and wires to create or edit
the ladder diagram.

19.4.8 To use the check point function for 7 x 9 ladders

The check point function is used to capture a snapshot of the current ladder that is displayed in
the Ladder dialog box. This snapshot is used as an “undo” function. After you have made edits,
you can return (revert) to previous captures and undo the last edits.

Use the following procedure to capture a check point or revert to a previous one:

1. Add a ladder to a sheet (see page 392).

OW350_80 395
19.4 What are 7 x 9 ladders?

2. Finish the desired edits in the Ladder dialog box. Pull down the Check Point menu and select
Capture. The latest changes will be stored (not saved to a file) in a captured moment.
3. If you want to undo the latest changes, select Revert from the Check Point menu. This
returns the Ladder dialog box to the latest stored capture. You can continue to use Revert
until all the captures made in this editing session have been displayed.

Note: Once you have used Revert to undo edits, the edits are gone, since Revert cannot be
undone. You would have to redo the edits manually if you want to restore the edits.

19.4.9 To export a ladder file for 7 x 9 ladders

At any time while editing a ladder in the Ladder dialog box, you can use the Export function to
create a text file of the current ladder. This text file may be imported into this or any ladder at a
later time. Use the following procedure to export a ladder file:

1. Create or edit a ladder in the Ladder dialog box (see page 392).
2. Pull down the File menu and select Export. A "Choose a file" dialog box appears prompting
you to define a name for the file (with a .txt extension) and to select a destination for the file.
3. Name the file and select the destination (directory). You now have a ladder file that can be
stored and reused.
This is similar to a Copy/Paste function. You can use Export to create Ladder files, store them
in libraries and then reuse the ladders that were successful for you.

19.4.10 To import a ladder file for 7 x 9 ladders

After you have created a ladder text file (see page 396), you can use the Import function to bring
the existing file into the current Ladder dialog box. Use the following procedure to import a ladder
file:

1. Add a ladder to a sheet (see page 392).


2. From the Ladder dialog box, pull down the File menu and select Import. A "Choose a file"
dialog box appears prompting you to select an existing ladder text file.
3. Browse to select the desired ladder text file. The ladder file appears in the Ladder dialog box
exactly as it appeared when it was exported.

19.4.11 To erase cells in the Ladder window for 7 x 9 ladders

This method of erasing one or more cells allows you to select and visualize the cells you want to
erase before you actually erase them. Use the following procedure to erase a selection:

1. Add a ladder to a sheet (see page 392).


2. To select cells in the Ladder dialog box, right-click the cell(s). Note that in order to select a
special function, contact, or coil cell, you must select outside of the box that appears in the
cell. When selected, the cell turns black.
3. Pull down the Edit menu, and select Erase Selection. The cells are removed from the
Ladder dialog box.

396 OW350_80
19.5 To audit a ladder

19.4.12 To use the Select All function on the Ladder window for 7 x 9 ladders

Choose the Select All item from the Edit menu and everything in the Ladder dialog box is
selected.

19.4.13 To use the Deselect All function on the Ladder window for 7 x 9
ladders

Select Deselect All from the Edit menu and everything in the Ladder dialog box is deselected.

19.5 To audit a ladder

For both types of ladders (7 x 9 and free-form), Control Builder can perform an audit on the
ladder. This audit ensures that the algorithm (special function) is correct and all associated points
are also correct. After you have added or edited a ladder, use the following procedure to audit a
ladder:

1. Access the Control Builder (see page 27).


2. From the main Control Builder window, pull down the File menu and select Save. When a
sheet is saved, it is automatically audited and checked for errors.
3. If there are errors found within the ladder algorithm, they display in the Error List window.

CAUTION! Ladders may not be used in a control function that contains fast boolean
algorithms (AND, OR, NOT, XOR, FLIPFLOP). Doing so may result in the Controller failing
after the load completes. Because of this limitation, do not use ladders in macros and do not
use macros on sheets with ladders. The use of macros obscures the ladder/fast boolean
condition.

OW350_80 397
S E C T I O N 20

20 Information and error messages

IN THIS SECTION

What is the Control Builder Error List window? ............................................................... 399


Error List window and field descriptions control builder error messages and
descriptions and more descriptions................................................................................. 399
Control Builder error message descriptions control builder error messages and
descriptions ..................................................................................................................... 400

20.1 What is the Control Builder Error List w indow ?

The Error List window displays algorithm errors for a particular sheet. These errors also appear in
the Operator Station Error Log.

To access the Error List, pull down the View menu on the main Control Builder window and select
Algorithm Errors. The Error List window appears.

20.2 Error List w indow and field descriptions control builder error
messages and descriptions and more descriptions

Figure 223: Error List window

OW350_80 399
20.3 Control Builder error message descriptions control builder error messages and descriptions

Error List window Fields

FIELD DESCRIPTION

Icon Red circle with an "x" indicates an error.


Algorithm (name) Name of the algorithm on the sheet that has the error.
Parameter The parameter (of the algorithm) that has the error.
Value The value of the parameter in question.
Error Short message stating the error.
Error details Extra information pertaining to the error.

20.3 Control Builder error message descriptions control builder error


messages and descriptions

The following error messages display in the Error List window.

Control Builder error messages and descriptions

MESSAGE DESCRIPTION

Algorithm template not found. The algorithm template could not be found.

Audit operation failed. The Control Builder could not successfully audit the sheet due to
errors.
Bit number > 32 or Invalid The point name has been defined with an invalid point name. Using
characters. the expected format, which is <point name> [bit], the bit is either an
invalid integer or not a number at all.
Cell input is not connected There is no power flow to the input of a cell in a ladder.
Cell output is not connected There is no downstream connection from a ladder line, orbar, or
contact.
CSS path not specified. A directory path was not specified for the .css (cascading style sheet)
file. A .css file is used to apply styles to graphic items. Enter the
correct path of the .css file you wish to use to apply styles.
Database offline. The system is unable to connect to the configured database.
Proceeding with this error results in control sheet edits being
committed to the file but not to the Ovation database.
Database type not defined. The correct Ovation database is not configured. This error implies an
incorrectly formatted Control Builder Project configuration file in the
directory with the currently opened .svg file. See To set Control
Builder configuration parameters (see page 29) for information on
setting the Database/Type attribute. Note that "None" is a valid
configuration/
Directory does not exist. The directory you specified does not exist. Enter a new directory path
or create a new directory.
Document path not defined. A directory path was not defined for the document.

400 OW350_80
20.3 Control Builder error message descriptions control builder error messages and descriptions

MESSAGE DESCRIPTION

Drop ID not yet specified. A drop ID was not specified for your sheet. A drop ID is required in
order to save a control function. Control does NOT update under this
condition.
Drop not found in database. The drop is not currently defined in the database. Create a drop or
select a new drop. Control does NOT update under this condition.
Embedded Device not found in For projects that have a valid SIS license, the embedded device is not
database. in the database.
Exponent exceeds allowed value. The entered exponent exceeds the allowed maximum limit.
Exponential format invalid for The format of the entered exponent is not valid for integers.
integer parameters.
File does not exist. The file you entered does not exist. Enter a different file name or
create a new one.
File not found. The file you are searching for was not found in the database.
Font not supported by this machine. The selected font type is not supported by the drop.
Foundation Fieldbus algorithm not The Ovation algorithm must be assigned to a specific Foundation
assigned to a device. Fieldbus function block. Control does NOT update under this
condition.
Foundation Fieldbus device is The device name specified for the Foundation Fieldbus function block
already in use. is already allocated to another Ovation algorithm. This is similar to a
point being originated by another algorithm. Control does NOT update
under this condition.
Hex format invalid for real The format for hexadecimal numbers is not valid for parameters that
parameters. require a real value.
Hex numbers must be prefixed with Hexadecimal numbers must begin with "0x."
0x.
Insufficient SIS permissions: For projects that have a valid SIS licence, the user does not have
Document is read-only. permission to edit the SIS document. It is read-only,
Invalid cell structure There is a problem with a cell in a ladder.
Invalid character. The entered character is not valid for the current entry field.
Invalid Control Module number. For projects that have a valid SIS license, the control module number
used is incorrect.
Invalid data type. The selected data type is not valid.
Invalid date. The entered date is not in a valid format.
Invalid datetime. The entered time is not in a valid format.
Invalid drop ID. The entered drop ID is not valid. Drop ID is required in order to save
sheets.
Invalid font size. The selected font size is not supported.
Invalid Foundation Fieldbus device The Fieldbus device name is not found in the database under the
name. current drop.
Invalid indicator type. The selected indicator type (for point status indicators or algorithm
value indicators) is not valid.
Invalid ladder special function The number of a holding register in a special function is outside the
register value. range 0 - 9999.

OW350_80 401
20.3 Control Builder error message descriptions control builder error messages and descriptions

MESSAGE DESCRIPTION

Invalid line style. The selected line style is not supported by the Control Builder.
Invalid point name format. An algorithm's output point name contains invalid characters. Valid
characters are all characters, except \, $, %, &, *, @, ~, ". Control
does NOT update under this condition.
Invalid point record type. An algorithm's output contains a point whose record type is
incompatible with the algorithm's definition. For example, a digital
point is used as the output for an algorithm requiring an analog point.
Control does NOT update under this condition.
Invalid style class. The selected style template is not defined in the current document.
IO channel is originated by another For projects that have a valid SIS license, the IO channel is not
sheet. originated on the current sheet, but is originated on another sheet.
IO channel not defined in the For projects that have a valid SIS license, the IO channel was not
database. properly defined. It must be defined in the Ovation Developer Studio.
Item not found. The item you are searching for could not be found.
Ladder is empty There are no cells defined in the ladder.
Missing required attribute. The attributes requires the user to define a value.
More than one decimal point You can only have one decimal point in a real number.
present.
More than one signal segment is You can only have one signal segment connected to an input.
connected to input.
Network name contains other than A network name can only contain alphanumeric characters (A-Z, 0-9).
characters A-Z, 0-9.
Network name is defined without a A unit name must be defined with every network name in a fully
unit name. qualified point name.
Network name longer than 8 A network name cannot contain more than eight characters.
characters.
Network not found in database. The network you are searching for was not found in the database.
No active unit available. The Control Builder is unable to determine which unit to use for the
drop defined by the currently active sheet.
No description available for point. This error implies that a point's description is empty and cannot be
displayed on the sheet.
No help information currently Help information is not available on the selected item.
available.
No ladders allowed Ladders are not allowed on sheets with Fast Boolean logic.
No value for cb-source upstream This error implies that an algorithm value is attached to an attribute
attribute. that does not currently have a value in the algorithm.
Not a recognized Control Builder The selected file is not a Control Builder file.
file.
Not a valid enumeration value. The current value for the enumeration is not valid. The default value
will be used instead. Control updates under this condition.
Numeric value expected. The entered value should be a numeric value.
Only SIS algorithms are valid in a For projects that have a valid SIS license, only SIS algorithms can be
SIS function. used on SIS sheets. Standard Ovation algorithms cannot be used on
SIS sheets.

402 OW350_80
20.3 Control Builder error message descriptions control builder error messages and descriptions

MESSAGE DESCRIPTION

Out of range for byte. The entered byte is not in a valid range. Valid range is 0 - 255.
Output point name is not unique. The output point name is used on more than one algorithm on the
sheet.
Point is originated by another Point is originated from an algorithm on another sheet.
sheet.
Point name contains invalid Point names can only contain certain valid characters. Refer to
characters. Ovation Graphics Builder User Guide for more information on valid
point names.
Point name too long. The entered point name is too long. Point names cannot exceed 24
characters for Ovation Windows systems or 16 characters for Ovation
Solaris systems.
Point not originated in the same The point is calculated by an algorithm on the current sheet, but the
drop as the sheet. point is originated in a different drop than the one that is executing the
current sheet. The sheet must run in the same Controller that
originates the points.
Point not found in database. An algorithm's output contains a point name that is not currently
defined in the database. Create a point or select a new point. Control
does NOT update under this condition.
Real values invalid for integer The entered real numbers are not valid for integer parameters.
parameters.
Secure parameter not defined in For projects that have a valid SIS license, this indicates that the
the database. parameter was not defined in the database.
Sheet number not yet specified. A sheet number was not defined in the Property Editor. The sheet
does not save under this condition.
Sheet title not yet specified. A sheet title was not defined in the Property Editor. The sheet does
not save under this condition.
SIS Logic Solver not found in the For projects that have a valid SIS license, the Logic Solver is not
database. found in the database. It must be defined in the Ovation Developer
Studio.
SIS Logic Solver undefined. For projects that have a valid SIS license, the Logic Solver is not
defined and must be defined in the Ovation Developer Studio.
System not available. When connecting to an Ovation Windows database, the system in the
database must match the system expected for the sheet. The system
is derived from the directory structure under OvPtSvr.
Target files/directory not specified. A target directory or file was not specified for a Copy operation.
Task ID not yet specified. A task ID was not specified in the Property Editor. The sheet does not
save under this condition.
Task not found in database. The entered control task was not defined in the database.
The Foundation Fieldbus block Fieldbus function block names must be unique within a sheet.
name is not unique.
Unable to open file. The selected file could not be opened.
Unit name contains other than Unit names can only contain alphanumeric characters (A-Z, 0-9).
characters A-Z, 0-9.
Unit name longer than six A unit name cannot be longer than six characters.
characters.

OW350_80 403
20.3 Control Builder error message descriptions control builder error messages and descriptions

MESSAGE DESCRIPTION

Unit name required when a network You must supply a unit name when specifying a network.
is specified.
Unit not found in database. When connecting to an Ovation Windows database, the unit in the
database must match the unit expected for the sheet. The unit is
derived from the directory structure under OvPtSvr.
Upstream algorithm belongs to a Foundation Fieldbus blocks may only be connected if they run on
different segment. devices on the same Fieldbus segment. The upstream algorithm is
running on a device on a different segment. To connect the blocks,
use an Ovation algorithm between them (GAINBIAS for analog
signals, and OR for digital signals). Be advised that under this
configuration, the control will not run independently on the segments.
This configuration requires continuous operation by the Controller for
the control to run correctly.
Value below allowable minimum. The entered value falls below the defined minimum limit.
Value exceeds limit. The entered value exceeds the defined limit for the parameter.
Value exceeds maximum allowable The entered value exceeds the defined maximum length.
length.
Value out of range. The entered value is not in the valid range for the parameter.
Value over allowable maximum. The value exceeds the maximum defined limit.
X-coordinates do not progress. The Function Generator graphic is invalid because the x coordinates
do not numerically progress. X(n) is less than X(n-1).

404 OW350_80
S E C T I O N 21

21 Using the Control Builder Scripting Facility

IN THIS SECTION

What is the Control Builder Scripting Facility? ................................................................ 405


Executing the xml file ...................................................................................................... 406
Format of the XML file ..................................................................................................... 406
AddAlgorithm ................................................................................................................... 407
AddFunction .................................................................................................................... 409
AddLine ........................................................................................................................... 410
AddPin ............................................................................................................................. 411
AddSegment.................................................................................................................... 412
AddSignal ........................................................................................................................ 413
AddText ........................................................................................................................... 414
BreakTracking ................................................................................................................. 415
OpenFunction .................................................................................................................. 416
RouteSignal ..................................................................................................................... 417
SelectAlgorithm ............................................................................................................... 418
SetValue .......................................................................................................................... 419
Example 1 of Control Builder Scripting Facility file - AddFunction root element ............. 419
Example 2 of Control Builder Scripting Facility file - Openfunction root element ........... 420

21.1 What is the Control Builder Scripting Facility?

The Control Builder Scripting Facility builds Control Builder sheets from a file of commands. The
commands are presented as a collection of XML formatted files. The facility produces Control
Builder SVG sheets that can be imported (see page 262) into an Ovation control system.

Note: The purpose of this section is to show you the format of the xml file and describe the
parameters used to build the file; however, you may build this xml file as you choose, provided
you adhere to the defined syntax and rules.

This section also provides information on executing the file so that it can be converted to an svg
file. The section, To use the Import operation (see page 262), gives information on importing the
file into the Control Builder.

OW350_80 405
21.2 Executing the xml file

21.2 Executing the xml file


Once you build the xml file, the libTest.exe program is used to execute the file and generate it
into an svg file that can be imported into the Control Builder.

The libTest.exe file is provided with the Control Builder and is found in the same directory where
the Control Builder is installed. You can find this directory by typing %CB_HOME% in the address
field of Windows Explorer.

To execute the libTest.exe program, do the following:

1. Open a command prompt window.


2. Change directories so that you are in the directory that contains the xml files.
3. Type the following command:
libtest executeXmlScript <xml_filename>
4. The input file must be an xml formatted file and the filename may include the path or
wildcards. You may execute a list of filenames at one time, as shown below:
libtest executeXmlScript aaa.xml bbb.xml cc*.xml
Once the file executes, the output will be a Control Builder .svg file (functional drawing). For
example, the output may be 0001.svg. The filename is taken from the cb-function-id attribute
of the AddFunction element (see page 409).
5. Ill-formed xml files may cause the libTest program to crash. Open the file in Internet Explorer
to make sure the file is well formed. If there are errors, error messages are appended to the
file, XMLCommandFileLog.htm.

21.3 Format of the XML file

Observe the following rules when creating an xml file:

1. The xml file can have only one of the following root elements: AddFunction or OpenFunction.
Only one of these root elements can be used in an xml file.
2. Once a root element is selected to start the xml file, it is the first command in the file and also
the last command in the file. It starts and ends the file.
3. Between the starting and ending root elements, are various other commands. Each command
has certain rules that define what can come before or what can come after that command.
4. Each command has defined attributes that are either required or optional for that command.
5. A "Parent" command is a command than must precede the current command. A "Child"
command is a command that can come after the current command.
6. Since the AddFunction and OpenFunction are root elements, they cannot have "parent
commands" or commands that come before them in the file.
7. AddFunction and OpenFunction can only have "children commands" which are commands
that are allowed to come after them in a file.
8. Certain commands (other than AddFunction or OpenFunction) can have either parent
commands, children commands, or both.
9. The "<" symbol starts a new command. The "/>" symbol ends a command.

406 OW350_80
21.3 Format of the XML file

The following commands can be used in the xml file:


 AddAlgorithm (see page 407)
 AddFunction (see page 409)
 AddLine (see page 410)
 AddPin (see page 411)
 AddSegment (see page 412)
 AddSignal (see page 413)
 AddText (see page 414)
 BreakTracking (see page 415)
 OpenFunction (see page 416)
 RouteSignal (see page 417)
 SelectAlgorithm (see page 418)
 SetValue (see page 419)

OW350_80 407
21.4 AddAlgorithm

21.4 AddAlgorithm

Description

The AddAlgorithm command adds a new algorithm symbol to a sheet.

Syntax

<AddAlgorithm attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

function-name Required Name of an algorithm symbol that can be inserted on a sheet. This
must be one of the names defined in the file template.tft in the Control
Builder install directory.
symbol-id Required Number of symbol variant of one of the symbols available for insertion
on the functional sheet. The symbol drawings are contained within the
symbols directory that is available to the Control Builder. An example
symbol name would be "ABSVALUE-1.svg" and the variant number is
the number between the '-' and the '.' in the file name.
x Required The x-location of the insertion point of the symbol on the control sheet.
This must be an integer that is on the insertion snap grid.
y Required The y-location of the insertion point of the symbol on the control sheet.
This must be an integer that is on the insertion snap grid.

Parent

AddFunction

Example
<AddAlgorithm function-name="AVALGEN" symbol-id="1" x="1440"
y="400" />

408 OW350_80
21.5 AddFunction

21.5 AddFunction

Description

The AddFunction command builds a new functional sheet. It contains the child elements that
describe the functional sheet contents.

Syntax

<AddFunction attributes> children </AddFunction>

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

cb-function-id Required Number of the control function drawing as a zero-filled, four-


character, uppercase hexadecimal number. The saved sheet will
have this name with the extension .svg.
cb-drop-id Required Number (1-255) of the Controller drop for the function
cb-task-id Required Number (1-5) of the task within the function will execute.

cb-sheet-number Optional Number that will be displayed on the sheet. Maximum 38


characters.
cb-sheet-title Optional Descriptive title of the sheet. Maximum 38 characters.
cb-engineer Optional Name of the engineer that created the sheet.
cb-revision Optional Revision number of the sheet.

Children
 AddAlgorithm
 SelectAlgorithm
 AddSignal
 BreakTracking

Parent

None -- AddFunction is a root element.

Example
<AddFunction cb-function-id="068D" cb-drop-id="2" cb-task-id="2"
cb-sheet-number="216" cb-sheet-title="T22 FILT1 BWS VALVE CLOSED"
cb-engineer="John Doe" cb-revision="A">

OW350_80 409
21.6 AddLine

21.6 AddLine

Description

The AddLine command allows a line to be added to the sheet.

Syntax

<AddLine attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

x1 Required x-location of the start of the line.


y1 Required y-location of the start of the line.
x2 Required x-location of the end of the line.
y2 Required y-location of the end of the line.
line-style Optional Line style is one of the following: solid (default), dashed, dash-dot or
dash-dot-dot.
stroke-width Optional Line width – maximum 10.
stroke-color Optional Color of the line.

Parent

AddFunction

Example
<AddLine x1="2040" y1="1000" x2="3000" y2="1000" line-
style="dash-dot" stroke-width="9" stroke-color="red" />

410 OW350_80
21.7 AddPin

21.7 AddPin

Description

The AddPin command inserts a pin on the selected algorithm. The insertion point must be located
so that the other end of the pin, considering the width and height, will be on a visible part of the
symbol body.

Note: The AddPin command is not required if the symbol already has the pin defined.

Syntax

<AddPin attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

parameter Required Name of the pin attribute of the symbol.


x Required x-location specifies the insertion point of the pin.
y Required y-location specifies the insertion point of the pin.
width Required Signed integer that specifies the x-extent of the pin.
height Required Signed integer that specifies the y-extent of the pin.

Parent

SelectAlgorithm

Example
AddPin parameter="IN3" x="1620" y="1590" width="30" height="00"
/>

OW350_80 411
21.8 AddSegment

21.8 AddSegment

Description

The AddSegment command specifies the downstream end of the segment of a signal. The
segment starts at either the location specified by the AddSignal command or the previous
AddSegment command. The final AddSegment command within an AddSignal element must be
on the input end of an input signal pin.

Syntax

<AddSegment attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

x Required x- and y-locations of the end of this segment of the signal.


y Required x- and y-locations of the end of this segment of the signal.

Parent

AddSignal

Example
<AddSegment x="1800" y="1500" />

412 OW350_80
21.9 AddSignal

21.9 AddSignal

Description

The AddSignal element specifies signal interconnections between algorithm pins or other signals.
Signals are specified in the direction of signal flow, from output to input. At least one AddSegment
element must be provided.

Attributes

<AddSignal attributes> children </AddSignal>

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

x Required x- and y-locations specify the origin point of the signal and must be either
the end of a previously specified output pin or a point on a previously
specified signal line.
y Required x- and y-locations specify the origin point of the signal and must be either
the end of a previously specified output pin or a point on a previously
specified signal line.

Parent

AddFunction

Children

AddSegment

Example
<AddSignal x="1800" y="480" >

OW350_80 413
21.10 AddText

21.10 AddText

Description

The AddText command allows general text to be added to the functional sheet unrelated to the
control specification. The location is based on the bottom left.

Syntax

<AddText attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

x Required x-location of the text on the sheet.


y Required y-location of the text on the sheet.
content Optional Content of the text to be added.
font-family Optional Font family.
font-size Optional Font size in points
rotation Optional Rotation of the text – degrees clockwise from horizontal.
font-style Optional Style of the font. The choices are normal or italic.
font-weight Optional Weight of the font. The choices are normal or bold.
font-color Optional The color of the font. The default is black.
font-decoration Optional The decoration of the font. The choices are normal (default),
underline, and overline.

Parent

AddFunction

Example
<AddText x="2300" y="1800" content="Here is some Text!" font-
family="Broadway" font-size="36" rotation="45" font-syle="normal"
font-weight="bold" font-color="green" font-decoration="underline"
/>

414 OW350_80
21.11 BreakTracking

21.11 BreakTracking

Description

The BreakTracking command disconnects tracking from a signal. It specifies the end of the
originating pin of the signal.

Syntax

<BreakTracking attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

x Required Integer that specifies the x-location of the end of the source pin.
y Required Integer that matches the y-location of the end of the source pin.

Parent

AddFunction

Example
<BreakTracking x="1700" y="1650"/>

OW350_80 415
21.12 OpenFunction

21.12 OpenFunction

Description

The Open Function command allows an existing sheet to be opened for editing. Once the function
is opened, algorithms can be added, new and existing algorithms can be edited, pins, signals, text
and lines can be added and tracking broken. The children are the same as for AddFunction (see
page 409).

Attributes other than the function id can be changed by supplying their values.

Syntax

<OpenFunction attributes > children </OpenFunction>

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

filename Required Name (including .svg) of the control function drawing to be


opened for editing.
cb-sheet-number Optional Number that displays on the sheet. A maximum of 24 characters
is allowed.
cb-sheet-title Optional Descriptive title of the sheet. A maximum of 48 characters is
allowed.
cb-engineer Optional Name of the engineer that created the sheet.
cb-revision Optional Revision number of the sheet.

Children
 AddAlgorithm
 SelectAlgorithm
 AddSignal
 BreakTracking

Parent

None - OpenFunction is a root element.

Example
<OpenFunction filename="068D.svg" cb-sheet-number="217" cb-sheet-
title="T22 FILT1 BWS VALVE CLOSED - Edited" cb-engineer="Jane
Doe" cb-revision="B" >

416 OW350_80
21.13 RouteSignal

21.13 RouteSignal

Description

The RouteSignal command creates a signal and routes it from the output pin of a source
algorithm to an input pin of a destination algorithm. This routing is functionally correct, but may
overlap other sheet content. More than one signal can be routed from a source pin. The
algorithms and pins must be constructed before this command can be executed.

Syntax

<RouteSignal attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

x1 Required x-location of the source algorithm.


y1 Required y-location of the source algorithm.
pin-name-1 Required Pin name of the source of the signal
x2 Required x-location of the destination algorithm.
y2 Required y-location of the destination algorithm.
pin-name-2 Required Pin name of the destination of the signal.

Parent

AddFunction

Example
<RouteSignal x1="1700" y1="1600" x2="1700" y2="2500" pin-name-
1="OUT" pin-name-2="IN" />

OW350_80 417
21.14 SelectAlgorithm

21.14 SelectAlgorithm

Description

The SelectAlgorithm command selects an algorithm or macro that has already been inserted by
an <AddAlgorithm> command. The particular algorithm is designated by the x and y parameters
which must match the x and y parameters of the <AddAlgorithm> command.

Syntax

<SelectAlgorithm attributes> children </SelectAlgorithm>

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

x Required Integer that matches the x parameter of a previous <AddAlgorithm >


element.
y Required Integer that matches the y parameter of a previous <AddAlgorithm >
element.

Children
 AddPin
 SetValue

Parent

AddFunction

Example
<SelectAlgorithm x="1700" y="1600">

418 OW350_80
21.15 SetValue

21.15 SetValue

Description

This command sets parameter values for the selected algorithm. Algorithm default values do not
need to be specified. The names of the parameters and the types of the values must be
compatible with the algorithm specifications in template.tft.

Syntax

<SetValue attributes />

Attributes

ATTRIBUTE REQUIRED/ DESCRIPTION


OPTIONAL

name Required Uppercase name of the parameter.


value Required Value of the parameter which may be a decimal integer, real number,
or a string as appropriate for that name. If the string represents a point
name, it must be uppercase.

Parent

SelectAlgorithm

Example
SetValue name="OUT" value="INPUT_OUTPUT" />

21.16 Example 1 of Control Builder Scripting Facility file -


AddFunction root element

This produces a sheet called 068D.svg.


<AddFunction cb-function-id="068D" cb-drop-id="2" cb-task-id="2"
cb-sheet-number="216"
cb-sheet-title="T22 FILT1 BWS VALVE CLOSED" cb-engineer="John
Doe" cb-revision="A">
<AddAlgorithm function-name="AVALGEN" symbol-id="1" x="1440"
y="400" />
<AddAlgorithm function-name="INPUT" symbol-id="1" x="1800"
y="400" />
<AddAlgorithm function-name="SUM" symbol-id="0" x="1700"
y="1600" />
<AddAlgorithm function-name="OUTPUT" symbol-id="1" x="1700"
y="2500" />
<AddAlgorithm function-name="OUTPUT" symbol-id="1" x="2000"
y="2500" />
<SelectAlgorithm x="1440" y="400">
<SetValue name="OUT" value="AVALGEN_OUTPUT" />
</SelectAlgorithm>

OW350_80 419
21.17 Example 2 of Control Builder Scripting Facility file - Openfunction root element

<SelectAlgorithm x="1800" y="400">


<SetValue name="OUT" value="INPUT_OUTPUT" />
</SelectAlgorithm>
<SelectAlgorithm x="1700" y="1600">
<SetValue name="OUT" value="SUM_OUTPUT" />
</SelectAlgorithm>
<RouteSignal x1="1440" y1="400" x2="1700" y2="1600" pin-name-
1="OUT" pin-name-2="IN1" />
<RouteSignal x1="1700" y1="1600" x2="1700" y2="2500" pin-
name-1="OUT" pin-name-2="IN" />
<AddSignal x="1800" y="480" >
<AddSegment x="1800" y="1500" />
<AddSegment x="1720" y="1500" />
<AddSegment x="1720" y="1550" />
</AddSignal>
<AddLine x1="2040" y1="600" x2="2040" y2="1000" />
<AddLine x1="2040" y1="1000" x2="3000" y2="1000" line-
style="dash-dot"
stroke-width="9" stroke-color="red" />
<AddText x="2300" y="1800" content="Here is some Text!" font-
family="Broadway" font-size="36"
rotation="45" font-syle="normal" font-weight="bold" font-
color="green" font-decoration="underline" />
<SelectAlgorithm x="1700" y="1600" >
<AddPin parameter="IN3" x="1620" y="1590" width="30"
height="00" />
</SelectAlgorithm>
<AddSignal x="1700" y="1740" >
<AddSegment x="1500" y="1740" />
<AddSegment x="1500" y="1590" />
<AddSegment x="1620" y="1590" />
</AddSignal>
<AddSignal x="1700" y="2120" >
<AddSegment x="2000" y="2120" />
<AddSegment x="2000" y="2430" />
</AddSignal>
</AddFunction>

21.17 Example 2 of Control Builder Scripting Facility file -


Openfunction root element

This example includes two files. The first produces a sheet 068D.svg and the second edits the
sheet.
<OpenFunction filename="068D.svg" cb-sheet-number="217" cb-sheet-
title="T22 FILT1 BWS VALVE CLOSED - Edited" cb-engineer="Jane
Doe" cb-revision="B" >
<SelectAlgorithm x="1700" y="1600" >
<SetValue name="OUT" value="NEW_OUTPUT" />
</SelectAlgorithm>
<BreakTracking x="1700" y="1650"/>
</OpenFunction>

420 OW350_80
Index

Algorithm ordering - change while in view


7 mode • 134
7 x 9 ladders (adding contacts, coils, and Algorithm ordering - print • 137
wires) • 395 Algorithm ordering - view • 132
7 x 9 ladders (adding special functions) • Algorithm parameters - editing • 128
394 Algorithm right-click menu • 128
7 x 9 ladders (best practices for designing) • Algorithm symbols - creating • 233
392 Algorithm symbols - reasons to create • 233
7 x 9 ladders (compressing) • 391 Algorithm Value function • 137
7 x 9 ladders (Deselect All function) • 397 Algorithm Value function - changing in
7 x 9 ladders (erase cells in Ladder window) Property Editor • 139
• 396 Algorithm Value function - using • 137
7 x 9 ladders (executing) • 390 Algorithm Value Indicators • 148
7 x 9 ladders (exporting ladder file) • 396 Algorithm Value Indicators - change using
7 x 9 ladders (import ladder file) • 396 Property Editor • 149
7 x 9 ladders (Select All function) • 397 Algorithm Value Indicators - adding • 148
7 x 9 ladders (using check point function) • Algorithm Values - organizing and
395 standardizing • 143
Algorithms • 123
A Algorithms - adding • 125
Algorithms - deleting • 130
Accessing and configuring the Ovation
Algorithms - move using anchors • 131
Control Builder • 27
Algorithms that support tracking • 379
Accessing functions from the Control Builder
Assigning component codes to a document •
main window • 37
78
Accessing sheets from a remote network
Audit function • 108
from a Point Menu • 349
Accessing the Control Builder in a Windows- B
based Ovation system • 27
Accessing the Ovation Control Builder • 27 BALANCER algorithm sheet examples • 162
Accessing the signal diagram window right- Best practices for creating algorithm
click menus • 321 symbols • 233
Accessing the SIS Tuning window for SIS Best practices for creating shapes for the
algorithms • 324 shape directory • 222
Add Algorithm window • 124 Best practices for using algorithms • 124
Adding an SIS control sheet to the SIS Best practices for using control signals • 180
Ovation system • 359 Best practices for using page connectors •
Adding comments (static text) to Control 185
Builder documents • 188 Best practices for using SIS algorithms on a
Adding SIS algorithms to a sheet • 361 sheet • 357
Adding text to simple graphics • 219 Best practices for using the Algorithm Value
Algorithm anchor alignment functions • 131 function • 137
Algorithm anchor spacing functions • 131 Best practices for using the Import Tool •
Algorithm anchors • 130 225
Algorithm anchors - modifying location • 130 Building control sheets • 95
Algorithm anchors - signal rerouting • 132
C
Algorithm Details report example • 116
Algorithm icons • 127 CALCBLOCK algorithm • 158
Algorithm ordering • 132 CALCBLOCK Editor - using • 159
Algorithm ordering - auto to manual • 133 Changing control sheet execution order •
Algorithm ordering - change from manual to 112
auto • 136

OW350_80 421
Index

Clearing the force value and leave Debug Copy operation (using) • 256
Mode • 338 Copyright Notice • 2
Compile operation • 250 Create a supplemental document from a link
Compile operation (add and delete output • 89
point names) • 255 Creating a new control sheet • 96
Compile operation (create new point map Creating a new control sheet in a Windows-
file) • 253 based Ovation system • 96
Compile operation (Find and Replace in Creating a new SIS sheet • 358
point map file) • 255 Creating a simple graphic in the Control
Compile operation (using) • 250 Builder • 216
Component code examples • 69 Creating custom algorithm symbols • 233
Component code reference hyperlinks • 90 Creating Ovation cabinets • 17
Component codes • 69 Cut, Copy, and Paste functions • 229
ComponentFieldDefinition.txt file • 75
ComponentFieldDefinition.txt file - adding D
tgo Control Builder • 77 Defining the control application • 16
Configuring component codes for signal Defining the I/O modules • 17
diagrams • 74 Defining the system I/O • 17
Configuring component codes in the Control Deleting control sheets in a Windows-based
Builder • 73 Ovation system • 108, 109
Configuring digital signal and algorithm Deleting objects • 229
colors • 290 Diagrams in planning control • 11
Configuring General Diagram colors • 288 Document hierarchy • 68
Configuring information in Control Builder Document Value function • 189
title box fields • 98 Document Value function - using • 189
Configuring non-digital algorithm colors • Document Values - changing in Property
293 Editor • 190
Configuring non-digital signal colors • 292 Draw menu • 40
Configuring point quality tags • 297 Drawing a curve • 218
Configuring point scan rates • 298 Drawing a line • 218
Configuring Signal Diagram colors • 285 Drawing a polygon • 217
Configuring signal point value labels • 295 Drawing a rectangle • 217
Configuring the BALANCER algorithm with Drawing an ellipse • 218
MASTATIONs • 160 Drawing canvas editing functions • 227
Configuring the Control Builder • 29 Drawing simple graphics • 215
Connecting SIS sheets • 373 Drawing toolbar • 46
Connector information report example • 117
Control Builder error message descriptions E
control builder error messages and
Edit context menu • 230
descriptions • 400
Edit menu • 38
Control Builder main window • 34
Editing the frame.svg file • 24
Control Builder menus • 37
Elements of a control sheet • 177
Control Builder operations • 241
Emerson code example • 73
Control Builder terminology • 6
Error List window • 399
Control design best practices • 15
Error List window and field descriptions
Control functions (control sheets) • 19
control builder error messages and
Control library • 237
descriptions and more descriptions • 399
Control library - creating • 237
Example 1 of Control Builder Scripting
Control planning process • 10
Facility file - AddFunction root element •
Control project scope • 16
419
Control sheet building best practices • 95
Example 2 of Control Builder Scripting
Control task area • 20
Facility file - Openfunction root element •
Control tasks cycle time • 21
420
Control types supported in Ovation • 3
Executing the xml file • 406
Copy operation • 256
Execution order • 112
Copy operation (example of copying control)
Execution Order report example • 118
• 260
Export operation • 260

422 OW350_80
Index

Export operation (using) • 260 Ladder types supported in Control Builder •


Exporting control logic to a library • 238 385
External web hyperlinks • 87 Ladders (auditing) • 397
Ladders (free-form) • 387
F Linking Control Builder documents • 67
Favorites Folder - creating a shared folder • Loading sheets in a Windows-based Ovation
158 system • 121
Favorites Folder right-click menu • 155
M
Favorites Folder toolbar • 154
Favorites window • 154 Macro Interface Editor window • 174
Favorites window - accessing • 154 Macro Interface Editor window - editing
Favorites window - adding a folder • 157 parameters • 175
Favorites window - adding symbols • 156 Macro Interface Editor window - Find and
File menu • 37 Replace • 175
Find Points function • 200 Macro Interface Editor window - view errors •
Find Points function - using • 200 176
Forcing an algorithm input value • 331, 332 Macro Interface Editor window and field
Format of the XML file • 406 descriptions • 174
Frame • 23 Macros • 165
Free-form ladder rules • 387 Macros - add to a sheet • 169
Free-form ladders (building) • 387 Macros - create a ControlMacro folder • 166
Free-form ladders (extend orbar or rail) • 388 Macros - create a symbol • 167
Function Generator Graph • 164 Macros - define in Control Builder • 166
Functions of Ovation SIS • 356 Macros - display in Signal Diagrams • 173
Macros - modifying • 173
G Macros - requirements • 166
Grouping objects using the Object Browser • Making configuration changes to view
55 sheets from a remote network • 350
Managing your Control Builder operations •
H 241
Moving objects • 228
Help menu • 43
How do I configure component codes? • 73 N
Hyperlinks • 86
Navigation menu • 304
I Navigation toolbar • 302
Numbering control sheets • 22
Import operation • 262
Import operation (using) • 262 O
Import Tool • 225
Import Tool - importing a shape • 225 Object Browser • 49
Importing a document into a control sheet • Object Browser - editing objects • 54
237 Object Browser containers • 50
Importing a library into a control sheet • 238 Object Browser right-click menu • 52
Importing control logic • 237 Object Browser toolbar • 51
Information and error messages • 399 Oil diagrams • 12
Introduction to Ovation Control Builder • 1 Online help system • 62
Opening a locked control sheet • 104
K Opening a recovered version of a file • 106
Opening a sheet in the Signal Diagram
Keyboard shortcuts • 47
window • 299
KKS code example -- 2, 3, 2, 2, 3 pattern •
Opening an existing control sheet • 99
71
Opening an existing control sheet using
KKS code example -- 2, 3, -2, 2, 3 pattern
component code layout • 102
(one ignored field) • 72
Opening an existing control sheet using drop
KKS code example - 2, 5, 5 pattern • 70
layout • 100
L Opening an SIS sheet in the Control Builder
• 360
Ladder items • 385

OW350_80 423
Index

Ovation Control Builder definition • 4


Ovation control definition • 2 R
Overview of building sheets for Ovation Reconcile operation • 268
systems • 96 Reconcile operation (using) • 268
P Reconciling tuning changes between the
Controller and the database for Windows-
Page connector descriptions • 186 based Ovation systems • 341
Page connectors • 185 Reconciling tuning changes in a Windows-
Page connectors - deleting • 188 based Ovation system • 341
Page connectors - determining where to use Recovering multiple files • 107
• 188 Related component codes • 84
Page connectors - output connectors • 188 Replacing a macro reference • 170
Page connectors - using on sheets • 186 Reusing control sheets • 114
Pins • 177 Revert function • 106
Pins - adding • 177 Revert function - using • 106
Pins - deleting • 179 Revision control • 98
Pins - moving • 179 Role of the Control Builder in Ovation • 5
Piping and instrumentation diagrams (P&ID)
• 12 S
Planning and Designing Ovation Control • 9 Saving a control sheet • 108
Planning control best practices • 9 Scripting Facility • 405
Plant process schematics • 13 Scripting Facility (AddAlgorithm parameter) •
Point Description display - changing in 408
Property Editor • 203 Scripting Facility (AddFunction parameter) •
Point Description function • 201 409
Point Description function - adding • 201 Scripting Facility (AddLine parameter) • 410
Point Editor window • 195 Scripting Facility (AddPin parameter) • 411
Point Editor window - Find and Replace Scripting Facility (AddSegment parameter) •
panel • 198 412
Point Editor window - modifying point names Scripting Facility (AddSignal parameter) •
• 196 413
Point Editor window fields and descriptions • Scripting Facility (AddText parameter) • 414
195 Scripting Facility (BreakTracking parameter)
Point reference - adding • 206 • 415
Point reference - changing in Property Editor Scripting Facility (OpenFunction parameter)
• 208 • 416
Point Reference function • 206 Scripting Facility (RouteSignal parameter) •
Point security groups • 199 417
Point security groups - assigning in the Scripting Facility (SelectAlgorithm
Control Builder • 199 parameter) • 418
Point status indicator - adding • 211 Scripting Facility (SetValue parameter) • 419
Point status indicator - changing in Property Selecting and deselecting objects • 228
Editor • 212 Seting a new forced algorithm input value •
Point Status Indicator function • 210 336
Points - creating in Control Builder • 193 Setting Control Builder configuration
Print Ladder(s) report • 119 parameters • 29
Print operation • 265 Setting tracking between algorithms • 183
Print operation (using) • 265 Setting tracking between sheets • 184
Printing Control Builder reports • 115 Setting tracking signals • 382
Printing control sheets • 115 Shape Directory • 222
Property Editor fields for simple draw items • Shape Directory - creating a shape • 222
219 Signal Diagram (display canvas colors) • 308
Property Editor window • 56 Signal diagrams • 281
Publish operation • 266 Signal diagrams (accessing from a Point
Publish operation (using) • 266 Menu) • 284
Publish supplemental documents • 92 Signal diagrams (accessing from Ovation
Applications window) • 283

424 OW350_80
Index

Signal diagrams (accessing from the Control To add a 7 x 9 ladder to a control sheet •
Builder) • 284 392
Signal Diagrams (accessing) • 282 To add a graph to a FUNCTION algorithm •
Signal Diagrams (display canvas) • 305 164
Signals • 179 To add an extended algorithm tag for the
Signals - adding • 180 LSCALC algorithm • 363
Signals - bending • 183 To add an SIS algorithm to a control sheet •
Signals - deleting (breaking) • 182 361
Signals - moving • 183 To assign a component code to a document
Signals - tips for adding • 181 in the Control Builder • 79
SIS Tuning window for the LSCALC To assign component codes to multiple
algorithm • 325 sheets in the Developer Studio • 81
SIS Tuning window for the LSCEM algorithm To change the default Signal Diagram colors
• 326 • 287
SIS Tuning window for the LSSEQ algorithm To clear all tracking on a sheet • 184
• 328 To configure the online sync program to
SIS Tuning window for the LSSTD algorithm synchronize signal diagrams on remote
• 330 networks • 347
Software platforms that Control Builder To connect control signals from the right-
supports • 6 click menu • 181
Standard toolbar • 45 To copy files from a remote network to a
Standardize Text operation • 271 local network • 351
Standardize Text operation (using) • 271 To create a custom style template for control
Storing control sheets in a Windows-based sheets • 61
Ovation system • 110 To delete a component code from the
Storyboarding for control • 13 Developer Studio • 84
Style Editor window • 58 To display a specific version of a sheet • 313
Style Editor window - using • 60 To display algorithm and point information
Style Editor window and field descriptions • using the right-click menu • 310
58 To display an additional Signal Diagram
Style operation • 274 window • 311
Style operation (using) • 274 To edit a 7 x 9 ladder • 393
Subdividing your control application • 16 To edit a control macro in the Control Builder
Supplemental document hyperlinks • 88 • 170
Supplemental documents • 91 To explode a macro on a Signal Diagram
Supplemental documents - editing • 91 window • 313
Symbol Browser window • 150 To find and replace comment text • 221
Symbol Browser window - using • 150 To install macros from another system • 168
System expansion planning • 14 To open a sheet in the Signal Diagram
window • 300
T To open an SIS sheet in the Control Builder
Tag names for internal point names • 114 • 360
Text Attributes toolbar • 46 To organize algorithm values in the Object
Title Page report • 119 Browser • 143
To access the LSCALC advanced editor To reconcile tuning changes between the
window • 365 database and the Control Builder • 342
To access the LSCEM advanced editor To refresh the Open Document hierarchy
window • 366 tree • 300
To access the LSSEQ advanced editor To replace a macro reference • 171
window • 368 To run the cbLoader program • 353
To access the LSSTD advanced editor To search for a sheet in the Open
window • 370 Documents window • 301
To access the Point Menu from the Ladder To standardize the appearance of algorithm
Viewer • 344 values • 144
To access the Signal Diagram Viewer To tune algorithm parameters • 323
Configuration window • 285

OW350_80 425
Index

To use the Algorithm Summary window and Using Nonsecure parameter algorithms •
Function Summary window right-click 372
menus • 322 Using Secure parameter algorithms • 372
To use the Choose files window • 245 Using signal diagrams at the Operator
To use the Copy operation Find and Station • 281
Replace function • 259 Using the Control Builder Scripting Facility •
To use the Event Log right-click menu • 321 405
To use the Macro Filter option • 247 Using the Control Builder to create
To use the Synchronize Online function • permissive windows • 120
279 Using the Control Builder What's This
To use the What's This function • 65 function • 64
Toolbars • 44 Using the Full View option in the Control
Tools menu • 42 Builder • 231
Tracking • 376 Using the online sync program to
Tracking (best practices) • 378 synchronize signal diagrams from remote
Tracking (purpose of) • 376 networks • 346
Tracking examples • 381 Using the signal diagram Algorithm Control
Tracking process • 377 window • 319
Tuning algorithms • 323 Using the signal diagram Algorithm
Summary window • 316
U Using the signal diagram Event Log window
Understanding algorithms and algorithm • 315
components • 123 Using the signal diagram Function Summary
Understanding basic Control Builder window • 317
concepts • 19 Using the signal diagram Properties
Understanding Control Builder windows, Summary window to tune algorithms • 320
menus, and toolbars • 33 Using the Zoom In and Zoom Out in the
Understanding how the Control Builder Control Builder • 232
searches in Windows-based Ovation V
systems • 26
Understanding icons on the Signal Diagram View menu • 40
display canvas • 309 Viewing algorithm information in a Signal
Understanding multiple network terminology Diagram window • 306
• 345 Viewing sheets from a remote network on a
Understanding points in the Control Builder • local Signal Diagram window • 348
193 Viewing sheets on a remote network • 345
Understanding Safety Instrumented Systems Viewing SIS Tuning windows for SIS
(SIS) • 355 algorithms • 324
Understanding SIS algorithms with
advanced editor windows • 365 W
Understanding the Control Builder What are 7 x 9 ladders? • 389
operations window sequence • 242 What are permissive windows? • 120
Understanding the elements of a control What are the best practices for using signal
sheet • 177 diagrams? • 282
Understanding the Select file to open What are the Signal Diagram windows? •
window • 99 314
Understanding the Signal Diagram What functions are provided by signal
Navigation toolbar and menu • 302 diagrams? • 281
Understanding the Synchronize Online What is a Safety Instrumented System? •
Directories window • 277 355
Understanding tracking • 375 What is Ovation multiple networking? • 345
Understanding when online graphics and What is the Ladder Viewer? • 344
control are mismatched • 307 What is the role of the Control Builder in a
Undo/Redo function • 230 Safety Instrumented System? • 357
Using control libraries • 237 What is the Synchronize Online function? •
Using ladder control logic • 385 277
Window menu • 43

426 OW350_80
Index

Z
Zoom function • 231
Zoom Window View function • 231

OW350_80 427

Potrebbero piacerti anche