Application Server User Guide

© 2019 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVEVA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int elaTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, Si mCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: Saturday, May 25, 2019
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to cont act sales, customer training, and technical support, see
https://sw.aveva.com/contact.
 Application Server User Guide

Contents
Chapter 1 IDE Overview ..................................................................................................... 17
What’s a Galaxy?.................................................................................................................... 17
Start the ArchestrA IDE ........................................................................................................... 18
Install and Activate Your Licens e ........................................................................................ 18
Manage Security Certificate Verification .............................................................................. 18
Create a Galaxy ...................................................................................................................... 18
Connect to a Galaxy................................................................................................................ 21
IDE Views and Toolboxes ........................................................................................................ 22
Templat e Toolbox ............................................................................................................. 23
Graphics Toolbox .............................................................................................................. 25
IDE Application Views........................................................................................................ 27
Object Icons ................................................................................................................ 28
Model View ................................................................................................................. 29
Deployment View ........................................................................................................ 31
Derivation View ........................................................................................................... 32
IO Devic es View .......................................................................................................... 33
IO Devic e Mapping View .............................................................................................. 34
Operations View .......................................................................................................... 34
Customizing Your Workspace .................................................................................................. 35
Dock Views ....................................................................................................................... 35
Float Views ....................................................................................................................... 35
Hide Views ....................................................................................................................... 36
Reset the Workspac e ........................................................................................................ 36
Synchronize Views ............................................................................................................ 36
Configure User Information ................................................................................................ 37
Log on with Security Enabled ............................................................................................. 38
Change Users ................................................................................................................... 39

Chapter 2 Introduction to Objects ..................................................................................... 41

About Templates and Instances ............................................................................................... 41
Instances .......................................................................................................................... 42
Templat es......................................................................................................................... 42
Propagation ...................................................................................................................... 43
About Base Templates ...................................................................................................... 43
Application Templat es.................................................................................................. 45
Device Integration Templates ....................................................................................... 45
System Templates ....................................................................................................... 45
About Derived Templates .................................................................................................. 46
View Object Properties ............................................................................................................ 47

Work with Objects .................................................................................................................. 49

Manage Toolsets .................................................................................................................... 49
Create Toolsets................................................................................................................. 50

3
Application Server User Guide Contents

Create Child Toolsets ........................................................................................................ 50

Deleting Toolsets .............................................................................................................. 51
Manage Galaxy Style Libraries ................................................................................................ 51
Import a Galaxy Style Library ............................................................................................. 51
Export a Galaxy Style Library ............................................................................................. 52
Reset a Pre-Defined or User-Defined Galaxy Style Library ................................................... 52
Create Derived Templates ....................................................................................................... 52
Derive Templates from Another Derived Template ............................................................... 53
Create Contained Templates ................................................................................................... 54
ApplicationObject Containment .......................................................................................... 55
Using Contained Names .................................................................................................... 59
Cont ainment Examples ...................................................................................................... 60
View Containment Relationships ........................................................................................ 62
Rename Contained Objects ............................................................................................... 62
Edit Objects ............................................................................................................................ 63
Object Editor Us er Assistance ............................................................................................ 64
Help File Structure ....................................................................................................... 64
About the General Editor Layout ........................................................................................ 65
Lock and Unlock Template Attributes ............................................................................ 65
Set Object Security ...................................................................................................... 68
Group Locking/Security ................................................................................................ 69
About the Attributes Page .................................................................................................. 69
About the Scripts Page ...................................................................................................... 74
About the Object Information Page ..................................................................................... 75
Customize Help ........................................................................................................... 76
Locate the Help Folders ............................................................................................... 76
About the Field Attributes, UDAs, and Extensions Pages ..................................................... 76
View the Field Attributes Page...................................................................................... 77
Determine Whether to Convert Field Attributes .............................................................. 77
Optimize Performance if You Use Field Attributes .......................................................... 78
Convert Field Attributes to Attributes................................................................................... 78
Special Considerations when Converting Field Attributes ............................................... 81
Limitations and Exclusions when Converting Field Attributes .......................................... 82
Update Scripts to Referenc e Converted Attributes ......................................................... 82
Referenc e Objects Using the Galaxy Browser ..................................................................... 83
Browse for Attributes ............................................................................................................... 83
Browse with an A rchestrA OPC UA Client ........................................................................... 85
View Attribute Details in the Galaxy Brows er ....................................................................... 85
Browse for Graphics................................................................................................................ 87
Browse for Element Properties ................................................................................................. 88
Create a Filter for the Galaxy Browser ...................................................................................... 89
Change How Information is Shown in the Galaxy Browser ......................................................... 91

Manage Objects ..................................................................................................................... 93

Check Out Objects .................................................................................................................. 93
Check In Objects .................................................................................................................... 93
Validate Objects...................................................................................................................... 94
Validate Scripts and Other External Components ................................................................ 94

4
Contents Application Server User Guide

Validate an Object Manually............................................................................................... 95

Create an Instance.................................................................................................................. 95
Rename an Object .................................................................................................................. 96
Delet e an Object ..................................................................................................................... 97
Export Objects ........................................................................................................................ 98
Protecting Objects on Export .............................................................................................. 98
About Protecting Objects on Export .............................................................................. 98
Exporting Objects as Protected .................................................................................. 100
Exporting Objects with I/O Auto Assignment ..................................................................... 100
Exporting Script Function Libraries ................................................................................... 100
Importing Objects .................................................................................................................. 101
Importing Protected Objects ............................................................................................. 103
Importing Objects with I/O Aut o Assignment ...................................................................... 104
Importing a SQLData Object ............................................................................................ 104
Importing Script Function Libraries ................................................................................... 105
Importing Client Controls ................................................................................................. 105
Importing an App from the AVEVA Digital Exchange .......................................................... 106
Importing ArchestrA Apps ................................................................................................ 106
Add a Control from an A rchestrA App to a ViewApp ..................................................... 108
Configurable Properties in ArchestrA Apps .................................................................. 108
ArchestrA App Development Guidelines ...................................................................... 110
ArchestrA App Limitations and Restrictions ................................................................. 111
Troubleshooting ArchestrA or WPF Apps that Fail to Import ......................................... 112
After You Import .............................................................................................................. 112

Configure Objects................................................................................................................. 115

Add Attributes to an Object .................................................................................................... 115
Configure an Attribute...................................................................................................... 117
Attribute Naming Conventions .......................................................................................... 118
Attributes and Scripting.................................................................................................... 119
Adding Features to Attributes ................................................................................................. 120
About Features Inheritance .............................................................................................. 120
Using the I/O Feature ...................................................................................................... 121
Configure I/O as Read-only ........................................................................................ 123
Configure I/O as Read/Write ...................................................................................... 124
Configure I/O as Write-only ........................................................................................ 126
Quality of Read, Read/Write, and Write I/O ................................................................. 129
Configure I/O for Use with AVEVA Telemetry Server Communic ation Drivers ................ 129
Using the History Feature ................................................................................................ 130
Using the Limit Alarms Feature ........................................................................................ 133
Using the ROC Alarms Feature ........................................................................................ 134
Using the Deviation Alarms Feature ................................................................................. 135
Using the State Alarm Feat ure ......................................................................................... 137
Using the Bad Value Alarms Feature ................................................................................ 138
Using the Statistics Feature ............................................................................................. 138
Using the Log Change Feat ure......................................................................................... 140
Using I/O Auto Assignment .................................................................................................... 140
Assigning Areas and Objects to Scan Groups ................................................................... 142
Renaming Application, System, and DI Objects ........................................................... 143
Renaming Scan Groups ............................................................................................. 143
Validating and Editing I/ O Assignments ............................................................................ 143

5
Application Server User Guide Contents

Using the IO Mapping View ........................................................................................ 145

Validating I/O References .......................................................................................... 147
Overriding I/O Auto Assignments ................................................................................ 147
Overriding Large Numbers of Attributes ...................................................................... 148
Uploading Run-Time Configuration Changes for Auto Assigned Objects ....................... 149
I/O Auto Assignment Workflow Example ........................................................................... 149
Using I/O Auto Assignment wit h OPC Clients .................................................................... 150
Override Scenario 1 — Siemens S7 Cont rollers with an OPC UA Client ........................ 151
Override Scenario 2 — Allen-B radley CIP Controllers with an OPC UA Client ............... 152
Writing and Editing Scripts ..................................................................................................... 152
About Scripts .................................................................................................................. 153
Script Execution .............................................................................................................. 154
Script Locking and Change Propagation ........................................................................... 156
Creating and Working with Content ........................................................................................ 157
Adding Graphics Items .................................................................................................... 158
Errors and Warnings in an Owned Graphic ....................................................................... 159
Modifying Graphics.......................................................................................................... 159
Set Graphics Properties with a Galaxy Style Library .......................................................... 160
Use Element Styles to Modify Graphics....................................................................... 160
Use Quality and Status Styles to Provide Run-Time Feedback ..................................... 161
Use UI Themes to Set Appearance of WPF Controls ................................................... 161
Using Symbol Wizards..................................................................................................... 162
Creating Symbol Wizards ........................................................................................... 163
Embedding Symbol Wizards into an Application .......................................................... 164
Renaming Graphics......................................................................................................... 165
Deleting Graphics............................................................................................................ 165

Configure Objects with an Object Wizard ......................................................................... 167

About Object Wizards............................................................................................................ 167
Object Wizard Feat ures ................................................................................................... 169
Create a Basic Object Wizard .......................................................................................... 169
Object Wizard Configuration Best Practices ...................................................................... 172
Object Wizard GUI Panes ................................................................................................ 173
Object Wizard User Int erface Details ................................................................................ 175
Object Wizard Components ................................................................................................... 178
Choic e Groups ................................................................................................................ 178
Add a Choice Group .................................................................................................. 178
Change the Prompt for a Choice Group ...................................................................... 178
Change Choice Group Order...................................................................................... 179
Delet e a Choice Group .............................................................................................. 179
Choic es .......................................................................................................................... 180
Add a Choice to a Choice Group ................................................................................ 180
Change the Prompt for a Choice................................................................................. 180
Change the Order of Choices within a Choice Group ................................................... 181
Set a Default Choice in a Choice Group ...................................................................... 181
Delet e a Choice......................................................................................................... 182
Options ........................................................................................................................... 183
Add an Option ........................................................................................................... 183
Change the Prompt for an Option ............................................................................... 183
Change Option Order ................................................................................................ 184
Set the Default State of an Option ............................................................................... 184
Delet e an Option ....................................................................................................... 184
Add Content for Use with an Object Wizard ............................................................................ 185
6
Contents Application Server User Guide

Add a New Object-Owned Symbol .................................................................................... 186

Link to Shared Content in the Graphic Toolbox.................................................................. 186
Associate Content with a Choice or Option ....................................................................... 187
Remove an Association from a Choice or Option ............................................................... 189
Multiple Content Item Associations ................................................................................... 190
Map Attribute and Symbol Configurations to a Choice or Option ......................................... 190
About Attribute and Symbol Overrides .............................................................................. 190
Delet e Content from an Object ......................................................................................... 191
Delet e an Attribute or Symbol from a Template ................................................................. 191
Example 1: Map a Simple Symbol Wizard to an Object Wizard........................................... 192
Example 2: Configure a Linked Symbol Associated with Multiple Choices ........................... 196
Conditional Visibility Expressions for Choic e Groups, Choices, and Options ............................. 198
Add a Basic Visibility Expression ...................................................................................... 199
Add a Visibility Expression with Logical Operators ............................................................. 200
Operators, Rules, and B ehavior for Visibility Expressions ................................................... 201
Object Wizard Visibility Settings in a Derived Template ...................................................... 202
Example 1: Basic Visibility Expressions ............................................................................ 203
Example 2: Complex Visibility Expressions ....................................................................... 204
Scenario 1: Visibility of option is contingent on specific choices .................................... 205
Scenario 2: Visibility of option is contingent on a combination of choices and options ..... 206
Example 3: Visibility of Choice Groups, Choices, and Options in a Derived Object Wizard ... 208
Trimming .............................................................................................................................. 208
Enable Trimming ............................................................................................................. 209
Example: Enable Trimming for Attributes and Symbols ...................................................... 210
Attribute and Symbol Overrides.............................................................................................. 211
Enter Overrides and Set Visibililty for Attribut e and Symbol Values ..................................... 213
About Attribute and Symbol Overrides .............................................................................. 214
Configurable Settings for Attribute and Symbol Values ...................................................... 215
Add Scripts to an Object Wizard............................................................................................. 216
Associate a Script with a Choic e or Option ........................................................................ 217
Multiple Script Associations.............................................................................................. 218
Object Wizard Derivation ....................................................................................................... 218
Derive a Child Template from a Template with an Object Wizard ........................................ 218
Set Visibility of Choices and Options in a Derived Template ............................................... 219
Reas ons to Derive a Template from an Object Wizard ....................................................... 220
Changes to Object Wizards in Derived Templates ............................................................. 220
Behavior of Object Wizard Components in a Derived Template .......................................... 221
Example: Set Visibility of Derived Wizard Choices and Options .......................................... 222
Object Wizard Test Mode ...................................................................................................... 222
Verify Behavior of Visibility Expressions ............................................................................ 223
About Object Wizard Behavior in Test Mode ..................................................................... 225
Example 1: Verify Behavior of Associated Attributes .......................................................... 225
Example 2: Verify Behavior of Associated Symbols ........................................................... 227
Propagation of Object Wizard Changes to Derived Objects...................................................... 232
Object Wizard Behavior when a Default Choice is Deleted ................................................. 233
Limitations Associated with Object Wizard Propagation ..................................................... 233
Extend an Inherited Object Wizard ......................................................................................... 233
Add a Choice Group to a Derived Template ...................................................................... 233
Add an Option to a Derived Template ............................................................................... 235
Add an Assocation to an Inherited Object Wizard .............................................................. 235

7
Application Server User Guide Contents

Add a Script to a Derived Templat e .................................................................................. 236

Add a Symbol to a Derived Template ................................................................................ 237
Link to a Symbol in the Graphic Toolbox ........................................................................... 238
Symbols and Object Wizards ........................................................................................... 240
Example 1: Add a Symbol to the Object ............................................................................ 240
Example 2: Link to a Symbol in the Graphic Toolbox ......................................................... 241
Configure Instances .............................................................................................................. 242
Configure an Instanc e ..................................................................................................... 242
View and Configure Symbols ........................................................................................... 243
Guidelines for Configuring Instances with an Object Wizard ............................................... 245
Override Default Settings ................................................................................................. 245
Create a New Instance with the Configure New Asset Editor .................................................... 246
About Object Options ...................................................................................................... 250
About Graphic Options .................................................................................................... 251
Add a Configured Asset to a Symbol ...................................................................................... 252

Deploying and Running an Application ............................................................................. 253

Deployment Overview ........................................................................................................... 253
Deploying Objects from the IDE to Run Time .................................................................... 254
Allocating Run-time Res ources ........................................................................................ 255
Allocating Galaxy Repository Node Memory ...................................................................... 255
Object, Area, Engine, and Platform Assignments .................................................................... 255
Data Integration Objects ........................................................................................................ 257
Auto-Build ............................................................................................................................ 257
Determining Galaxy Status .................................................................................................... 258
Configuring Advanced Communication Management............................................................... 258
Selecting Advanced Communication Management ............................................................ 260
Configuring Scan Modes .................................................................................................. 260
Simulation Server.................................................................................................................. 262
Simulation Server and the OPCClient Object..................................................................... 263
I/O Auto Assignment in the Simulation Server ................................................................... 263
Configure the Simulation Server ....................................................................................... 264
View Simulat ed Data ....................................................................................................... 265
Unknown Data Types ...................................................................................................... 266
Deploying Objects ................................................................................................................. 267
Deployment Error Messages ............................................................................................ 270
Publishing Managed InTouch Applications ........................................................................ 270
Redeploying Objects ............................................................................................................. 270
Redeploying the WinPlat form Object ................................................................................ 271
Retentive Attribute Properties and Behavior ...................................................................... 272
Undeploying Objects ............................................................................................................. 272
Uploading Run-time Configuration.......................................................................................... 273
Uploading Restrictions ..................................................................................................... 274
Undeployment Situations ................................................................................................. 274
Associating All Galaxy Graphics with an InTouchViewApp ....................................................... 274
About Associating All Galaxy Graphics with an InTouc hViewA pp ........................................ 275
Configuring the Include All Galaxy Graphics Option ........................................................... 276

8
Contents Application Server User Guide

Working with History ............................................................................................................ 277

Application Server History Components .................................................................................. 277
Sending Historic al Data Bet ween Application Server and the Historian ............................... 278
Saving Object Attribute Data to the Historian .......................................................................... 278
Saving Process Values as Historical Data ......................................................................... 278
Saving Data Quality as Historical Data .............................................................................. 279
Additional Quality Data Saved to the Historian ............................................................. 279
Saving the Data Timestamp as Historical Data .................................................................. 280
Saving Alarms and E vents as Historical Data .................................................................... 281
Deploying and Undeploying Attribut es .............................................................................. 282
Saving Historical Data During Run Time ........................................................................... 282
Advanced Communication Management ..................................................................... 282
Store-and-Forward Mode ........................................................................................... 282
Buffered Behavior...................................................................................................... 283
Configuring Common Historical Attributes ............................................................................... 283
Configuring System Objects to Store Historical Data ............................................................... 285
Configuring the WinPlat form Object to Store Historical Data ............................................... 287
Configuring an AppE ngine Object to Store Historical Data ................................................. 288
Configuring an Area Object to Save Alarm Counts as Historical Dat a ................................. 289
Configuring Application Objects to Save Historical Dat a .......................................................... 290

Working with Alarms and Events ....................................................................................... 293

Understanding E vents ........................................................................................................... 293
Types of E vents .............................................................................................................. 293
Understanding Alarms ........................................................................................................... 295
Types of Alarms .............................................................................................................. 296
State Alarms ............................................................................................................. 296
Limit Alarms .............................................................................................................. 297
Target Deviation Alarms ............................................................................................. 298
Rate of Change Alarms .............................................................................................. 299
Statistical Alarms ....................................................................................................... 300
Setting Alarm State with Object Attributes ......................................................................... 300
AlarmModeCmd Attribute ........................................................................................... 300
AlarmInhibit Attribute ................................................................................................. 300
AlarmMode Attribut e .................................................................................................. 300
_AlarmModeEnum Attribute ....................................................................................... 301
Alarms and Buffered Data .......................................................................................... 301
Setting Alarm State for Individual Alarms .......................................................................... 301
Enabling, Silencing, and Dis abling Alarms ........................................................................ 302
Enabling Alarms ........................................................................................................ 304
Silencing Alarms........................................................................................................ 304
Disabling Alarms ....................................................................................................... 304
Shelving Alarms .............................................................................................................. 304
Enabling Alarm Shelving ............................................................................................ 305
Shelving Alarms at Run Time ..................................................................................... 306
Throttling Alarms ............................................................................................................. 307
Propagating Timestamps with Alarms and E vents ............................................................. 308
Alarms or E vents Become Active ................................................................................ 308
Alarms Become Dis abled ........................................................................................... 308
Alarms Revert to Normal ............................................................................................ 308

9
Application Server User Guide Contents

Alarm Acknowledgement ........................................................................................... 308

Acknowledging Alarms with Signature Required .......................................................... 309
Configuring Alarms................................................................................................................ 309
Configuring Alarming for System Objects .......................................................................... 309
Configuring WinPlat form Object Alarms ...................................................................... 310
Configuring Alarms for an AppEngine Object ............................................................... 312
Configuring Alarms and E vents for Application Objects ...................................................... 313
Setting Alarms on the Attributes Page ............................................................................... 316
Distributing Alarms and E vents .............................................................................................. 317
Subscribing to Alarms and E vents from a Client ................................................................ 318
Using InTouch HMI as the Alarm and E vent Client............................................................. 318
Understanding the Syntax of Alarm Queries ................................................................ 318
Alarm Query Syntax when Register Using Galaxy_<GalaxyName> is Enabled .............. 319
Examples of Alarm Queries ........................................................................................ 319
Alarm Requirements for InTouch Client Applications .................................................... 320
Alarms and E vents in the InTouch HMI and in Application Server ....................................... 321
Configuring Plant State-Based Alarms .................................................................................... 322
Mapping Alarm Modes to Plant States .............................................................................. 323
Configuring State-Based Alarming on an Area Object ........................................................ 325
Viewing Plant State-Bas ed Alarms at Run Time ................................................................ 325
User Access and Security During Run Time ................................................................ 325
Configuring Alarm Historization, Mapping, and Shelving Priority Ranges .................................. 326
Configuring Historization for Alarms and E vents ................................................................ 327
Monitoring Alarm Severities at Run Time .......................................................................... 328
Understanding How Alarms are Ranked at Run Time ........................................................ 328
Using Aggregated Alarm Information ...................................................................................... 328
Configuring Alarm State Aggregation ................................................................................ 329
Aggregating Alarm State Information ................................................................................ 329
About the AlarmCntsBySeverity Attribute .................................................................... 331
Local Alarm Display Display in the Object Viewer ........................................................ 331
Aggregat ed Alarm Display in InTouch OMI Navigation ................................................. 332
About Alarm Adorner Attributes .................................................................................. 334
Monitoring Alarm State Information at Run Time ................................................................ 335

Working with Multiple GR Nodes and Galaxies............................................................... 337

Understanding the Multi-Galaxy Environment.......................................................................... 337
Setting up Multi-Galaxy Communication ................................................................................. 337
Naming Galaxies in a Multi-Galaxy Environment ............................................................... 340
Unpairing Galaxies .......................................................................................................... 340
Renaming Paired Nodes .................................................................................................. 341
Renaming Galaxies ......................................................................................................... 341
Accessing Multiple Galaxies .................................................................................................. 341
Using the Galaxy Browser with Multiple Galaxies .............................................................. 342
Using Object Viewer with Multiple Galaxies ....................................................................... 343
Using InTouch with Multiple Galaxies ............................................................................... 344
Guidelines for Accessing Multiple Galaxies ....................................................................... 346
Working with Security in a Multi-Galaxy Environment ................................................... 346
Pairing Galaxies wit h Multiple Network Interface Cards ................................................ 347
Working with IDE Extensions on a GR Node ............................................................... 347
Working with Alarms .................................................................................................. 348

10
Contents Application Server User Guide

Enhancing Multi-Galaxy Performance ............................................................................... 349

Remedying Performanc e Issues After the Fact ............................................................ 349
Scaling the Multi-Galaxy Environment for Optimum Performanc e ................................. 349
Setting Remote Galaxy References in the Owning Object Property .......................................... 350
Working with ArchestrA Services............................................................................................ 352
About the ArchestrA Servic e Bus...................................................................................... 352
Defining Service Discovery .............................................................................................. 352
Defining User-Configurable ASB Services ......................................................................... 352
Configuring and Deploying ArchestrA Services.................................................................. 353
Creating an Instance of an ASB Service ...................................................................... 353
Assigning the Service Instance to a Node ................................................................... 353
Deploying the Instance .............................................................................................. 354
Configuring ArchestrA Service TCP Ports ......................................................................... 354
Configuring the ASBGRBrowsing Service ......................................................................... 355
Configuring the ASBMxDataProvider Service .................................................................... 356
Configuring the ASBAuthentication Service ....................................................................... 357
IOMB LSService .............................................................................................................. 358
Managing Galaxies in a Multi-Galaxy Environment .................................................................. 358
Uninstalling and Reinstalling Application Server ................................................................ 358
Backing Up a Galaxy ....................................................................................................... 359
Deleting a Galaxy ............................................................................................................ 359
Restoring a Galaxy .......................................................................................................... 359
Restoring to an Existing Galaxy .................................................................................. 359
Restoring to a New Galaxy ......................................................................................... 360
Upgrading a Galaxy......................................................................................................... 360
Migrating a Galaxy .......................................................................................................... 360
Upgrading SQL Server .................................................................................................... 360
Troubleshooting a Remote Galaxy Connection ....................................................................... 360
Connecting to a Remote GR from the IDE ......................................................................... 366
Fixing Communication Issues with the OS Configuration Utility ................................................ 367

Working with Buffered Data ................................................................................................ 369

About Buffered Data.............................................................................................................. 369
Components that Use Buffered Data ................................................................................ 369
Configuring Buffered Data for an Attribute............................................................................... 370
Using Object Viewer with Buffered Data ................................................................................. 371
Using ArchestrA Scripts to Process Buffered Dat a .................................................................. 373
Scripting Basic Functions ................................................................................................. 373
Sample Script and Out put ................................................................................................ 373
Scripting Tips and Best Practices ..................................................................................... 374
Use Asynchronous Scripts for Buffered Data ............................................................... 374
Buffered Data Script Syntax and Configuration ............................................................ 374
Using BindTo for Buffered Data .................................................................................. 375
Buffered Data Run-time Behavior ........................................................................................... 375
About Buffered Data and History ............................................................................................ 376
About Buffered Data and Alarms and E vents .......................................................................... 377
AppEngine Reconnect Configuration for Undeploying and Redeploying Objects Linked to the
Telemet ry Server ............................................................................................................ 377
Alarm Functions and Buffered Data .................................................................................. 378

11
Application Server User Guide Contents

Alarm and E vent Ty pes and Buffered Data ....................................................................... 380

Working with References .................................................................................................... 383

Using Message Exchange and Attributes ................................................................................ 383
Referenc e Strings ................................................................................................................. 383
Relative References ........................................................................................................ 384
Property References........................................................................................................ 385
Handling Time Zones with the Time Property .............................................................. 386
Preserving Time Stamps from the Publishing Source ................................................... 386
Arrays ............................................................................................................................ 386
Formatting Reference Strings........................................................................................... 387
Using Literals ............................................................................................................ 387
Viewing Attributes in Objects ................................................................................................. 389
Viewing References and Cross References ...................................................................... 390
Finding Objects ............................................................................................................... 391
Using Galaxy Referenc es in InTouch ...................................................................................... 392
Telemet ry Server Data References ........................................................................................ 394
Telemet ry Server Dynamic Tags ...................................................................................... 395
Dynamic Data References vs. Static Data References ................................................. 395
Dynamic Tag Prerequisites ........................................................................................ 396
Naming Rules ........................................................................................................... 396
Configuration Errors................................................................................................... 396
DNP 3 Data References.............................................................................................. 397
IEC 60870-5 Dynamic Data References ...................................................................... 401
Modbus Data References........................................................................................... 403
Telemet ry Server Static Data Referenc es ......................................................................... 406

Configure Security................................................................................................................ 409

About Security ...................................................................................................................... 409
Security Model for Galaxies ................................................................................................... 410
About Authentication Modes ............................................................................................ 411
Multiple Accounts Per User ........................................................................................ 412
Changing Security Settings ........................................................................................ 412
About Security Groups..................................................................................................... 412
About Roles .................................................................................................................... 413
About Users .................................................................................................................... 416
About Credentials ............................................................................................................ 417
Associate an OS Group wit h a Credential .................................................................... 418
About SQL Server Security .................................................................................................... 419
Configuring Security .............................................................................................................. 420
Assigning Users to Roles ................................................................................................. 426
Deleting Security Groups ................................................................................................. 428
Deleting Roles ................................................................................................................ 428
Deleting Users ................................................................................................................ 428
About OS Group-based Sec urity ............................................................................................ 429
Connecting to a Remote Node for the First Time ............................................................... 429
Cached Data at Log In ..................................................................................................... 429
Mixed or Native Domains ................................................................................................. 429
Using Domain Local Groups ....................................................................................... 430
Using Security and Distribution Domain Configurations ................................................ 430

12
Contents Application Server User Guide

Using InTouch Access Levels Security ............................................................................. 430

Using Secured and Verified Writes ................................................................................... 430
Using Configurable Descriptions and Comments for Secured and Verified Writes .......... 431
About Secured and Verified Writes Logged Information................................................ 432

Working with Languages ..................................................................................................... 433

Defining and Configuring Galaxy Languages .......................................................................... 433
Graphics Language S witching................................................................................................ 433
Alarm Comment Language S witching ..................................................................................... 434
Workflow .............................................................................................................................. 434
Configuring Languages for a Galaxy ...................................................................................... 434
Adding a Language to a Galaxy ....................................................................................... 434
Removing a Language from a Galaxy ............................................................................... 435
Modifying the Font for a Language ................................................................................... 436
Changing the Default Language for a Galaxy .................................................................... 437
Exporting Symbol Text for Offline Translation .......................................................................... 438
Types of Language Dictionary Files .................................................................................. 438
Exporting Language Data for All Symbols in a Galaxy ........................................................ 438
Exporting Language Data for Specific Objects................................................................... 439
Exporting Symbol Language Data for a Managed InTouch Application................................ 440
Exporting Symbol Language Data for a Published InTouch Application ............................... 441
Exporting Symbol Text to an Existing Dictionary File .......................................................... 441
Translating Exported Symbol Language Files ......................................................................... 442
Translating Exported Symbol Text Dictionary Files ............................................................ 442
Importing Translated Symbol Language Files.......................................................................... 443
Importing Translated Symbol Dictionary Files .................................................................... 443
Examples of Symbol or Object Mismatch Handling during Language Imports ...................... 445
Language Data Handling for Galaxy Operations ................................................................ 447
Exporting Alarm Comments for Offline Translation .................................................................. 447
Guidelines and Recommendations ................................................................................... 447
Organizing Your Export .............................................................................................. 447
Translation File Formatting and Editing ....................................................................... 447
Reimporting .............................................................................................................. 447
About the Alarm Comments Language File ....................................................................... 448
Exporting Alarm Comments from V ery Large Galaxies ....................................................... 448
Exporting All Galaxy Alarm Comments ............................................................................. 448
Exporting Alarm Comments by Area ................................................................................. 449
Using File Names ...................................................................................................... 449
Exporting Objects Not Assigned to an Area ................................................................. 449
Translating Exported Alarm Comment Language Files ............................................................ 451
Importing Translated Alarm Comment Language Files ............................................................. 452
Re-exporting Alarm Comments .............................................................................................. 453
Exporting New Untranslated Alarm Comments .................................................................. 454
Exporting Modified Existing Alarm Comments ................................................................... 454
Testing the Language Switching Functionality at Run Time ...................................................... 454

Managing Galaxies .............................................................................................................. 455

Backing Up and Restoring Galaxies ....................................................................................... 455

13
Application Server User Guide Contents

Changing Galaxies ................................................................................................................ 457

Deleting a Galaxy.................................................................................................................. 457
Galaxy Object Components Synchronization .......................................................................... 458
Definitions....................................................................................................................... 458
Typical Out-of-Sync Scenarios ......................................................................................... 458
Using the Synchronization Feature ................................................................................... 458
Exporting a Galaxy Dump File................................................................................................ 459
Editing the Galaxy Dump File................................................................................................. 460
About the Galaxy Dump File Structure .............................................................................. 460
Host Attributes........................................................................................................... 460
About Quotation Marks and Carriage Returns ............................................................. 461
Time Formats in Excel ............................................................................................... 461
Enabling I/O Aut o Assignment in the Galaxy Dump File ..................................................... 461
Importing a Galaxy Load File ................................................................................................. 462
Hosting Multiple Galaxies in One Galaxy Repository ............................................................... 463
Disk Space Requirements ..................................................................................................... 463
Managing Communication between Galaxy Nodes .................................................................. 463
Mapping Network Drives with User Account Control Enabled ................................................... 464
About ArchestrA Us er Accounts ............................................................................................. 464
Using Multiple Network Interface Cards .................................................................................. 465
Defining the Order of the NIC ........................................................................................... 465
Configuring the IP Address and DNS Settings ................................................................... 466
Configuring Multiple NICs ................................................................................................ 466

Working with Redundancy .................................................................................................. 471

About Redundancy................................................................................................................ 471
Configuring AppEngine Redundancy ................................................................................ 471
Redundancy during Run Time .......................................................................................... 472
Engine Restart After Failure ............................................................................................. 473
CPU Load Balancing ....................................................................................................... 473
Working with AppEngine Redundancy .................................................................................... 474
Configuring the Redundancy Message Channel ................................................................ 474
Configuring Redundancy ................................................................................................. 475
Configuring Redundancy in Templates ........................................................................ 476
Deleting Redundant AppE ngines ................................................................................ 476
Deploying AppEngine Objects .......................................................................................... 477
Configuration Requirements ....................................................................................... 477
Undeploying AppEngine Objects ................................................................................ 478
During Deployment .......................................................................................................... 478
Objects at Run Time .................................................................................................. 478
During Run Time ............................................................................................................. 479
AppEngine Redundancy States .................................................................................. 479
Troubleshooting .................................................................................................................... 480
Generating Alarms .......................................................................................................... 481
Generating History .......................................................................................................... 482
Working with Data Acquisition Redundancy ............................................................................ 482

14
Contents Application Server User Guide

Configuring Data Acquisition Redundancy ........................................................................ 482

Deploying Redundant DIObjects ...................................................................................... 483
What Happens in Run Time ............................................................................................. 483
RedundantDIObject and PLC Connectivity .................................................................. 483

Glossary ................................................................................................................................. 485

Index ....................................................................................................................................... 493

15
 Application Server User Guide

C HAPTER 1
IDE Overview
®
This section explains how to creat e and open a Galaxy. It also briefly describes the ArchestrA
Integrated Development Environment (IDE ).
The IDE is the integrated design and development tool from which all ArchestrA objects are configured
and deploy ed to target computers. You work from the IDE to create, configure, and maintain the objects
that comprise your application and the underlying infrastructure that supports your application.
Using the ArchestrA IDE, you can import new types of objects in to the Galaxy Repository, configure new
ones, and deploy them to computers in your network. Multiple us ers can work concurrently on different
sets of objects from different ArchestrA IDEs.

In This Chapter
What’s a Galaxy? ......................................................................................................................... 17
Start the ArchestrA IDE ................................................................................................................. 18
Create a Galaxy............................................................................................................................ 18
Connect to a Galaxy ..................................................................................................................... 21
IDE Views and Toolboxes ............................................................................................................. 22
Customizing Your Workspace........................................................................................................ 35

What’s a Galaxy?
A Galaxy represents your entire production environment, including all computers and components that
run your application. A Galaxy is a collection of platforms, engines, templates, instances , and attributes
you define as the parts of you r specific application. Persistent information about this collection of objects
is stored in a Galaxy database.

17
Application Server User Guide IDE Overview

A Galaxy database resides on a single net work computer. A Galaxy databas e can reside on any
computer on your net work with the SQL Server, Bootstrap, and Galaxy Repository software ins talled.
But, you cannot store parts of a Galaxy database on several computers.
A Galaxy Repository (GR) is the name of the single computer where the Galaxy database is located.
You can deploy Galaxy components, such as platforms and engines, on multiple computers to share the
work load while applications are running. For more information, see Deploying and Running an
Application on page 253.
A Galaxy's names pace is the set of unique object and attribute identifiers. The namesp ace and the
values of each of its identifiers define an Application Server application, and can be accessed by clients
of the configuration system as well as the Application Server Message Exchange in a deployed system.
A key benefit of the Application Server namespace is that it allows Application Server objects and
process data to be referenced by scripts and animation links from any comput er in t he Galaxy without the
reference needing to specify the object's location.
Galaxies also include security, which is turned off by default. Using security allows you to limit what users
can do. You can add more users, security roles, and security groups later if you want. For more
information, see Configure Sec urity on page 409.

Start the ArchestrA IDE

When you start the IDE, you must select an existing Galaxy or create a new Galaxy. You cannot open the
IDE without opening a Galaxy.

Install and Activate Your License

Before you can open the IDE, you must have a valid license. For information about licensing, see
"License Installation and Activation" in the System Platform Installation Guide. If you need additional
information, see the AVEVA Enterprise Licensing Guide.

Manage Security Certificate Verification

The Arc hestrA IDE may take 30 seconds to open on a system that is not connected to the Internet. When
the IDE starts, the operating system attempts to verify the digital certificates for internal components
against a Certificate Revocation List (CRL) located on a public website. If your system cannot access the
public site within 30 seconds, the IDE startup proc ess resumes and complet es.
To maintain a better security profile by checking components against a CRL, keep your interne t
connection enabled and allow the verification to proceed.
To avoid the potential delay, in Internet Explorer or through Control Panel, open Internet Options,
Advanced Options, and uncheck the Security option to Check for publisher's certificate revocation.

Create a Galaxy
Each time you start the ArchestrA IDE, you must connect to a Galaxy. You can either create a new
Galaxy or select an existing Galaxy before opening the IDE. You must have activated a valid license
before opening the IDE.
Creating a new Galaxy requires you t o specify a Galaxy Repository (GR) node name and the name of the
Galaxy. The Galaxy database is created and is ready for you to connect to and use.
Guidelines for Creating a New Galaxy
 Activate a valid license before opening the IDE.
 You can only create a new Galaxy on a computer with the Bootstrap and the Galaxy Repository
software installed.

18
IDE Overview Application Server User Guide

 To be able to create a new Galaxy, TCP/ IP must be enabled on the comput er hosting the SQL
Server database.
The TCP/ IP protocol setting can be verified with SQL Server Configuration Manager. See the
System Platform Installation Guide for instructions on enabling the TCP/IP protocol for SQL Server.
 New Galaxies are c reated without security. To learn more about setting security for your Galaxy, see
Configure Securit y on page 409.
 A computer name, as well as the name of the domain on which the comput er exists, should include
only English language characters, alphabetic and numeric. Use of characters from other language
character sets that are not also included in the English language character set can result in a failure
to create the new Galaxy.
To create a new Galaxy
1. From the Start menu, go to the Wonderware System Platform folder, and then select System
Platform IDE. The Connect to Galaxy dialog box appears.

2. Click New Galaxy.

3. Specify the properties of your new Galaxy:

o In the GR Node Name list, type, or select the name of a computer that has the Galaxy
Repository soft ware installed. If necessary, click the Browse button to locate the node
where the Galaxy Repository is installed.
o In the Galaxy Name box, type the name of the Galaxy you want to create within that Galaxy
Repository. A Galaxy name can be up to 32 alphanumeric characters, including _ (underscore),
$, and #. The first character must be a letter. A Galaxy name c annot contain a blank space.

Note: You cannot use the following reserved names as Galaxy names: Me, MyContainer,
MyArea, MyHost, MyPlatform, MyEngine and System. You cannot use a name that conflicts with
an existing object in the backup Galaxy file.

o In the Galaxy Type list, select the galaxy type from the available standard galaxy cab files,
which are located in the BackupGalaxies folder. The following cab files are included with
Application Server:

19
Application Server User Guide IDE Overview

Base_InTouch.cab: Use the Base_InTouch cab file to creat e InTouch HMI Galaxies. This is
mainly for use if you are already using InTouc h HMI applications, and can be us ed to convert
legacy InTouch applications to managed applications.
Default.cab: The Default cab file is the recommended starting point for creating a new Galaxy.
The Default.cab file contains default screen profiles, templates, a basic equipment model, and
an example InTouch OMI ViewA pp that provides an introduction to key features.
Default_EMPTY.cab: Use the Default_EMP TY.cab file to create a baseline Galaxy that contains
only base template objects. It is intended primarily as a recovery mechanism for recreating a
damaged galaxy. After creating the bas eline galaxy, you can import existing objects into it from
aaPKG files.
Reactor_Demo_InTouch. cab: This is the same as the Base_InTouch.cab file, but includes a
demonstration run-time application, "$ReactDemo," and all the configuration objects and graphic
files used to create the demo. $ReactDemo is derived from the InTouchViewApp object.
o If you have created Galaxy backups, your cab files will also appear, in addition to the cab files
included with Application Server.
The selected backup file is used as a template to create a new Galaxy. The system restores the
selected backup Galaxy and renames it to the Galaxy name that you provided in the Galaxy
Name box.
4. Click Create. The Create Galaxy dialog box opens, showing the Galaxy database being created.

Note: If you use a backup cab file that was created in a previous version of Application Server, and if
Enhanced Security mode is in effect, you will be prompt ed to enter S QL SysAdmin credentials before
proceeding.

5. After the Galaxy database is created, click Close. You are ready to open the Galaxy and begin
creating your application. You must be a member of the aaConfigTools OS group to connect to a
Galaxy, or you must be running the IDE as administrator. For more information about opening a
Galaxy, see Connect to a Galaxy on page 21.

20
IDE Overview Application Server User Guide

Connect to a Galaxy
You must connect to a Galaxy before you can perform work in it. To connect to a Galaxy, you must be a
member of the aaConfigTool s OS group on the GR node. To add a user to the aaConfigTools group,
use the Windows Control Panel. If you are not a member of aaConfigTools, you can instead start the IDE
as administrator and then connect to the Galaxy.

Important: In a domain-based network, the aaConfigTool s OS group must exist on the GR node. You
will not be able to connect to the Galaxy if you are not a member of the aaConfigTools group on the GR
node.

If security is enabled for an existing Galaxy, you cannot open it without logging in, even if you are a
system administrator or member of t he aaConfigTools group. If you do not have log on rights to a Galaxy,
you cannot log in to that Galaxy. For more information about Galaxy security, see
01Standardize_S ecurity_Configure Security.
To connect to a Galaxy
1. On the Start menu, point to Programs, Wonderware and click ArchestrA IDE. The Connect to
Galaxy dialog box appears.

2. Do the following:
a. In the GR node name list, select the name of a computer you previously connected to. Click the
Brow se button to browse and select from the availa ble domains and nodes on your
network.
b. In the Galaxy name list, select the name of the Galaxy on that GR node.
c. Click Connect.
– If you are a member of the aaConfigTool s OS group on the GR node or running the IDE as
administrator, AND the Galaxy you select does NOT have security enable, you are
connected to the Galaxy.
– If you are a member of the aaConfigTool s OS group or running the IDE as administrator,
AND the Galaxy you select has security enabled, the Login dialog box appears. Ty pe your
user name and password and click OK.
– If you are not a member of the aaConfigTool s OS group or running the IDE as
administrator, you are blocked from connecting to the Galaxy and a message about
insufficient permissions is displayed. Take the corrective action described in the message
and relaunch the IDE.
Once the Galaxy opens in the IDE you can start working with your Galaxy.

21
Application Server User Guide IDE Overview

IDE Views and Toolboxes

After you open a Galaxy, the IDE opens and shows the different views of your Galaxy.

For a complete discussion of items such as templates and instances, see About Templates and
Instances on page 41.
Views in the IDE include:
Templat e Toolbox Expand the top level folders to see the different templates in the
toolboxes.
Graphic Toolbox Cont ains ArchestrA graphics and Situational Awareness Library symbols
that can be used in the Galaxy. For more information, see the Creating
and Managing ArchestrA Graphics User Guide.

22
IDE Overview Application Server User Guide

Application views Click the tabs at the bottom or icons at the top to open:
 Model view - the object relationship to the aut omation scheme
layout. The objects are organized into A reas that typically represent
the physical plant layout.
 Deployment view - the object relationship to the comput ers that
comprise the deployed system that the objects run on.
 Derivation view - the derivation path from base template to the
instances. This view allows a user to see all object instances that
were based on a given template. All templates and instances appear
in this view.
 IO Devices view - the object relationship to scan groups and DI
objects. This view lets you assign objects that were configured for
I/O automatic assignment in the Object Editor to scan groups, and
assign scan groups to Device Integration (DI) objects. The IDE then
builds the I/O references for each object.
 IO Device Mapping view - shows the relationships of objects and
attributes to scan groups and DI objects. This view lets you see,
validate, and edit the I/O references of object attributes that have
been automatically configured.
 Operations view - shows the results of validating the configuration
of objects.
Status bar Shows messages, user name, Galaxy name and node, and license
information. Turn off the Status bar by clicking Status bar on the View
menu.

Template Toolbox
The Template Toolbox lists template toolsets, which contain object templates. The Template Toolbox
shows a tree view of template categories in the Galaxy. Expand the toolsets to see their contents.
A new Galaxy is automatically populated with the content defined by the cab file that was used to create
it. At a minimum, the newly-created Galaxy will include base templates.
 The Default.cab includes first level derived templates in addition to base templates, to simplify the
process of building your Galaxy and a sample InTouch OMI ViewA pp.
 The Default_EMP TY.cab includes only base templates. See About Base Templates on page 43 for
additional information.
 The Base_InTouch.cab and the Reactor_Demo_InTouch.cab files include only the base templates
needed to support an InTouch HMI application.

23
Application Server User Guide IDE Overview

Default.cab Template Toolbox Default_EMPTY.cab Template Toolbox

Base_InTouch.cab Template Toolbox Reactor_Demo_InTouch. cab Template

Toolbox

24
IDE Overview Application Server User Guide

Graphics Toolbox
The Graphic Toolbox lists symbols and other graphic-related content. The Graphic Toolbox shows a tree
view of the symbol/graphic toolsets. As with the Template Toolbox, new Galaxies are populated with the
content defined by the cab file used to create it. Expand the toolsets to see their contents.
 The Default.cab includes several symbol and graphic libraries, including the ArchestrA Symbol
Library, the Situational Awareness Library, and an icon library. The Default.cab also includes various
Screen Profiles, Layouts, Apps and Controls.
 The Default_EMP TY.cab includes only a basic set of Apps and Controls.
 The Base_InTouch.cab and the Reactor_Demo_InTouch.cab include the ArchestrA Symbol and
Situational A wareness Libraries. The Reactor_Demo-InTouch.cab also includes additional symbols
used for the InTouch HMI reactor demo app.

25
Application Server User Guide IDE Overview

Default.cab Graphic Toolbox Default_EMPTY.cab Graphic Toolbox

26
IDE Overview Application Server User Guide

Base_InTouch.cab Graphic Toolbox Reactor_Demo_InTouch. cab Graphic

Toolbox

IDE Application Views

Base templates and non-base templates are included with Application Server. The templates are
automatically imported into the IDE when you first create a Galaxy.
Base templates appear in the Template Toolbox and in the Derivation view with a $ as the first character
of their name. You cannot directly modify base templates but you can use them to create your own
objects or derived templates.
When you move from one view to another, the selected object in the first view is selected in the second
view, if the object exists in that view. For example, templates are not shown in the Deployment view,
Model view and IO Devices view.
You can open views from the View menu, or click the icons in the main toolbar. Keyboard shortcuts can
also be used to open the views.

27
Application Server User Guide IDE Overview

View Shortcut Icon

Model View Ctrl+Shift+M

Deployment View Ctrl+Shift+D

Derivation View Ctrl+Shift+R

Templat e Toolbox Ctrl+Shift+T

Graphics Toolbox Ctrl+Shift+P

Operations View Ctrl+Shift+O

IO Devic es View Ctrl+Shift+I

IO Devic e Mapping view Ctrl+Shift+G

Object Icons
In the Model, Deployment, Derivation, and IO Devices views, objects are listed in a tree structure that
functions like a standard Microsoft Windows Explorer tree. Under each branch of the tree, objects are
listed in alphabetical order. Default objects are shown in bold.
For objects shown in any view, icons to the left of the object name are used to show:
 Object deployment status
 Error and warning conditions
 If the object is checked out
 If a template contains an Object Wizard

Not deployed

Deployed

Deployed, but pending configuration changes exist that have not been deploy ed.

Deployed, but software modifications exist that have not been deployed.

Applies only to redundant AppEngines. An AppEngine is undeploy ed, but its redundant
pair is deployed.

Applies only to redundant AppEngines. An AppEngine is deployed, but its redundant pair
is not deployed.
Applies only to redundant AppEngines. An AppEngine is deployed, its redundant pair is
not deployed, and pending configuration changes exist that have not been deployed.

Applies only to redundant AppEngines. An AppEngine is deployed, its redundant pair is

not deployed, and software modifications exist that have not been deploy ed.

28
IDE Overview Application Server User Guide

[No Good. No additional icon is displayed for deployed objects running on -scan or off-scan
icon] with a good status.
Warning

Error. The object in an Error state and cannot be deployed.

The process of asynchronously trans ferring files to the target node is not yet complete.
This icon is normally visible for only a few moments at the end of an deployment
operation, unless the object is deployed on a slow network. If the icon remains for more
than a few moments, check if the application is OnScan, as the files will not transfer if the
application is OffScan. This icon completely replaces the original while it is shown.
The object is a base template (read -only).

The object is checked out.

The template contains an Object Wizard.

To assign an object to anot her, drag it onto the host object. If that object is an
inappropriate assignment match, the international Not symbol appears. To unassign an
object, drag it to the Unassigned Host folder.

Note: You must undeploy an object that is currently deployed before reassigning it from one object to
another.

Model View
The Model view shows objects in terms of their physical or containment relationships, whic h can be
organized through a folder structure. This Model view most accurately represents an application
perspective of the processes that users are emulating: for instance, specific process areas, tanks,
valves, pumps and their relationships based on containment.
For more information about containment, see Create Contained Templates on page 54.

Note: You must undeploy an object before reassigning it to another object.

29
Application Server User Guide IDE Overview

The tree structure acts like a standard Microsoft Windows Explorer tree. Initially, it shows a simple
hierarchy: <Galaxy name> and the Unassigned Area folder.

In the Model view, all objects are grouped by areas and by containment relationship. The Model view
shows these relationships in the following ways:
 The top of the tree is the Galaxy.
 Top-level Areas are shown under the Galaxy.
 Within each Area, contained Areas are listed. Areas support hierarchical composition; that is, they
support sub-Area construction. Areas can be nested only 10 le vels (after the sub-area is 10-levels
deep, you cannot add another sub-level).
 Objects that belong to an Area are listed under the Area.
 Objects contained by other objects are listed under their respective containers. Multiple levels are
allowed. For more information about containment, see Creat e Contained Templates on page 54.

Note: Contained objects belong to the same Area as the object that contains them.

Some object’s hierarchical, or cont ained, names are truncated if you have multiple levels shown. To
view the entire hierarchical name, select the object and click Properties on the Galaxy menu. The
entire hierarchical name is shown in the Propertie s dialog box. For more information about
hierarchical names, see Using Contained Names on page 59.
 Objects that currently do not belong to an Area are listed under Unassigned Area. Cont ainment
relationships bet ween parent and child objects are shown there.
In each branch of the tree, objects are listed in alphabetical order. Default objects are shown in bold.

To assign an object to another, drag it onto the host object. If the object is an inappropriat e
assignment match, the international Not symbol appears. To unassign an object, drag it to
the Una ssigned Host folder.

30
IDE Overview Application Server User Guide

Deployment View
The Deployment view shows instanc es only in terms of their assignment relationships. This view enables
you to organize thos e objects through a folder structure.
This view shows which objects instances reside on which comput ers. In the ArchestrA environment, the
physical location of object instances is not required to approximate the real-world environment it models.
The Deployment view does not need to reflect your physical plant environment.
The tree structure acts like a standard Windows Explorer tree. It is initially divided into two hierarchical
levels: <Galaxy Name> and the Unassigned Host folder.

In the Deployment view, objects appear in a tree according to their distribution relationships in a
multi-node system in the following ways:
 The top of the tree is the Galaxy.
 WinPlatforms are shown under the Galaxy.
 Under each WinPlatform, assigned AppEngines are listed.
 Under each AppE ngine, assigned Areas and DIObjects, such as DINetwork Objects, are listed.
 Under each Area, assigned ApplicationObjects are listed.
 Under each ApplicationObject, contained ApplicationObjects are listed. Multiple levels are allowed.
 Under each DINetwork Object, assigned DIDevice Objects are listed.

31
Application Server User Guide IDE Overview

 Unassigned objects are grouped together in the Unassigned Host folder. Area and containment
relationships are maint ained in this view.

Important: DINet work objects have specific configuration limits such as whether more than one object
can be deployed to a single WinPlatform. The IDE does not check for these limits. For more information
about configuration limits, see the online help for the DINetwork object.

Derivation View
The Derivation view shows objects and templates in terms of their parent/child relationship. An object
derived from another object appears in a hierarchy level under it.
The tree structure acts like a standard Windows Explorer tree, and initially is divided into three
hierarchical levels: <Galaxy Name>, <Used Base Templat es>, and the Unused Base Templates folder.

In the Derivation view, objects appear according to their parent-c hild relationship in the following ways:
 The top of the tree is the Galaxy.
 Base templates with associated child objects, either derived templates or instances, are shown
under the Galaxy.
 Under each base template, derived templat es and instanc es created from the base templat e are
listed. Multiple levels are allowed. Instances creat ed from derived templates are listed under their
parents.
 Templat es with no associated derived templates or instances are grouped together in the Unused
Base Templates folder.
Objects with names that start with a "$" are templates, either base or derived. Under each branc h of the
tree, child objects are listed in alphabetical order.

32
IDE Overview Application Server User Guide

As in other views, dragging one object onto another in the Derivation view associates the two objects
based on the predefined rules of the object types. For example, you can drag ApplicationObj ects onto
other ApplicationObjects but you cannot drag ApplicationObjects to an Engine.

IO Devices View
The IO Device s view is used for I/O auto assignment and shows the relationship of system objects and
application objects to scan groups and Device Integration (DI) objects. Before using this view, system
and application objects must be configured to use I/O auto assignm ent by adding one or more attributes
to the object and activating the I/O feature. See Edit Objects on page 63 and Using I/O Auto Assignment
on page 140 for additional information.
You will also use the Object Editor to add scan groups to DI objects (OPCClient, DDESuiteLinkClient, or
RedundantDIObject) before using the IO Device s view.
Once you have configured system and application objects for I/O aut o assignment, and added scan
groups to at least one DI object, you will assign the system and application objects to scan groups in the
IO Devices view. This links (auto-binds ) the system and application objects to PLCs, through the DI
objects.
To open IO Device s view, click IO Devices on the View menu. You can also open the IO Device s view
by pressing Ctrl+ Shift+I, or click the IO Devices icon in the main toolbar of the IDE.

System and application objects appear as child objects to scan groups, and scan groups appear as child
objects to DI objects.

33
Application Server User Guide IDE Overview

Note: Only instances, and not templates, appear in the IO Device s view.

Device linkage, which is established by assigning a system or application object to a scan group,
ensures that all of the object’s attributes that have been prepared for automatic I/O assignment will
match up with a corresponding input source or output des tination in the scan group. The I/O references
are then referred to as auto-bound.

Important: Objects must be undeploy ed before they can be assigned to a scan group.

System and application objects that are not yet assigned to a scan group are placed under the folder
"Unassigned IO Devices." To assign objects to a scan group, and t hus allow I/O automatic assignment to
occur, simply select objects in the Unassigned area, and drag and drop them to the applicable scan
group. Once an object has been assigned to a scan group, the I/O reference for each I/ O attribute is
automatically configured.

IO Device Mapping View

The IO Device Mapping view shows I/O references for attributes that have been configured for I/O auto
assignment, and that have been assigned to a scan group through the IO Device s view. To open this
view, click IO Device Mapping in the View menu. The IO Device Mapping view will also open if you
select a DI object, scan group, or object assigned to a scan group in the IO Devices view. Other ways to
open this view are by pressing Ctrl+Shift+G, or by clicking the IO Device Mapping icon in the main
toolbar.

The IO Device Mapping view shows I/O auto assigned attributes with resolved I/O references for
objects that have been assigned to scan groups. The IO Device Mapping view lets you enter override
values to change the I/O reference. You can also validate the I/O references.
You select the references that are displayed in the IO Device Mapping view by selecting objects in the
IO Devices view. Manually configured referenc es are not displayed in the IO Device Mapping view, nor
are attributes associated with objects that are not assigned to a scan group. Only I/O references for the
object or group of objects currently selected in the IO Devices view are displayed. You can select DI
objects, scan groups, and application and system objects in the IO Device s view. If only the top level
item in a device hierarc hy is selected, all subordinate items are automatically selected. If, however, you
select a subordinate item along with the top level item, only I/O references for the selec ted items are
displayed. You can select multiple items at different hierarchical levels.

Note: Selecting a subordinate object will exclude non -selected objects within the device hierarchy, even
if the parent object is selected.

Operations View
The Operations view shows the results of validating the configuration of objects. You may need to open
it before you see it. On the View menu, click Operations.

During the validation of an object, its icon and name appear with the status of t he operation.

34
IDE Overview Application Server User Guide

Important: You can validat e both templates and instances if they are checked in.

The status of the object (Status column) is shown with an icon and a descriptive word or phrase.
When validation is complete, the Command Result column shows a "Succeeded" or "Failed" message
and additional information about the validation results. For more information about validating objects,
see Validate Objects on page 94.

Note: You can validat e all objects in the Galaxy by running the Validate operation on the Galaxy object.
In that case, Command Result messages are shown after all objects in the Galaxy are validated.

The Operations view, like the Template Toolbox and Applications views, is also updated as the
status and conditions of objects in the Galaxy change.

Customizing Your Workspace

You can customize your workspac e by docking and floating the IDE’s views. You can also hide some of
the views.

Dock Views
To dock a view, drag the view to the location you want it. For example, drag the title bar of the Template
Toolbox and dock it under the Application views. You can also undock it by dropping it anywhere on your
desktop. Drag it back to dock it again.

Float Views
You can also float a view. With your cursor over the view you want to float, click the arrow. On
the menu that appears, click Floating.

35
Application Server User Guide IDE Overview

You can also float just one view. To float the Derivation view, click the arrow. On the menu
that appears, click Floating. The view floats on your desktop. You can move it to another
location or dock it.

Hide Views
To hide a view, click the Pin icon. The views "hide" as tabs on the side of the window. The
Operations and IO Device Mapping views hide at the bottom of the window, and the IO
Devices view hides at the right side. The Graphic and Template Toolboxes, and Model,
Derivation, and Deployment views are at the left side of the window.

When you move the mouse over the tab, the view expands into the workspace.

Reset the Workspace

You can easily reset the IDE workspace and restore views back to their default locations.
To return the views to the default docking
 On the View menu, click Reset Layout.

Synchronize Views
You can specify that a selected object stay selected as you move through the views. In any of the views,
select the object you want to synchronize. On the View menu, click Synchronize Views. Now as you
move from one view to another, that object stays selected.

36
IDE Overview Application Server User Guide

Configure User Information

You can configure options for a Galaxy, including prompts for check -in comments and user defaults.
These user options apply to the currently open Galaxy and do not change options for other Galaxies.
If you specify a security group, that security group must already exist. For more information about
security and security groups, see 01Standardize_Sec urity_Configure Security.
To configure user information
1. On the Edit menu, click User Information. The Configure User Information dialog box appears.

2. In the Prompts area, do one or more of the following:

o Select the Ask for Check In Comments check box if you want to be prompted to type
comments when checking in templates and objects.
o Select the Warn before launching an editor for a read-only object check box if you want to
see a prompt that informs you if you are opening an instance or templat e as read-only. The
prompt warns you if you open an instance or template while someone else is working on it. If
someone else is working in the instance or template, you cannot make changes.
o Select the Warn for insufficient permissions check box if you want to see a prompt that tells
you if you have permission to creat e or modify InTouchView applications. Thes e permissions
authorize or prevent you from creating and modifying InTouchView Applications.

37
Application Server User Guide IDE Overview

o Select the Warn before launching an InTouchViewApp editor check box if you want to see a
prompt each time you attempt to edit an InTouchView application instance. You can edit the
associated template or canc el the operation. If you do not select this check box, the request to
edit the InTouchViewApp instance is automatically redirected to the associated template.
o Select the Warn before launching a Linked Symbol editor check box if you want to see a
prompt each time you attempt to edit a Graphic Toolbox symbol linked to an object. You can edit
the linked symbol or cancel the operation. If you do not select this check box, the linked symbol
opens in the Symbol Editor without a warning, and you will be able to edit the sym bol. After you
save the symbol, any edits you have made will propagate to all objects that link to the symbol.
o Select the Warn before launching ViewApp in Preview Mode check box to restore the first
warning message that appears after requesting a preview of a ViewApp. You need to select this
prompt to display the message again after the user selected the check box on the warning
message to hide the message.
o Select the Warn for Platform issue s in Preview Mode check box to restore the warning
message that appears after requesting a preview without the WinPlat form deployed. You need
to select this prompt to display the message again after the user selected the check box on the
warning message to hide the message.
3. Select the Initial scan state for deployed obje cts. You can select On Scan or Off Scan. You can
change this setting on an individual basis in the Deploy dialog box when you deploy.
4. Select the Scan state defaults when undeploying or redeploying instanc es. Force Off Scan will
attempt to take the target object offscan when an already deployed object is redeployed. Don’ t
Force Off Scan does not force the target to go off scan when you deploy.

Note: Redeployment of objects that are currently deployed on -scan will be canceled unless this
option is selected.

5. Make your Auto context selection.

6. In the Field Attribute s section, select the Show Field Attribute s check box to display the Field
Attribute s tab in the User Defined Object editor.
By default, the Field Attribute s tab is displayed only if field attributes are already defined for the
object. You can override the default by selecting this option. For more information about working with
legacy field attributes, see About the Field Attributes, UDAs, and Extensions Pages on page 76.
7. In the User defaults area, provide the following object names of Framework objects you select to be
defaults with respect to assignment relationships.
o Type the Platform name.
o Type the Application Engine name.
o Type the Area name.
o Type the View Engine name.
o Type your Security Group name, if any.
8. When you are done, click OK.

Log on with Security Enabled

Some Galaxies have security associated with them. If you try to open a Galaxy with security, you need to
log on to the Galaxy to open it.

Note: If you do not have logon rights, you cannot open a Galaxy.

For information about setting up security in the ArchestrA environment, see Configure Security.

38
IDE Overview Application Server User Guide

To log on to a Galaxy
1. When you open a Galaxy that has security enabled, the Change User dialog box appears.
2. Type your user name and password. If OS authentication security is enabled for the Galaxy, select
the Domain that contains your user account from the dropdown list. If the list is unavailable, the
selected Galaxy is on your local computer.
You can change your password after you type your user name and password. Click Change
Password. Type the new password and then retype it.
3. Click OK. Your logon data is validated by the Galaxy Repository being accessed. Depending on
operating system security, the IDE opens. If the GR does not rec ognize your user name or
password, you are prompted to ent er them.

Change Users
You can change users in a Galaxy at any time. Any security restrictions associated with a user change
when the user logs on or logs off from the Galaxy. For more information about users and security, see
Configure Securit y on page 409.
If the Galaxy has not been configured to enable security, you see a message. All users in an
open-security environment are treated as the DefaultUser by the Galaxy. In an open -security
environment, all users have full access to everything.
To change users
1. On the Galaxy menu, click Change User.
If security is enabled on the Galaxy, the Change User dialog box appears.
2. Enter your logon information and click OK.
o If needed, click Change Password to change the password for the new user.
o Type the new password and then retype it.
3. Click OK.

39
 Application Server User Guide

C HAPTER 2
Introduction to Objects
In This Chapter
About Templates and Instances ..................................................................................................... 41
View Object Properties .................................................................................................................. 47

About Templates and Instances

Before you start modeling your application using the Application Server, you must understand templates
and object instances.
Templates are elements in Application Server that contain common configuration parameters for object
instances that you use multiple times in your application.
For example, you might create a template for valves. You configure the template with all the unique
attributes for valves. You use that template to make object instances of valves. You can furt her configure
and customize each object instance to represent a specific valve.
Object instance s are the specific devices in your environment, such as diaphragm valves or very
complex devices, like a reactor. You create an instance from a template and then customize the specific
instance as needed.
Instances are deploy ed to the run-time environment. Templates exist in the development environment
and cannot be deployed.
Creating templates and instances is very similar to object -oriented programming. For example,
templates and instances have a parent/child relationship t hat involves inheriting attributes. There are
differenc es, however, bet ween object-oriented programming and creating templates and instances in
Application Server.

41
Application Server User Guide Introduction to Objects

Collectively, templates and instances are called objects. The following graphic shows the di fferent kinds
of objects and how they are organized.

Galaxy Objects

AutomationObjects

System Objects Domain Objects

Device Integration
EngineObjects PlatformObjects AreaObjects Application Objects
Objects (DIObjects)

AppEngine WinPlatform Area AnalogDevice FS Gateway

DiscreteDevice AB TCP Network

Switch AB PLC5

User-Defined and so on

If you are new to this kind of programming, the next section explains the basic concepts you need to
know before you start. If you are familiar with object-oriented programming, the concepts in the next
section may be familiar to you, but notice the important differenc es between object -oriented
programming and Application Server.

Instances
Instances are the run-time objects created from templates in Application Server. Instances are the
specific things in your environment like processes, valves, conveyor belts, holding tanks, and sens ors.
Instances can get information from sensors on the real-world device or from application logic in
Application Server. Instances exist during run time.
In your environment, you may have a few instances or s everal thousand. Many of these instances may
be similar or identical, such as valves or holding tanks. Creating a new valve object from scratch when
you have several thousand identical valves is time-consuming. That’s where templates come in.

Templates
Templat es are high-level definitions of the devices in your environment. Templates are like a cookie
cutter from which you can make many identical cookies.
You define a templat e for an object, like a valve, one time and then use that template when you need to
define another instance of that item. Template names have a dollar sign ($) as the first character of their
name.
A template can specify application logic, alarms, security, and historical data for an object.
A template can also define an area of your environment. You can extend and customize a templat e by
adding attributes, scripts, or features to meet the specific needs of your environment. Objects inherit
attributes, scripts and features from their parents.
Application Server comes with predefined templates, called base templates. You cannot modify base
templates. All templates you creat e are derived from base templates.
You can also nest templates, or contain them. Contained templates consist of nested object templates
that represent complex devices consisting of smaller, simpler devices, including valves. A reactor is a
good candidate for containment.

42
Introduction to Objects Application Server User Guide

Templat es only exist in the development environment.

Using the Diaphragm valve template, you can quickly create a Diaphragm valve instance wh en you need
another Diaphragm valve in your application.

Templates Child Instances

Parent Template

Derived Template

Derived Template

Each template inherits Each object instance

attributes inherits attributes
from the one above it from its template

Propagation
If you need to change something about all diaphragm valves, you can change the template for the
Diaphragm valve and all diaphragm valves in your application inherit the changes, assuming the
attributes are locked in the parent template. This makes it easy to maintain and update your application.

About Base Templates

When you first open the IDE, you see a set of read-only base tem plates, which are indicated by an
orange lock symbol. If you based your Galaxy on the Default.cab, you will also see a set of first -level
derived templat es, separat ed into subfolders, in the Template ToolBox.

43
Application Server User Guide Introduction to Objects

You cannot modify base templates, but you can use them to create derived templates, which are copies
of the base templates. We recommend that you use the first -level derived templates that are provided
under the _Default Templates folder to create additional templates. Most of these first-level derived
templates have the prefix Master_. You can modify derived templates and use them to creat e instances
of them for your applications.

The Template Toolbox includes:

 Asset templates
Use these templates to represent real devices in your Galaxy, such as pumps and valves.
 Device integration templates
Use these templates to create instances that communicate with external devices, such as PLCs.
 System templates
Use these templates to define system instances, like other computers.

44
Introduction to Objects Application Server User Guide

Application Templates
These base templates let you easily create devices in your Galaxy. They contain the properties you need
to set for each kind of device. For example, a DiscreteDevice device c ontains all the settings you need to
specify for an on/off device. Of course, you can extend and customize any device by using attributes,
scripts, and feat ures.

Device Integration Templates

These base templat es represent the communication with external devices. External devices run on the
application engine.
For example:
 DINet work object – Refers to the object that represents the network interface port to the device
through the Data Access Server. The object provides diagnostics, and configuration for that specific
card.
 DIDevice object – Refers to the object that represents the actual external device (such as a PLC or
RTU), which is associated to the DINet work Object.

System Templates
These objects represent the parts of a Galaxy and not the domain they are monitoring/controlling. These
base templates let you create more system level grouping and computers, such as areas you add
objects to or another host AppEngine.

WinPlatform Object
The WinPlatform platform object is a key base object becaus e you need a platform to host the objects
you are modeling. This object:
 Calculat es various statistics for the node it is deployed to. These st atistics are published in attributes.
 Monitors various statistics related to the node it is deployed to. Thes e monitored attributes can be
alarmed and historiz ed.
 Start and stop engines, based on the engines startup type which are deployed to it.
 Monitor the running state of engines deployed to it. If the plat form det ects an engine failed, it can,
optionally based on the value of the engine’s restart attribute, restart the engine.

AppEngine Object
The AppE ngine object must have a Platform on which to run. This object:
 Hosts ApplicationObjects, device integration objects and areas.
 Cont ains the logic to set up and initialize objects when they are deployed.
 Cont ains the logic to remove objects from the engine when they are undeployed.
 Determines the scan time which all objects within that particular engine run.

Area Object
All application objects belong to an area. Areas can contain sub -Areas. Areas provide a key
organizational role in grouping alarm information and providing that information to those who us e
alarm/event clients to monitor their areas of responsibility.
The values of three Area object alarm attributes can be saved to the historian:
 Active alarm counter
 Unacknowledged alarm counter

45
Application Server User Guide Introduction to Objects

 Disabled (or silenced) alarm counter

ViewEngine Object
The ViewEngine object must have a Platform on whic h to run. This object:
 Hosts InTouchViewApp and ViewA pp objects.
 Cont ains the logic to set up and initialize objects when they are deployed.
 Cont ains the logic to remove objects when they are undeployed.
 Determines the scan time which all objects within that particular engine run.
 Determines if the ViewA pp objects that it hosts will be read/ write or read-only.

Note: InTouch applications are not affected by the "ViewApps are Read Only" setting of the
ViewEngine. This setting is used for the ViewA pp object only.

InTouchViewApp Object
The InTouchViewApp object must have a ViewEngine on which to run. This object:
®
 Manages the synchronization and delivery of files required by the associated InTouc h application.
 Provides run-time access to tags on the associated InTouch application.
 Starts WindowMaker for the associated InTouch application when edited.

Note: InTouch applications are not affected by the "ViewApps are Read Only" setting of the ViewEngine
that hosts the InTouchViewApp object. This setting is used for the ViewApp object only.

ViewApp Object
The ViewApp object must have a ViewEngine on whic h to run. This object:
 Provides visualization at run time for an InTouch OMI application.
 Incorporates a Screen Profile and the content defined in an associated Layout.
 Provides run-time access to your production environment.
 The deployed ViewA pp can be read/ write or read -only, depending on whether the ViewE ngine
hosting the ViewApp object has its "ViewApp are Read Only" setting enabled (ViewAppsReadOnly
attribute set to true).

About Derived Templates

All templates you create within the IDE are derived templates.
When creating your Galaxy application, plan ahead and create derived templates for devices of a certain
type so you can use the templates to create the individual instances.
A new derived template is an ex act copy of its parent template with the possible exceptions of locking
and security and modified attribute values. You can lock attributes to prevent them from being modified in
child templates.
After you create a new derived template, you can customize it. For more information about customizing
and extending templates, see Create Derived Templates on page 52.
E very template has a set of attribut es and default values. When you create an instance, attributes are
inherited by the instance. In the instance, you can rec onfigure many of the attributes inherited from the
parent template if they are not locked on the parent template.
For more information about customizing instances, see Edit Objects on page 63.

46
Introduction to Objects Application Server User Guide

View Object Properties

You can view the properties of an object by right-clicking and clicking Propertie s. Object properties vary,
depending on the type of selected object and whether it is a base template, a derived template, or an
instance.

The Properties window contains the tabs that allow you to examine different object properties. Only tabs
applicable to the object are displayed.

Tab Name Di splayed for Object Type:

General All objects including GalaxyObject

Attributes All objects except GalaxyObject

Referenc es Instances only

Cross References Instances only

Change Log All objects including GalaxyObject

Operational Limits All objects including GalaxyObject

Errors/Warnings All objects except GalaxyObject

The General tab contains basic information for the object, such as the codebas e (major version), what
template it is derived from, and any current errors and warnings.
The Attributes tab lists the object’s attributes and values. In addition to attributes t hat have been added
to the object, attributes for Errors and InAlarm are also listed, as are attributes for CodeBase (major
version of the object), MinorVersion ("dot" version), and ConfigVersion. The ConfigVersion will increment
each time the object has been checked in after an edit.

47
Application Server User Guide Introduction to Objects

The Reference s tab lists I/O references for the object.

The Cross References tab lists any attributes that are cross referenced for the object.
The Change Log tab is a historical list of changes, including deploy/undeploy oper ations, that have been
made to the object.
The Operational Limits tab lists prohibited actions and the reason for the prohibition. For example,
Check In is not allowed for objects that are already checked in.
The Errors/Warnings tab lists any errors or warnings for the object.
For more information about specifying the properties of objects, see Work with Objects on page 49.

48
 Application Server User Guide

C HAPTER 3
Work with Objects
You can work with objects using the Application Server development environment. Both templates and
instances are collectively referred to as objects. For more information about what templat es and
instances are, see About Templates and Instances on page 41.

In This Chapter
Manage Toolsets .......................................................................................................................... 49
Manage Galaxy Style Libraries ...................................................................................................... 51
Create Derived Templates ............................................................................................................. 52
Create Contained Templates ......................................................................................................... 54
Edit Objects.................................................................................................................................. 63
Browse for Attributes ..................................................................................................................... 83
Browse for Graphics ..................................................................................................................... 87
Browse for Element Properties ...................................................................................................... 88
Create a Filter for the Galaxy Browser............................................................................................ 89
Change How Information is Shown in the Galaxy Browser ............................................................... 91

Manage Toolsets
Toolsets are high-level folders shown in the Template Toolbox and Graphic Toolbox. You can create a
toolset to store the templat es and graphics used in your application. You can also creat e toolsets within
toolsets.
Use the Template Toolbox to view and organiz e object templates.

49
Application Server User Guide Work with Objects

Use the Graphic Toolbox to view and organize ArchestrA Symbols, ViewApp Layouts, Screen Profiles,
and cont rols and apps.

You can move content bet ween their respective toolsets (folders). You can also show or hide toolsets to
make the workspace less cluttered.

Create Toolsets
When you create your own toolset, it must have a unique name. Toolset names are not case sensitive, so
Valves is the same name as valves. A toolset name can be up to a maximum of 64 alphanumeric and
special characters, including spaces, except $.
To create a new toolset in the Toolbox
1. On the Galaxy menu, point to New and click either Template Toolset or Graphic Tool set.
2. Type a name for the new toolset.
A new toolset appears and is in focus. Now, you can drag templates into the new Template toolset,
or you can drag graphics into the Graphics toolset.

Create Child Toolsets

Toolsets can be created wit hin existing toolsets. Nested toolsets help in further organizing templates and
graphics. You can creat e a maximum of ten levels of toolset folders.
To create a child toolset
1. Select the parent toolset.
2. On the Galaxy menu, point to New and click either Template Toolset or Graphic Tool set.
3. Type a name for the new toolset.
A new toolset appears beneath the parent toolset and is in focus.

50
Work with Objects Application Server User Guide

4. Drag templates into the new child Templat e toolset, or you can drag graphics into the Graphics
toolset.

Deleting Toolsets
You can delete toolsets you no longer want or need. Before you start, make sure you move or delete all
content from the toolset.
The toolset you want to delete must be empty, or it cannot deleted.
To delete a toolset
1. Select the toolset you want to delete.
2. On the Edit menu, click Delete.
3. Click Yes to delete the toolset.

Manage Galaxy Style Libraries

A Galaxy Style Library applies a set of visual and numeric styles to ViewApps in the current Galaxy. A
Galaxy Style Library includes:
 A set of Quality and Status format styles that are applied to elements in a ViewA pp to indicate the
status or quality of specified ArchestrA attributes.
 A set of pre-defined and user-defined Element Styles. These define visual properties, such as file,
line, and text graphic elements.
 A set of pre-defined and user-defined numeric format styles. Depending on the format style, these
define the value range, precision, whether or not the number has a fixed width, and start/end bit
positions of common types of numbers.
A Galaxy Style Library can be exported from the IDE and imported into other Galaxies.

Note: Only one Galaxy Style library can be loaded and used in a Galaxy at a time.

A Galaxy Style Library includes two types of Element Styles:

 Pre-Defined Element Styles. These Element Styles have been configured with default values, but
you can modify them to your requirements.
 User-Defined Element Styles. These Element Styles do not contain preset values and can be
configured to meet the needs of your applications.
You can create your own Galaxy Style Library by overriding the default style configurations and exporting
the library. For information about setting Element Style overrides, see "Working with Element Styles" in
the Creating and Managing ArchestrA Graphics User’s Guide.
If you want to restore the original default visual properties for your graphic elements, each of the s tyles
pages includes a Re set to Default button.

Import a Galaxy Style Library

To import a Galaxy Style Library
1. On the Galaxy menu, click Import and click Galaxy Style Library.
2. Browse for the library file. Galaxy Style Library files are XML files.
3. Select the file and click Open. The selected Galaxy Style Library is loaded in the IDE.
If you imported a Galaxy Style Library, it is now the active Galaxy Style Library for the entire Gala xy.

51
Application Server User Guide Work with Objects

Note: If a Galaxy Style Library is imported to the IDE while a ViewApp is running, application graphics are
refres hed with new Element Styles. The ViewApp refreshes automatically. A restart is not required.

Export a Galaxy Style Library

You can create your own Galaxy Style Library by overriding the configuration of Element Styles and
exporting the library. For information about setting Element Style overrides, see "Working with Element
Styles" in the Creating and Managing ArchestrA Graphics User’s Guide.
To export a Galaxy Style library
1. On the Galaxy menu, click Export and click Galaxy Style Library. The Export Galaxy Style
Library dialog box appears.
2. Browse to a path and type a name for the exported library file.
3. Click Save. The file is saved with the specified name and a .xml file extension.

Reset a Pre-Defined or User-Defined Galaxy Style Library

If you changed the values of Quality and Status values, Pre-Defined or User-Defined Galaxy Element
Styles, or Format Styles, you can restore the default values by clicking the Reset to Default button.

Create Derived Templates

All templates you create are derived templates. A derived template inherits attribut es and behaviors from
the parent template. You cannot change the attributes in a base template.
After you create a derived templat e, you can customize and modify its attributes. If you change locked
attributes in the parent templat e, the changes propagate to the derived template.

Templates Object Instances

Base Template

Derived Template

After you create derived templates, you can customize them, and you can create instances of the
templates. You c an change and modify unlocked attributes in the instances, making adjustments to meet
the needs of the specific object you are modeling.
For example, your plant processes can use several models of a pump made by a single vendor. Each
model has unique characteristics that map to different attribut e values of the Discret eDevice base
template.
To derive a template from another template
1. Select the base template to use as the parent template in the Template Toolbox or Derivation
views pane.

52
Work with Objects Application Server User Guide

2. On the Galaxy menu, click New and click Derived Template. A derived template is created in the
same toolset as its parent and plac ed in name edit mode. The default name is the same as the
parent template followed by a numeric sequence.
3. Rename the derived template, if needed. Template names can be up to 32 alpha numeric or special
characters, including the required $ as the first character. The second character cannot be $ and the
name must include at least one letter. Template names cannot contain spac es.

Note: The following reserved names cannot be us ed as templat e names: Me, MyContainer, MyArea,
MyHost, MyPlatform, MyEngine and System.

4. You are ready to customize your new template. For more information, see Edit Objects on page 63.

Derive Templates from Another Derived Template

You can create derived templates from other derived templat es. The child template inherits attributes
from all parent templates. Any changed attributes in the immediate parent overrides attributes changes
in grandparent levels.
If you change locked attributes in the parent template, the locked attributes propagate to the derived
template.

Templates Object Instances

Derived Template

Derived Template

A derived template is an exact copy of its parent with the exceptions of locking, security, and the
unlocked attributes that have been edit ed. If you create a new derived template from an existing
container template, the new derived template has the same contained templates.
A good practice is to create a hierarchy of derived templat es until you reach logical endpoints. Then
create instances from each unique derived template.
To create a derived template from a derived template
1. In the Template Toolbox or Derivation view, select the derived template you want to use as the
parent template.
2. On the Galaxy menu, click New and click Derived Template. A derived template is created in the
same toolset as its parent. You can edit the name of the ne w derived template. The default name is
the same as the parent template followed by a numeric sequence.
Templat e names can be up to 32 alphanumeric or special characters, including the required $ as the
first character. The second character cannot be $ an d the name must include at least one letter.
Templat e names cannot contain spaces.

Note: The following reserved names cannot be used as template names: Me, MyContainer, MyArea,
MyHost, MyPlatform, MyEngine and System.

53
Application Server User Guide Work with Objects

3. You can c reat e another derived template by repeating the previous steps, or you can customize y our
new derived template. For more information about customizing your template, see Edit Objects on
page 63.

Create Contained Templates

Cont ainment is the relationship in which one object includes another. Containment relations hips
organize objects in a hierarchy. You can build objects that represent complex devices consisting of
smaller, simpler devices.
In scripts, these objects can be referred to by the name that derives from the containment relationship.
This name is called a hierarchical name.
An object can have three kinds of names if it is contained by anot her object. The three names include:

Name Description

Tag Name The unique name of the individual object. For example, Valve1.

Cont ained The name of the object within the context of its container object. For example, the
Name object whose Tag name is Valve1 may also be referred to as Tank1.Outlet, if
Tank1 contains it and it has the contained name "Outlet".

Hierarchical Hierarchical names that are fully-qualified names of a contained object include the
Name name of the objects that contain it.
Because the object that contains it may also be contained, there are potentially
multiple hierarchical names that refer to the same object.
For example, if:
"Reactor1" contains Tank1 (also known within Reactor1 by its contained name
"SurgeTank").
"Tank1" contains Valve1 (also known wit hin Tank1 by its contained name "Outlet").
Valve1 could be referred to as:
"Valve1"
"Tank1.Outlet"
"Reactor1.SurgeTank.Outlet".

Note: Base templates cannot be contained by another template, either as the container or as the
template being contained. You can only use containment with derived templates.

54
Work with Objects Application Server User Guide

Higher level objects contain lower level objects. This allows you to more closely model complex plant
equipment, like tank systems. You can nest templates to 10 levels.

180

Inlet Valve

180

Outlet Valve

Level

Agitator

Note: Objects can only contain objects like themselves. For example, ApplicationObjects can only be
contained by other ApplicationObjects. Areas can only contain ot her Areas .

ApplicationObject Containment
ApplicationObjects can be cont ained by other ApplicationObjects. This provides context for the
contained object and a naming hierarchy that provides a powerful tool for referencing objects.

Note: Base templates cannot be contained by another template, either as the container or as the
template being contained. You can only use containment with derived templates.

An example of a containment hierarchy is a tank that contains the following objects:

 Inlet Valve
 Agitator
 Outlet Valve
 Level

55
Application Server User Guide Work with Objects

Tank Template

Tank

180

InletValve

Agitator

180

OutletValve

Level

To enable referencing and flexibility within scripting, these objects can be referenced in several different
ways. Each object has a unique tag name, such as:
 Inlet Valve = InletValve01
 Agitator = Agitator01
 Outlet Valve = OutletValve01
 Level = Level01

56
Work with Objects Application Server User Guide

Tank = Tank01

180

InletValve = InletValve01

Agitator = Agitator01

180

OutletValve = OutletValve01

Level = Level01

Within the cont ext of each hierarchy, the contained names are unique, in that the names only refer t o this
tank system and the contained objects.
So if the tank is named Tank01, the contained names are:
 Tank01.Inlet

 Tank01.Agitator
 Tank01.Outlet
 Tank01.Level

57
Application Server User Guide Work with Objects

Tank = Tank01

180

Inlet Valve = Tank01.InletValve

Agitator = Tank01.Agitator01

180

Outlet Valve = Tank01.Outlet01

Level = Tank01.Level01

58
Work with Objects Application Server User Guide

This naming convention adds context to the instances contained by Tank01.

Additionally, you can use containment references in scripts such as:

 Me.Outlet: Allows a script running within the parent object to generic ally reference its child outlet
instance.
 MyContainer.Inlet: Allows a script running in any of the children instances to referenc e anot her
child instance named Inlet that belongs to the same parent.

Using Contained Names

The contained name of a contained object only has to be unique in the context of its container.
An object can have t hree kinds of names, depending if it is contained by another object. The three names
include:

Name Description

Tag name The unique name of the individual object. For example, Valve1.

Cont ained name The name of the object within the context of its container object. For
example, the object whose tag name is Valve1 may also be referred to as
Tank1.Outlet, if Tank1 contains it and it has the contained name "Outlet".

59
Application Server User Guide Work with Objects

Name Description

Hierarchical name Hierarchical names that are fully-qualified names of a contained object
include the name of the objects that contain it.
Because the object that contains it may also be contained, there are
potentially multiple hierarchical names that refer to the same object.
For example, if:
"Reactor1" contains Tank1 (also known within Reactor1 by its contained
name "SurgeTank").
"Tank1" contains Valve1 (also known within Tank1 by its contained name
"Outlet").
Valve1 could be referred to as:
"Valve1"
"Tank1.Outlet"
"Reactor1.SurgeTank.Outlet".
For example, an instance of a $Tank is named Tank01. An instance of $Valve called Valve01 is
contained within the instance of $Tank.
Change the contained name of Valve01 to InletValve. Now Valve01 can also be referred to by its
hierarchical name Reactor1. InletValve. The name of the contained object can be changed, though,
within the scope of the hierarchy.
Cont ained names can be up to 32 alphanumeric or special characters. The second character cannot be
$ and the name must include at least one letter. You cannot use spaces.

Containment Examples
You can have a Tank object that contains two DiscreteDevice objects that represent its inlet and outlet
valves.

Note: Base templates cannot be contained by another template, either as the container or as the
template being contained. You can only use containment with derived templates.

To implement containment
1. Create the following instances: Tank1 from $UserDefined and Valve from $DiscreteDevice. Valve
has only one name, Valve.
2. In the Model or Deployment view, drag Valve on to Tank.

Note: If Tank1 already contains an object with a contained name of Valve, the Galaxy generates a
unique contained name for the newly contained object, such as Valve_001.

3. Change the contained name of Valve within Tank1 to Outlet. Valve can now be referred to by its
tagname, Valve, as well as its hierarchical name, Tank1.Outlet.
4. Create an instance called Reactor1 from $Us erDefined.

60
Work with Objects Application Server User Guide

5. In the Model or Deployment view, drag Tank1 onto Reactor1.

6. Change the contained name of Tank1 to Holding. Tank1 now has two names, Tank1 and
Reactor1.Tank. Also, Valve1 has a three-part hierarchical name: Reactor1.Tank.Outlet.
For the three objects in this example (Reactor1 cont aining Tank1 containing Valve1), the
following naming hierarchy exists:

To implement template-level containment

Note: Contained Templates do not have tagnames. When an instance hierarchy is created from a
template and its contained children, unique tagnames will be created for the instances based on their
contained names.

1. Create the following derived templates: $Tank from $UserDefined and $Valve from
$DiscreteDevice.
2. Derive $Inlet from $Valve.
3. In the Template Toolbox, drag $Inlet on to $Tank. If $Tank already contains a templat e named
Inlet, the Galaxy generat es a unique tagname for the new contained template, such as
Inlet_001.
The contained template now has a hierarchical name $Tank.Inlet.
4. Create an instance (Tank001) of $Tank.

61
Application Server User Guide Work with Objects

5. The Model and Deployment views show an instance Tank001 that contains an instance called
Inlet.

View Containment Relationships

Cont ainment relationships appear for templat es in the Template Toolbox. For instances, the
relationship appears in both the Model and Deployment views.
In the Derivation view, if a template contains other templates, you can expand it to show the
containment under that template.

The Derivation view shows templates and instances with regard to cont ainment in the following ways:
 Non-cont ained instances show their tagnames.
 Cont ained instances show their tagnames and hierarc hical names.
 Non-cont ained templates show their template name.
 Cont ained templates show their hierarchical name.

Rename Contained Objects

Before you rename a contained name of an object, make sure that the object is not checked out to
another user or currently deployed.
The new cont ained name must comply with naming restrictions. Template names can be up to 32
alphanumeric or special characters, including the required $ as the first character. The secon d character
cannot be $ and the name must include at least one letter. You cannot use spaces.
Cont ained names also cannot be the same contained name as an existing contained object within the
same level of hierarchy in the containment relationship.

WARNI NG! Be careful when renaming contained objects. References from other objects to the
object being renamed are not automatically updated with the new name. You must update the
references. Objects with broken references receive bad quality data at run-time.

62
Work with Objects Application Server User Guide

To rename an object’s contained name

1. Select the object in an Application view.
2. On the Edit menu, click Rename Contained Name.
3. Type a new contained name.
All IDEs connected to the Galaxy show the object’s new cont ained name.

Edit Objects
With the Object Editor, you define attribut es specific to an object. When you open the Object Editor in
non-ReadOnly mode, the object is checked out. No one else can edit an object while you are working
with it. If someone else is already working on the object, you can open it to view but you cannot make
changes.
The Object Editor contains pages that can be used to modify objects. To view a page in the editor, click
its tab. Three pages – Attribute s, Scripts, and Object Information – are common to all objects, while
other pages are unique to certain object types. If you import a Galaxy or objects with field attributes, the
Field Attribute s page will be present for those objects; the Field Attributes page can also be enabled
through a Galaxy user configuration option. See Configure Us er Information on page 37 for more
information.
The Attributes page divides into two or more panes when you initially open it. The number of panes the
Attributes page divides in depends on whether or not attributes or symbols have been defined for the
object, whether the object is an instance or a template, and if it is an instance, whether or not it is derived
from a template that includes an Object Wizard.

When editing an object, you may see attribute text boxes showing a --- (dash dash dash). The --- is a
placeholder reference that does not cause the associated object to be placed in a warning configuration
status when it is validat ed. You may also see attribute text boxes showing a
---.--- (dash dash dash dot das h dash dash). You need to provide a valid reference in the text box. The
---.--- placeholder causes the associated object to be placed in a warning configuration status when the
associated object is validated.

63
Application Server User Guide Work with Objects

Important: Edit the I/O auto assignment placeholder in the Object Editor ONLY if you do NOT want to
use I/O auto assignment for the object. In most cases, I/O auto assignment is the preferred method.

When you save an object, the configuration dat a fo r the object is validated. If errors or warnings are
identified during validation, a message appears. You can cancel the save or save the object
configuration as it is.
 If you cancel, the Object Editor remains open so you can correct the problems.
 If you save the configuration as it is, the object is placed into a bad or warning state. The object’s
status is marked in the Galaxy database as Good, Warning or Error. Error means the object is
undeploy able.
To edit an object in the Object Editor
1. Select the object.
2. On the Galaxy menu, click Open. A red check mark appears next to the object’s icon indicating it is
checked out and the Object Editor opens.

Note: If you are adding I/O attributes to an application object or system object, such as an area
object, the preferred method of adding and editing I/O references is through the IO Device s view
and IO Device Mapping view. Editing I/O references set for aut omatic assignment in the Object
Editor disables automatic assignment. For more information about I/O auto assignment, see Using
I/O Auto Assignment on page 140.

3. Make your changes. For more information about locking attributes, see About the Attributes Page on
page 69. For more information about setting security, see Set Object Security on page 68.
4. When you finish configuring the object, click Save or Close on the Galaxy menu.
 Save keeps the editor open and saves all configuration changes to the Galaxy database.
 Close closes the editor.
 To keep the object checked out, select the Keep Checked Out check box before closing.

Object Editor User Assistance

Tooltips are available in the Object Editor. Point to any editor option and a tooltip appears, showing the
attribute name. This name is used when referring to the attribute in scripts, for example.
Each object also includes documentation about usage, configuration, run -time behavior, and attributes.
For help with configuring the object, select the object in the Template Toolbox or in an application view
and press Ctrl + F1, or right-click on the object and select Object Help from the shortcut menu. If you
want, you can customize the object help file. See Customize Help on page 76 for more information.

Help File Structure

The header part of the Help file contains the following information:

 Tag name The object’s name.

 Cont ained Name The object’s contained name. For more information, see Create
Cont ained Templates on page 54.

 Description A short summary of what the object is for.

 Code Base The code version of the object.

 Derived From The immediate parent template for the object.

64
Work with Objects Application Server User Guide

 Object Version The configuration version of the object.

 Process Order The run-time execution order within the host engine's scan (none,
before, after) relative to the Relative Object element.

 Relative Object The object that runs before or after in the Proce ss Order.

The rest of the help file shows general information about the object.

About the General Editor Layout

When you open the attributes for an instance or a template, you see the Object Editor. The Object Editor
is where you configure the object's attributes and add scripts or associated graphics to the object. The
Object Editor has several pages related to the type of object you select. If you are working with an
instance, you see different pages than if you are working with a template.
For example, the following illustration shows an analog devic e template.

When you open the Obj ect Editor, the object is automatically checked out so no other user can work on it.
When you close the Object Editor, the object is checked in to the Galaxy database, if it was aut omatically
checked out when the editor was opened.
 To keep the object checked out, click Keep Checked Out before closing.

 To save configuration changes you made, close the editor, and check the object back in
About the Object Information Page on page 75, click the Close icon.
After the object is checked in, other us ers can edit it.

Lock and Unlock Template Attributes

When you create derived templates, you can lock or unlock some or all of the attributes and enabled
features. Locking an attribute prevents it from being changed in derived templates or instances. You can
only lock attributes in templates.

65
Application Server User Guide Work with Objects

Locking an attribute in a templat e specifies that its value or s etting is inherited by all derived objects, both
templates and instances. Locking an attribute also makes the attribute act as a constant during run time.

Note: When you lock values and settings for an attribute, they are not visible when you us e Object
Wizards, and thus the locked values and settings will be inherited by all derived objects.

In the Attribute s page, you must enable locking before an attribute or any of its features can
be locked in a template. To enable locking, click the Show/Hide Lock icon to the right of the
attribute name. When locking is enabled, lock symbols will appear next to values that can be
locked. Lock symbols are not visible in the template or its derived instances unless locking is
enabled.
 Attributes that are locked in a parent template are referred to as "locked in parent." This parent can
be at any parent level above the selected object.
 Attributes that are locked in a template are referred to as "locked in me."

Caution: When using I/O auto assignment, do not lock the "Read from" field (input source) or "Write to"
field (output destination). If you lock these fields in the parent templat e, they cannot be updat ed with the
resolved reference when the object is deployed and the runtime value will be " ---A uto---".

See Group Lock ing/Security on page 69 for information about locking or unlocking all of a feature’s
attributes with a single click.

Lock controls and status are shown with an icon. If the option is enabled, click the lock control to switch it
between locked and unlocked. These icons mean:

66
Work with Objects Application Server User Guide

Icon Name Description

Locked The associated attribute is locked (in me) and enabled. Only templates
(in me) can have this kind of lock. The attribute value is read/writ e.
Derived templates and instances do not have a unique copy of this
attribute. Child objects share the locked attribute of the parent.
Changing the value of a locked attribute in the parent template updates the
value of that attribut e in all derived templates and instances.

Locked The associated attribute is locked in the parent object and cannot be
(in parent) unlocked or modified by the child object. Both templates and instances can
have these. The attribut e is read-only.
The templates and objects do not have a unique copy of this attribut e, but
instead use the attribute value in the parent where the attribute is locked.

Unlocked The associated attribute is unlocked and enabled. Both templates and
instances can have this kind of lock. The attribute is read/write.
The object has its own copy of the attribut e value and the value is not
shared by derived objects.

Indeterminat e Refers to a specified group of options. An indeterminate state indicat es

different lock states for individual options in the group.

Undefined The associated attribute doesn't exist. This indicates that another attribut e
be enabled before the associated attribute is created and before its lock
status can be determined.

Note: Locking an attribute during configuration makes its value a constant. You cannot write to locked
attributes during run time.

To lock an attribute example

1. Create a derived template from the $DiscreteDevice bas e template. Name the derived template
$Valve.
2. Open the $Valve template and on the State s page, lock one of the attributes by clicking the Lock
icon.
3. Save $Valve.
4. Create a derived template from $Valve. Name it $BigValve.
5. Create an instance from $Valve named Valve1.
In the editor of $Valve, the attribute lock icon shows the attribute is locked in me.
You cannot change the attribute value in $BigValve and Valve1. The editor options for the
attribute are disabled and the lock icon, if shown, indicates a lock in the parent. Also, the attribute
lock icon in children derived from $Valve is now locked and disabled.
If you change the attribute value in $Valve, the change propagates to $BigValve and Valve1
after you save the changes.

67
Application Server User Guide Work with Objects

To unlock an attribute example

1. Using the objects from the previous example, in the $Valve template’s editor, unlock the locked
attribute.
2. Save $Valve.
In the editor for $Valve, the attribute lock icon shows it is unlocked.
The lock type for this attribute of $BigValve now indicates locked in me. The lock type for this
attribute of the Valve1 instance shows unlocked but the locking icon is unavailable.

Set Object Security

Operators interact with objects through the individual attribut es of those objects. Each attribute on the
Object Editor that can be modified by operator's at run time and can have an associated security control,
which is used to modify its run-time security classification.
In the Attribute s page, security icons must be enabled before you can set security for an
attribute or any of its features in a template. To enable security, click the Show/Hide
Security icon to the right of the description field.
When security is enabled, security symbols will appear next to values for which security is configurable.
Security symbols are not visible in the template or its derived instanc es unless enabled in the parent
template.
If an attribute's security classification is configurable, click the security control to select one of seven
possible states:

Security Icon Description

Lets you change this value without restriction even if you have no defined
permissions on the object. Anyone can write to these attributes to perform safety
or time critical tasks that can be hampered by an untimely logon request, such as
halting a failing process.

Lets you work with Operate permissions to do certain normal day -to-day tasks.
These include writing to attributes like Setpoint or Command for a Discrete
Device object. This level of security requires you to have Operat e permission for
the security group for the object.

Requires you to authenticate using your user name and password each time you
want to write to the attribute. You also need to have Operate permissions for the
object.

Requires you to have Operate permissions to log on again and a second,

different user to also log on as the verifier before writing to the attribute. The
verifier needs to have Can Verify Writes permission for the object.

Allows end users with Tune Operational permissions to tune the attribut e in the
run-time environment. Examples of tuning are attributes that adjust alarm
setpoints and P ID sensitivity.

68
Work with Objects Application Server User Guide

Security Icon Description

Allows end users with Configure Operational permissions to configure the

attribute’s value. Requires that the user first put the object off scan. Writing to
these attribut es is considered a signific ant configuration change. For example, a
PLC register that defines a Discret e Device input.

Only allows users to read this attribute’s value in the run-time environment. This
attribute is never written to at run time, regardless of the user's permissions.

If an attribute’s security is shown in gray, its security classification is locked in its parent object and
cannot be changed or it requires the enabling of a group attribute.

Group Locking/Security
The lock and security controls associated with option groups and features quickly set those conditions for
all options in the group.

The group control typically reflects the setting for all options in the group or feature set. But, if
at least one option in the group has a lock or security control that is different from the other
options, the group control shows an indeterminate icon.

In addition to the undefined controls, the group c ontrols for locking and security are the s ame as those for
individual options.
You can lock or unlock all of the attributes associated with a feature by selecting the lock icon next to the
feature name, after you activat e the feature. This will lock or unlock all of the attributes for the feature,
unless an attribute was locked at a higher level. For example, if you locked an attribute in a template, and
then created another derived template, the attribute that was locked in the original template cannot be
unlocked (locked in parent).
If an attribut e is locked in the template, you can change the value in that template, but not in the derived
children. If you change the value in the parent template, the change propagates to all child objects. For
more information, see Configure Objects on page 115.

About the Attributes Page

If the object you are editing does not have any attributes defined, the Attribute s page will be empty. The
Attribute s page will also show a pane for symbols, and depending on the type of object (template or
instance) and its contents, may show additional Object Wizard configuration panes.

69
Application Server User Guide Work with Objects

You can activate various features, such as I/O, History, State Alarm and Statistics. See Configure
Objects on page 115 for more information about attributes and features. When you add an attribute to an
object, information about the attribute is shown.

Opens the Object Wizard editor.

To filter attributes, click the Filter button. You can then select filtering criteria by checking
source type, enabled feature type, writ eability type, lock status, data type, visibility type
(hidden or not hidden), and diagnostic type (configuration, run time, or both).
Adds a new attribut e.

Duplicates the selected attributes.

Removes the selected attributes.

To display the Scripts pane us ed to associate scripts with an Object Wizard, click the
Scripts button.
Shows Details about an attribute. The name, description, and icons representing activated
features for the object’s attributes will be shown.

When you add an attribute to an object, the Attributes page divides into three sections. The left side of the
page lists attributes, the top right shows information about the currently selected attribut e, and the
bottom of the right side contains fields for configuring feat ures.
You can search attribut es by entering the characters you are trying to find in the Search Current
Attributes text box. This will display attributes that contain the characters you enter.

Note: The search function finds attributes that contain the search term any where within the attribute
name. For example, if you want to locat e all attributes associated with P ump125, you could enter "125" in
the text box. All attributes with 125 anywhere in their names will be shown.

You can also search for attributes by typing the character you are searching for when the curs or is
pointed at the attribute list. The first attribute that contains the character, any where within its name, will
be highlighted.

70
Work with Objects Application Server User Guide

Note: The search begins at the attribute that is currently selected. Selection will move to the next
attribute that contains the character entered.

 On the left side of the page, all attribute names for the object are listed. Pressing the Show Details
button reveals additional information about the listed attributes. Check boxes are provided for
Inherited and User extended.
o Inherited: Checking this displays attributes that were added in the parent template used to
create the object.
o User extended: Checking this displays details about any features you added to the attribute, for
example, for I/O.
 At the top of the right side, information for the current attribute is listed. Additional fields may be
listed, depending on the data type of the attribute. H owever, all data types include the following
properties:

Property Description

Name Attribute name (for example, Attribute001).

Description User defined; a description of the attribute.

Data type Can be set to Boolean, Integer, Float, Double, String, Time, ElapsedTime, or
InternationalizedString.
The data type determines which features can be added to an attribute. For
example, when configuring a Boolean data type, only two alarm features are
available: State Alarm and Bad Value Alarm. When configuring an Int eger
data type, there are four available alarm features: Limit Alarms, ROC Alarm s,
Deviation Alarms and Bad Value Alarms.
To create an array, check the Array option and specify the array's length in the
# of elements box. You can creat e an array for each data type except
InternationalizedString.

71
Application Server User Guide Work with Objects

Property Description

Writeability Can be set to Calculated, Calculated retentive, Object writeable, or User

writeable. See the Object Viewer User’s Guide for additional information about
writeability categories.
 Calculat ed: Permits only scripts within the same object to write to the
attribute. Calculated attribut es are not saved across restarts. If you select
Calculat ed for an attribute, only scripts running on the same object can
write to the attribute.
 Calculat ed Retentive: Permits only scripts within the same object to write to
the attribute. Calculated Retentive attributes are saved across engine
restarts.
 Object Writeable: Permits other objects to write to this attribute in addition
to being set by scripts within this object. Object Writeable attribut es are
saved across restarts. This category is not user writeable.
 User Writeable: Permits other users to write to this attribute in addition to
being set by scripts and objects throughout the system. User Writeable
attributes are saved across restarts. They can be locked at configuration
time. If locked, they are read only.

Initial value Specifies the initial value for the attribut e when the object is deployed. Enter
value dat a for each data type. In the case of a non-arrayed Boolean, select
True or False in the list box. For an arrayed Boolean, select the appropriate
checkbox.

 At the bottom of the right side, fields for configuring activated feat ures are displayed. A vailable
features include:

Feature Description

The I/O feature is used to activate the attribute for I/O. You can select Read
(input), Read/Write (input and out put), or Write (out put).
When you select the I/O feature for application objects and system objects,
such as areas, the "Read from / Write to attribute text box contains the
placeholder reference <IODevice>.
[HierarchicalName].[AttributeName].InputSource or
<IODevice>.[HierarchicalName].[AttributeName]. OutputDest.
You should not edit these placeholders in the Object Editor, but instead use the
IO Devices view to assign the object to a scan group. This will allow the
placeholder to automatically resolve to the correct I/O reference. See Using I/O
Auto Assignment on page 140 for additional information.

The History feat ure enables historization to the Wonderware Historian.

Note: The AppE ngine hosting the object must be configured for historization.

The State Alarm feat ure is available for Boolean data types. You can set alarm
priorities, the alarm state, an alarm message, and time deadband.

72
Work with Objects Application Server User Guide

Feature Description

The Limit Alarms feature is available for integer, float, and double dat e types.
With it, you can set value alarms (Hi, HiHi, Lo, LoLo), and the limits, priority, and
messages to apply to each alarm limit.

The Rate of Change (ROC) Alarm feature is available for integer, float, and
double date types. With it, you can set alarms if changes within a time period
exceed specified values, and the limits, priority, messages, and time period to
apply to each ROC alarm.
The Deviation Alarm feature is available for integer, float, and double date
types. With it, you can set deviation alarms (major and minor), and the
tolerance, priority, messages, target value, deadband, and settling period.

The Bad Value Alarm feature adds an alarm if the value returned from the
attribute is determined to be bad quality.

The Statistics feature monitors statistics associated with the object.

The Log Change feature will cause the attribute to generate an event each time
the attribute value changes.

73
Application Server User Guide Work with Objects

About the Scripts Page

The Scripts page is divided into several areas. To learn more about using scripts, see Writing and
Editing Scripts on page 152.

The main areas of the Scripts page include:

 Scripts list: Shows all scripts currently associated with the object. The columns indicate which kind
of trigger the script uses: Startup, On Scan, Execute, Off Scan and Shutdown. Click the Add button
( ) to add a new script.
 Inherited scripts name list: Shows all scripts associated with the object’s parent. The columns
indicate which kind of trigger the script uses: Startup, On Scan, Execute, Off Scan and Shutdown.
 Aliase s area: Lets you create and modify aliases that apply to the script you are working on. Aliases
are logically descriptive names for typically long ArchestrA reference strings that you can use in the
script to make the script more readable.
 Declarations area: Provides a plac e to add variable declaration statements, such as DIM
MyArray[1] as FLOAT;. These declared variables live from the start to the shutdown of the object
and can be used to hold values that persist from one execution of the script to the next. They apply
only to the script in which they are declared.
 Basi cs area: Provides a location in which you set the expression, triggering conditions, and other
settings that run the script in the run-time environment. See Writing and Editing Scripts on page 152
for descriptions of triggers and when they are executed. This area includes:
Configure Execution Order: Sets the execution order of multiple scripts (inherited and local)
associated with this object.
Hi storize Script State: Select to send the state of the script to the Wonderware Historian.

74
Work with Objects Application Server User Guide

 Script Creation box: Shows the script you are writing.

About the Object Information Page

The Object Information page is common to all object configuration editors.

This page includes the following fields:

 Description: A short summary of the object’s purpos e.
 Hierarchical Name: The fully qualified name of a contained object, including the container object’s
TagName.
 Container: The name of the other object that contains this object, if applicable.
 Codebase: The code version of the object.
 Derived From: The immediate parent template of the object, either a base or derived template.
 Host: Another object to which the object is assigned (for example, a WinPlatform hosts an
AppEngine). An object's host determines where an object will run when it is deployed.
 Area: An object that repres ents a logical grouping to which this object belongs. An object's area
mostly affects the way in which its alarms are reported to alarm clients.
 Security group: The security group the object is associated with.
 Execution order: If you want this object to run before or after another object within its engine's scan,
select from the Proce ss order list. Click the Browse button to specify the Relative object in the
Attribute Brow ser. For more information about the Attribute Brow ser, see Reference Objects
Using the Galaxy Brows er on page 83.
 Add Object Help: Opens a copy of the HTML help page for the template this object is derived from.
You can edit this information. This allows you to creat e Help about the object you are currently
configuring for downstream users. This Help appears when you select an object in a view and then
click Object Help on the Help menu. See Customize Help on page 76 for more information.

75
Application Server User Guide Work with Objects

Customize Help
Do not use Microsoft Word as an editor to create downstre am object HTML help pages. Use an HTML or
plain text editor instead.
If clicking Add Object Help opens Word on your computer, change the program associated with editing
HTM files. Open the Windows Explorer's Folder Options dialog box and go to the File Types page to
make this change. For more information about associating programs with files, see your Windows help.

Locate the Help Folders

The path to each object’s Help folder is unique. It depends on the pat h you selected when you installed
the Galaxy Repository. The path to an object’s Help is:
\<Installation Path>\Framework\FileRepository\
<YourGalaxyName>\Objects\<TheObjectID>\Help\1033
The default is:
<Installation Path> is \<Program Files\ArchestrA\
To add images to the Help file, place the images in the proper folder on the Galaxy Repository computer
and use a relative path to those images in the HTML file.
For the previous example, place images in the \1033 folder or create an images folder under it.

About the Field Attributes, UDAs, and Extensions Pages

Starting with Wonderware Application Server 2014 R2, the functionality of Field Attributes, UDAs and
attribute extensions has been combined into a single unit of functionality simply called an Attribute. The
functions and capabilities of the Field Attribute s, UDAs, and Extensions pages in the Object Editor
have been combined and made available in the Attribute s page.

The UDAs and Extensions pages are no longer present in Application Server 2014 R2 and subsequent
versions. By default, the Field Attributes page does not normally appear in Application Server 2014 R2
and later versions, but will under the circumstances detailed in the next section.

76
Work with Objects Application Server User Guide

View the Field Attributes Page

While the Field Attribute s page is not displayed by default for Galaxies created with Application Server
2014 R2 and lat er versions, it will be displayed when you open an Us erDefined Object in the Object
Editor and any of the following conditions apply:
 The derived template or instance created from the $UserDefined base template contains Field
Attributes.
 You import UserDefined Objects created in a previous version of Application Server that contain
Field Attributes.
 You have an existing Galaxy with Field Attributes already defined and migrate it to System Platform
2014 R2 or later.
 You select the Show Field Attributes option in the Configure User Information dialog. See
Configure User Information on page 37 for more information.

Determine Whether to Convert Field Attributes

Converting Field Attribut es to Attributes provides the following advantages:
 It is easier and faster to work with Attributes, rather than Field Attributes.
 All of your Attributes will appear on the same Object Editor page if you convert Field Attributes.
 Attributes can provide performance advantages over Field Attributes during run time (t he actual
performance improvement can vary bet ween systems).
You may not want to convert Field Attributes if:
 You have a large number of objects that use Field Attributes.
 You do not want to modify and test scripts that reference Field Attributes.

77
Application Server User Guide Work with Objects

 The objects are working well using Field Attributes, and there is no active development on these
objects. Additional effort will be required for converting, testing, and redeploying objects.

Optimize Performance if You Use Field Attributes

If you choose to continue using Field Attributes, use the following guidelines to maximize performance:
 No more than 64 Field Attributes (maximum of 32 analog and 32 discrete) should be used for an
individual object. If this limit is exceeded, the performance of object editing and check-in operations
slows down significantly.
 Do not extend an existing Field Attribut e by activating features on the Attribute s page.
For example, to add historization t o an existing Field Attribute, select the Enable history option from
the Field Attribute s page.
DO NOT use the Attributes page to add the History feature.
 Converting from Field Attributes to Attributes will greatly enhance performance, particularly if many
Attributes are us ed.

Convert Field Attributes to Attributes

You can choose which objects with Field Attributes to convert to Attributes, but only first -level derived
objects can be selected. That is, you can only select templates and instances that are directly derived
from the $UserDefined base template. Objects derived from first-level templates or individual Field
Attributes cannot be individually selected for conversion.
When you start the conversion process, you are pres ented with a list of all first -level templates and
instances that contain Field Attributes. First-level templates without Field Attributes, but that have
derived objects with Field Attributes, are also listed. From this list, you will select which objects to
convert.
The conversion proc ess is hierarchical and cascades to all child templates and instances of the selected
objects. All Field Attributes contained in a template’s hierarchy of derived objects are converted.

Note: Objects will be unavailable for selection (grayed out ) if the object or any of its derived objects are
deployed, checked out, or protected. See Protecting Objects on Export on page 98 for more information
about protecting objects.

To convert field attributes to attributes

Before starting the conversion process, see Special Considerations when Converting Field Attributes on
page 81 for a discussion of potential differences in behavior between convert ed Attributes and the
original Field Attributes.
1. Back up all UserDefined Objects (UDOs) before starting Field Attribute conversion.
2. Ensure that all UDOs that you want to convert are checked in and not deployed. You will not be able
to convert Field Attribut es for objects that are deployed, checked out, or protected.

78
Work with Objects Application Server User Guide

3. From the Galaxy menu, select Configure, then Convert Legacy UserDefined Object(s)...

4. When you select Convert Legacy UserDefined Object(s)... from the menu, a list of all first-level
objects with Field Attributes is displayed. First-level templates that do not themselves include Field
Attributes, but have child objects with Field Attributes, are also listed.

5. Select the objects you wish to convert and click next.

79
Application Server User Guide Work with Objects

Note: Objects will be grayed out and unavailable for selection if the object or any of its derived
objects are deployed, checked out, or protected.

6. The next screen is informational, and shows that Field Attributes will be consolidated onto the
Attributes page. Click next to proceed.

7. The screen that follows is informational as well, and lists the limitations that apply to script
conversion. These are:
 Only field references that begin with "me." are converted.
 Field references outside the selected objects are not converted.
 Field references in scripts that use indirect functions or string manipulations are not converted.
 Field references within A rchestrA graphics are not converted.
8. Click next to proceed.
9. To begin converting Field Attributes for the selected first-level objects and their child objects, click
the Convert button ( ).

WARNI NG! Once you start the conversion process, it cannot be cancelled. The time needed to
convert Field Attributes depends on the number of objects with Field Attributes, the number of Field
Attributes, and the depth and complexity of the object hierarchy. Field Attribute conversion requires
at least as much time as Galaxy migration.

 Click back if you need to make any changes.

80
Work with Objects Application Server User Guide

 To cancel, simply close the dialog.

WARNI NG! While the conversion process is active, you cannot deploy or edit objects.

10. Each object is listed as its Field Attributes are converted. The status of the conversion process is
also reported to the SMC Logger.

Important: In the event that Field Attribut e conversion fails for an individual template, the template
will remain checked out after the conversion process stops. Undo the checkout for the template, and
then you can resume attribute conversion for any remaining objects. To find which template did not
convert, check the SMC Logger.

11. When all objects containing Field Attributes have been converted, click Close.

Special Considerations when Converting Field Attributes

When you convert Field Attribut es to Attributes, there may be some differences bet ween the original
Field Attribute and the converted Attribute.
 If the Field Attribute "Bad. Condition" was extended (for example, by adding historization), it will send
alarm notifications after conversion, even if alarming was not enabled.
 Prior to conversion, the Field Attribute description is Analog_001.Desc. After conversion, this
changes to Analog_001.Description.

81
Application Server User Guide Work with Objects

 Prior to conversion the History Extension description points to Analog_001.Desc. After

conversion, the History Feature points to Analog_001.Hist.DescAttrName.

 If a Field Attribut e has "Generate event upon change" enabled, then the Log change feature
(LogDataChangeEvent) will be added to the convert ed attribute.
 When the Field Attribute I/O option, "Output destination differs from input source," is selected and left
unlocked, but Output destination is locked, the converted Attribute will have the following locking
properties:
o "Write to" will be locked. This is the same as the original Field Attribute property.
o "Output destination differs from source" will be locked. This differs from the original Field
Attribute property.

Note: Default names for Field Attributes begin with either " Discrete" or "Analog." The conversion process
preserves this part of the Field Attribute name, even though this division does not apply to the converted
Attributes.

Limitations and Exclusions when Converting Field Attributes

Objects that are protected, checked out, or deploy ed will not be converted. If an object derived from a
first-level template you want to convert is protected, checked out, or deployed, the first -level template will
not be selectable for conversion. The entire hie rarchy of the first-level object must be available for
conversion (conversion works on an all or none basis).
The following Field Attribut e features are not converted to Attribute features. You will have t o be enter the
information for them manually.

Field Attribute Feature Equivalent Attribute Feature

Enable Deadband Limit Alarms

Description Description

Engineering Units Eng units

Update Scripts to Reference Converted Attributes

The conversion process applies certain changes to scripts that contain I/O references. In the conversion
process, the Field Referenc e I/O namespace is truncated to match the Attribute namespac e. These
reference changes are as follows:
 Me.Analog_001.Input.InputSource converts to Me.Analog_001.InputSource

 Me.Analog_001.Output.OutputDest converts to Me.Analog_001.OutputDest

 Me.Analog_001.Input.Value converts to
Me.Analog_001.Value

Note: Only Field Attributes that begin with "me." are converted. No other changes are made to scripts.
Scripts within graphics are not converted.

While Field Attribute conversion updates I/O references within scripts, other attribut e referenc es are not
updated. For example, while a Field Attribute description is truncated to "Desc," the description is not
truncated for Attributes. Therefore, you will have to do some manual updating.

82
Work with Objects Application Server User Guide

Reference Objects Using the Galaxy Browser

Use the Galaxy Browser to browse for:
 Attributes of objects. You can quickly find an object attribute or attribute property and add a reference
to it when you are configuring an object.
 ArchestrA graphics.
 Graphic element properties.
The Galaxy Browser shows attributes, graphics, or attributes and elements, depending on what you are
doing at the time you access the browser.

Browse for Attributes

You use the Galaxy Browser to browse for:
 Attributes of objects, either instances or own relative referenc es.
 Attributes of templates.
You can open the Galaxy Browser to browse for attributes from:
 Within an AutomationObject Editor. For ex ample, from a script, from an attribute of type
MxReference, or from a custom alarm message attribut e field).
 Within an ArchestrA Graphic Editor. For example, to use in scripts, animation links and references,
properties and custom properties.
 Within InTouc h WindowMaker. For example, to use in a reference expression from an animation link
or a script.
 Within an OPC UA server associated with an ArchestrA UA Client service.
The Galaxy Browser shows objects in the left pane and the attributes associated with the current
selection on t he right pane. Only attributes that can be referenced at run time are shown. You can browse
"Me." references for alarm messages only.
When you open the Galaxy Browser, the last browsed location for attributes is shown. The G alaxy
Browser shows the object list based on the last used state (tag name or Hierarchical name). If the last
used state of the browser was Tagname and the selected edit or reference is a Hierarchical name, the
browser opens in Tagname mode.
The status bar displays the attribute property name, and the it displays the graphic element attribute
name and description.
To browse for attributes
1. In any area on a page, click the Browse button, if available. The Galaxy Browser

83
Application Server User Guide Work with Objects

opens.

If you are browsing for attributes to use with an ArchestrA Symbol, such as for an
animation or script, the Galaxy Browser shows the attributes in an Attribute
Brow ser tab.

2. By default, the browser shows only those attributes that are frequently accessed.
If you are viewing t he attributes of an object for the first time, the right pane can be
blank. Select the Show all attributes check box to show all of the object’s
attributes.

84
Work with Objects Application Server User Guide

3. To filter the list of tagnames, click the Filter button. For information about
configuring a filter, see Create a Filter for the Galaxy Browser on page 89. To
switch the content of the left pane bet ween a Tagname and Hierarchical Name
list of objects, click the Show Tag name or Show Hierarchical name buttons.
4. You do not have to explicitly make a selection in the Property list. If you only
select an attribute (leaving Property set to <none>), the property of the attribut e
defaults to Value.
If the option in the Object Editor is already configured with an object reference, the
Attribute Brow ser shows it or expands to the nearest matching
object/attribut e/property currently configured in the Galaxy.
If you selected text in the script editor, that text is used as the initial reference
string and the brows er finds the nearest attribute reference to the selected text
5. When you are done selecting the attribute/property, click OK to place the
reference int o the Object Editor and close the Galaxy Browser.
 The fully-qualified reference string appears in the editor option.
 If you are working in the script editor, the selected reference appears in the
script at the current curs or position and replaces text that was selected.

Browse with an ArchestrA OPC UA Client

You can use an instance of the ArchestrA OPC UA Client Service hosted by your Galaxy to browse a
namespace in an OPC UA server.
You must prefix the item reference or attribute name with the Scope name/Service name defined in the
OPC UA Client Service editor.
To access an OPC UA server item reference, use the following syntax:
<namespace>:<UAItemReference>
Namespace is the OPC UA client service scope name defined in the client service editor. For example
"TestServer".
UAItemReference is the identifier of the item (the complete path of the OPCUA Server item, followed by
the NodeId) in the OP C UA Server.
For example:
TestServer:PLC01.PLCObject1
For more information about browsing with an ArchestrA UA Client and the syntax variations, see the
ArchestrA OPC UA Client Service Guide.

View Attribute Details in the Galaxy Browser

When you view attributes in the Galaxy Browser, you see two areas. The objects shown in the left area
include all of the logged in user’s checked-out objects plus the checked-in versions of all other objects.

Important: The Galaxy Browser shows only the Primary AppEngine and its attributes of a redundant
pair. Any Backup AppE ngine is not shown.

The right area shows the attributes of the object selected in the left pane. Depending on the attribute
selected, you can see these properties:

<none> Automatically defaults to the Value property of the selected attribute.

85
Application Server User Guide Work with Objects

Category Determines when and where the attribute’s data exists (for example,
configuration or run time), which users can write to it, and whether the
attribute is lockable or unlockable.

Dimension1 Returns the dimension of the attribute if it is an array.

(only for arrays)
Locked Determines whet her the attribut e is currently locked. Valid values are:
Unlocked
LockedInMe
LockedInParent.

Quality The quality of the attribute as defined in the OPC Draft 3.0 quality
definition. ArchestrA stores and transports OPC quality as a 16-bit value.
OPC quality is stored for an attribute as a current quality, and it can be
historized and sent to clients.
SecurityClassification Determines which permissions a user has with respect to the attribute
when using an ArchestrA application in the run -time environment.
Relevant only for attributes that can be written to by users in the run-time
environment. If an attribute has no security, this column is blank.

Data Type The data type of the attribut e:

 Integer
 Boolean
 Float
 Double
 String
 Internationalized String
 Time
 ElapsedTime
 Referenc eType
 Categoriz edStatus Type
 DataTypeEnum
 SecurityClassificationEnum
 DataQuality Type
 CustomEnum
 CustomStruct
For information about each of these, see the help for the object.

86
Work with Objects Application Server User Guide

Value The primary value of the attribute.

Sometimes, a list of numbers is included in the Property list. Those
numbers map to single bits in an integer attribute’s Value property. Valid
bit field specifiers are:
.00 (least significant bit)
.01 .02 .03 .04 .05 .06 .07 .08 .09 .10 .11 .12 .13 .14 .15 .16 .17 .18 .19
.20 .21 .22 .23 .24 .25 .26 .27 .28 .29 .30
.31 (most signific ant bit)

Important: Bit field specifiers are not allowed for integer arrays. Although bit field access is only
supported in integers, they appear to be allowed for data types besides integer because they do not
cause a warning during configuration. They cause errors in the run -time environment.

Browse for Graphics

You use the Galaxy Browser to browse for graphics from:
 The ArchestrA Graphic Editor, when editing a graphic from the Galaxy, being either a graphic from
an object (Template or Instance) or a graphic from the Graphic Toolbox.
 InTouch WindowMaker when editing a managed InTouch application hosted by the Galaxy.
The graphic currently being edited (or browsed from) does not appear in the list of graphics.
Within the same user session, the Galaxy Browser remembers the last browsed location for graphics and
presents it whenever called as the starting location so that context is kept. Initial default location for
graphic browsing is the Graphic Toolbox with the root selected (Galaxy node).
You can use the Galaxy Browser to browse graphics from:

The Graphic Toolbox. The browser shows the Graphics Toolbox toolset organization on the
tree in the left pane and a list of the graphics contained in the currently selected node
(Galaxy node or toolset node) in the right pane.
AutomationObject templates. The browser shows the Template Toolbox in the left pane
and the right pane shows the graphics associated with the currently selected template in
the right pane.
AutomationObject instances. The browser shows a flat list of existing instances of objects
in the left pane. The right pane shows the graphics associated with the currently selected
instance. You creat e or apply filters to reduce the scope of the instances shown i n the left
pane.
Relative references. This is possible only when you edit a graphic belonging to an object
and browse for graphics from that specific object.

To browse for graphics from the Graphic Editor

1. Click the Embed Graphic button in the Graphic Editor. The Galaxy Browser opens,

87
Application Server User Guide Work with Objects

showing the location of the graphics on the left pane and the graphics associated with
the current selection on the right pane.

2. Select a graphic from the list and then click OK.

3. Click in the canvas to place the graphic.

Browse for Element Properties

If you are working on a graphic, you can create references to properties of ot her graphics. For example,
you can reference another graphic’s properties from an animation link or script. You can browse the
properties of all elements on the canvas or custom properties.

88
Work with Objects Application Server User Guide

To browse for element properties

1. In any area on a page, click the Browse button, if available. The Galaxy Browser
opens.

2. Click the Element Browser tab.

3. By default, the browser shows only those properties that are frequently accessed. If
you are viewing the properties of an element for the first time, the right pane can be
blank. Select the Show all properties check box to show all of the object’s attributes.
4. Select the property and then click OK.
o The fully-qualified reference string appears in the option.
o If you are working in t he script editor, the s elected referenc e appears in the script at
the current cursor position and replaces text that was selected.

For more information, see "Working wit h Element Styles" in the Creating and Managing ArchestrA
Graphics User’s Guide.

Create a Filter for the Galaxy Browser

You can create one or more filters that limit the list based on the object name or common attributes. You
can also configure the columns you want to show for the list.
The Default filter provides an unfiltered list of objects and attributes. It cannot be edited.

89
Application Server User Guide Work with Objects

To create a filter
1. Click the Filter icon. The Edit Filter dialog box appears.

2. Click the Plus button and type a name for your new filter.
3. Click the Filter tab.
4. Configure the filter details.
5. Click the Di splay tab.

6. Configure the columns to show in the right pane of the Galaxy Browser. Use the up
and down arrows to set the order for the columns.
7. Click OK. The new filter appears in the Filter list.

90
Work with Objects Application Server User Guide

Change How Information is Shown in the Galaxy Browser

You can change how information shown in right pane of the Galaxy Browser. You can view:
 A list of only the attribute or graphic names.
 A list of details for attributes or graphics.
 Named graphic icons.
 Thumbnails for graphics.
The following figure shows graphic thumbnails.

91
 Application Server User Guide

C HAPTER 4
Manage Objects
After you create several objects, like templates, you need to manage them. For example, you need to
check objects in and out, you need to validate objects, and you may need to rename objects. You can
also export and import objects, allowing you to reuse objects created in one Galaxy in another Galaxy.

In This Chapter
Check Out Objects........................................................................................................................ 93
Check In Objects .......................................................................................................................... 93
Validate Objects ........................................................................................................................... 94
Create an Instance ....................................................................................................................... 95
Rename an Object ........................................................................................................................ 96
Delet e an Object ........................................................................................................................... 97
Export Objects .............................................................................................................................. 98
Importing Objects ....................................................................................................................... 101

Check Out Objects

To make changes to an object, you must check out the object. Then, you can modify the object and save
private versions of it before checking the object in for other users to use. You can select more than one
object for checking out at the same time.
The Galaxy marks the objects as checked out to you and it updates the object’s Change Log that you
can view in the Properties dialog box. A check mark is shown next to an object’s icon in the IDE. No one
else can check out the object until you check it back in or until you perform an Undo Checkout
operation. However, others can open the object for read -only viewing.
To find objects that have been checked out, use the Find dialog box.
To check objects out
1. In the Template Toolbox or Application views, select the objects you want to work with.
2. On the Object menu, click Check Out. Or, open the Object Editor. An object is automatically
checked out to you when you open its editor.
The Object Editor opens. You are ready to make your changes.

Check In Objects
After you finish making your changes, you check the object back into the Galaxy. When you check the
object back in, a dialog box prompts you to ent er comments about changes you made.
You can turn this dialog box off if you do not want to enter information about your changes. For more
information, see Customizing Your Work space on page 35.

Note: If the object was automatically checked out when the editor was started and you close the editor
without making any changes to the object’s configuration, an undo -checkout is automatically performed.

To check in an object to the Galaxy database

1. In an Application view or the Template Toolbox, select the object after you are finis hed making
your changes.

93
Application Server User Guide Manage Objects

2. On the Object menu, click Check In. The Check In dialog box appears.

3. Type any comments you want and click OK.

Validate Objects
Objects need to be validated before they can be deployed. An object validates it’ s configuration either
when you are configuring it, or typically when you save that configuration to the Galaxy databas e.
Validating an object’s configuration includes:
 Checking allowable attribute value ranges.
 Compiling its scripts.
 Verifying its attribute references.
 Validating its extensions.
 Validating other configuration parameters that are unique to the object.

Important: Script validation on a template does not resolve references used in the script. For example,
references to attributes that do not exist will not be discovered.

Typically, each option on the Object Editor that requires a string or numeric input has an allowable range
of inputs. If you type an input outside the allowable range and then try to change the Object Edi tor page,
close the Object Editor or save the object’s configuration, a message appears about the input error,
showing the allowable range.
To open the Validation area
 On the View menu, click Operations. The Validation area opens.

Validate Scripts and Other External Components

Some objects depend on external components to run, such as script function libraries and references to
other objects’ attributes. The status of these external components can change, perhaps disabling some
capability of the object.
For example, an object refers to a value of an attribute of another object, which is subsequently deleted.
This will result in the remaining object going to a Warning status.
Normally, the system will update the validation status of an object when the missing script function or
object/attribut e is later added to the system. But there are a few cases where the status of an object
needs to be manually validated by the user.
For example:
 When importing scripts and script libraries, there are cases when the script will import before the
associated library and validate incorrectly, and
 When graphics associated with an object are imported along with a graphic they embed, the
containing graphic may be imported first and validated incorrectly.

94
Manage Objects Application Server User Guide

In each of these situations, the object may incorrectly have a status of either Bad or Warning. In this
case, you may want to manually validate the object to update its status, especially if the status is
preventing the object from being deployed. For more information, see Validate an Object Manually on
page 95.
Two kinds of indicat ors are shown in the object icons:
 Deployment status for instances only.
 Configuration status for templates and instances.

Validate an Object Manually

After you check an object in, you can verify that an object’s configuration is valid and updat e its status by
manually validating it. You can use the Template Toolbox, the Application views or the Find dialog
box to find objects that need to be validated.
To validate all objects in the Galaxy, validate the Galaxy object.

Note: For a large Galaxy this is potentially a time consuming operation, and should be used only when
necessary.

You can select more than one object for validation.

If an object is being edited, validation may not be performed. Also, if validation is in proc ess on an object,
other operations you start on the object will fail.

Note: You cannot cancel validation operations.

To manually validate one or more objects

1. In the Template Toolbox, the Application views or the Find dialog box, select the objects you want
to manually validate.
2. On the Object menu, click Validate. The Operations view in the IDE opens.

3. Continue using the IDE to perform other operations, if needed, while validation is going on, including
work on other objects in the Galaxy. If you are validating a Galaxy, then you must leave the Galaxy
alone until the validation process is complete.
4. When the validation process is complete, you see the results of the validation in the Operations
View. If the validation failed on an object, you see a message. Correct the problem and validate
again.

Note: You can also see the errors or warnings that led to an object having a status that is not Good by
looking at the Error/Warnings tab within the object's Properties.

Create an Instance
After you create templates, you can create instances. Creating instances makes a specific object from a
template, with all the characteristics and attributes of the template.

95
Application Server User Guide Manage Objects

After you have created an instance of an object, it can be deployed.

Template Child Instances

Parent Template

You can also customize an instance, if needed. For example, you can have a valve template. When you
create an instance of that valve, you can specify the inputs and outputs for that specific valve on your
factory floor.
To create an instance
1. Select the template you want to use for the instance. For example, to create a valve instance, select
a valve template.
2. On the Galaxy menu, click New and then click Instance. An instance is created.
3. Rename the instance. Select the instance. On the Edi t menu, click Rename. Type the new name.
Instance names can be up to 32 alphanumeric characters. You cannot use $ as the first character.
The name must include at least one letter. Instanc e names cannot include spaces.
4. To move the new instance in the Deployment view or Model view, drag the instance to the new
location.
You are ready to configure the instance, if needed. For more information, see Edit Objects on page
63.

Rename an Object
You can rename an object. Although you can change an object’s containment relationship with another
object, you cannot directly rename an object’s hierarc hical name. You can rename its tagname and
contained name, and its hierarc hical name will change automatically. See Rename Contained Objects
on page 62 for more information about renaming cont ained objects.
Object names must be unique within each namespace, not within the Galaxy.
 Templat e names can be up to 32 alphanumeric characters, including the required $ as the first
character. The second character cannot be $ and the name must include at least one letter. You
cannot use spac es in an object name.
 Instance names can be up to 32 alphanumeric characters. You cannot use $ as the first character.
The name must include at least one letter. You cannot use spaces.

Note: You cannot use the following reserved names for objects: Me, MyContainer, MyArea, MyHost,
MyPlatform, MyEngine and System.

An object can have three kinds of names if it is contained by anot her object. The three names include:

Name Description

Tagname The unique name of the individual object. For example, Valve1.

Cont ained The name of the object within the context of its container object. For example, the
name object whose Tagname is Valve1 may also be referred to as Tank1.Outlet, if
Tank1 contains it and it has the contained name "Outlet".

96
Manage Objects Application Server User Guide

Name Description

Hierarchical Hierarchical names are fully-qualified names of contained objects that include the
Name name of the objects that contain it.
Because the object that contains it may also be contained, there are potentially
multiple hierarchical names that refer to the same object.
For example, if:
"Reactor1" contains Tank1 (also known within Reactor1 by its contained name
"SurgeTank").
"Tank1" contains Valve1 (also known within Tank1 by its contained name "Outlet").
Valve1 could be referred to as:
"Valve1"
"Tank1.Outlet"
"Reactor1.SurgeTank.Outlet".

When you rename an object, references from other objects to the object being renamed can be broken.
Objects deployed wit h brok en references receive bad quality data during run time.

Note: Some objects may refer to themselves or to parent/host objects up in the parent/child hierarchy.
Referenc es that go up or down the hierarc hy to refer to other objects are called relative references.
Objects with relative referencing are updated automatically if you rename them.

After renaming, all IDEs connected to the Galaxy show the new object name.
To rename an object’s tagname
1. Select the object you want to rename.
2. On the Edit menu, click Rename.
3. Type the new name for the object.
4. When you are done, press Enter.

Delete an Object
You can delete both templat es and instanc es with the following exceptions. You cannot delete:
 Deployed instances
 Cont ainers for other objects
 Objects checked out by other users
 Templat es that have children (derived templates or instances)

Note: Make sure you correctly select the objects you want to delete. Aft er you delete an object, you
cannot undelete it. You must recreate it.

To delete an object from the Galaxy

1. In the Template Toolbox or Application views area, select the object to delete. Select multiple
objects by using Shift+click or Ctrl+click.
2. On the Edit menu, click Delete. When the message appears, confirm you want the object deleted
and click Yes.

97
Application Server User Guide Manage Objects

Export Objects
You can export some or all of your Galaxy objects. When you export, you are exporting the objects’
associated templates, configuration state, and containment state of thos e objects. The information is
saved in an .aaPK G file.
After the Galaxy objects are exported, you can import them into the same or another Galaxy.
If your objects have scripts associated with them, you need to ex port the script library separat ely. For
more information about exporting script libraries, see Exporting Script Function Libraries on page 100.
For more information about scripts and script libraries, see the Application Server Scripting Guide.
If you are exporting an InTouchViewApp object and want to include graphics that are not embedded in
the application, such as graphics called from a script, you need to embed the specific desired graphics in
the InTouchViewA pp.

Note: You can associate all Galaxy graphics with an InTouchViewApp for backup, restore, and
deployment operations, but not for import and export operations.

Before you start, make sure all objects you want to export are checked in. If an object selected for export
is checked out, the checked in version of that object is exported instead. This can lead to old versions of
objects being exported.
Exporting an entire Galaxy is different than backing up the database. Unlike the case with backups,
change logs for the objects are not exported. When you export objects, only the related security
information for the specific object is exported.
To export an object
1. In the Template Toolbox or Application Views, select one or more objects to export.
2. On the Galaxy menu, click Export and then click Automation Object(s). The Export Automation
Object(s) dialog box appears.
To export all of the objects in the Galaxy, on the Galaxy menu, click Export and then click All
AutomationObjects.
3. In the Export dialog box, browse to a path and type a name for the exported file.
4. Click Save. The file is saved with the specified name and an .aaPK G extension.
5. When the export is complete, click Close. Now you can import the .aaPKG file into another existing
Galaxy.

Protecting Objects on Export

Protect symbols and derived templates by flagging the objects as protected in the galaxy database.
Protected symbol and template behavior is similar to that of a base templat e. This option is available
through a specialized form of the Export Object(s) operation.
System Integrators and other system designers can use this functionality to protect objects designed in a
master galaxy that are intended for use in production galaxies or galaxies on run-time nodes.

About Protecting Objects on Export

Protecting an object on export does not change the object in the galaxy from which it was exported.
Protection is effective only on import of protected objects. Specific behavior is described as follows:

98
Manage Objects Application Server User Guide

Element or Function Description

Base Templates Are protected by default and cannot be checked out, edited or
renamed.

Protected templates and Cannot be checked out, edit ed, or renamed, but can be deleted. A
symbols template derived from a protected template is unprot ected.
Protected templates and symbols are marked with a lock icon.

Ancestor objects Are protected in the export ed .aaPKG file when a child object is
protected.

Protection effective Protection is effective on import of protected objects. A protected

object retains its protected status even when exported using the
standard Export Object(s) workflow.
Instances Cannot be protected. Only templates and symbols can be protected.

Select both templat e and The option to export objects as protected is disabled. Only templat es
instance for export and symbols can be protected.
Export workflow The export workflow is the same as for all objects except that you
can select the option to export As P rotected Object(s).
Graphics Symbols and client controls directly or indirectly embedded in a
protected graphic are also protected.
Protected symbols can be opened in the Graphic Editor as
read-only.
Scripts If the Execution type of a script is locked, the script and its attributes
will not be visible in the Object Edi tor or Properties window. This
also applies to all child objects.

Protected objects are mark ed in the Template Toolbox, Graphic Toolbox , or Application views (Model,
Deployment, or Derivation View) with a gold-colored padlock icon.

99
Application Server User Guide Manage Objects

Exporting Objects as Protected

The export objects workflow is the same as for all objects with the exception of specifying the export of
selected objects as protected.
To protect objects on export
1. In the Template Toolbox, Graphic Toolbox, or in the Application Views (Model, Deployment, or
Derivation), select one or more templates or symbols to export.
2. On the Galaxy menu or context menu, click Export and then click As Protected Object(s). The
Export Automation Object(s) dialog box appears.
3. In the Export Automation Object(s) dialog box, browse to a path and type a name for the exported
file.
4. Click Save. The file is saved with the specified name and an .aaPK G extension.
5. When the export is complete, click Close. Now you can import the .aaPKG file into another existing
Galaxy.

Exporting Objects with I/O Auto Assignment

Objects configured for I/O auto assignment can be ex port ed the same way as other objects. See
Configure Objects on page 115 for additional information.
Application objects configured for I/O auto assignment are linked to DI objects and scan groups.
Therefore, when you import these objects into a different Galaxy, the objects will look for DI object and
scan group names that match the linkages that were ma de in their originating Galaxy. If a matching DI
object and scan group are not found, all I/O aut o assignment information is discarded, and the
application objects are placed under the "Unassigned IO Device" folder in the IO Device s view.
 When exporting application objects, some I/O mapping assignments may be unavailable when
importing the objects into a different Galaxy. Application objects that do not find a DI object and
associated scan group that match their I/O references will lose their I/O mapping assignments and
will have to be remapped.
 When exporting an application object with overrides in the I/O mapping table, overrides are
preserved if a DI object and scan group that match its assignment from the original Galaxy are
present in the new Galaxy.

Note: The I/ O mapping references are permanently deleted if matching DI objects and scan groups
are not found. The I/ O referenc es will not reconstitute, even if you lat er add the scan groups and DI
objects to which the application objects were formerly mapped.

 When exporting DI objects, there are no special considerations related to I/ O assignments. I/O
references for application objects will not change when the DI objects are imported into another
Galaxy.

Note: When importing a DI object into a different Galaxy, an existing DI object with the same name
as the import ed DI object may be overwritten. This can break device linkages to application objects
previously configured within the Galaxy.

Exporting Script Function Libraries

If you want to export objects that use scripts, the scripts are exported with the object.
Some scripts include functions that depend on external files called script function libraries. In this case,
you must export the script function libraries separately.

100
Manage Objects Application Server User Guide

To export a script function library

1. On the Galaxy menu, click Export and click Script Function Library. The Export Script Function
Library dialog box appears.

2. In the Script Function Library list, select the library or libraries you want to export. If needed,
browse to folder where you keep your script libraries.
3. Click OK. The selected script library is exported. Each script is named with the name of the script and
an .aaSLIB file name extension.
4. When the export is complete, click Close. Now you can import the .aaSLIB file int o another existing
Galaxy.

Importing Objects
You can reuse objects from anot her Galaxy in your Galaxy. This saves you a lot of time if the objects are
already set up in another Galaxy.
Importing instances previously exported from a Galaxy retains previous associations, when possible,
such as assignment, containment, derivation, and area.
You can import objects from exported .aaPKG files or from an .aaP DF file. An .aaPDF file contains the
configuration dat a and implementation code for one or more base templates. It is created by a developer
using the ArchestrA Object Toolkit.
You cannot have two objects with the same name or more than one copy of the same version of an object
in the same Galaxy. When you import an object, you can choose how you want naming and version
conflicts handled.
You should perform an "Upload Runtime Changes" before importi ng a new version base templat e if
instances of the template are deployed. This saves changes made at Runtime to the Galaxy database.
Objects that were creat ed in Application Server 2014 R2 or later cannot be imported int o a Galaxy
running an older version. For example, you cannot import an object created in Application Server 2017
into a Galaxy running Application Server 2012.

Note: The Applic ation Server version is not the same as the Codebase version. Objects with newer
Codebases can be imported.

To import objects
1. On the Galaxy menu, click Import and click Object(s). The Import AutomationObject(s) dialog
box appears.

101
Application Server User Guide Manage Objects

2. Browse for the file with either an .aaPKG or an .aaPDF extension. You can select more than one file.
Click Open. The Import Preferences dialog box appears.

3. In the Objects with same Tagname and Codebase as an existing object area, select one of the
following:
 Skip: Do not import leaves the existing object unchanged.
 Overwrite objects if the imported configuration version i s higher replaces the existing
object wit h the object being import ed if the imported object has a newer configuration. This is the
default.
 Overwrite objects regardless of configuration version replaces the existing object
regardless of whether the existing object has an older configuration or the same configuration.
4. In the Ba se Templates with a different revision number in the Codebase or a different minor
version area, select one of the following:
 Skip: Do not migrate - objects with an older codebase are not migrated when a newer
codebase exists in the Galaxy.
 Migrate - objects with an older codebase are migrated when a newer the replac ement object.
For more information about migrating, see After You Import on page 112.
5. In the Objects with same Tagname but with a different Codebase area, select one of the
following:
 Skip: Do not import leaves the existing object unchanged.
 Rename object in Galaxy imports an object with a matching tagname but a different codebase
from the existing one. The existing object is not overwritten but is renamed.
 Rename importing object imports an object with a matching tagname but a different codebase
from the existing one. The existing object is not overwritten. The import ed object is renamed.
6. In the Template Protection Change Management area, click the checkbox to prohibit overwriting
an unprotected object with a protected object (default). Clear the checkbox to allow overwrites.
7. Click OK. The import process starts.
8. When the import process is complete, you can start using the objects you imported.

102
Manage Objects Application Server User Guide

Importing Protected Objects

The import objects procedure is the same for all objects, protected or unprotected. The following
describes import preferences and results specific to importing protected objects:

Import Preferences Result for Protected Objects

Objects with same Tagname Overwrite preferenc es are governed by the Template
and Codebase as an existing Protection Change Management option, "Never overwrite an
object: unprotected object with a protected object" (default).
 Skip: Do not import
 Overwrite objects if the
imported configuration
version i s higher
(default)
 Overwrite objects
regardless of
configuration version

 Overwrites can occur if both the packaged and galaxy

objects have the same prot ection status.
 A protected object can overwrit e an unprotected object only
if specifically permitted by clearing the "Never overwrit e ..."
option.
 When overwriting a protected parent object, protection is not
cascaded to child objects. Unprotected child objects remain
unprotected.
Base Templates with newer Import and migration of base templates is unchanged by
or older Codebase s (or protected object import functionality.
minor version update s):
 Skip: Do not migrate
 Migrate

103
Application Server User Guide Manage Objects

Import Preferences Result for Protected Objects

Objects with same Tagname Object renaming on import can occur only if the object to be
but with a different renamed is not protected.
Codebase:
 If the object in the Galaxy is protected, and the importing
 Skip: Do not import object is not, and Rename importing object is selected, the
importing object is renamed to have the suffix "_new".
 Rename object in Galaxy
 If the object in the Galaxy is unprotected, and the importing
 Rename importing object
object is protected, and Rename object in Galaxy is
selected, and the Never overwrite an unprotected object
with a protected object option is not selected, the object in
the Galaxy is renamed with the suffix "_old".

Importing Objects with I/O Auto Assignment

Objects configured for I/O auto assignments can be imported the same way as other objects. See
Importing Objects on page 101 for additional information.
When importing objects that utilize I/O auto assignment, be aware of the following:
 If you are importing DI objects, there are no special considerations relat ed to I/O auto assignment.
I/O device mapping is not affected. An imported DI object will overwrite an existing DI object with the
same name.
 If you are importing application objects, different outcomes can result, depending on the DI objects
and scan groups that already exist in the Galaxy.
o I/O device mapping is recreated, if possible, for each application object that is successfully
imported and for which a DI object and scan group are found that match the existing I/O
assignment. This includes all user-configured I/O attribute overrides.
o Objects for which a DI object and scan group with matching names cannot be found are moved
to the unassigned area. All I/O information for those objects is discarded. This includes default
I/O auto assignment information as well as any custom configured I/O attribute overrides. You
will need to assign these objects to a DI object and scan group in the new Galaxy and recreate all
user-configured overrides. None of this information is preserved for application objects that do
not find a matching DI object and scan group.

Importing a SQLData Object

The SQLData object is used to store and retrieve data from a SQL Server databas e. Typical applications
for this object include basic recipe management and database capture of attribute values.
The SQLDat a object can be configured to use one of the following authentication modes:
 Windows Integrated Security
 Windows Account
 SQL Server Authentication
When you import an object from another galaxy that is configured with SQL Server Aut hentication, the
encrypted password does not follow the object, and the object will be in a warning state in the new
galaxy. You must open the object in the Object Editor and enter a new password to remove the warning
state.

104
Manage Objects Application Server User Guide

Importing Script Function Libraries

You can enhance an object’s functionality by attaching a script to it. Some scripts include functions that
depend on external files called script function libraries. Scripts are included in the object import
operation, but you must import the script function libraries separately.
To import a script function library
1. Select Import from the Galaxy menu.
2. Browse to the directory that contains the script function library you want to import.
3. Select the script function library to be imported, and then select Open to start importing the selected
library. Acceptable file types and file name extensions for script function libraries are:
o Script Library Files (.aaSLIB file extension)
o .NET or .COM files (.dll, .tlb, .olb, or .exe file extensions)
o InTouch Script Extension Files (. wdf file extensions)
An information window opens when the import successfully completes.
4. Validate any symbols that use the custom script functions contained in the imported library. See
Validate Objects on page 94 for additional information.
5. Redeploy any InTouchViewA pp instanc es containing symbols that use the script functions in the
imported library.

Note: When you import a new version of an existing script library into a Galaxy, you must stop and restart
the engine that hosts the script's owning object. The new script version does not replace the old version
until after the hosting engine has restarted and you have redeployed the object.

If you import an object whose script references a script function library that is not resident in the Galaxy,
the imported object is set to Bad state and cannot be deploy ed. To correct this, import the script function
library and validate the object. For more information about scripts, see the Application Server Scripting
Guide. For more information about validating scripts, see Validate Objects on page 94.
If you import a script function library that is a different version than the current library, a message is
displayed to notify you that there are dependent objects. The message indicates how many objects will
need to be redeployed if you continue with the import. If you continue wit h the import, the dependent
objects are marked for redeployment.
Script function libraries that are COM libraries developed using Visual Studio 6 or earlier are not
automatically deployed. To place this COM library on the target platform, you c an either:
 Install it directly on the target plat form and register it.
 Import it to the Galaxy, and then export it as an aaSLIB. Modify the aaSLIB xml to designate that the
library is to be registered as a COM object. Reimport the aaSLIB so that it is aut omatically deployed
and registered.

Importing Client Controls

If you import a client control that is a different version than the current object, a message is displayed to
notify you that there are dependent objects. The message indicates how many objects will need to be
redeployed if you continue with the import. If you continue with the import, the dependent objects are
marked for redeployment.
When the import process is complete, restart the IDE to apply the changes made by the import process.
After the IDE has restart ed, you can start using the objects you imported.

105
Application Server User Guide Manage Objects

Importing an App from the AVEVA Digital Exchange

A number of pre-built InTouch OMI apps are available for download from the AVEVA Digit al Exchange.
To access the Digital Exchange
1. Select Import from the Galaxy menu.
2. Select Digital Exchange.

3. Select Brow se Digital Exchange. Your browser will open and connect to the AVEVA Digital
Exchange.
4. Log in, or sign up for new account.
5. Click on the link for the System Platform Developers Community and browse for apps. Select the
app you want and follow the online instructions.

Importing ArchestrA Apps

An ArchestrA App is collection of one or more cont rols primarily developed with Windows Presentation
Foundation (WPF) for use in InTouch OMI ViewApps. Other technologies such as Windows Forms
(WinForms) and HTML5, can also be used. You can create your own ArchestrA Apps, which can be
imported via WPF interoperability. For more information about creating your own ArchestrA Apps, see
the InTouch OMI S DK Help. The InTouch OMI SDK is installed automatically when you install the IDE.

106
Manage Objects Application Server User Guide

You can enhance a Galaxy's functionality by adding an embedded control from an ArchestrA App to a
pane in a layout for inclusion in a ViewApp.
In order to qualify for import as an Arc hestrA App, the App should contain at least one WPF
FrameworkElement Class control (System.Windows.FrameworkElement).
ArchestrA Apps should be organized in a single folder which can optionally include subfolders. These
subfolders typically contain locale files.
To import an ArchestrA App
1. Assemble the App, together with all required dependencies and relat ed files, into a folder.
2. Select Import from the Galaxy menu.
3. Select Arche strA App.

4. Select the folder that contains the App to be imported.

The contained App, along with all dependent files, including dependent files contained in subfolders,
are imported when you select OK.
If the App does not import successfully, see Troubleshooting ArchestrA or WPF Apps that Fail to
Import on page 112.

107
Application Server User Guide Manage Objects

After the import process completes successfully, a new object appears in the Graphic Toolbox named
DisplayModule_00n, where n is 1 or the next available integer. The new object can be renamed, deleted,
or exported as an .aaPKG file for use in another Galaxy. See Export Objects on page 98 for additional
information.

Add a Control from an ArchestrA App to a ViewApp

Cont rols from the imported App appear when the Toolbox tab of the Layout or ViewApp Editor is
selected.
To assign a control from an App to a ViewApp
1. Open a layout in the Layout Editor.
2. Select the Toolbox tab to list the available ArchestrA Apps.
3. Select an ArchestrA App. The controls available in the App are shown.
4. Select a control and drag it onto a pane.
5. Save the layout. You can then use the layout that contains the embedded control in a ViewApp.

Configurable Properties in ArchestrA Apps

ArchestrA apps can contain two types of configurable properties:

 Dependency properties

 CLR properties (.NE T framework properties )

108
Manage Objects Application Server User Guide

Configurable Property Data Types

 System.Boolean
 System.Byte
 System.Char
 System.Decimal
 System.Double
 System.Int16
 System.Int32
 System.Int64
 System.SByte
 System.Single
 System.String
 System.UInt16
 System.UInt32
 System.UInt64
 System.DateTime
 System.Drawing.Color
 System.Windows.Media. Color

109
Application Server User Guide Manage Objects

 System.Windows.Media.Brush
 Any property that can be converted to or from string
CLR properties can only be set at configuration (design) time, while dependency properties can be
bound to any attribute and can be set at run time. If a dependency property is changed at run time, the
new value is propagated to the attribut e. Dependency properties are dat a-bindable at design time, and
you can set the binding direction to in (read), out (write), or both. To change the binding direction, click on
the arrow to toggle the binding direction.
For dependency properties, you must specify the attribute to whic h you are binding the property, as well
as the direction of the binding (in (read only), out (write only) or both. The attribute naming convention is
the same you use, for example, when configuring an animation in the Graphic Editor. Note that the
ViewApp Editor does not provide syntax validation for attribute names, but the Logger will list any
configuration errors. Binding is only supported for the following basic data types.
DataBindable Properties
 System.Boolean
 System.Byte
 System.Char
 System.Decimal
 System.Double
 System.Int16
 System.Int32
 System.Int64
 System.SByte
 System.Single
 System.String
 System.UInt16
 System.UInt32
 System.UInt64

ArchestrA App Development Guidelines

The following types of properties are available for configuring WPF-based displays:
 Public writable CLR properties on the display that are not hidden using the browsable attribute
 Dependency Properties
 Nested Properties which satisfy the criteria of configurable properties
 Enum and Flag properties
 Any property that can be converted to or from string
The following types of properties are NOT available for configuring WPF-displays:
 Any property defined by the System.Windows.UIElement class
 Any property defined by the System.Windows.FrameworkElement class
o The Tooltip property is an exception to this and can be configured

110
Manage Objects Application Server User Guide

 The following properties defined by the System.Windows.Controls.Control class

o Is TabStop
o TabIndex
o Templat e
 Any property defined by the System.Windows.Controls.Content Cont rol class

Optional Filter File: AppManifest.xml

You can include an optional file called AppManife st.xml in your import ed ArchestrA App. See the
InTouch OMI SDK Help, located in the Wonderware Documentation folder, for additional information
about AppManifest.xml. This file will allow you to filter properties when you are configuring the app. The
basic file structure is:
 DLL name
o Cont rol name
– Property
The following is a sample AppManifest.xml file, from the Hamburger App. The files specifies controls and
properties that are exposed to System Platform IDE users as they configure a layout or ViewApp.
<?xml version="1.0"?>
<AppManifest AppVersion="1.0"?>
<Filters>
<!--List all the Controls that need to be exposed to the ArchestrA IDE user
to utilize them in a View Application.
Only the controls listed here will be available for the IDE users to place
them on panes within a Layout or a ViewApp.-->
<Control AssemblyName="ArchestrA.Apps.HamburgerApp"
ControlFullName="ArchestrA.Apps.HamburgerApp.HamburgerButton">
<!--List the public properties on this control that need to be exposed
when user is configuring this control in a Layout or
a ViewApp. The Property Editor within the Layout Editor and ViewApp
Editor includes these properties when this control is
selected and allows the user configure new default values.-->
<Property Name="HamburgerColor" />
<Property Name="SlideInPanePosition" />
<Property Name="Background" />
</Control>
</Filters>
</AppManifest>

ArchestrA App Limitations and Restrictions

 E vents and scripting are not supported
 Only basic datatype properties configuration
 Apps cannot be imported from a net work share location
 Collections and arrays are not supported
 Upgrading Apps is not supported
 Nested properties can be viewed and configured, but they cannot be configured with dat a binding

111
Application Server User Guide Manage Objects

 To host the .NET controls, use the WPF element WindowsForm Host to wrap the control into WPF.

<UserControl x:Class="ArchestrA.Visualization.TrendApp.TrendControl"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
mc:Ignorable="d"
d:DesignHeight="300" d:DesignWidth="300">
<Grid>
<WindowsFormsHost x:Name="FormsHost" />
</Grid>
</UserControl>

Troubleshooting ArchestrA or WPF Apps that Fail to Import

There are two major factors that may stop an Arc hestrA or WPF app from successfully importing.
Expose control s and properties: Make sure that you have included an AppManifest.xml file with the
app, and that all controls and properties that are needed in your app are explicitly exposed in it. For
additional information about the AppManifest.xml file, see ArchestrA App Development G uidelines on
page 110and the AppManifest.xml File topic in the InTouch OMI S DK Help, located in the Wonderware
Documentation folder.
Block busine ss logic from executing during design time: If you have business logic executing in the
control constructor, or in static properties or static constructors, the import operation will not be
successful. The control constructor is invoked when the control is instantiated. Therefore, do not
include business logic withi n the control or static constructors, or in static properties.
 If you cannot remove business logic from a control or static constructor, or a static property, make
sure the property is not invoked or that the property does not execute while in design mode.
 To block execution of logic within a constructor while in design time, add the following line to the
constructor:
!DesignerProperties.GetsInDesignMode
For additional information about app development, refer to the section on App Development Best
Practices in the InTouc h OMI SDK Online Help. You can access the help from the Window s Start
menu, then navigate to the the Wonderware Documentation folder.

After You Import

Imported templat es are listed in the proper toolset in the Template Toolset as defin ed in the object.
Imported instances are shown in the Application views.
The following post-import rules apply:
 If a toolset does not exist, it is created.
 If the object belongs to a security group that does not exist, it is associated with the Default se curity
group.
 If the object belongs to an area that does not exist, it is associated with the Unassigned Area.
 If the host to which the object is assigned does not exist, it is assigned to the Unassigned Host.
 If you selected Migrate from the Import Preferences dialog box, the migrated objects are marked
with "software upgrade required" if they are deployed. These objects will be upgraded when the
objects are redeploy ed.

112
Manage Objects Application Server User Guide

 If you import a new version of an existing instance, the new version is marked as requiring
deployment if the existing object is already deployed.

113
 Application Server User Guide

C HAPTER 5
Configure Objects
Enhance and extend derived templates and instances by adding and configuring features, attributes,
scripts, and symbols. These elements can be associated with an Object Wizard in a derived template to
simplify the task of creating instances.
The Object Editor includes a separate page for adding scripts. All other elements (symbols, attributes,
Object Wizards, and external content) are added and configured from the Object Editor's main page. For
an overview of the Attribute s page, see About the Attributes Page on page 69.

In This Chapter
Add Attributes to an Object .......................................................................................................... 115
Adding Features to Attributes ...................................................................................................... 120
Using I/O Auto Assignment .......................................................................................................... 140
Writing and Editing Scripts........................................................................................................... 152
Creating and Working with Content .............................................................................................. 157

Add Attributes to an Object

There are two ways to add attributes to an object. These are:
1. Select the Add Attribute button. The first attribut e you add to an object has the default name
"Attribute001" and the default data type "Boolean.
Subsequent attributes added with the Add Attribute button use the previous attribute's name and
increments the number at the end of the name, or appends "1" at the end of the name if the previous
name did not end in a number. It also retains the previous attribute's description, Data type, and
Writeability.
2. Select the Duplicate Attribute button to duplicate an attribut e ;that was previously configured.
Selecting Duplicate Attribute retains any features that were configured for the selected attribute, in
addition to name, description, Data type and Writeability.

115
Application Server User Guide Configure Objects

Note: When you add an attribute to a derived templat e, the attribute, its data type, and writeability are
automatically locked in derived objects.

If attribute parameters such as initial values and security classifications are locked in the template, they
cannot be changed in child instances. If these parameters are unlocked in the template, the initial value
and security are editable and lockable in derived templates. When unlocked in either the base or derived
template, the value is editable in instances.
After you add an attribute to an instanc e, it appears in the Attribute Brow ser list for use with the
scripting and attribute configuration functions. For more information about using the Attribute Brow ser,
see Reference Objects Using the Galaxy Browser on page 83.
In the Attribute s page, you can define the following initial information and parameters for the attribute:
 Add a new attribute to an object.
 Name the attribute and provide a description.
 Configure its data type.
For a Boolean data type, you can specify different text strings for the ’False’ label and ’True’ label.
For example, if a Boolean attribute is associated with the status of a motor, you can specify the
states as "Stopped" and "Running". Text boxes appear for you to enter these strings when you
select a Boolean data type.
These labels are also shown in the Value and Limit columns of the Alarm and E vent database and
InTouch AlarmView control.
 Specify the attribute writeability.
 Set initial values if the attribute is user writeable.
 Enable and set locks and security on the new attribut e.
 Set whether the new attribut e is an array and how many elements are in the array.
You can then add Features to the attribute. For more information, see Adding Features to Attributes on
page 120.

116
Configure Objects Application Server User Guide

Configure an Attribute
To configure attributes
1. Highlight the attribute you want to configure.
2. Edit the Name of the attribute.
3. Enter a De scription.
4. Select a Data type:
 Boolean: Enter False and True labels (if not False and True).
 Integer: Enter Initial value and Engineering units.
 Float: Enter Initial value and Engineering units.
 Double: Enter Initial value and Engineering units.
 String: Enter Initial value.
 Time: Enter Initial value.
 ElapsedTime: Enter Initial value.
 InternationalizedString: Enter Initial value.
5. Select Writeability type:
 Calculat ed
 Calculat ed retentive
 Object writeable
 User writeable
6. Enter the Initial value for the attribute.
7. Select the checkbox if the attribute is part of an array.
8. Enter the Engineering unit type (numeric data types only).
9. Select Features and configure them. See A dding Feat ures to Attributes on page 120 for additional
information.
10. Lock the Initial value, if you do not want users to be able to modify the value in derived objects. You
can show or hide the lock icon by toggling the Show/Hide Lock icons button. See Lock and Unlock
Templat e Attributes on page 65 for additional information.

117
Application Server User Guide Configure Objects

11. Configure the attribute's security state. You can show or hide the security icon by toggling the
Show/Hide Security icons button. See Set Object Security on page 68 for additional information.

Attribute Naming Conventions

Attribute names can have up to 32 alphanumeric characters, including periods. Attribute names must
include at least one letter.
 An attribute name that starts with an underscore (_) as the first character of the name is a hidden
attribute.
Hidden attributes do not appear in the Attribute Brow ser, the Properties>Attribute s dialog box, or
the Object Viewer unless you select to view Include Hidden.
 Using the word "quality" as an attribute name is not supported. "Quality" is used by InTouch HMI in a
set of dot fields to show the reliability of data values assigned to an I/O tag. An attribute named
"Quality" cannot be accessed through FS Gateway or InTouch due to a naming conflict.

Important: After creating an attribute, it is available for adding Features or additional attributes. If you
extend an attribut e you have added to an object or another attribute, and then delete or rename that
attribute, all associated Features and additional attributes added to the object are lost.

To create and associate a attribute with an object

1. On the Attribute s page of the Object Editor, click the Add (+) button. An attribute is added to the
Attribute s list.
2. Type the new attribute name and add an optional description.
3. In the Data type list, select the Data type for the new attribute. The available Feat ures and basic
options change depending on your selection in the Data type list.
4. Set the remaining paramet ers as needed.

Note: For detailed information about each item on the Attribute s page, see About the Attributes
Page on page 69.

5. Lock the values, if needed. The lock is available only when you are working with a templat e. If you
are working with an instance, it shows the lock status for the value in the parent object.

118
Configure Objects Application Server User Guide

6. Set any security you need. For more information about setting security, see Set Object Security on
page 68.
7. Save and close the Object Editor when you are done.

Attributes and Scripting

When using attributes in scripting, keep the following guidelines in mind.
 If you use Calculated and Calculated retentive attributes as counters, they must be manually
initialized. For example, if you use me.Attribute=me.Attribute+ 1 as a c ount er in a script, you
must also initialize the attribute with something like me.Attribute=1 or me.Attribute=<some
attribute value>.
 Calculated attributes can be initialized in scripts with Execution type triggers of On Scan and
Execute, but not initialized in Startup scripts.
 You must initialize Calculated retentive attributes in Startup scripts and you can initialize thes e
attributes in On Scan and Execute scripts. A Calculated retentive attribute retains the attribute’s
current value after a computer restart, redundancy-related failover, or similar situation in which valid
checkpoint data is present.
Your Startup script should contain a statement testing the Boolean value of the
Engine.StartingFromCheckpoint attribute on the object’s AppEngine. If the value is TRUE, do not
initialize the attribut e. If the value is FALSE, initialize the attribut e. For more information about
Engine.StartingFromCheckpoint, see the help for the AppEngine object, available from the
AppEngine object editor.

119
Application Server User Guide Configure Objects

Adding Features to Attributes

The Attribute s page allows you to configure an existing attribute for I/O, alarms, and history functionality
not embedded in the original object.

About Features Inheritance

You can add Features to attributes that are in either derived templates or in instances. You cannot add
Features to attributes in Base templates. The following parent -child object characteristics also apply to
Features added to objects:
 If you add a Feat ure to an attribute in a derived template that has objects derived from it, all child
objects inherit the Feature.
 You cannot add a Feature to attributes on derived objects that duplicate parent object Features in
name and type.
 You cannot add a Feature with the same name as an existing Feature.
 Renaming a Feature on an attribute in the template to whic h it was originally added renames all ot her
objects derived from the template. This change happens when the template is checked in.
 You can check in a template with an attribut e configured with a new Feature with the same name as
an existing Feat ure on an attribute in a derived object. The template definition of the Feature
overrides the Feature in the derived object.
 If you remove a Feature on an attribut e from a template, that Feature is removed from any child
object. You see the change when you check in the template.

120
Configure Objects Application Server User Guide

To create and associate a Feature with an object

1. On the Attribute s page, select an attribute from the Attribute s Li st. The available Features
dynamically change to allowed Feature rules for the selected attribute type.
2. Click the button for the Feature you want to apply to the selected attribute. The associated
parameters for each kind of Feature become available. For detailed information about each item on
the Attribute s page, see About the Attributes Page on page 69.
3. Select the parameters for the Feature you have added. A vailable Features, which vary depending on
the attribute’s Data Type and Writeability, are the following:
 I/O: For information about adding the I/ O Feature, see Using the I/O Feature on page 121.
 Hi story: For information about adding the History Feature, see Using the History Feature on
page 130.
 Limit alarms: For information about adding a Limit alarm Feature, see Using the Limit Alarms
Feature on page 133.
 ROC alarms: For information about adding a Rate of Change (ROC) alarm Feature, see Using
the ROC Alarms Feature on page 134.
 Deviation alarms: For information about adding a Deviation alarm Feature, see Using the
Deviation Alarms Feature on page 135.
 State alarm: For information about adding a State alarm, see Using the State Alarm Feature on
page 137.
 Bad Value alarm: For information about adding a Bad Value alarm, see Using the Bad Value
Alarms Feature on page 138.
 Statistics: For information about adding a Statistics Feature, see Using the Statistics Feature on
page 138.
 Log change: For information about adding a Log Change Feature, see Using the Log Change
Feature on page 140.
4. Lock the values, if needed. The lock symbol is available only when you are working with a template.
If you are working with an instance, it shows the lock condition of the value in the parent object.
5. Set any security for the attribute. For more information about setting security, see Set Object
Security on page 68.
6. Save and close the Object Editor to include the new Features in the configured object.

Using the I/O Feature

The I/O Feature allows you to configure all aspects of data input and output for an attribute.
You can configure I/ O type and you can specify input sources and output destinations. The I/O types you
can specify are:
 Read (Input): See Configure I/O as Read-only on page 123.
 Read/Write (InputOutput): See Configure I/O as Read/Write on page 124.
 Write (Output): See Configure I/O as Write-only on page 126.
You can also configure advanced properties, described in t he following table. The attribute’s data type
and I/O type determine what Advanced I/O properties are available.

121
Application Server User Guide Configure Objects

I/O Feature
Advanced
Property Description

Buffered Enable buffered data to propagate to data subscribers the entire subset of values
accumulated within a single scan cycle.
Buffering data ensures that if a given attribute changes its value several times
during a single scan cycle, there is no folding of data, which occurs when an
accumulation of values of multiple data changes within a single scan are
overwritten and only the latest value is stored.

Deadband Specify the minimum amount by which a value must vary in order for the attribute
to register a change, for example, by triggering an alarm, historizing an alarm or
event, or triggering a script.
The Deadband property is not available for string data types.
Reflect input to Enable to propagate an input value to an output destination. Enabling
output automatically disables the Output de stination differs from input source
option.
Typically, set this option when you want to read an input from one source,
manipulate its value in a script, and send the manipulated value to a different
destination address, all during a single scan of an object. For more information,
see Using Read/Write I/O in Scripts on page 126.
A vailable only when the I/O type is Read/Write. You must set separate Read
from and Write to properties.

Output every A vailable only when Reflect input to output is selected. Write to the specified
scan output destination occurs even when there has been no state or data change
since the previous scan.
The timestamp is not updated if there has been no state or data change since t he
previous scan.

Enable I/O Enables scaling between the raw value and the Engineering Units (EU) value.
scaling Scaling is the process of taking raw data from a devic e and pres enting it as an
appropriate value for your application.
Application Server supports two types of data scaling: linear and square root,
described in this table.
A vailable only for integer, float, and double data types.

Maximum A vailable only when I/O scaling is enabled.

Raw: The raw input maximum to be used in the scaling equation.
EU value: The maximum value in engineering units to be used in the scaling
equation.
Extended E U range: The highest value allowed for the attribut e before it is
clamped, if clamping is enabled, or set to NaN. This value must be greater than or
equal to the specified maximum EU value.

122
Configure Objects Application Server User Guide

I/O Feature
Advanced
Property Description

Minimum A vailable only when I/O scaling is enabled.

Raw: The raw input minimum to be used in the scaling equation.
EU value: The minimum value in engineering units to be used in the scaling
equation.
Extended E U range: The lowest value allowed for the attribute before it is
clamped, if clamping is enabled, or set to NaN. This value must be less than or
equal to the specified minimum EU value.

Conversion A vailable only when I/O scaling is enabled.

mode
Select Linear or Square Root conversion mode from the list.
Linear: Typically converts directly from one value scale and type (raw) to another
value scale and type (EU).
ScaledValue = ((RawValue-RawMin)/(RawMax-RawMin) *
(EngUnits Max-E ngUnitsMin)) + EngUnitsMin
Square Root: Provides more precise scaling, typically used when the raw value is
too large to be us efully scaled to an EU.
ScaledValue = sqrt((RawValue-RawMin)/(RawMax-RawMin))
If RawValue < RawMin, then ScaledValue = (sqrt (RawMin) *
(EngUnits Max-E ngUnitsMin)) + EngUnitsMin

Clamp input to A vailable only when I/O scaling is enabled.

EU range
If enabled, the scaling calculation result is clamped at either the maximum EU
range value or the minimum E U range value, and the attribute quality is set to
Uncertain.
If not enabled, and the attribute value exceeds the EU range, then the value will
continue to scale out of range, and the quality is set to Bad.

Configure I/O as Read-only

Select Read in the I/O parameters area. Define an input source by using I/O auto-assignment, or by
typing in the reference string, or by clicking the Attribute Brow ser button at the right.
 Use I/O auto-assignment to prepare the input source for automatic assignment to a configured
Device Integration (DI) object or other data source. For information about using I/O auto-assignment,
see Using I/O Auto Assignment on page 140.

Important: If the InputSource attribute is locked in the parent template, the attribute cannot be
updated with the res olved reference when the object is deployed, and the run -time value will be
"---Aut o---".

 Use the Attribute Browser to select an attribute and automatically insert the correct reference string
for that attribute. For more information about using the Attribute Browser, see Reference Objects
Using the Galaxy Brows er on page 83.

123
Application Server User Guide Configure Objects

 If you are configuring an I/O attribut e for use with the Telemetry Server, see Configure I/O for Use
with AVEVA Telemetry Server Communication Drivers on page 129 for additional information.

You can add multiple Read (input) I/O Features to an object. However, you cannot add a Read/Write
(InputOutput ) I/O Feature to an attribute that already has either a Read or a Write (output) I/O Feature.
Arrays are not supported.

Note: Lockable attributes can be configured with a Read I/O Feature, but they only function correctly
during run time if the configured attribut e is unlocked.

If the data types of the attribute and its I/O source attributes are the same, they are set to equal values
according to the object’s execution rate. If the two attributes are different data types, coercion rules are
applied.
If c oercion fails or the input value is out of the attribute’s range, quality for the configured attribute is set to
Bad. Otherwise, the configured attribute quality matches the source attribute. When the object is Off
Scan, quality is always Bad and user sets are accepted.
Attributes configured with a Read I/O Feature are not protected by their security classification. The only
enforced security specifies if an IDE user can edit or add features to the object. A Read I/O Feature can
be added to a template or instance. If added to a template, the existence of the Read I/O Feature is
automatically locked in derived objects.

Configure I/O as Read/Write

Select Read/Write in the I/O parameters area. Define an input source by using I/O aut o-assignment, or
by typing in the reference string, or by clicking the Attribute Brow ser button at the right.

124
Configure Objects Application Server User Guide

 Use I/O auto-assignment to prepare the input source for automatic assignment to a configured
Device Integration (DI) object or other data source. For information about using I/O auto-assignment,
see Using I/O Auto Assignment on page 140.
If InputSource or OutputDest attributes, or both, are locked in the parent template, the attributes
cannot be updated with the resolved reference when the object is deployed, and the run-time value
will be "---Auto---".
 Use the Attribute Browser to select an attribute and automatically insert the correct reference string
for that attribute. For more information about using the Attribute Browser, see Reference Objects
Using the Galaxy Brows er on page 83.
 If you are configuring an I/O attribut e for use with the Telemetry Server, see Configure I/O for Use
with AVEVA Telemetry Server Communication Drivers on page 129 for additional information.
If the output destination and the input source are not the same, click Output de stination differs from
input source. Enter a De stination attribute by using I/O auto-assignment, by typing in the reference
string, or by using the Attribute Brow ser to search for the reference string in an object.

Important: If you clear the Output de stination differs from input source check box, the Write to text
box automatically shows "---". In the run-time environment, "---" is the same reference as the Read from
value ent ered during configuration time. During run time, you can change the Read from reference.
During configuration, do not lock the Write to parameter if you clear the Output de stination differs
from input source check box.

A Read/Write I/O Feature allows an attribute in a template or an instance to be configured so that its
value is both read from and written to an external reference. The Read/Write I/ O Feature monitors the
value/quality of an input and sends outputs on state change.

125
Application Server User Guide Configure Objects

The Write to (output) destination can be the same or different from the Read from (sourc e). The
references are always to another acceptable attribute type in the Galaxy.
You can add multiple Read/Write I/ O Features to an object. However, you cannot add a Read/Write I/O
Feature to an attribute that already has a Read or Write I/O Feature.

Note: You can add a Read/Write I/O Feature to lockable attributes, but they only function correctly during
run time if the configured attribute is unlocked.

When Objects Are On Scan

When an object is On Scan, the value and quality of the attribute configured with a Read/W rite I/O
Feature mirrors the quality of the externally referenced attribute during a successful read. The data
quality of the attribut e is set to Bad when reads fail. Reads can fail because of communication errors or
datatype conversion failures.
While the object is On Scan, the data can change quality. If an external set (for example, from a user) to
an attribute changes either the value or quality, then a write of the attribute’s value to the destination
occurs during the next execute phase. The quality must be Good or Uncertain for a writ e to occur. For
writes to occur because of a quality change, the quality change must be a transition from Bad or
Initializing to Good or Uncertain.
The attribute called WriteValue is publicly exposed and plays an important role in driving outputs. When
the object is Off Scan, quality is always Bad and user sets are accepted.

Using Read/Write I/O in Scripts

Two common types of scripts can be written on an attribute configured with a Read/Write I/O Feature:
One can look at the input side and one can look at the out put side.
The input side script uses the current value coming from the input source location and performs logic or
calculations on it. This script refers directly to the attribute in its expressions. For example, if the attribute
is "me.attribute1", the script refers directly to "me.attribute1" for data change conditions and
for expressions within the script.
The output side script can modify output or validate a new requested output value. This script refers to
the "WriteValue" attribute configured on the attribut e: "me.attribute1.WriteValue".
To validate a new requested value to the attribute1, for example, a data change condition expression is
written on "me.attribute1.WriteValue". In addition, if the script wants to do clamping or
validation, it can manipulat e the "me.attribute1.WriteValue" directly to clamp the output value.
For example:

If (me.attribute1.WriteValue > 100.0 ) then

Me.attribute1.WriteValue = 100.0;

Endif;
The data change expression for this script is "me.attribute1.WriteValue" because this value
changes when a new value is about to be written to the field.
The script can intercept this value just before output and manipulate it. To prevent WriteValue from being
written out, its data quality can be set to Bad with the SetBad() function.
For more information, see Work ing with Outputs on page 128.

Configure I/O as Write-only

Select Write in the I/O parameters area. Define a Write to (output) destination by using I/O
auto-assignment, or by typing in the reference string, or by clicking the Attribute Brow ser button at the
right.

126
Configure Objects Application Server User Guide

 Use I/O auto-assignment to prepare the output destination for automatic assignment to a configured
Device Integration (DI) object or other data source. For information about using I/O auto-assignment,
see Using I/O Auto Assignment on page 140.
 If the OutputDest attribute is locked in the parent template, the attribute cannot be updated with the
resolved reference when the object is deployed, and the run-time value will be "---Auto---".
 Use the Attribute Browser to select an attribute and automatically insert the correct reference string
for that attribute. For more information about using the Attribute Browser, see Reference Objects
Using the Galaxy Brows er on page 83.
Select the Output Every Scan check box if you want the attribute to write to the De stination attribute
every scan period of the object. Otherwise, the write executes only when the value is modified or when
quality changes from Bad or Initializing to Good or Uncert ain.

Writeable and Calculat ed attributes can be configured with a Write I/O Feature. Arrays are not
supported.
A Write I/O Feature can be added to a derived template or to an instance. If added to a templat e, the
existence of the Write I/O Feat ure is automatically locked in derived objects. The output Destination
attribute is separately lockable in templates.
If the data types of the configured and destination attributes are the same and only when the quality of
the extended attribute is good, the two attributes are set to equal values according to the configured
object’s execution rate. If the two attributes are different data types, coercion rules are applied. If
coercion fails, the extended attribute is placed into a configuration error and type mismatch state .
An attribute that is enhanced with a Write I/O Feat ure has the following characteristics:

127
Application Server User Guide Configure Objects

 A value can be output only when quality is Good or Uncertain. The quality is not output, only the
value is output, because quality is not output on sets.
 When the quality changes from Bad or Initializing to Good or Uncertain, the value is output, even if
the value is not modified.
 When the quality changes from Good to Uncertain, with no value modific ation, the value is not
output.
 When the object goes Off Scan, no out put is done.
 When the extended object is Off Scan, quality is always Good and user sets are accepted.

Working with Outputs

The following information applies to the functionality of Read/Write and Write Featu res as well as to the
output function of the Field-Reference, Switch, and Analog-Device objects.
If a single set request is made to a destination attribute during a single scan cycle, that value is sent to the
destination. During a single scan cycle, though, more than one set request to the same destination is
possible. In that case, folding occurs and the last value is sent to the destination.
During a single scan cycle, only the last value requested during a scan cycle is sent to its destination
when the object executes. Its status is marked as Pending as it waits for write confirmation from the
destination object. All other set requests during that scan cycle are marked as successfully completed.
If one or more new sets are requested during the next scan cycle, then the second scan cycle's value is
determined as described in the preceding paragraphs. It is then sent to the destination when the object
executes again and the value sent to the destination during the previous scan cycle is marked with
successful completion status even if write confirmation is not received.
Within a single scan cycle, data is folded and only the last set requested is sent to the destination, unless
the Buffered attribute is enabled. For example, an {11,24,35, 35,22,36,40} sequenc e of set requests
results in a value of 40 being sent to the destination object. All other values result in successful
completion status.
The exception to this behavior is when you enable the Buffered attribute. For more information, see I/O
Feature advanced properties information in Using the I/O Feature on page 121.
Boolean data types are an exception to folding behavior when the Buffered attribute is not enabled.
Boolean data types are used in User sets from InTouch or FS Gateway. This allows an unknown user
input rat e (for ex ample, repeated button pushes) with a consistent object scan rate for outputs, and
creates reproducible res ults.
In this case, a combination of folding as described plus maintenance of a queue of one el ement deep
better meets the expectation of users. To begin with, the first value set after the object is deployed (the
default True or False) is always written to its destination.
Subsequently, the following occurs during a single scan cycle: A two-tiered caching scheme of a Value to
be Sent and a Next Value to be Sent is implemented. The Value to be Sent is based on data change as
compared to the last value sent to the destination object. The Next Value to be Sent is based on data
change as compared to the Value to be Sent value.
When the first data change occurs, the new value is cached in the Value to be Sent queue. Folding
occurs if the same value is requested again. If another value change occurs, this second value is cached
in the Next Value to be Sent queue. Again, folding oc curs if the same value is requested again.
The Value to be Sent value is sent during the next scan cycle, and the Next Value t o be S ent value is sent
during the following scan cycle.

Note: In the case of Boolean data types used in Supervisory sets (sets between ApplicationObjects and
ArchestrA) or a mixture of Supervisory and User sets during a single scan cycle, the behavior is the same
as the other data types.

128
Configure Objects Application Server User Guide

For Boolean data types and User sets, the following examples apply:

Previous
Scan Cycle Scan Cycle Value to be Next Value
Value Sent Set Requests Sent to be Sent

0 1,0,0,1,1 1 none

1 1,0,0,1,1 0 1

0 1,1,0,0 1 0

1 1,1,0,0 0 none

When the same attribute is extended with an Input extension and an Out put extension, writes to the
Output extension’s De stination occur every scan regardless of whether the extended attribute has
changed.
This behavior occurs even when the Output Every Scan check box is cleared, which may add more
network traffic. The behavior does not apply to an Input extension.

Quality of Read, Read/Write, and Write I/O

When the object is On Scan, the value and quality of an attribute configured with a Read I/O Feature
mirrors the quality of the externally referenced attribute in the case of successful reads. The data quality
of the configured attribute is set to Bad when reads fail because of communication errors or datatype
conversion failures.
While the extended object is On Scan, it behaves as follows: If an external set (for example, from a user)
to the configured attribute caus es either the value or quality to change, then a write of the configured
attribute’s value to the destination occurs during the next execute phase.
The quality must be Good or Uncertain for a write to occur. For writes to occur because of a quality
change, the quality change must be a transition from Bad or Initializing to Good or Uncertain. The
attribute called WriteValue is publicly exposed.
When the configured object is Off Scan, quality is always Bad and user sets are accepted.

Configure I/O for Use with AVEVA Telemetry Server Communication Drivers
If you are using AVEVA Telemetry Server Communication Drivers to send and receive dat a from
Application Server, you will need to configure I/O attribut es, in accordance with the applicable
communications protoc ol. The Telemetry Server communicates with outstations via the DNP 3, IEC
60870, and/or Modbus prot ocols. Use the reference syntax that corresponds wit h the protocol you are
using. Since some outstations may send data to the Telemetry Server only once per day, you will also
need to enable buffering to ensure that data is not lost.

Note: If multiple attribut es with I/O enabled are configured for buffered data from the same data point in
the Telemetry Server, only one attribute will receive the buffered data at run time.

Dynamic References
You can configure Telemetry S erver data points using dynamic references. When you create and deploy
an attribute with a dy namic reference in Application Server, the point is automatically generated on the
Telemet ry Server, and eliminates the need to manually create the same reference in two places.
Additional Information
For more information about enabling buffered data and creating Telemetry Server referenc es, see the
following sections:

129
Application Server User Guide Configure Objects

 Work ing with Buffered Data on page 369

 Telemet ry Server Data References on page 394
 Telemet ry Server Dynamic Tags on page 395

Using the History Feature

Any attribute that exists at run time and is not already historized can be configured with a history Feature.

A history Feature can be added to a template or an instance attribute. If added to a template attribute, the
existence of the history Feature is automatically locked in derived objects.
You can configure Writeable and Calculated attributes of the following data types with a history Feature:
 Float, Double (stored as a Float)
 Integer
 Boolean
 String stored as Unicode, 512 character limit
 Custom Enumeration stored as an Integer
 ElapsedTime stored as seconds
You can configure the following attributes for a history Feature:

130
Configure Objects Application Server User Guide

Hi story
Feature
Attribute s Description

Description The attribute c ontaining t he description string, if any, associated with the attribute
being configured.
Enter the attribute manually, or use the brows e button to open the Galaxy
Browser to find a specific attribute.
Example: For the description associated with Attribute001 that has been added
to object Reactor31, you would enter or brows e to
"Reactor31.Attribute001.description".
The description also can be a simple string without reference to an attribute.

Force Storage Period after which the value, in milliseconds, must be historized even if the value
Period has not changed.
A value of 0 disables the parameter.
Example: A setting of 3600000 indic ates the value must be stored once per hour
(measured from the time the object was last put onscan).
If the force storage period value is less than the scan period of the host object,
forced storage will occur every scan period (effectively equivalent to setting a
value deadband of 0).

Value The threshold value, measured in engineering units, that the absolute value of
Deadband the difference bet ween the new and last-stored values must differ before storing
the new value to history.
A value of zero (0) is valid and means that any level of change results in the new
value being stored.
A change in Quality always causes a new record to be stored, regardless of
whet her the Value has changed.
Trend High The default top of a trend scale.
This value must be greater than or equal to the low value for the trend.
If this value is changed at run time, the maximum engineering unit change is not
reflected in the Historian until you redeploy the object.
This attribute applies only to numeric data types.
Trend Low The default bottom of a trend scale.
This value must be less than or equal to the high value for the trend.
If this value is changed at run time, the minimum engineering unit change is not
reflected in the Historian until you redeploy the object.
This attribute only applies to numeric data types.

Enable Enable and provide a valid swinging door rate deadband and the forc e storage
swinging door period becomes the deadband override period.
Boolean or string dat a types cannot be configured with a swinging door
deadband.

131
Application Server User Guide Configure Objects

Hi story
Feature
Attribute s Description

Rate A vailable only if swinging door is enabled.

deadband
The percent age rate of change deadband based on the change in the slope of
incoming data values to the Historian.
Example: A swinging door rate deadband of 10 percent means that data is saved
to the Historian if the percentage change in slope of consecutive dat a values
exceeds 10 percent.
Default is 0.0, which indicates a swinging door rate deadband is not applied. Any
percentage greater than 0.0 can be assigned to the rate deadband.

Interpolation The method used by the Historian to interpolate analog historical data. The
type interpolation type determines which analog value is selected during a Historian
data retrieval cycle.
Select an Int erpolation type:
System Default: The Wonderware Historian system-wide interpolation setting is
used. The system-wide setting must be eit her stairstep or linear interpolated.
Stairstep: The last known value is returned with the given cycle time. If no valid
value can be found, a NULL is returned to the Historian.
Linear: Historian calculates a new value at the given cycle time by interpolating
between the last known value prior to the cycle time and the first value after the
cycle time.

Rollover value A positive integer value that represents a tag’s reset limit when the Historian
operates in counter retrieval mode.
In counter retrieval mode the Historian uses a t ag's rollover value to calculate and
return the delta change between consecutive retrieval cycles.
The default value is 0.0.
Boolean and string data types cannot be configured with a rollover value.

132
Configure Objects Application Server User Guide

Using the Limit Alarms Feature

Select the Limit alarms Feature to add and configure a Limit Alarm on an attribute of Integer, Float, or
Double data type. You can add a Limit alarm Feature to a template or instance. If added to a template
attribute, the Limit alarm Feature is automatically locked in derived objects. Limit alarm Features cannot
be added to attribute arrays.

You can enable up to four categories of Limit alarms. When enabled, alarms will be triggered when the
value reaches the configured limit.
 HiHi
 Hi
 Lo
 LoLo
For each Limit alarm, specify the following parameters:

Limit Alarm Feature

Parameters Description

Limit The limit that the attribut e value must exceed to trigger an alarm. Enter
the limit value for each enabled Limit alarm category.
Priority A numeric value for the urgency of the alarm. Valid values are 1 through
999, with 1 being the most urgent.
For more information about pre-configuring alarm priorities, see Mapping
Alarm Severity to Priority.
Alarm message Browse and select an existing attribute or type a text string as an alarm
message. This text string appears in the InTouch alarm view.

133
Application Server User Guide Configure Objects

Limit Alarm Feature

Parameters Description

Alarm deadband The amount, in engineering units, that the attribute value must exceed
the configured HiHi, Hi, Lo, or LoLo limit before an alarm is triggered.

Time deadband The time, in seconds, that must elapse after the attribute value exceeds
an alarm limit before the alarm is triggered.

Using the ROC Alarms Feature

Select the ROC alarms Feature to add and configure a Rate of Change (ROC) alarm on an attribute of
Integer, Float, or Double data type. You can add a ROC alarm Feature to a t emplat e or instance. If added
to a template attribute, the ROC alarm Feature is automatically locked in derived objects. ROC alarm
Features cannot be added to attribute arrays.

You can enabl e up to two categories of ROC alarms. When enabled, alarms will be triggered when the
value reaches the configured limit.
 Up: Rate of increase
 Down: Rate of decrease.
For each ROC alarm, specify the following parameters:

ROC Alarm s Feature

Parameters Description

Limit The limit that the attribute rate of change value must exceed to trigger an
alarm. Enter the limit value for each enabled alarm category.
The down limit is a positive value, but indic ates a negative rate of
change, or a descending rate Hi limit.

134
Configure Objects Application Server User Guide

ROC Alarm s Feature

Parameters Description

Priority A numeric value for the urgency of the alarm. Valid values are 1 through
999, with 1 being the most urgent.
For more information about pre-configuring alarm priorities, see Mapping
Alarm Severity to Priority.
Alarm message Browse and select an existing attribute or type a text string as an alarm
message. This text string appears in the InTouch alarm view.
Changes per Select a unit of time for the rate of change calculation – seconds,
minutes, hours, or days.
E valuate every The time interval, in milliseconds, at which the rate of change calculation
and detection is performed.

Using the Deviation Alarms Feature

Select the Deviation alarms Feat ure to add and configure a Deviation alarm on an attribute of Integer,
Float, or Double data type. You can add a Deviation alarm Feature to a template or instance. If added to
a template attribute, the Deviation alarm Feature is automatically locked in derived objects. Deviation
alarm Features cannot be added to attribut e arrays.

You can enable up t o two c ategories of Deviation alarms. When enabled, an alarm will be triggered when
the attribute level deviates from a target value by a configured amount.
 Major: The major alarm deviation toleranc e.
 Minor: The minor alarm deviation toleranc e.
For each Deviation alarm, specify the following parameters:

135
Application Server User Guide Configure Objects

Deviation Alarms
Feature Parameters Description

Tolerance The major or minor deviation tolerance that the attribute value must
exceed to trigger an alarm.

Priority A numeric value for the urgency of the alarm. Valid values are 1
through 999, with 1 being the most urgent.
For more information about pre-configuring alarm priorities, see
Mapping Alarm Severity to Priority.

Alarm message Browse and select an existing attribute or type a text string as an alarm
message. This text string appears in the InTouch alarm view.

Target The setpoint value for deviation calculation.

Deviation deadband The amount the attribute value must drop (measured in engineering
units) below any of the deviation limits before the respective condition
is set to FALSE.

Settling period The time, in seconds, allowed for the attribute value to return wit hin
allowable range after a Target change is made before the deviation
alarm is triggered.
A deviation alarm cannot occur again until the alarm clears.
The value you specify will be converted to the following format: days
hh:mm:ss.fffffff.

136
Configure Objects Application Server User Guide

Using the State Alarm Feature

Select the State alarm Feature to add and configure a State alarm on an attribute of Boolean data type.
You can add a State alarm Feature to a template or instance. If added to a template attribute, the State
alarm Feature is automatically locked in derived objects. State alarm Features cannot be added to
attribute arrays.

You can set an alarm message and Priority for a state alarm. The time deadband is used to filter out
rapid, transitory value spikes, and the active alarm state determines the trigger value (True or False) that
will activate the alarm. For eac h State alarm, specify the following parameters:

State Alarms Feature

Parameters Description

Category The alarm category. Select a category from the list box. See State
Alarms on page 296 for additional information.
Priority A numeric value for the urgency of the alarm. Valid values are 1
through 999, with 1 being the most urgent.
For more information about pre-configuring alarm priorities, see
Configuring Alarm Historization, Mapping, and Shelving Priority
Ranges on page 326.
Alarm message Browse and select an existing attribute or type a text string as an alarm
message. This text string appears in the InTouch alarm view.

Active alarm state The state of the active alarm, True or False, when the alarm is
triggered.

Time deadband The time, in sec onds, that must elapse aft er the attribute value exceeds
an alarm limit before the alarm is triggered.

137
Application Server User Guide Configure Objects

Using the Bad Value Alarms Feature

Select the Bad value alarms Feature to add and configure a Bad Value alarm on an attribute of Boolean,
Integer, Float, or Double dat a type. If enabled, alarms will be triggered when the attribute has bad dat a
value or data quality.
A bad value results from bad data quality. Bad quality can occur when:
 The PLC indicates that quality is bad (for example, if communications with a physical device is lost).
 There is a communications error (for example, an OP C or I/O server failure).
 There is a configuration error (for example, a broken I/O reference).
 An out of range value is recorded.
 A script sets data quality to bad.
You can configure graphic elements to highlight when a bad data quality state occurs, and its underlying
cause. See Use Quality and Status Styles to Provide Run-Time Feedback on page 161 for more
information.
You can add a Bad V alue alarm Feature to a template or instance. If added to a template attribute, the
Bad Value alarm Feat ure is automatically locked in derived objects. Bad Value alarm Features cannot be
added to attribute arrays.

In the Alarm message box, you can browse and select an existing attribute or you can type a text string
as an alarm message. This text string appears in the InTouch alarm view.
Specify a Priority for this alarm, a numeric value for the urgency of the alarm. Valid values are 1 through
999, with 1 being the most urgent.
For more information about pre-configuring alarm priorities, see Configuring Alarm Historization,
Mapping, and Shelving Priority Ranges on page 326.

Using the Statistics Feature

Select the Statistics Feature to add and configure calculation of statistics on an attribute of Boolean,
Integer, Float, or Double dat a type. If enabled, the following statistics are calculated:

138
Configure Objects Application Server User Guide

 Time since last transition: If no change in the input value, the elapsed time value increments to show
the total elapsed time since the last transition. A change in input value resets the elapsed time since
last transition.
 A verage: Defined as the sum of the sample size divided by the number of sample size attributes in
the data set.
 Standard deviation: Defined as the amount of variation or "scatter" from the average.

You can configure the following parameters for the Statistics Feature:

Statistics Feature
Parameters Description

Auto reset on bad value If enabled, the input automatically triggers a reset command when the
quality of an input goes from BAD or UNCERTA IN to GOOD.

Values per sample set The maximum number of samples to collect in calculating the mean
and standard deviation. The minimum numb er of samples is 2.
A large sample set will impact run-time performance.
This attribute is unavailable for a Boolean data type.

139
Application Server User Guide Configure Objects

Using the Log Change Feature

Select the Log Change Feature to log system events for an attribute of Boolean, Integer, Float, or
Double data type.

When enabled, the Log Change feature logs data change events as well as user events.

Using I/O Auto Assignment

Instead of configuring I/O references manually, or writing scripts to set them at run time, you can use I/O
auto assignment. Manual configuration of I/O referenc es can be time consuming. Scripting these
references eliminates the issues of manual configuration, but can signific antly increase the time needed
for deploying objects. With I/O auto assignment, you do not need to check out individual objects to
configure I/O references, and you do not experience the run-time penalties associated with scripting.

Note: I/O aut o assignment is the default setting for application and other system objects, such as area
objects. Device Integration (DI) Objects must be manually configured.

When you add input or output attributes to an area or application object in the Attribute s page of the
Object Editor, the default setting prepares these attributes for I/O aut omatic assignment. The auto
assignment reference appears in the I/O section of the Attribute s page if you have enabled the I/O
attribute feat ure. The default string for an input reference is:
<IODevice>.[ObjectName].[AttributeName].InputSource
where [ObjectName] is the hierarchical name of the application or system object, and [ AttributeName] is
the name of the attribut e.
The default string for an out put reference is:
<IODevice>.[ObjectName].[AttributeName].OutputDest
The string <IODevice> is a placeholder that indicates the I/O reference will be built automatically in a
process called auto binding. The reference res olves automatically as an auto-bound reference when you
link the object to a scan group and DI object, without having to manually enter or script the reference.
The following is an example of an I/O referenc e string before the object has been assigned to a scan
group and DI object:
<IODevice>.Mixer.Tank.Inlet.InputSource
Once you assign the object to a scan group, the reference resolves to include the assigned Device
Integration (DI) object and scan group. For example, assigning the object to the scan group "Fast" under
DI object "OPC001" will change the reference to:
OPC001.Fast.Mixer.Tank.Inlet.InputSource

140
Configure Objects Application Server User Guide

Important: Do not lock InputSource or OutputDest attributes when using I/O auto assignment. If either
InputSource or OutputDest attributes, or both, are locked in the parent template, the attribut es cannot be
updated with the resolved auto-bound reference when the object is deployed, and the run-time value will
be "---Auto---".

I/O auto assignment is configured in the IO Device s view. Use this view to associate application and
system objects with DI objects and scan groups.
Scan groups are contained by DI objects and help categorize devices that are associated with them on
the basis of how often their I/O points are scanned. For basic information about DI objects, refer to
Device Integration Templates on page 45. For basic informati on about scan groups, refer to the
OPCClient Object help file.

Note: A DI object will not appear in the IO Device s view unless at least one custom scan group has been
defined for it.

Assign objects that need to be closely monitored or that have a faster rate of change t o a scan group with
a faster scan rate. Objects with slower rates of change can be assigned to a scan group with a slower
scan rate. The scan rate is the rate at which the ArchestrA run time will perform scans. This may be
different than the scan rate a PLC uses to monitor the hardware attached to it.

Note: Fast scan groups consume more network and computing resourc es than slow scan groups. In a
large Galaxy, load balancing may require you to use multiple scan groups with similar scan rates.

The I/O referenc es for the objects’ attributes set to use I/O automatic assignment are dynamic ally
generated when you assign an object to a scan group. The auto-bound reference replaces the
placeholder string and is displayed in the IDE. It is generally in the following format:
<DIObject>.<ScanGroup>.<Object>.<Attribute>

141
Application Server User Guide Configure Objects

<DIObject> and <ScanGroup> correspond to the name of the DI object and scan group to which you
assign the object. For example, if the DI object name is DI01 and the scan group name is FastSG, then
the auto-bound reference will start with DI01.FastSG.
<Object> may consist of multiple elements if there are contained objects. The following is an example
of an object string:
Tank3.Valve1.Attr2
Here, Tank3.Valve1 corres ponds to <object>. The complete auto -bound I/O reference would be:
DI01.FastSG.Tank3.Valve1.Attr2
Although you assign objects, references are generated for each I/O attribute associated with the object,
and not for the object itself. Therefore, you may have to change the I/O references for a subset of an
object’s attributes. Once objects are associated with DI objects and scan groups, you can validate the
auto-bound assignment for each of the object’s attributes in the IO Device Mapping view, and if
necessary, you can ent er override values in this view.

Assigning Areas and Objects to Scan Groups

The IO Devices view displays all application and system objects, as well as DI objects that have custom
scan groups associated wit h them. Templates are not shown in this view, nor are DI objects that do not
have custom scan groups defined for them (DI objects with only the default scan group are not displayed
in the IO Devices view).

Note: You cannot assign application and system objects to a default scan group; these assignments can
only be made for custom scan groups.

In the IO Devices view, objects and areas are initially unassigned and placed in a flat view under the
"Unassigned IO Devices" folder. You then select one or more of these unassigned objects or areas and
drag and drop them onto a scan group. Deployed application and system objects cannot be assigned to
a scan group. Undeploy them first.

Note: DI objects can remain deployed during the assignment process.

Once an object is attached to a scan group, the I/O references for the objects’ attributes set to use I/O
automatic assignment are automatically generated for you by concatenating the DI object, scan group,
object (including contained objects), and attribute names.
You can assign multiple objects for auto-binding at once. Hold down the shift or ctrl key to select
multiple objects and drag the selected items to a scan group. Object assignment is based on hierarchy
and area inheritance, as follows:
 If all the objects you select are at the same hierarchical level, all contained (subordi nate) objects that
have not been assigned, except sub-areas, are also selected and will move to the same scan group.
o To assign a sub-area, it must be specifically selected.
o If some contained objects were previously assigned to a different scan group, these will retain
their original assignments. To change an existing assignment, you must specifically select the
assigned object and move it to a different scan group.
 If you select objects at different hierarchical levels for assignment to a scan group – for example, if
you select an area, an object within the same area, and an object from another area – then only the
selected items move to the scan group.
 If you select an area that contains anot her area, only the area selected will move. You must
specifically select an area to assign it, regardless of its hierarchical level.
When an area or containing object is assigned to a scan group, the objects it contains are assigned as
follows:

142
Configure Objects Application Server User Guide

 Objects within the area that share the area's device linkage will be reassigned to the new device
along with the area. This remains true even in the case where both the area and the contained
objects are not currently linked to a device. Unassigned objects within the area will use the area’s
assignment.
 Objects within the area that are already assigned to a scan group that is different from that of the
hosting area will retain their original assignments.
 If necessary, you can reassign cont ained objects to a different scan group after the initial
assignment, or override assignments in the IO Device Mapping view .

Note: You cannot change scan group or DI object assignments for deployed objects in the IO Device s
view. You must undeploy the object first.

Deleting a scan group will delete the I/O assignments of any objects that were previously assigned to it,
including override values.

Caution: Creating or deleting scan groups within a derived DI object template may overwrite I/O
assignments when these changes are propagated to instances of the DI object template. If this happens,
all I/O aut o assignment information for objects linked to the updat ed DI objects, including override
values, will be lost. The objects will move to the "Unassigned I/O Devices" folder.

To assign an object or area to a scan group

1. In the IO Devices view or Model view, select application objects and areas for assignment.
2. Drag and drop the objects and areas to a scan group in the IO Devices view.
3. The object or area and all cont ained objects will be moved to the selected scan group.

Note: If the area or object has contained objects that were previously assigned to a different scan
group, these will retain t heir original assignments. Contained areas will not move and must be overtly
selected.

4. The I/O references for each attribute set for I/O aut o assignment will be dynamically configured and
displayed as auto-bound in the IO Device Mapping view .

Renaming Application, System, and DI Objects

You can rename application, system and DI objects in the IO Devices, Model and Deployment views. If
an area or object has already been assigned to a scan group, its I/O references are updated
automatically.

Renaming Scan Groups

Changes to scan groups (renaming, adding, or deleting them) can only be done by editing the DI object
that contains the scan group in the Object Editor. Use the DI object’s Scan Group page to make any
necessary changes.
If scan groups are renamed at the template level, the changes will propagate to the DI object instances
and I/O assignments will be preserved.

Validating and Editing I/O Assignments

The IO Device Mapping view is a table that displays I/ O auto assignment references for application and
system objects that are linked to DI object scan groups. Only auto-bound references are display ed in the
IO Device Mapping view. Application and system objects not yet assigned to a scan group, and
manually configured references and are not shown. To be visible in the IO Device Mapping view , the
object must be selected in the IO Devices view.

143
Application Server User Guide Configure Objects

When you initially open the IO Device Mapping view after starting the IDE, the table will scroll so the far
right column is in view.

 Selecting a DI object in the IO Device s view lists I/O auto assignment attributes for all aut o-bound
objects linked to all scan groups under it.
 Selecting individual scan groups restricts the scope of the information displayed in the I/O Device
Mapping view to the auto-bound objects that have been linked to the selected scan groups.
 Selecting individual application or system object further restrict s the scope of attributes displayed to
only those associated with the selected object.

Note: You can select multiple items in the IO Device s view. Selected items can be at different
hierarchical levels. Selecting a subordinate object will exclude non-s elected objects within the device
hierarchy, even though the parent object is selected.

In the IO Device Mapping view , you can view and validate I/O references for each automatically
generated attribute, and you can override the automatically generated I/O references. As is the case in
the IO Devices view, you do not have to check out objects to change their I/ O assignments.

144
Configure Objects Application Server User Guide

Using the IO Mapping View

The IO Mapping view is divided into columns, each of which displays information for an I/O attribute that
has been aut o assigned.

Column Heading Definition

Device Device Integration Object (DIO) name

ScanGroup Scan group name

Object Application object or area object name

Attribute Attribute name

I/O Input or Output

Device.ScanGroup Override setting: ent er an override value to replace the DIO and scan
Override group that was automatically assigned

Object.Attribute Override setting: ent er an override value to replace the object and
Override attribute names

Resulting Reference Conc atenated I/ O reference string (for example,

"DIO1.SG2.Mixer3.Attr5" or "DIO1.SG2.Conveyor.40001")

Runtime Value Data returned from run time when the Validate References button has
been clicked

You can change how I/O attributes are displayed by sorting, grouping, or filtering the attributes.
Attributes are initially sorted by Device name (DI object). To sort attributes using a different column, click
on the column heading once to sort in ascendin g order. Click a second time on the same column heading
to sort in descending order. A third click on the column heading turns off sorting for that column.

145
Application Server User Guide Configure Objects

To group objects by I/O assignment criteria, drag a column heading to the top of the table in the IO
Device Mapping view. For example, if you drag the heading "Attribute" to the top of the table, I/O
assignments will be grouped by attribute name. In the figure below, I/O assignments are grouped by
attribute name. Note each attribute grouping has been expanded.

Note: Grouping is not available for the Device.ScanGroup Override, Object.Attribute Override, or
Resulting Reference columns.

You can use more than one column heading to group I/O assignments. In the figure below, assignments
are grouped first by attribute name, and then by I/ O type.

Columns can also be filtered to display only certain entries by clicking the filter symbol and then selecting
the filtering criteria. When a filter is applied, the color of the filter symbol changes to orange.

Note: Filtering is not available for the Device.ScanGroup Override, Object.Attribute Override, or
Resulting Reference columns.

The table contains additional information that you can reveal by clicking the Show Details button.

Details Column
Heading Definition

Attribute Dat a Ty pe Attribute type as defined by the attribute definition set in the Object Editor

Target Data Type Attribute type of the target, as determined by the run time

146
Configure Objects Application Server User Guide

Details Column
Heading Definition

Runtime Quality Data quality from run time

Validating I/O References

Use the IO Device s pane and the IO Device Mapping pane to populate the Re sulting References
column in the IO Device Mapping grid. You can then validate auto-bound I/O attributes that have been
assigned in IO Device Mapping. To begin I/O reference validation, press the Validate References
button, available in the IO Device Mapping pane.
Validating I/O references is separate and distinct from the Validate function available in the Template
Toolbox and in the application views. That Validate function validates the object's references
configuration against the the Galaxy Repository. It is a configuration validation.
In contrast, validating I/ O references is a run-time validation, and performs a one-time "get" from the
run-time subsystem to retrieve the value and quality of the resulting references. A referenc e string in the
Resulting References column is validated if a valid value and good quality are returned for that string.
Objects should be deployed for an I/O reference validation to be meaningful.

Note: As a best practice, it is more efficient to validat e each reference while performing I/O
auto-assignment than it is to perform a single validation after configuring and deploying the entire
application.

An estimate of the time needed for validation is displayed. The time is updated as validation progresses.
When validation completes, the total number of unres olved I/ O referenc es is displayed along with the
total number of auto-bound references checked, for ex ample, "2 out of 5000 referenc e(s) failed to
validate." To view references that did not validate during the validation period, click the "Show Advanced
Columns" button. This will reveal the Runtime Quality column.
You can sort the Runtime Quality column to aggregate unresolved I/O references at the top of the list of
references. See Using the IO Mapping View on page 145 for additional information on sorting. You can
then move the associated objects to a different scan group or apply overrides. Recheck the references
after completing any required reassignments and overrides.

Overriding I/O Auto Assignments

The IO Device Mapping view contains two override columns. To change an I/O assignment, enter the
new paramet er in one or both of the two override columns.
The information in ot her columns cannot be edited directly. You can also reassign an object to a different
scan group in the IO Devices view, in which case the new assignment will be reflected in the IO Device
Mapping view.

Note: If an object is already deploy ed, changing any of its I/O assignments in the IO Mapping view will
change the object’s status from "Deployed" to "Deployed with pending configuration changes."

To override the DI object and scan group assignment that was made in the IO Devices view, enter the
value you want in the column Device.ScanGroup Override. Naming restrictions for the
Device.ScanGroup Override value are as follows:
 The value must contain one DI object name and one scan group name contained by the DI object,
separated by a period (.).
 The value cannot start or end with a period.
 The value cannot have any leading spaces.

147
Application Server User Guide Configure Objects

 The I/O referenc e cannot be longer than 329 characters.

To override the object and attribute name, enter the value you want in the column Object.Attribute
Override. Naming restrictions for the Object.Attribute Override value are as follows:
 The value cannot have any leading spaces.
 The I/O referenc e cannot be longer than 329 characters.
You can change attribute information using the Object Editor (after checking out the object), instead of
overriding values in the IO Device Mapping view. However, if you enter the specific I/O reference for an
attribute in the Object Editor (manual configuration), it will no longer appear in the IO Device Mapping
view. Only attributes configured for I/O automatic assignment appear in this view.

Overriding Large Numbers of Attributes

If you have a large number of overrides to ent er, information can be copied and pasted bet ween the IO
Device Mapping view and Microsoft Excel. However, you must be careful when moving data to and
from the IO Device Mapping view. Observe the following conditions:
 Only data in the two override columns is editable. All other columns are read only.
 E ven though you can only change the override columns, always copy all columns. This will help yo u
verify that data is being copied correctly when you paste back into the IO Device Mapping view.
 When you copy data from the IO Device Mapping view , column headers are aut omatically included
to help you while editing in Excel. When you copy your edited dat a back to the IO Device Mapping
view, do not copy this header row, only copy the data.
 If you need to sort attributes, sort them in the IO Device Mapping view before you copy them int o
Excel.
 Do not change the sort order of the attributes in the IO Device Mapping view until you have pasted
the edits made in Excel and applied them.
 Do not sort the attributes in Excel. Attributes can only be sorted in the IO Device Mapping view and
the sort order cannot change until your edits have been applied.

WARNI NG! The IO Device Mapping view does not verify data that is copied to it. Therefore, if the
order of attributes i s different in Excel than it is in the IO Mapping view, the I/O references will be
broken. Once changes are applied, there is no way to undo them.

To validate and edit I/O assignments

1. Click the Validate References button to check that the I/ O assignments in the IO Device Mapping
table are valid. This action retrieves data and quality information from the run-time data ac quisition
subsystem.

Important: I/O assignments can only be validated if the Platform, AppE ngi ne, and associated DI
object have been successfully configured and deployed.

2. Check the data returned in the Runtime Value column. If the assignment is not valid or if the quality
is bad, no dat a will be returned (the Value column will be empty), and "Not Connected" will be
displayed in the Runtime Quality column (click the Show Details button to reveal this column).
3. To isolate invalid assignments, select the filter icon at the top of the Runtime Quality column filter for
"Not Connected" messages.
4. Edit the I/O assignment of objects as needed.
 To override a scan group and DI object assignment, enter the new value in the
Device.ScanGroup Override column. The override value for this column cannot contain more
than one period (.) to separate the DI object name from the scan group name.

148
Configure Objects Application Server User Guide

 To override an object and attribute name, enter the new value in the Object.Attribute Override
column.
5. Click Apply Pending Overrides to save your changes.
 To discard the last unsaved override setting, click Undo Last Pending Override.
 To discard the all unsaved override settings, click Undo All Pending Overrides.

Uploading Run-Time Configuration Changes for Auto Assigned Objects

If changes are made during run time to an auto assigned I/O reference, you can upload these changes
as overrides to the original assignments. Invalid changes are ignored, and an error message is sent to
the SMC Logger.
 Run-time changes to scan groups or DI objects are saved as Device.ScanGroup overrides.
 Run-time changes to objects or attribut es are saved as Object.Attribute overrides.
When you look at the object in the IO Device s view, you will see that the original I/O auto assignment
setting is retained and the object remains auto assigned to its original DI object and scan group.
The changes uploaded from run time will appear in the Resul ting References column of the I/O Device
Mapping view. The same information from run time will appear when you examine the object’s I/O
attributes in the Object Editor. These changes are preserved ac ross subsequent redeployments.
To upload run-time configuration changes
1. From the Model or Derivation view, select the object(s) with run-time changes you want to preserve.
2. Click Upload Runtime Changes from the Object menu. The Upload Runtime Changes dialog box
will appear and provide status of the upload process.

I/O Auto Assignment Workflow Example

This section describes the basic steps for implementing I/O auto assignment, from start to finish. The
basic steps are:
1. Use the Attributes page of the Object Edi tor to prepare system objects and application objects for
I/O auto assignment.
2. Use the Object Editor to configure DI objects and scan groups.
3. Use the IO Device s view to assign system and application objects to scan groups (objects must be
undeploy ed).
4. Use the IO Device Mapping view to validate I/O references. You can enter overrides in this view, if
necessary.
To prepare objects for I/O auto assignment
1. Create a derived template from the $UserDefined base template and open it in the Object Editor.
2. Add attributes as needed. For each attribute that requires input or output, click the I/O button.
The default I/O mode is Read/Write, and the default string indicating that the attribute is primed for
I/O auto assignment appears in the Read from / Write to field.
3. Change the I/O mode as needed.

Important: Do not change the default string if you want to use auto assignment for the attribute. The
default string indicates that auto assignment is not yet complete and the object is not linked to a PLC.

4. Save and check in the template, then close the Object Editor.
5. In the Template Toolbox, create instances from the UDO derived template. The instances appear in
the Model view, under Unassigned Area.

149
Application Server User Guide Configure Objects

To configure DI objects and scan groups

1. In the Template Toolbox, create a device integration (DI) object from the $OP CClient,
$DDESuiteLinkClient, or $Redundant DIObject template. The DI object appears under "Unassigned
Area" in the Model view and under "Unassigned IO Devices" in the IO Device s view.
2. Add one more scan groups to the DI object you created in the previous step. The naming convention
for the scan groups must conform to the naming convention of the PLC with which you are
connecting.
The scan groups will show as belonging to the DI object in the IO Device s view.
To assign system and application (user created) objects to scan groups - Method 1
1. Create a new area and set it as the default. Do not deploy the area yet.
2. In the IO Devices view, drag and drop the area to a scan group.
3. Create new application objects. As you create new objects, they will appear in the IO Device s view
under the default area.
The IDE will complete the references for each I/O attribute for you.
4. If you need to change the scan group assignment for an object, drag and drop it to the new scan
group.
To assign system and application (user created) objects to scan groups - Method 2
1. Create a new area and assign it to a scan group.
2. Create new application objects. These will appear under the Unassigned folder in the Model view.
3. Assign the application objects to the area assigned to the scan group in step 1. All application objects
assigned to the area will inherit the area’s linkage to the DI object and scan group.
4. If you need to change the scan group assignment for an object in the area, drag and drop it to the
new scan group.
To validate I/O references (and override auto assigned values, if necessary)
1. Open the IO Device Mapping view. This view opens automatically if you select an object, scan
group, or DI object in the IO Device s view.
Each row in the IO Device Mapping table contains the I/O reference for one attribute.
2. Enter an override value for the attribute in one of the override columns.

Note: The DI Object.Scangroup Override column can only contain the DI object name and scan
group name, separat ed by a period (.).

3. Deploy the plat form and associated DI objects.

4. Click the Validate References button to check that communication is established with the PLC.
5. Deploy the objects.

Using I/O Auto Assignment with OPC Clients

Using I/ O auto assignment wit h the OPC communication protocol may require that you add overrides to
allow communication bet ween the IDE and certain PLCs, such as Allen-Bradley Logix and Siemens S7
controllers.
If you are using auto assignment to communic ate with a device connected to an OP C Server on a
different node (for ex ample, a DAServer in a remote Galaxy), you will use overrides to build valid I/O
references with all required parameters to fulfill the OPC hierarchical path. If bulk edits are required, you
can copy and paste bet ween the IO Device Mapping view and Microsoft Excel.

150
Configure Objects Application Server User Guide

I/O auto assignment uses the syntax: <DI Object.ScanGroup>. <Object.Attribute>. It is the first part of
the syntax that limits how the OPC client builds the I/O auto assignment reference, since additional
parameters in the device hierarchy, such as Ethernet ports and backplanes are not included. While these
parameters may be logically viewed as part of the DI Object.ScanGroup reference, you must add the
parameters to the Object.Attribute override column (not the DI Object.ScanGroup override column)
to create the fully qualified I/O referenc e.
Using DDESuiteLink instead of OP C will accommodate the automatically generated I/O reference to
these PLCs, and in most cases, overrides will not be needed.

Caution: Do not change the order of references, either in Excel or in the IO Device Mapping view by
sorting, grouping, or filtering the reference list while editing references.

Override Scenario 1 — Siemens S7 Controller s with an OPC UA Client

The following scenario illustrates using I/O aut o assignment with a Siemens S7 PLC. The Siemens S7
PLC in this example scenario includes a TCP/IP port that is in addition to the OPC DI object and scan
group names captured by I/O auto assignment in the IO Device s view.
To configure the Siemens S7 PLC with the OPC Client
1. Select the OPCClient object or scan group that contains the PLC in the IO Device s view.

I/O attributes for each object associated with the OPCClient or scan group (depending on whic h is
selected in the IO Device s view) are shown in the IO Device Mapping view.
2. In the IO Device Mapping view , the resulting reference will be in the form:
OPCClientName.ScanGroupName.ObjectName.AttributeName
Example (Re sulting Reference column):
OPCClient_01.SG1.UDO_01.Attribute_001
3. Do not edit the Device.ScanGroup Override column (leave it blank). This leaves the DI Object and
scan group assignment as defined in the IO Devices view.
4. Enter the fully qualified field reference in the Object.Attribute Override column. For example:
S7C_1.S7C_200_1.UDO_01.Attribute001

5. Apply the override. The res ulting reference will be display ed. For ex ample:
OPCClient_01.SG1.S7C_1.S7C_200_1.UDO_01.Attribute001

151
Application Server User Guide Configure Objects

Override Scenario 2 — Allen-Bradley CIP Controllers with an OPC UA Client

The following scenario illustrates using I/O aut o assignment with a Allen Bradley Logix PLC. The Allen
Bradley Logix PLC in this example scenario includes a device hierarchy with a port object, ethernet port,
backplane, and controller. Thes e are in addition to the OP C DI object and scan gro up names captured by
I/O auto assignment in the IO Device s view.
To configure the Allen-Bradley Logix PLC with the OPC Client
1. Select the OPCClient object or scan group that contains the PLC in the IO Device s view.
I/O attributes for each object associated with the OPCClient or scan group (depending on whic h is
selected in the IO Device s view) are shown in the IO Device Mapping view.
2. In the IO Device Mapping view , the resulting reference will be in the form:
OPCClientName.ScanGroupName.ObjectName.AttributeName
Example (Re sulting Reference column):
OPCClient_01.SG1.UDO_01.Attribute_001
3. Do not edit the Device.ScanGroup Override column (leave it blank). This leaves the DI Object and
scan group assignment as defined in the IO Devices view.
4. Enter the fully qualified field reference in the Object.Attribute Override column. For example:
CIP_1.CIPENB_1.CIPBackPlane_1.CIPLogix5000_1.UDO_01. Attribute001

5. Apply the override. The res ulting reference will be display ed. For ex ample:
OPCClient_01.SG1.CIP_1.CIPENB_1.CIPBackPlane_1.
CIPLogix5000_1.UDO_01.Attribute001

Writing and Editing Scripts

You can write scripts that run commands and logical operations based on specified criteria being met to
extend and customize your objects. For example, a script can be configured to start running when a key
is pressed, a window is opened, or the value of an attribute changes.
With scripts, you can create a variety of customized and aut omated system functions. A script adds
behavior that runs when the object that contains the script is deployed and the object is either:
 On scan in the run-time environment or
 Changes scan or start/shutdown state
A script typically runs based on attributes of the object that contains it, but can be started by another
script based on changing values of attributes of more than one object.
When a script condition is true, the script runs at least once immediately. The maximum length of a script
trigger period is 49-days. A script never runs if the trigger period exceeds 49-days.

152
Configure Objects Application Server User Guide

For specific information about writing scripts, including the scripting language, syntax, commands, and
using .NE T, see t he Application S erver Scripting Guide. For more information about the scripts page, see
About the Scripts Page on page 74.

Important: You cannot pass attributes as parameters for system objects. Instead, use a local variable as
an intermediary or explicitly convert the attribute to a string using an appropriate function call when
calling the system object.

About Scripts
The following characteristics apply to the scripting environment:
 Script text has no length limitations.
 Selecting a script function from the Script Function Library dialog box adds it and its syntax to the
script text where you can edit it.
 You can save a script with syntax errors, but the object cannot be deployed until you correct the
script syntax errors.
 You can validate your scripts before using them. This helps you avoid syntactically correct but
semantically incorrect combinations such as two statements declaring the same variable. Variables
can be declared only one time in a single block.
 You can change the name of a script at any time by renaming it in the Object Editor.
 In the run-time environment, a script execution error stops the script’s current execution. Script
execution is retried on the next AppEngine scan.

153
Application Server User Guide Configure Objects

Script Execution
The existence and execution order of scripts associated with an object are inherently locked at each
stage of development in the template, derived template, and instance. For example, a set of scripts
associated with a template are treated as an ordered block in the Configure Execution Order dialog
box when configuring execution order in a next-generation derived template.
New scripts in the derived templat e can be ran in any order before and after the templat e’s block of
scripts. The derived template’s execution order is treated as a block in any dow nstream derived
templates or instances. Scripts cannot trigger any faster than the scan period of the A ppE ngine the script
is associated with or faster than the scan period of the AppE ngine that hosts the object that the script is
associated with.
Scripts run in one of two modes:
 Synchronous scripting mode is the default for running scripts in the run-time environment. This mode
runs scripts in order while an object is running on scan.
 Asynchronous scripting mode is a group of scripts running on the same, lower priority execution
thread. Thes e scripts only support Execute triggering and run independently from each other. Set the
maximum number of independent threads in the AppEngine configuration editor. To use either
scripting mode, you must select Execute as the Execution Type in the Scripts area on the Scripts
page.
To create and associate a script with an object
1. Add a script. On the Scripts page of the Object Editor, click the Add ( + ) button. A script is added to
the Scripts Name list.
2. Type a name for the script and press Enter. Script names can be up to 32 alphanumeric characters,
including periods. At least one character must be a letter.

Note: For detailed information about eac h item on the S cripts page, see About the Scripts Page on page
74.

3. Select a trigger that starts the script in the run -time environment.
Execution Type triggers include: Startup, On Scan, Execute, Off Scan and Shutdown.
 If you select Startup, On Scan, Off Scan, or Shutdown, the Ba sics group is unavailable. The
script is triggered when the object starts, goes on scan, goes off scan, or shuts down.
If you select Execute, the Basics group is available.
 If you selected Execute as the script trigger, select a Trigger Type. Depending on the type
selected, you are required to enter an Expre ssion and/or Trigger Period and Deadband
values. When t he combination of Expression, Trigger Type, Trigger Period and/or Deadband
is satisfied in the run-time environment, the script starts running. See the following table for more
information.
The Trigger Period format is as follows:
Hours:Minutes:Seconds:Milliseconds
For example, 3 hours, 5 minut es, and 10.5 seconds is:
03:05: 10.5000000
Expressions are limited to one language statement in length and calling only synchronous mode
script functions. A void using script functions with side effects in expressions because subtle
behaviors can occur.

154
Configure Objects Application Server User Guide

Trigger Type Description

Periodic When the object containing the script is going On Scan, a Periodic script
evaluates its expression at the next scheduled scan period of the AppEngine.
The script then runs periodically at the trigger interval specified in the Trigger
Period box. A time interval of zero (0) starts the script during every scan. This
trigger does not require an expression.
While True When the object containing the script is going On Scan, a While True script
evaluates its expression at the next scheduled scan period of the AppEngine.
The script runs if true and then periodically thereafter at the trigger interval.
The script continues running as long as the Expre ssion value evaluates to true.
A Trigger Period is required. Zero (0) evaluates the expression at the AppEngine
scan period and non-zero means the expression is evaluated at the specified
time interval.

On True When the object containing the script is going On Scan, an On True script
evaluates its expression at the next scheduled scan period. The script starts at
the transition between the expression going from false to true.

On False When the object containing the script is going On Scan, an On False script
evaluates its expression at the next scheduled scan period. The script starts at
the transition between the expression going from true to false.

Data Change Scripts run when the value or quality of the expression changes. The expression
must evaluate to a single, non-arrayed value of the following types: integer, real,
time, elapsedtime, string, double, Boolean, custom enumeration and quality. To
allow execution based on quality, select the Quality changes check box.
A deadband can be specified for all data types. Deadband units for time and
elapsedtime types are milliseconds. Deadband is always ignored for strings
because any change (even from "ABC" to "abc") is considered a change. Only
major changes in quality (from Good/Uncertain to Bad/ Initializing or vice versa)
are considered changes.
After the object is put on scan, Data Change -triggered scripts start running at the
AppEngine’s next scan period and then at each subsequent scan period in which
the value or quality changes.

While False When the object containing the script is going On Scan, a While False script
evaluates its expression at the next scheduled scan period, runs if false, and then
periodically thereafter at the trigger interval.
The script runs as long as the Expre ssion value evaluates to be false. A Trigger
Period is required. Zero (0) evaluat es the expression at the AppE ngine scan
period and non-z ero means the expression is evaluated at the specified time
interval.

4. Select one or more of the following:

155
Application Server User Guide Configure Objects

 Set the Runs Asynchronousl y and associated Timeout Limit parameters, as needed. The
Timeout Limit is set in milliseconds. Note t hat if a script exceeds the Timeout Limit, it continues to
execute all sequential statements, but generat es a warning in the logger when it completes. If
the script contains a loop, it will exit the loop and complete ex ecution of the script, when the
timeout limit is reached.
 Select Report Alarm on Execution Error and set a Priority for the alarm if you want the
alarming function to alert you if a script execution failure occurs.
 Select Hi storize Script State to store the state of the script in your application’s historian.
5. In the Declarations area, type variable declarations about the script you are writing.
6. Set aliases for the reference strings in the Aliase s area. This can simplify the script code and allows
script code to be created and locked at a template level using alias names. When an individual
instance of that template is created, you can link external attributes to the alias nam es.
In the Aliase s area, click the Add button to add a new alias. An alias is added to the list. The name
is shown in edit mode. Double-click the Reference entry, and ent er a reference string for the alias.
You can also click the Browse button at the end of the Reference block to open the Attribute
Browser for easy selection of an object’s attributes.
7. Write the script in the Script Creation box. Use the Display Script Function Brow ser and Di splay
Attribute Brow ser buttons to help you insert script functio ns and object attribute references in your
script. For help with the specific commands and syntax, see "QuickScript .NET Functions" in the
Application Server Scripting Guide.
Click the Validate Script button to validate if your script contains any syntax errors.
8. Order the scripts. If you have more than one script associated with a single object, click Configure
Execution Order. Ordering does not apply to asynchronous scripts. If a script is added to an
instance derived from a templat e that contains scripts, the new script aut omatically defaults to
running after the derived scripts.
9. When you are done creating your script and setting its execution triggering parameters, save and
close the Object Editor.

Script Locking and Change Propagation

When you lock a script in a template, the following rules apply:
 The name of a script and its existence is implicitly always locked. This means:
o You cannot delet e the script in derived objects.
o You cannot change the name of the script in derived objects.
o If you rename the script in the templat e, the name changes in all derived objects.
o If you delete a script from the template, the script is deleted from all derived objects.
o If you add a script to the template, the script is added to all derived objects.
o You can add scripts to derived objects. Adding scripts to derived objects does not affect parent
object scripts.
 You can lock or unlock the script text in a template. There is script text for Declarations, Execute,
Startup, Shutdown, On Scan and Off Scan.
 You cannot separately lock a script in the script editor. A single group lock is used to lock or unlock all
scripts at once. Once a script is locked, derived templates and instances cannot modify any of the
script text.
 You can lock alias names and alias references separately.

156
Configure Objects Application Server User Guide

o When you create aliases for a script, an Alias Reference attribute is created for each script with
aliases. To lock alias references, you must lock the AliasReference attribute.
o Changes to alias names only propagate to derived objec ts when alias es are locked in the
Scripts page.
o Changes to alias references only propagate to derived objects when the AliasReference
attribute is locked in the Attribute s page.
o If the AliasReference attribute is not locked, the alias references will be e ditable in derived
objects, but changes made in the parent template will not propagate to derived objects.
 The script description, runs asynchronous flag, expression, trigger type, trigger period, deadband
and execution error alarm are individually lockable and can be locked separately from the script text.
A group lock is provided for this group of attributes.
 When you add a script to a templat e, all properties of the script are editable.
 When you add a script to an instance, all properties of the script are edit able, except the lock
properties (locks do not serve any purpose in instance since you cannot derive child objects from
them).

Important: An expression typically uses attribute references. If you lock the expression and the
associated script in a template, use aliases in both the expression and the script. This allows you to
specify the attributes that the aliases point to on a per -instance basis while the script code is locked.

The following rules apply to the derivation behavior of locked script attributes:
 If an attribute is locked in a templat e, then all templates and instances derived from the templat e
share the copy of the value of the locked attribute. A change to the valu e is only allowed in the
template that locked it. The change propagates to all derived templates and instances.
For scripts, locking an attribute of the script, such as its script text or execution type, in a templat e
means all derived templates and instances point to that locked attribute. Future changes to that
locked attribute’s value, such as modifying the script text, propagate and appear in all derived
templates and instances.
If instances are deployed, they are marked pending update status. After they are redeployed, the
change to the locked attribute in the template exists in the deployed instance.
 If an attribute is not locked in a template, then all templates and instances derived from that template
receive their own copy of the value of that unlocked attribute. A change to that unlocked value is
allowed in derived templates and instances because they own their own copy. Any change to the
unlocked attribute value in the template does not propagate to any derived template or instance.
An unlocked attribute in a script (such as expression or script order) in a template means that all
derived templat es and instances have their own copy and the value of that unlocked attribute can
change. Future changes to that locked attribute’s value (for example, modified expression) in the
template does not propagate to any derived template or instance. If instances are deployed, their
status does not change to pending update. Redeploying them does not cause the value to change in
the deployed instance.

Creating and Working with Content

Use the Content pane of the Attribute s page to add, modify, rename or delete local graphics; to link to
graphics or External Content objects in the Graphic Toolbox; or to view inherited graphics. You must
have the derived templat e or object instance checked out in order to add, modify, or delete cont ent
associated with the object; otherwise, you can only view local graphics.
You can view content inherited from parent templates, but you cannot add, modify, or delete inherit ed
content. This means that in order to edit an inherited content item, you must check out the derived
template that owns the cont ent.

157
Application Server User Guide Configure Objects

You cannot add content to a bas e template, only to derived templates or instances.
To add or link to content:
 To create a graphic that is owned by the object, select the Add Content button (2). This creates
a new object-owned graphic.
 To link to an existing graphic or external content object to the object, select the Link Content
button. This opens the Galaxy Browser. Then, select the symbol or External Content object to
be linked to the object.
 To edit an owned-graphic, select the graphic and click the Edit (1) button.

Note: If you edit a linked graphic in the Graphic Toolbox, the changes will affect all object s that
link to that graphic.

Adding Graphics Items

To add a symbol to the object
This procedure adds an owned symbol to the object. To link a symbol or external content item, see Link
to Shared Content in the Graphic Toolbox on page 186.
1. From the Content pane in the Attribute s page of the Object Editor, click the Add (+) button. A new
symbol name and symbol icon are added to the pane.
2. Select the new symbol in the Symbol s pane.
3. In the Details pane, edit the new local symbol name.
4. In the De scription box, type a description for the graphic symbol being added.

158
Configure Objects Application Server User Guide

5. Click Edit. The Graphic Editor opens. For instructions on using the Graphic Editor, see "About
Creating and Managing ArchestrA Symbols" in the Creating and Managing ArchestrA Graphics
User’s Guide.

Errors and Warnings in an Owned Graphic

When you save an owned symbol (graphic) that you have edited in the Graphics Editor, the owning
object is also saved. If there are any errors and warnings, they will be shown in the Save Confirmation
dialog. However, the errors and warnings include not jus t the symbol you are saving, but because the
owning object is also being saved, the dialog lists all errors and warning related to the owning object and
other symbols owned by the object.
To determine if the warning or error is related to the symbol you ar e saving, or if it is related to t he owning
object (or other symbol owned by the object), check the prefix in the warning/error message. The first
(left-most) entry in each error/warning message lists the symbol or object name.

Modifying Graphics
All modifications made to graphic symbols referenced by other objects are visible in the referenced
objects.
To modify a graphic symbol
1. On the Graphics page of the Object Editor, click the Name of the graphic symbol to be modified.
2. Click Open. The graphics tool box opens, showing the selected graphic symbol.

159
Application Server User Guide Configure Objects

3. Make changes. See "About Creating and Managing ArchestrA Symbols" in the Creating and
Managing ArchestrA Graphics User’s Guide.

Set Graphics Properties with a Galaxy Style Library

To view and manage the settings for the Galaxy Style Library, select Configure on the the Galaxy menu.
A Galaxy Style Library lets you set the appearance and behaviors of different graphics properties within
a ViewApp at run time.
 Use Element Styles to Modify Graphics on page 160 define graphics properties such as font size,
font color, fill color, line weight, and line color.
 Use Quality and Status Styles to Provide Run -Time Feedback on page 161 provide vis ual cues
about different quality and status states.
 Use UI Themes to Set Appearance of WPF Cont rols on page 161 define graphics properties for WPF
and navigation controls used in ViewApps.

Use Element Styles to Modify Graphics

Element Styles define one or more visual properties such as fill, line, text, blink, outline, and status
properties of graphic elements. You can apply an Element Style to a graphic element to set
preconfigured visual properties defined in that Element Style. Element Styles establish consistent visual
standards for symbols.

For more information about Element Styles, see Managing Galaxy Style Libraries and "Working with
Element Styles" in the Creating and Managing Arc hestrA Graphics User’s Guide.

160
Configure Objects Application Server User Guide

Use Quality and Status Styles to Provide Run-Time Feedback

In the same way that Element Styles can be used to preconfigure consistent visual properties of graphic
elements, Quality and Status styles can be preconfigured to provide visual elements specific to quality
and status states at run time.

You can configure text, fill, line, outline, blink, and associated display icons for t he following Status styles:
 Communication Error
 Configuration Error
 Pending
 Operational Error
 Software Error
 Security Error
 Warning
 Out of Servic e
 Device Failure
 Bad
 Uncertain
 Installing

Use UI Themes to Set Appearance of WPF Controls

UI Themes define the color settings that are applied to WPF controls used in ViewA pps. In order to set
the colors for a WPF control, the cont rol must comply with the Material Design Spec. See the MS DN
WPF Community Projects website for additional information:

161
Application Server User Guide Configure Objects

https://blogs.msdn.microsoft.com/wpf/ 2015/10/29/wpf-community-projects/

The UI Theme includes the following configurable parameters:

 Theme (light or dark): default – light
 Background color
o Default light background color: grey, lightest setting
o Default dark background color: blue-grey, second darkest setting
 Primary color – default teal
o Low. This setting is only used by WPF controls that explicitly include the Primary Low property.
The low setting is always darker than the mid setting. Default is the second darkest setting
(second from left).
o Mid. This setting is used by all WPF controls that use the Material Design Spec. Default is the
middle setting.
o High. This setting is only used by WPF controls that explicitly include the Primary High property.
The high setting is always lighter than the mid setting. Default is the second lightest setting
(second from right)
 Accent color – default purple (darkest setting)

Using Symbol Wizards

The ArchestrA Graphic Editor includes the Symbol Wizard Editor, which can be us ed to creat e symbols
containing multiple visual or functional configurations called Symbol Wizards. A Symbol Wizard can be
embedded into managed InTouch applicati ons like standard ArchestrA symbols.
A Symbol Wizard’s configuration is selected to meet the requirements of an application. Incorporating
multiple configurations in a single Symbol Wizard reduces the number of symbols needed to develop an
ArchestrA application.

162
Configure Objects Application Server User Guide

The Symbol Wizard Editor can create Symbol Wizards from traditional ArchestrA Symbols and
Situational A wareness Library symbols. Both types of symbols are located in the Graphic Toolbox in
separate toolkit folders. Symbol Wizards are saved in the IDE’s Graphic Toolbox and are not associated
with any specific ArchestrA object templat e or object instance. Except for the ability to select a specific
symbol configuration, Symbol Wizards behave like standard ArchestrA Symbols.
Situational A wareness Library symbols provide an additional benefit of including defined properties and
their associated attributes to more easily creat e configurations. Some Situational Awareness Library
symbols include a Type property to assign a specific function for a symbol configuration. For example, a
meter symbol can be configured to repres ent a thermometer, a pressure meter, or flow meter by simply
changing the attribute assigned to the Type property.
Typically, the process of creating and embedding a Symbol Wizard in an application requires the
involvement of a Designer and a Cons umer. A Designer creates Symbol Wizards using the Symbol
Wizard Editor. A Consumer selects a configuration of a Symbol W izard and embeds the instance of the
symbol into managed InTouch applications.

Creating Symbol Wizards

A Designer uses the Symbol Wizard Editor to define the various required symbol configurations based
on a set of rules and symbol layers. A Designer defines a set of layers, which are used to group a set of
graphic elements, custom properties, and named scripts. Graphic elements and other symbol properties
can be assigned to no layers or multiple layers. Graphic elements that are not assigned to any layer
always appear in all symbol configurations.

163
Application Server User Guide Configure Objects

A Designer can create a rule for each layer that defines the conditions when the layer is included in a
symbol configuration. Rules are assigned with Choice Groups, Choices, and Options. A Designer selects
a configuration to be the symbol default that appears when the symbol is embedded in a managed
InTouch application.
After creating all symbol configurations, the Designer verifies how each configuration of a symbol using
the Symbol Wizard Preview. Designers set values in the Wizard Options view to verify that eac h
configuration appears as designed bas ed on the layer rules set for the symbol.
When a Symbol Wizard is finished, the Designer saves it to the Galaxy library so that it is available for
use in managed InTouch applications. For more information about creating Symbol Wizards, see
"Working with Symbol Wizards" in the Creating and Managing ArchestrA Graphics User’s Guide.

Embedding Symbol Wizards into an Application

Symbol Wizards are stored in a Galaxy library just like standard ArchestrA Symbols. When a Consumer
selects a Symbol Wizard and embeds it into a managed InTouch application, the Symbol Wizard’s
default configuration is selected. The Cons umer can change the symbol’s configuration by changing the
options from the Symbol Wizard’s Wizard Options section of the Propertie s view. Depending on the
selected configuration, there can be additional configuration -related properties that can be selected by
the consumer.

After selecting a symbol configuration and changing any properties, the Consumer saves the Symbol
Wizard so that it can be embedded into a window from WindowMaker.
While the InTouc h application is running, the Symbol Wizard appears as the configuration selected by
the Consumer. A Symbol Wizard configuration cannot be changed during run-time.
For more information about how to embed Symbol Wizards into a managed InTouch applications, see
"Working with Symbol Wizards" in the Creating and Managing ArchestrA Graphics User’s Guide.

164
Configure Objects Application Server User Guide

Renaming Graphics
You can rename a graphic symbol.
To rename a graphic symbol
1. On the Graphics page of the Object Editor, click the Name of the graphic symbol to be renamed.
2. Type the new name, and press Enter. The new name is saved.

Deleting Graphics
Caution: Deleting a graphic symbol with embedded references breaks the links to their related objects.
"Symbol Not Found" appears when you open objects whose embedded graphic symbols have been
deleted.

To delete a graphic symbol

1. On the Graphics page of the Object Editor, click the Name of the graphic symbol to be deleted.
2. Click the Delete button. The Delete dialog box appears. The left pane lists the graphic symbol
selected for deletion. The right pane shows all embedded references to the selected graphic.
3. Click Yes.

165
 Application Server User Guide

C HAPTER 6
Configure Objects with an Object Wizard
In This Chapter
About Object Wizards ................................................................................................................. 167
Object Wizard Components ......................................................................................................... 178
Add Content for Use with an Object Wizard .................................................................................. 185
Conditional Visibility Expressions for Choic e Groups, Choices, and Options ................................... 198
Trimming.................................................................................................................................... 208
Attribute and Symbol Overrides ................................................................................................... 211
Add Scripts to an Object Wizard .................................................................................................. 216
Object Wizard Derivation............................................................................................................. 218
Object Wizard Test Mode ............................................................................................................ 222
Propagation of Object Wizard Changes to Derived Objects ........................................................... 232
Extend an Inherited Object Wizard ............................................................................................... 233
Configure Instances .................................................................................................................... 242
Create a New Instance with the Configure New Asset Editor ......................................................... 246
Add a Configured Asset to a Symbol ............................................................................................ 252

About Object Wizards

An Object Wizard can be added to any derived template, and provides a simplified user interface for
configuring instances (assets) from the template. To access the Object Wizard edit or:
1. Open a template in the Object Editor.
2. If the templat e does not open to the Attribute s page by default, select it now.

167
Application Server User Guide Configure Objects with an Object Wizard

3. If necessary, select the Object Wizard button to open the Object Wizard editor. The Attributes
tab divides into multiple panes that are used for building the Object Wizard.

Object Wizards can be used either within the IDE, or from the Configure New Asset editor that also lets
you configure an associated graphic as you configure the object.

Note: The Configure New Asse t editor can only be used if 1) the template contains a symbol, and 2)
your security setting allows you to edit graphics.

A single template with an Object Wizard can replace a number of derived templates for configuring a
variety of similar instances. You can add an Object Wizard to any derived template.
Depending on their level of permissions, users can:
 Create and configure instances from within the IDE, and add them to the Galaxy, or modify existing
instances. A user simply opens an instance and ans wers a series of prompts or questions. See
Configure Instances on page 242 for additional information.

168
Configure Objects with an Object Wizard Application Server User Guide

 Use the Configure New Asset editor to creat e and configure instances and a representative
symbol, simply by dragging an associated symbol into a graphic, and then answering a series of
prompts or questions. See Create a New Instanc e with the Configure New Asset Editor on page 246
for additional information.

Object Wizards consist of a series of user -selectable choices and options that are used to customize a
deployable instance. Each choice and option may have one or more attributes, symbols, and/or scripts
associated with it.

Object Wizard Features

An Object Wizard contains choices and options that guide users through the process of configuring
instances. You can replace many derived templates by using a single template with an Object Wizard,
since the Object Wizard can contain a wide variety of configuration possibilities. Attributes and features
contained in the Object Wizard that are not needed in a particular instance are removed and are not a
part of the run-time object. Finally, and perhaps most importantly, an Object Wizard is easy to use and
can reduce user training and system maintenance costs.
Object Wizards provide the following benefits:
 Simplified workflow for configuring instances
 Automatic propagation of changes, without having to lock templates
 Unnecessary attributes can be trimmed from instances to reduce the footprint of deployed objects
 Unus ed symbols can be hidden from users to reduce clutter
 Reduced system maintenance
 Reduced training requirements for plant personnel

Create a Basic Object Wizard

An Object Wizard can include Choice Groups, each with two or more Choices, and/or Options. A Choice
Group is a radio button list that lets the user select one choice. An Option c ontains a checkbox that a user
can select or deselect. To add an Object Wizard to a template:

169
Application Server User Guide Configure Objects with an Object Wizard

1. In the IDE, open a derived template in the Object Editor.

2. If the Attributes page is not already selected, select it now. See Creat e Derived Templates on page
52.

Note: Only templates derived from the $UserDefined base template open in the Object Editor with
the Attribute s page selected. The Object Editor always opens the first page of the object. For
example, the Object Editor opens the General page of the $AnalogDevice template.

3. Configure the template by adding:

o Attributes
o Symbols or other content such as links to documents and videos
o Scripts
See Add Attribut es, Symbols and Scripts to an Object Wizard for additional information.
4. If the Object Wizard editor is not already open, select the Wizard button.
With Object Wizard editor open, the IDE should look like this:

See Object Wizard GUI Panes on page 173 for additional information.

170
Configure Objects with an Object Wizard Application Server User Guide

5. Add a Choice Group by selecting the Add Choice Group (1) button. With the Group name selected,
change the name of the Group shown in the Prompt (5) text field. See Add a Choice Group on page
178 for more information.

6. To add more Choices to a Choice Group, select the Choice Group and then press the Add Choice
(2) button. To change the name of a Choice, select the Choice and enter the new name in the
Prompt field. See Add a Choice to a Choice Group on page 180 for more information.
7. Add Options by selecting the Add Option (3) button. Change Option names the same way that you
change Choice Group and Choice names. See A dd an Option (see "Add an Option" on page 183) for
more information.
8. Use the Up and Down arrow (4) buttons to change the order of Choice Groups, Choices (within a
Choic e Group), or Options.
9. To associate an attribute or content wit h a Choice or Option:
a. Select the Choice or Option.
b. Select the attribute or content (symbol or other type of content) you want to associate with the
Choic e or Option.
c. Select the Add Association button (or drag the attribute or content to the Associations pane).
d. Settings for the selected attribute or content are shown in the Settings pane, once the
association is made. Configure visibility and value overrides, as needed.

171
Application Server User Guide Configure Objects with an Object Wizard

Note: No settings are shown for symbols that do not contain custom properties or a Symbol
Wizard.

Object Wizard Configuration Best Practices

An Object Wizard can be added to any derived template. However, to maximize the benefits of using
Object Wizards, add your Object Wizard to the template as close to the top level of the derivation
hierarchy as possible. To build an Object Wizard you must:
 Add and configure attributes, symbols, links to external content, and scripts before you build the
Object Wizard.
 An Object Wizard requires at least one Choice Group or Option. See Object Wizard Components on
page 178 for additional information.
 Configure Choices and Options by associating attributes, symbols/content, and scripts with Choices
and Options. We recommend that you limit the number of items you associate with each Choice or
Option to avoid configuration mismatches.
 When configuring Choices and Options, keep the work flow as simple and direct as possible.
Remember that users will be working sequentially through the Object Wizard. If you enable a feat ure
at one level of the Wizard hierarchy, you cannot disable the same feature at a subsequent level.
For example, if a symbol has Custom Property " X" enabled and is associated with a Choice, do not
associate the same symbol with " X" disabled to an Option furt her down in the hierarchy. Instead,
leave " X" disabled and override the setting when deriving an instance.
 Configure the Conditional Visibility Expressions for Choice Groups, Choices, and Options on page
198 of Choices and Options in derived instanc es.
 Configure settings for the associated attributes and symbols. Scripts and external content do not
have settings that can be configured.

172
Configure Objects with an Object Wizard Application Server User Guide

 Select whether each attribute, symbol, and other content can be Trimming on page 208 from derived
instances. Scripts are always configured as trimmable.

Object Wizard GUI Panes

The user interfac e for configuring Object Wizards is accessed through the Attribute s page within the
Object Editor of the Integrat ed Development Environment (IDE ).

Select the Object Wizard button to open the Object Wizard user interface. The Attribute s
page divides into multiple panes for use in creating and editing an Object Wizard. See Object
Wizard User Interface Details on page 175 for additional information.
Select the Scripts button (located at the top right of the Attributes pane) to open the
Scripts pane.

Ref Name Description

1 Choice s and Add, rename, reorder, and delete Choice Groups, Choices, and Options that
Options pane comprise the Object Wizard in the Choice s and Options pane (1). You can
also set the logic for displaying Choices and Options.
2 Associations Drag and drop attributes, content, and scripts to the Associations pane (2)
pane to associate them with a choice or option; you can use the Add button at the
top of the pane instead of dragging and dropping. You can select multiple
attributes, symbols, or scripts at once. You will also enable and disable
trimming of associated attributes and symbols in this pane. See Trimming
on page 208 for additional information.
You can view associations for individual attributes, symbols, and scripts in
this pane by selecting an attribute, symbol, or script. Every association of
the item is displayed. Select an association to view the item's configuration.

173
Application Server User Guide Configure Objects with an Object Wizard

3 Settings pane Configure attribute and symbol overrides in the Settings pane (3).
Overrides are set individually for each choice or option with which the
attribute or symbol is associated. Default settings for attributes are set in the
Details pane (7).
Columns can be resized by selecting a column header (in this case, Value)
and moving its edges to widen or narrow it.
4 Attribute s The Attribute s pane (4) lists the attributes contained in the template. You
pane can creat e new attributes in this area. To associate attributes with the Object
Wizard, highlight a Choice or Option, and then select and drag one or more
user-c reated attributes from the Attribute s pane to the Associations pane
(2). See Associate Attributes with Choices and Options for additional
information.
Default configuration settings for a selected attribute are displayed to the
right of this pane, in the Details pane (7). See About the Attributes Page on
page 69 for additional information. Configured settings for the selected
attribute that apply to a selected Object Wizard Choice or Option are shown
in the Settings pane (3). You can also enable attribute features
(historization, I/O, alarms, etc. in the Attribute s pane. Multi-select can be
used to enable features for attribut es, as well as to associate att ributes. To
use multi-select for features, select the attributes in the Attribute s pane and
enable the feature in the Details pane.
5 Content pane The Content (5) pane lists symbols and external content items contained in,
or linked to the object. To associate symbols with the Object Wizard,
highlight a Choice or Option, and then select and drag one or more items
from the Content pane to the Associations pane (2). You can add a new
symbol to the object from this pane, or link to a symbol in the Graphic
Toolbox. See Associate Content with a Choice or Option on page 187 for
additional information.
6 Scripts pane To display the Scripts pane (6), select the Scripts button. The Scripts
pane lists scripts contained in the object. To associate a script with the
Object Wizard, highlight a Choice or Option, and then select and drag one or
more scripts from the Scripts pane to the Associations pane (2). See
Associate Content with a Choice or Option on page 187 for additional
information.
To add a script to the object, select the Scripts tab at the top left of the
Object Editor.
7 Details pane The Details pane (7) displays details of a selected attribute, symbol, or
(Attribute other content. This pane lets you configure individual attributes, but is not
Editor) usually used while configuring an Object Wizard. See Configure Objects on
page 115 for additional information.

174
Configure Objects with an Object Wizard Application Server User Guide

Object Wizard User Interface Details

The Object Wizard user interface provides a number of visual elements to help you as you build an
Object Wizard.

Ref Icon Name Description

1 Object Wizard Opens/closes the Object Wizard editor (Choice s and Options,
button Associations, Settings, Attributes, and Content panes.
2 Scripts button Opens/closes the Scripts pane so you can associate scripts with
Object Wizard Choices and Options.
3 Test mode button Changes the Object Wizard editor to test mode. This lets you
verify the behavior of the Object Wizard. See Object Wizard Test
Mode on page 222 for additional information.
4 <#> Number of Number of trimming-enabled attributes, symbols/content, and
associations scripts associated with a Choice or Option. This can help in the
maintenance of complex Object Wizards by letting you quickly
identify where trimming has been enabled.
5 <#> Total configured Total number of configured settings for all attributes and symbols
settings that are associated with each Choice or Option. This can help in
the maintenance of complex Object Wizards by letting you quickly
identify where overrides have been configured.

175
Application Server User Guide Configure Objects with an Object Wizard

6 Trimming Place a check in the checkbox to enable trimming for an attribut e

checkbox or symbol. Trimming is always enable for scripts, and is enabled
by default for attributes. See Trimming on page 208 for additional
information.
7 <#> Number of Number of configured settings for each attribute or symbol that is
configured associated with the selected Object Wizard Choic e or Option.
settings Scripts and external content items do not have configurable
settings.
8 Add symbol Add (creat e new) symbol button. The new symbol is owned by the
button object. See Add Attribut es, Symbols and Scripts to an Object
Wizard for additional information.
9 Link content Link to an existing symbol or external content item in the Graphic
button Toolbox. The symbol/content can be shared with other objects.
See Add Attribut es, Symbols and Scripts to an Object Wizard for
additional information.
10 Edit symbol Opens the selected symbol in the Graphic Editor.
button
11 Symbol Wizard Symbol Wizard settings are indicated by a unique icon. See
icon Attribute and Symbol Icons, below.

12 Attribute / Custom Attribute and symbol custom property icons are displayed for
Property icons Boolean, integer, float, double, string, time, elapsed time, and
internationalized string. An icon is also display ed for Symbol
Wizard settings. See Attribute and Symbol Icons, below.
13 Setting Override Attribute, custom property, and Symbol Wizard settings that
indicator contain an override are indicated by bold text and an X next to the
value. To remove the override, select and clear the X. See
Override Icons, below.
14 <text Visibility Sets the conditional visibility of Object Wizard elements. See
field> Expression Conditional Visibility Expressions for Choic e Groups, Choices,
and Options on page 198 for additional information.

15 Visibility indicator icons When the icon is unmuted, the setting is visible to the user when
configuring instances. When muted, the setting is hidden. See
Visible About Attribute and Symbol Overrides on page 190 and
Configurable Settings for Attribute and Symbol Values on page
Visible - override 215 for additional information. A small x in the top right corner of
Hidden the icon indicates that the visibility setting is an override, and may
differ from the setting in the parent template.
Hidden - override Note: In derived templates, visibility indicators replac e visibility
expressions for Object Wizard choices and options. See Object
Wizard Derivation on page 218 for additional information.
16 XRef Total number of configured overrides for the selected symbol or
attribute. If the attribute or symbol is associated with multiple
Object Wizard Choices or Options, hover over t he XRef number t o
see which Choic es and Options have overrides configured.

Attribute and Symbol Icons

176
Configure Objects with an Object Wizard Application Server User Guide

Icon Description / Data Type Attribute Symbol

Symbol Wizard Choice or Option X

Boolean data type X X

Integer data type X X

Float data type X X

Double data type X X

String dat a type X X

Time data type X X

Elapsed time data type X X

Internationalized string data type X X

[No Large type with no icon indicates that the item is an attribute feature. X
icon] Attribute features are selected in the Details pane (see Object Wizard
GUI Panes on page 173) and include I/O, History, State Alarms, Bad
Value Alarms, Hi/Lo Alarms, etc.
Note: For custom properties, string, time, and elapsed time data types can be toggled bet ween
reference/ex pression and string literal. This does not apply to attributes.

reference/expression

string literal

Override Indicators

Indicator Description

This is the default setting (no override). If the setting is changed in a parent template,
this value will also change.
Setting has been overridden. Changes made in a parent template will not cause the
this value to change. The value is shown in bold and an X appears next to the value.
No override: Setting is visible and is not overridden. If the visibility of this item is
changed in a parent template, the visibility of this setting will also change.
No override: Setting is hidden and is not overridden. If the visibility of this item is
changed in a parent template, the visibility of this setting will also change.
Override has been applied: The visibility setting ("visible") is locked in this template. If
this item is hidden in a parent template, this setting will remain visible (setting will not
change).
Override has been applied: The visibility setting ("hidd en") is locked in this template. If
the this item is made visible in a parent template, this setting will remain hidden
(setting will not change).

177
Application Server User Guide Configure Objects with an Object Wizard

Object Wizard Components

An Object Wizard consists of Choice Groups and Options. Choice Groups contain at least two Choices,
and Object Wizard users must select one Choice from every Choice Group.
Once you create Choice Groups, Choices and Options, you can associate attributes, symbols, and
scripts with them to create an Object Wizard work flow. Typically, you creat e and configure the required
attributes, symbols, and scripts prior to adding an Object Wizard to the template. See Configure Objects
on page 115 for additional information.
Choic es are chosen by selecting the radio button next to the Choice. Only one Choice can be selected
from a Choice Group. When users select a Choice, they are also selecting any elements (attributes,
symbols, and scripts) associated with the Choice, even though those elements may not be visible to
them.
Options are selected by placing a check in the Option's checkbox. Options can be either true (c hecked)
or false (unchecked). Attributes, symbols, and scripts can only be associated with the true state. No
action is implement ed when an Option is set to false.
You can rename Choice Groups, Choices, and Options as needed and add a description (the description
is visible to users as a tooltip). Choice Groups and Options must be uniquely named; a Choice Group and
an Option cannot have the same name. Choices within a single Choice Group must also be uniquely
named.

Choice Groups
Add a Choice Group
To add a Choice Group to an Object Wizard:
1. Select the Add Choice Group button.

When you add a Choice Group, it includes two Choices. To add additional Choices, see Add a
Choic e to a Choice Group on page 180. Choices within a Choice Group are mutually exclusive; one,
and only one, Choice can be selected from a Choice Group. Choices are chosen by selecting the
radio button next to the Choice. For example, an Object Wizard user must choose Choice #1 OR
Choic e #2 (but not both or neither).
2. Change the default name of the Choic e Group. See Change the Prompt for a Choice Group on page
178 for additional information.
3. Set the position of the Choice Group in the Object Wizard as needed. See Change Choice Group
Order on page 179 for additional information.
4. Set the conditional visibility of the Choice Group, if needed. See Conditional Visibility Expressions for
Choic e Groups, Choices, and Options on page 198 for additional information.

Note: You cannot restrict the visibility of the Choice Group if it is the first element in the Object
Wizard.

Change the Prompt for a Choice Group

To change the prompt for (rename) a Choice Group:
1. Highlight the Choice Group.

178
Configure Objects with an Object Wizard Application Server User Guide

2. In the Prompt field, change the name from the default name ("Group #1" ) to a more descriptive
name. Choice Groups must have unique names. Two Choice Groups cannot have the same name,
and a Choice Group cannot have the same name as an Option.
3. You can add additional detail about the Choice Group in the De scription field. The description is
displayed as a tooltip in Test mode and when using the Object Wizard to configure an instance.

Change Choice Group Order

To change the order in which the Choic e Group appears in the Object Wizard:
1. Highlight the Choice Group.
2. Select the Move Up or Move Down button until the Choice Group appears in the correct order within
the Object Wizard.

Delete a Choice Group

To delet e a Choice Group:
1. Highlight the Choice Group.
2. Select the Remove Choice Group button. The Choice Group, all of its Choices, and any configured
settings for associated attributes and symbols are removed immediately. You are not asked to
confirm the deletion. There is no undo.

179
Application Server User Guide Configure Objects with an Object Wizard

Note: Associated attributes, symbols and scripts are not removed the object. Only the settings that
were ent ered in the Settings pane are cleared.

Choices
Add a Choice to a Choice Group
To add additional Choices to a Choice Group:
1. Highlight the Choice Group.
2. Select the Add Choice button.

3. Change the default name of the Choice. See Change the Prompt for a Choice on page 180 for
additional information.
4. Set the position of the Choice Group in the Object Wizard as needed. See Change Choice Group
Order on page 179 for additional information.
5. Set the conditional visibility of the Choice, if needed. See Conditional Visibility Expressions for
Choic e Groups, Choices, and Options on page 198 for additional information.

Note: You cannot restrict the visibility of a Choice if its Choice Group is the first element in the Object
Wizard.

Change the Prompt for a Choice

To change the prompt for (rename) a Choice:
1. Highlight the Choice.
2. In the Prompt field, change the name from the default name ("Choice #1") to a more descriptive
name. Choices within a single Choice Group must have unique names. A Choice in a different
Choic e Group can have the same name. For example, you may have a number of Choice Gr oups
that contain a Choice named "None of the above."

180
Configure Objects with an Object Wizard Application Server User Guide

3. You can add additional detail about the Choice in the De scription field. The description is displayed
as a tooltip in Test mode and when using the Object Wizard to configure an instanc e.

Change the Order of Choices within a Choice Group

To change the order in which the Choic e appears in the Choice Group:
1. Highlight the Choice.
2. Select the Move Up or Move Down button until the Choice appears in the correct order within its
Choic e Group.

Set a Default Choice in a Choice Group

To set a different default Choice in a Choic e Group:

Note: When you create a Choice Group, the first Choice is selected by default.

181
Application Server User Guide Configure Objects with an Object Wizard

 Select the Choice you want to set as the default. The radio button for the new default will show it as
selected.

You can set a different default Choice in a derived template than is in the parent template. The new
default is marked by an X in the derived template to indicate it is an override.
Users can switch from the default Choice when they configure objects if the Choice Group is visible,
based on selections that the user has already made in the Object Wizard. See Conditional Visibility
Expressions for Choice Groups, Choic es, and Options on page 198 for additional information about
setting conditional visibility.

Delete a Choice
To delet e a Choice from its Choice Group:
1. Highlight the Choice.
2. Select the Remove Choice button. The Choice, along with the settings for any associated attributes,
symbols, and scripts, is removed immediately (you are not asked to confirm the deletion). There is no
undo.
If you remove the default Choice from a Choice Group, the first (top -most) Choice in the Choice
Group is automatically assigned as the new default. See Set a Default Choice in a Choic e Group on
page 181 for information about changing the default Choice.

Note: Associated attributes, symbols and scripts are not removed the object. Only the settings that
were ent ered in the Settings pane are cleared.

182
Configure Objects with an Object Wizard Application Server User Guide

Options
Add an Option
To add an Option to an Object Wizard:
1. Select the Add Option button.

An Option has two states, true or false (selected or unselected). When using the Object Wizard to
configure an instance, setting an Option to true will implement configuration aspects (attributes,
symbols, scripts) associated with the Option. If the Option is false, the Option has no effect.

2. Change the default name of the Option. See Change the Prompt for an Option on page 183 for
additional information.
3. Set the position of the Option within Wizard as needed. See Change Option Order on page 184 for
additional information.
4. Set the conditional visibility of the Option, if needed. See Conditional Visibility Expressions for
Choic e Groups, Choices, and Options on page 198 for additional information.

Note: You cannot restrict the visibility of the Option if it is the first element in the Object Wizard.

Change the Prompt for an Option

To change the prompt for (rename) an Option:
1. Highlight the Option.
2. In the Prompt field, change the name from the default name ("Option #1") to a more descriptive
name. Options must have unique names. Two Options cannot have the same name, and an Option
cannot have the same name as a Choice Group.

183
Application Server User Guide Configure Objects with an Object Wizard

3. You can add additional det ail about the Option in the De scription field. The description is displayed
as a tooltip in Test mode and when using the Object Wizard to configure an instanc e.

Change Option Order

To change the order in which the Option appears in the Object Wizard:
1. Highlight the Option.
2. Select the Move Up or Move Down button until the Option appears in the correct order within the
Object Wizard.

Set the Default State of an Option

The default state of an option can be TRUE (checked) or FALSE (unchecked). When you add an Option
to the Object Wizard, its default state is FALSE (unchecked). To change an Option's default state:
 Select the checkbox next to the Option until its state matches the desired state (checked or
unchecked).
Users can switch from the default state when they run t he Object Wizard if the Option is visible, based on
selections that the user has already made in the Object Wizard. If the Option is not visible, the default
state is used to configure the instance. See Conditional Visibility Expressions for Choice Groups,
Choic es, and Options on page 198 for additional information about setting conditional visibility.

Delete an Option
To delet e an Option:
1. Highlight the Option.

184
Configure Objects with an Object Wizard Application Server User Guide

2. Select the Remove Option button. The Option, along with the settings for any associated attributes,
symbols, and scripts, is removed immediately (you are not asked to confirm the deletion). There is no
undo.

Note: Associated attributes, symbols and scripts are not removed the object. Only the settings that
were ent ered in the Settings pane are cleared.

Add Content for Use with an Object Wizard

You add attribut es, symbols, scripts, and other content to a template object with an Object Wizard the
same way that you add content to any other object. After adding the content, you can associate individual
attributes and other cont ent to individual Choices and Options. This association allows content that is not
needed to be trimmed when you derive instances from the template. This helps to reduc e the footprint of
run-time objects. See Trimming on page 208 for additional information.

Note: Only user-created attributes can be associated with Object Wizard Choices and Options.

When you associate content with Choices and Options, the propagation of these items to derived
instances is determined by:
 User selection of Choices and Options during configuration.
 Trimming on page 208 configuration for attributes and symbols, as they apply to the selected
Choic es and Options.
Cont ent is trimmed from a derived instance when the instanc e is saved. Note that all items are
propagated to derived templates, regardless of configuration and t rimming settings, since unlike
instances, templates are not run-time objects.
Both attributes and symbols can have unique settings for each association. The visibility of these
settings, which determines if the setting can be overridden by a user deriving instances from the
template, can also be configured.
For detailed information about Symbol Wizards and custom properties, see " Using Custom Properties"
and "Working with Symbol Wizards."
Cont ent can either be added or linked to an object.
When you select the Add Content button, a new symbol is created that is owned by the
object. Any changes made t o the symbol are only applicable to the owning object. Changes
to the symbol in the parent object will cascade to child objects. The Add Content button
does not let you create an object-owned external content item.
When you select the Link Content button, the Galaxy Browser opens the Graphic Toolbox
(GTB). Selecting a symbol or external content object from the Graphic Toolbox creates a
link between the object and the content, but the object does not own the content. Changes
to the content will cascade to every object with which the item is linked, regardless of the
hierarchical relationship of the objects.
For information on adding scripts to a template, see Writing and Editing Scripts on page 152.
The settings configured in the Attribute Editor and Graphic Editor provide the default settings for each
attribute and symbol. You can override the default values in the Settings pane. Note that you can set
different values for each Choice or Option with which the content is associated.

185
Application Server User Guide Configure Objects with an Object Wizard

In addition, you can allow the user to override the default values in derived instances. See " About the
Attributes Page on page 69" and "Add Attributes to an Object on page 115" for information about adding
and configuring attributes.

Add a New Object-Owned Symbol

To add a new object-owned symbol:
1. In the Content pane, select the Add Content button . The symbol is added with a default name
(based on the previously added symbol, if any).
2. In the Details pane, edit the name of the symbol and add a description.
3. In the Content pane, select the Edit button to open the Graphic Editor. See Creating and
Managing ArchestrA Graphics User Guide for information about using the editor to create symbols.
When you done editing the symbol, save and close the Graphic Editor.
4. Associate the symbol with one or more Choices or Options, as described in Associate Content with a
Choic e or Option on page 187.
The icon next to the symbol name in the Content pane indicates that the symbol is owned by the
object.

Link to Shared Content in the Graphic Toolbox

You can link an object to cont ent in t he Graphic Toolbox. Content can be a symbol or an external content
object.
To link to an existing content item in the Graphic Toolbox:
1. In the Content pane, select the Link Content button .

186
Configure Objects with an Object Wizard Application Server User Guide

The Galaxy Browser opens. Select an existing symbol from the Graphic Toolbox.

2. In the Details pane, edit the default name of the content as needed. The edited name applies only to
the object to which it is linked. The name of the content item remains unchanged in the Graphic
Toolbox. You can also add a description .

Note: If you choose to link to the same content item more than once, it is automatically renamed
within the object wit h an incremental number appended to the original name. Its name in the Graphic
Toolbox is not changed, and is displayed in brackets in the following format: OriginalName1
[OriginalName]. In most cases, linking to the same item more than once is not an efficient use of
an Object Wizard.

3. Optional: To edit the linked content, select the Edit button to open the Graphic Editor (for
symbols) or the External Content Edi tor (for external content items). Any change you make to the
symbol or external content item changes the configuration of the content, and the change affects any
object that links to the symbol/content item.

Note: Editing protected symbols, such as symbols contained in the Situational Awareness
Library, is not permitted. If you edit an item in the Graphic Toolbox, the changes will affect every
object that links to the item.

Associate Content with a Choice or Option

In most cases, you will have added content to the object prior to adding the Object Wizard. Once you
have begun configuring the Object Wizard, you can associate the following types of content with Object
Wizard Choices and Options:
 Attributes: shown in the Attributes pane
 Symbols: shown in the Content pane
 External Content Objects: shown in the Content pane

187
Application Server User Guide Configure Objects with an Object Wizard

 .NET Controls: shown in the Content pane

 Scripts: shown in the Scripts pane
To associate content with a Choice or Option:
1. Highlight a Choice or Option in the Choice s and Options pane.
2. Select and drag one or more item from the Attribute s, Content, or Scripts pane to the
Associations pane. Use the Shift or Ctrl key to enable multi-select for items in a single pane.

Note: Individual items can be associated with more than one Choice or Option. However, a Choice
or Option does not have to have any items (attributes, etc.) associated with it. For ex ample, a Choice
labeled "No" or None" typically would not have any content associated with it.

Note: A content item (attribute, symbol, etc.) does not have to be associated with an Object Wizard
Choic e or Option. Unassociated items are simply a part of the object and are propagated to all
derived objects.

188
Configure Objects with an Object Wizard Application Server User Guide

3. If applicable, highlight an attribute or symbol and enter overrides for the default values. The overrides
affect only the Choice or Option for which they are ent ered. For example, a symbol can have one
label for one Choice, and a different label for anot her. The override applies only to the associated
Choic e or Option. See Attribute and Symbol Overrides on page 211 for additional information.

Note: You can resize columns in the Settings pane by selecting the column header and moving its
edges to widen or narrow the column.

4. If applicable, override the default trimming setting for eac h associated item.
o Trimming is disabled by default for symbols (trimming checkbox is unchecked).
o Trimming is enabled by default for attributes (trimming checkbox is checked).
o Trimming is enabl ed for scripts and cannot be disabled.
o Note that the trimming defaults for symbols and attributes are different. See Trimming on page
208 for additional information.

Remove an Association from a Choice or Option

To discontinue the association of a content item (attribute, symbol, etc.) with a Choice or Option:
1. Locate the Option, or the Choice within its Choice Group (1), and highlight it.
2. In the Associations pane, select the content item (2) y ou want to remove from t he Choic e or Option.
3. Select the Remove Association button (3). The item is no longer associated with the Choice or
Option.

Note: Removing an association does not remove the content item. The content remains a part of the
template, and if the content is associated with other Choic es or Options, those associations remain
intact. However, removing an association may affect the trimming of content within instances (see
Trimming on page 208 for additional information). If the content is completely unassociated with any
Object Wizard Choice or Option, it is always included in derived instances.

To completely remove an attribute from a templat e, see Delete Cont ent from an Object on page 191.

189
Application Server User Guide Configure Objects with an Object Wizard

Multiple Content Item Associations

Attributes, symbols, and other cont ent can be associated with more than a single Choice and/or Option.
Each association can utilize different override values (settings ) for a particular attribute or symbol . To
change a setting for a particular association, enter overrides of the defaults in the settings pane.
You can use different overrides for eac h Choice or Option with which an attribute or symbol is
associated. For example, an integer attribute could have a default value of 10, but could have an override
of 5 for one Choice and an override of 20 for a different Choice.

Map Attribute and Symbol Configurations to a Choice or Option

You can associate a particular attribute or symbol configur ation wit h an Object Wizard selection (Choice
or Option). In this way, pre-configured attributes and symbols can be added to the derived instance,
simply by selecting an Object Wizard Choice or Option. Different configurations can be applied to
different Choices and Options.
Mapping thes e configurations to Object Wizard Choices and Options may require additional planning
and testing. This is especially important if multiple configurations of the attribut e or symbol are being
mapped. Mismatches bet ween configurations can res ult in different behaviors in the derived instance
than intended. Use Te st mode to catch potential mismatches.

About Attribute and Symbol Overrides

Override values for an attribute or symbol (with a Symbol Wizard or custom properties) can be configured
for each associated Choice or Option. When you associate an attribute or symbol, the default values are
listed in the Settings pane. To configure values that apply to the selected Choice or Option, enter the
values in the Settings pane. If the attribute or symbol is associated with multiple Choices or Options,
different values can be used for each one. Values for the Choices and Options are saved when you save
the object. If the setting is marked as visible, users can override your setting (or override the default, if
you have not configured a setting) as they derive and configure instances from the Object Wizard.
Symbols with overrides that affect their shape, for example, certain Situational Awareness Library
symbols, are rendered with the applicable shape-changes as

Note: If you override a Symbol Wizard setting, the only way to make t he setting visible again is to remove
the override. Attributes and custom properties with overrides can be made visible again by selecting the
visibility checkbox.

A configured setting is defined as any change from the default configuration of the attribute or symbol.
This includes changing a value or visibility. For example, you might change the default Boolean value
from true to false, or you might change an integer value from 5 to 10, or change engineering units from
liters to cc. Changing the visibility of an setting also counts as a configured setting.
 The default visibility setting for attribut e values is hidden (Visibility icon is muted (grayed-out) in the
Settings pane).
 The default visibility setting for Symbol Wizard and custom property values is visible (Visibility icon is
unmuted in the Settings pane).
 Visibility overrides are indicated by a small X in the upper right quadrant of the visibility icon.

190
Configure Objects with an Object Wizard Application Server User Guide

The total number of configured settings for each individual attribute and symbol is displayed in the
Associations pane (1). The total number of configured settings for ALL attributes and symbols
associated with an individual Choice or Option is displayed in the Choice s and Options pane (2).

Delete Content from an Object

You can delete (completely remove) a content item from an object. When you delete content, all settings
and associations to the items are also removed.
If there are any instances or templates derived from the template that use the deleted item, the deletion
of the item will propagate to all the derived objects. That is, all objects derived from the template will no
longer contain the deleted content.

Delete an Attribute or Symbol from a Template

You can delete, that is, completely remove an attribute or symbol (object -owned or link ed) from a
template that has an Object Wizard. If there are objects derived from the Object Wizard that use the
deleted attribute or symbol, the deletion propagates to all the derived objects. That is, the deleted
attribute or symbol is removed from all derived objects.
Linked symbols will still exist in the Graphic Toolbox. However, since added symbols are owned by the
object, deleting an added symbol completely removes it. Once you save the template that contains the
deleted symbol, the symbol cannot be retrieved.
To delete an attribute or symbol from an template:
1. Select the symbol from the Symbol s pane. To delete an attribute, select it from the Attributes pane.
You can select more than one attribute or symbol at a time.

191
Application Server User Guide Configure Objects with an Object Wizard

2. Select the Delete button. This removes the selected symbol from the object. Use the Delete button
in the Attribute s pane to delete attributes.

Note: Added (object-owned) symbols are permanently deleted once the object is saved. Linked
symbols are removed from the object but remain in the Graphic Toolbox.

Example 1: Map a Simple Symbol Wizard to an Object Wizard

This example shows how to create a simple Symbol Wizard, set configurations, and map the
configurations to Object Wizard Choices.
1. Create a new symbol in the Graphic Toolbox.
2. Build a simple Symbol Wizard in the Graphic Editor. by adding a Choice Group with three Choic es
named Red, Green, and Blue.
3. Add thee shapes, filled with colors that correspond to the Choices. Rename the shapes so you can
identify them.

192
Configure Objects with an Object Wizard Application Server User Guide

4. Assign each shape to the corresponding Choice by dragging the shape name from t he Elements tab
to the corres ponding Choice in the Layers tab.

5. Save and close the Graphic Editor.

6. Derive a new template from the Template Toolbox, and add an Object Wizard with:
o One Choice Group. Change the name of the Choice Group to "Select Color."
o Three Choices: Red, Green and Blue.
7. Link the Symbol Wizard you created in step 1 to the derived template.
8. Configure each Symbol Wizard association to match the corresponding Object Wizard Choice.
o Red Symbol Wizard Choice selected for Red Object Wizard Choice.
o Blue Symbol Wizard Choice selected for Blue Object Wizard Choice.

193
Application Server User Guide Configure Objects with an Object Wizard

o Green Symbol Wizard Choice selected for Green Object Wizard Choice.

Note: Only the default selection can be marked as visible (you can remove the checkmark to hide
the default selection). Selections with override are not visible. Us ers cannot modify selections that
are not visible.

9. Switch to Test Mode.

194
Configure Objects with an Object Wizard Application Server User Guide

10. With the default Option Wizard Choice selected (Red, in this example), you should see somet hing
like this:

The Symbol Wizard Choice Group can be changed in the Symbol Settings pane, since we did not
turn off visibility for the default selection.
11. With any of the non-default Option Wizard Choices selected, you should see somet hing like this:

195
Application Server User Guide Configure Objects with an Object Wizard

In this case, Symbol Wizard settings cannot be changed because there is a non-default configuration
of the Symbol Wizard is associated with the Green Object Wizard Choice. When a non -default
selection is made in the Symbol Wizard, its visibility setting is turned off and disabled.

Example 2: Configure a Linked Symbol Associated with Multiple

Choices
This example shows the steps required to link and configure a symbol from the Graphic Toolbox, set
configurations, and associate different configurations with Choices and Options. This example uses a
symbol from the Situational Awareness Library.

Note: Most symbols in the Situational Awareness Library are Symbol Wizards.

To configure a linked symbol associated with multiple choices

1. Derive a templat e from the $UserDefined template, then:
a. Add an Object Wizard Choice Group and name it "2-Way Valve Configuration."
b. Add three Choices, named: "Solenoid," "ElectroHydraulic," and "Manual."
2. Navigate to the Equipment folder of the Situational A wareness Library (in the Graphic Toolbox),
and link to the SA_Valve_2Way symbol.
Associate the linked symbol with each of the Choices created in step 2, and set the ActuatorType in
the Settings pane to match the associated Object Wizard Choice.
3. Set visibility and overrides for each association:
 For Solenoid:
o Select the Solenoid Choice from the Choi ces and Options pane.
o Select SA_Valve_2Way from the Associations pane.
o In the Settings pane, make sure that ActuatorType is set to the default (Solenoid), then turn off
visibility.
 For ElectroHydraulic and Manual:
o Select the ElectroHydraulic or Manual Choice from the Choice s and Options pane.
o Select SA_Valve_2Way from the Associations pane.

196
Configure Objects with an Object Wizard Application Server User Guide

o In the Settings pane, set the ActuatorType to match the Choice in the Choices and Options
pane. Since both ElectroHydraulic and Manual are overrides, visibility of these settings
automatically changes to hidden.

4. Switch to Test mode and check each of the Choices in the Choice s and Options pane.
o ActuatorType under Symbol Settings should be grayed -out to indicate it is hidden
o The symbol setting should match what you have selected in the Choice s and Options pane.

197
Application Server User Guide Configure Objects with an Object Wizard

o The symbol thumbnail should match the selected ActuatorType.

Conditional Visibility Expressions for Choice Groups,

Choices, and Options
You can set whether or not a user will be able to see individual Choice Groups, Choices and Options as
they use the Object Wizard.Visibility expressions are scripted and us e simple logical expressions to
determine if users will be able to see a particular Option or Choice when configuring instances. The
visibility expression determines if the Object Wizard component will be visible or hidden, based on the
user's previous Object Wizard selections. For example, selecting Choice #1 may hide (or show) Choic e
Groups, Choice or Options that follow that Choice in the Object Wizard.

Note: You cannot add a visibility expression to the first listed item (Choice Group or Option) in an Object
Wizard; the first item is always visible.

When a user uses the Object Wizard to configure an instanc e, the default behavior of any elements
hidden by visibility expressions remains in effect. For example, if Choice #1 is the default of a Choice
Group, and the Choice Group is hidden, Choice #1 is still selected for the configured instance, even
though it is not visible to the user. If the default state of an Option is True but the Option is hidden, the
Option remains True for the configured instanc e.
Visibility is set through logic expressions assigned to Choices and Options. These logic expressions use
the Boolean operators AND, OR, and NOT.
In derived templates that contain an Object Wizard from the parent object, icons are used to implement
visibility settings that are in addition to the settings made in the parent object. Note that the visibility
settings made in the parent Object cannot be changed in the derived template. See Object Wizard
Visibility Settings in a Derived Template on page 202 for additional information.

198
Configure Objects with an Object Wizard Application Server User Guide

Add a Basic Visibility Expression

To add a basic visibility expression to a Choice Group, Choice or Option:
1. Highlight the item for which you are setting visibility (Choice Group, Choice or Option). You can
select any item except the initial one. That is, you cannot make the visibility conditional of the first
item (Choice Group or Option) in the Object Wizard. If the first item is a Choice Group, you cannot
make it or any of its Choices conditional.
2. Place the cursor in the Visibility text box of the selected item, and type " [ " (open bracket character).
A drop-down list of all preceding items (Choices and Options) is displayed.

Note: Choices are listed in format "Choice Group Name:: Choice Name", for example, Choice
Group #1::Choice #1. Options are listed in the format "Option::State", for example Option
#1::True.

Note: While you can simply select an item for a simple visibility expression without typing an open
bracket, we recommend that you always type the open bracket as a matter of habit. As you begin
building more complex visibility expressions, you risk deleting the expression if you select an item
from the drop-down without first typing an open bracket.

3. Select the item from the drop-down list that will be used to control the visibility of the selected item.
For example, you can make Option #2 visible only if Choice #1 of Choice Group #1 has been
selected (Group #1::Choice #1), and/or if Option #1 is set to True (Option #1:: True).

Note: When a user configures an instance, the default behavior of elements remains in effect, even
if they are hidden from the user. The default Choice of a hidden Choice Group is still selected, and
hidden Options remain in their default states.

For additional information, seeOperators, Rules, and Behavior for Visibility Expressions on page
201.

199
Application Server User Guide Configure Objects with an Object Wizard

Add a Visibility Expression with Logical Operators

To add a visibility expression that uses logical operators to a Choice Group, Choice or
Option:
1. Highlight the item for which you are setting visibility (Choice Group, Choice or Option). You can
select any item except the initial one. That is, you cannot make the visibility conditional of the first
item (Choice Group or Option) in the Object Wizard. If the first item is a Choice Group, you cannot
make it or any of its Choices conditional.
2. Place the cursor in the Visibility text box of the selected item, and type " [ " (open bracket character).
A drop-down list of all preceding items (Choices and Options) is displayed.

Note: Always type an open bracket before selecting an item from the drop-down list. Simply
selecting an item wit hout first typing an open bracket will overwrite the existing expression.

Note: Choices are listed in format "Choice Group Name:: Choice Name", for example, Choice
Group #1::Choice #1. Options are listed in the format "Option::State", for example Option
#1::True.

3. Select the item upon which you are basing the visibility of the selected item. It will be entered in the
visibility expression. To expand the expression:
o Place the cursor at the front of the expression (before the open bracket) and enter the NOT
operator, or
o Place the cursor at the end of the expression (after the close bracket) and enter the AND or OR
operator.
4. Type " [ " (open bracket character) and select another item from the drop -down. All Object Wizard
items must be enclosed in brackets. Enclose items and operators in parentheses as needed to
ensure that the expression resolves as intended.

5. Add additional operators, parentheses, and Object Wizard items as needed to complete the visibility
expression. For example:

200
Configure Objects with an Object Wizard Application Server User Guide

[ChoiceGroup1::Choice1] AND ([Option1::True] OR [Option2::True] OR

[Option3::False])

Note: When a user configures an instance, the default behavior of elements remains in effect, even
if they are hidden from the user. The default Choice of a hidden Choice Group is still selected, and
hidden Options remain in their default states.

For additional information, see Operators, Rules, and Behavior for Visibility Expressions on page 201.

Operators, Rules, and Behavior for Visibility Expressions

As you build an Object Wizard, you can create visibility expressions that selectively hide Choice Groups,
Choic es, and Options. This can simplify the workflow by only showing Choices and Options that are
applicable, based on Choices and Options that the user has already made. When an Option or Choice
Group is hidden, the system applies the configured default values for attribut es, symbol and scripts
associated with the hidden Option or Choice Group. You can leverage this capability to hide advanced
functions from users tasked wit h configuring instances from templates that contain Object Wizards.
The Vi sibility prompt lets you assemble expressions to hide or show Choic e Groups, Choices, or
Options based on what the user has previously selected. Note that Visibility cannot be conditional for the
first Object Wizard item (Choic e Group or Option). The first Object Wizard item is always visible.
A vailable logical operat ors are AND, OR, and NOT.
Observe these basic rules and behaviors when building visibility expressions:
 Always start by typing the " [ " (open bracket character) in the visibility text box. This will bring up a list
of all Choices (from other Choice Groups) and Options that precede the selected it em. Do not simply
highlight an element without first typing the open bracket character.
 Choic es are listed with their Choice Group. Each Option is listed twice, for both states (True and
False). Use fully qualified Option/Choice selections surrounded by brackets. The separator between
Choic e Groups and Choices, and between Options and their states is "::" For example:
[Valve Type::3-Way] OR [Valve Ty pe::4-Way] AND [Option1::True]
 Valid logical operators:
o Valid binary operators are "AND" and "OR".
o Valid unary operator is "NOT".
o "AND" has a higher precedence than "OR".
o "NOT" has a higher precedence than "AND" or "OR".
o You can use "&" or "&&" instead of "AND".
o You can use "|" or "||" instead of "OR".
o You can use "!" instead of "NOT".
 Parentheses can be used to build complex expressions. For example:
[ChoiceGroup1::Choice1] AND ([Option1::True] OR [Option2::True] OR
[Option3::False])
Note that wit hout parenthes es, this expression would resolve very differently, since "AND" has a
higher precedence than "OR". If parentheses were not used, the expression would resolve this way:
[ChoiceGroup1::Choice1] AND [Option1::True] OR [Option2::True] OR
[Option3::False]
 Literals and operators are not case sensitive.
 Spacing between literals and operat ors is optional.

201
Application Server User Guide Configure Objects with an Object Wizard

 The visibility expression editor validat es the logical expression as you enter it, but does not check if
the expression is possible. For example, the expression "[Valve Type::3 -Way] AND [Valve
Type::4-Way]" would not be flagged since it is logically correct, even though the condition is
impossible (you cannot select more than one Choice from a single Choice Group).

Object Wizard Visibility Settings in a Derived Template

When you derive a template from a template with an Object Wizard, derived Object Wizard elements can
no longer be edited, and Object Wizard group names are grayed out. Other noticeable changes are:

 A visibility icon appears next to each derived wizard item.

 You can override visibility settings by clicking on the visibility icon.
 The item counts are res et to zero; changes made in the derived object will increment the counters.

 If you change a default selection, the setting override indicator appears next to the changed
setting.
See Object Wizard User Interface Details on page 175 for more information about visibility icons and the
setting override indicator. For additional information about derivation and visibility, see Object Wizard
Derivation on page 218.

The visibility expressions that were configured in the parent Object Wizard remain in effect. You can,
however, hide Choice Groups, Choices, and Options. Instead of using Boolean expressions to set the
visibility of Groups, Choices, and Options, use the visibility icon . When changing the visibility settings
of a derived Object Wizard:
 The behavior of a hidden Choice or Option does not change when configuring an instance from the
derived Object Wizard. The default state of a hidden Option remains in effect when the instanc e is
configured. If the Option's default state is True, any attributes, symbols, or scripts associated with it
are aut omatically configured for the instance. Similarly, the default Choice in a hidden Choice Group
is automatically selected, along with its associated attributes, symbols and scripts.
 You cannot hide (turn off the visibility of) a default Choice. You can, however, hide the entire Choice
Group.
 If every Choice except the default is hidden, the entire Choice Group is hidden.

202
Configure Objects with an Object Wizard Application Server User Guide

 If you change a default choice, the entire Choic e Group is automatically hidden. You can turn
visibility on again for the Choice Group. Once the Choice Group has been made visible, you can hide
individual Choices.

Example 1: Basic Visibility Expressions

This example shows how to build a basic visibility expression. In this case, we want to hide a Choice
Group unless an Option is True.
1. Select Group #1 and type [ (open bracket) in the Visibility text box.
2. Select Option #1::True from the drop-down list. The Visibility text box contains:

[Option #1::True]

3. Select Test mode.

203
Application Server User Guide Configure Objects with an Object Wizard

4. With Option #1 unselected (false), Group #1 is hidden.

5. Set Option #1 to True. Group #1 is now visible.

Example 2: Complex Visibility Expressions

Setting more complex rules for the visibility of Choices and Options requires the us e of the logical
operators AND, OR, or NOT, and may also necessitate the use of parentheses to ensure that the
expression is parsed correctly. The rules for using logical operators are listed inOperators, Rules, and
Behavior for Visibility Expressions on page 201.

204
Configure Objects with an Object Wizard Application Server User Guide

Scenario 1: Visibility of option is contingent on specific choices

Consider the following scenario. We want to allow a user to select Option #1 only when Choice #1 or
Choic e #3 is selected from Group #1.

1. Select Option #1 and type [ (open bracket) in the Visibility text box.
2. Select Group #1::Choice #1 from the drop-down list.
3. Place the cursor in the text box after ] (close bracket) and type OR.
4. Type [ and select Group #1::Choice #3 from the drop -down list. The Visibility text box should contain:

[Group #1::Choice #1] or [Group #1::Choice #3]

5. Select Test mode.
6. Select Group #1::Choice #1. Option #1 is visible
7. Switch to Group #1::Choice #3. Option #1 remains visible.
8. Switch to Group #1::Choice #2. Option #1 is now hidden.

205
Application Server User Guide Configure Objects with an Object Wizard

Scenario 2: Visibility of option is contingent on a combination of choices and

options
In this case, we want allow a user to select Option #3 only when Group#1::Choice #1 and
Group#2::Choice #1 or Group#2::Choic e #2 is selected and Option #2 is true. This expression can be
interpreted in different ways:
 (Group#1::Choice #1 and Group#2::Choice #1) or (Group#2::Choice #2 and Option #2:: True)
 Group#1::Choice #1 and (Group#2::Choice #1 or Group#2::Choice #2) and Option #2::True
Let's assume that we want the latter int erpretation.
1. Select Option #3 and type [ (open bracket) in the Visibility text box.
2. Select Group #1::Choice #1 from the drop-down list.
3. Place the cursor in the text box after ] (close bracket) and type AND.
4. Type [ and select Group #2::Choice #1 from the drop -down list.
5. Place the cursor in the text box after ] (close bracket) and type OR.
6. Type [ and select Group #2::Choice #2 from the drop-down list.
7. Place the cursor in the text box after ] (close bracket) and type AND.
8. Type [ and select Option #2 from the drop -down list.
9. Position the cursor in the text box enclose Group#2::Choice #1 or Group#2::Choice #2 in
parentheses.
10. The Visibility text box should contain:

Group#1::Choice #1 and (Group#2::Choice #1 or Group#2::Choice #2) and Option

#2::True
11. Select Test mode.
12. Select Group #1::Choice #1. and Group#2::Choice #1. Option #3 is hidden.

206
Configure Objects with an Object Wizard Application Server User Guide

13. Set Option #2 to True. Option #3 is now visible.

207
Application Server User Guide Configure Objects with an Object Wizard

Example 3: Visibility of Choice Groups, Choices, and Options in a

Derived Object Wizard
This example illustrates how a derived Object Wizard with hidden Choices and Options is translated at
run time and test mode:

In the example above, the following items are hidden:

 Group: Limit Switches
 Choic e: 4-Way (in the Group Valve Type)
 Choic e: Both (in the Groups Limit Switches (2 -Way) and Limit Switches (3-Way))
 Option: State Alarm
 Option: Deviation Alarm - Tuning

Trimming
Trimming refers to the ability of the Object Wizard to remove unneeded attributes, symbols, and scripts
from derived instanc es. By removing unneeded items, the size of instances an be minimized, thus
allowing more efficient utilization of run -time system resources. This can also result in faster
deployments.
 When you associate an attribut e with a Choice or Option, the Trim checkbox (1) is checked by
default. This means that trimming is enabled, and the attribut e will be evaluated for trimming.

208
Configure Objects with an Object Wizard Application Server User Guide

 When you associate a symbol with a Choice or Option, the Trim checkbox is unchecked by default.
This means that trimming is DISabled, and the symbol will NOT be evaluated for trimming.
 When you associate a script with a Choice or Option, the Trim checkbox is checked. Trimming
cannot be disabled for scripts.

Note:Symbols do not exist as run-time objects, but do exist as part of a ViewApp. Trimming unnec essary
symbols can help to reduce system resource requirements.

The total number of trimmable items (attributes, symbols, and scripts) associated with each Object
Wizard Choice and Option is displayed in the Choice s and Options pane (2). Items that are not enabled
for trimming are not included in this count. The default trim state of associated symbols is disabled.

Note: The count of trimmable items resets to 0 in derived templates.

Enable Trimming
Whether or not an attribute or symbol associated with a Choice or Option will be evaluated for trimming is
determined by the state of its trimming checkbox in the Associations pane. See Object Wizard User
Interface Details on page 175 for additional information.

Note: Scripts are always evaluated for trimming.

To enable trimming:
1. Select the Trim checkbox in the Associations pane.
o When checked, trimming is enabled.
o When unchecked, trimming is disabled.

2. Symbols and attributes are evaluated for trimming when an instance is derived, in accordance wit h
the following behaviors (scripts are always evaluated for trimming):
o If none of its associations have trimming enabled, the item is not evaluated for trimm ing and is
always propagat ed to derived instances.

209
Application Server User Guide Configure Objects with an Object Wizard

o The item is propagated to the instance if any Choice or Option where trimming is enabled is
selected.
o The item is trimmed if at least one of its associations has trimming enabled, and none of the
associations with trimming enabled are selected (even if associations with trimming disabled
have been selected).
o Trimming occurs only when the instance is saved.

Note: Trimming is not applicable to derived templates, since these are not run-time objects.

Example: Enable Trimming for Attributes and Symbols

When you associate an attribute with a Choice or Option and set it as trimmable, you can use Test mode
to see how attributes and symbols will be added to, or removed from, instances that are configured from
the Object Wizard. For example:
1. Create a derived template and open it in the Object Editor.
2. Add an attribute: Attribute001.
3. Add a symbol: S1.
4. Add a Choice Group (with two Choices) and one Option. Leave Choice #1 as the default choice, and
leave the default state of Option #1 as not selected.
5. Associate Attribute001 and S1 with Choice #1, and dis able trimming for both.
6. Associate Attribute001 with Choice#2, and enable trimming for the attribute.
7. Associate S1 with Option #1, and enable trimming for the symbol.
8. Select Test mode. Note that with the default selections, Attribute001 does not appear in the
Attribute s pane, and S1 does not appear in the Symbol s pane.

210
Configure Objects with an Object Wizard Application Server User Guide

9. Select Choice #2. Note that Attribute001 now appears in the Attribute s pane.

10. Enable Option #1. Note that S1 now appears in the Symbol s pane.

Attribute and Symbol Overrides

You can associate different configurations of symbols and attributes with different Object Wizard
Choic es and Options. You can also allow users to override values that you previously set as they
configure derived objects. See Configurable Settings for Attribute and S ymbol Values on page 215 for
additional information about setting overrides and visibility for symbol wizard and custom property
values. For detailed information about Symbol Wizards and custom properties, see " Using Custom
Properties" and "Working with Symbol Wizards" in the Creating and Managing ArchestrA Graphics User
Guide.
The Settings pane lets you configure setting overrides and visibility for associated attributes and
symbols.

211
Application Server User Guide Configure Objects with an Object Wizard

Attribute Overrides
For attributes, you can override default settings and set visibility for:
 Attribute description
 Data type
 Initial value
 Engineering units (if applicable)
 Activate/ deactivate features, such as I/O and alarms
 Feature values
Attribute Setting Visibility
When you associate an attribut e with an Object Wizard Choice or Option, its settings are hidden by
default. You can make settings visible by selecting the checkbox next to the setting. You can also make
overrides visible.
Symbol Overrides
For symbols, you can override default settings and set visibility for:
 Symbol Wizard Choices and Options
 Custom properties
Symbol Setting Visibility
When you associate a symbol with an Object Wizard Choice or Option, Symbol Wizard and custom
property settings (if any) are vi sible by default. If you override a symbol custom property or Symbol
Wizard setting, its visibility automatically turns off (the setting is hidden). You can make an overridden
custom property setting visible again by selecting the checkbox next to the setting.

Note: If you override a Symbol Wizard setting, the only way to mak e the setting visible again is to remove
the override.

Custom properties can be Boolean, integer, float, string, etc. See Object Wizard User Interfac e Details
on page 175 for additional information. For detailed information about custom property data types, see
"Using Custom Properties" in the Creating and Managing A rchestrA Graphics User Guide. When
configuring string, time, and elapsed time custom properties, a toggle is provided in the Settings pane to
configure the custom property as either:

Reference string or an expression. Reference strings will be evaluated to determine their meanings.
For example, Me.Tank1.InletValve.PV

String literal. String literals are passed as static text.

212
Configure Objects with an Object Wizard Application Server User Guide

To change the string type, select the icon next to the text field.

Enter Overrides and Set Visibililty for Attribute and Symbol Values
For bot h attributes and symbols that contain a wizard or custom properties, you c an enter overrides that
apply only to the associated Object Wizard Choice or Option. While the following procedure shows how
to configure a symbol, the procedure for configuring attributes is virt ually identical. See also About
Attribute and Symbol Overrides on page 190.
To configure a Overrides for a Choice or Option
1. Select the Choice or Option you want to configure (Choice s and Options pane).
2. Select a symbol or attribute (Associations pane) associated with the Choice or Option. See Add
Attributes, Symbols and Scripts to an Object Wizard for information about associating symbols with
Object Wizards.
This does not apply to scripts since they can only be associated with a Choice or Option. Th ere are
no configuration or visibility settings that can be configured.
3. In the Settings pane, override t he default values as needed. Overrides are shown in bold and by an
X next to the new value. See
o You can resize columns in the Settings pane as needed by selecting and moving the boundary
between column headers.
o Symbol Wizard and Custom Property settings are visible by default. Overrides are aut omatically
hidden from users.
– You can only restore the visibility of a Symbol Wizard setting with an override by removing
the override.

Note: This behavior is unique t o Symbol Wizard overrides. You can change visibility settings
for both Custom Property overrides and attribute overrides.

– You can restore the visibility of an Custom Property with an override by selecting the
Visibility icon until it is unmuted. The icon will have a small X in its upper right quadrant to
indicate that Visibility has been overridden.
o Switching a Custom Property string type between expression/reference and static text is an
override (value is displayed with bold type with an X next to the value and in the Visibility
setting).

213
Application Server User Guide Configure Objects with an Object Wizard

o Attribute settings are hidden by default. You can override the Visibility settings for attributes that
use their default setting, as well as for attributes that have an override.

Note: Attribute, Symbol Wizard, and Custom Property values that are marked as visible can be
overridden by users as they configure instances.

Note: The total number of configured settings (visibility settings and value settings ) is shown in the
Associations pane, and is reflected in the Choice s and Options pane. See About Attribute and
Symbol Overrides on page 190 for additional information.

About Attribute and Symbol Overrides

Override values for an attribute or symbol (with a Symbol Wizard or custom properties) can be configured
for each associated Choice or Option. When you associate an attribute or symbol, the default values are
listed in the Settings pane. To configure values that apply to the selected Choice or Option, enter the
values in the Settings pane. If the attribute or symbol is associated with multiple Choices or Options,
different values can be used for each one. Values for the Choices and Options are saved when you save
the object. If the setting is marked as visible, users can override your setting (or override the default, if
you have not configured a setting) as they derive and configure instances from the Object Wizard.
Symbols with overrides that affect their shape, for example, certain Situational Awareness Library
symbols, are rendered with the applicable shape -changes as

Note: If you override a Symbol Wizard setting, the only way to make t he setting visible again is to remove
the override. Attributes and custom properties with overrides can be made visible again by selecting the
visibility checkbox.

214
Configure Objects with an Object Wizard Application Server User Guide

A configured setting is defined as any change from the default configuration of the attribute or symbol.
This includes changing a value or visibility. For example, you might change the default Boolean value
from true to false, or you might change an integer value from 5 to 10, or change engineering units from
liters to cc. Changing the visibility of an setting also counts as a configured setting.
 The default visibility setting for attribut e values is hidden (Visibility icon is muted (grayed-out) in the
Settings pane).
 The default visibility setting for Symbol Wizard and custom property values is visible (Visibility icon is
unmuted in the Settings pane).
 Visibility overrides are indicated by a small X in the upper right quadrant of the visibility icon.
The total number of configured settings for each individual attribute and symbol is displayed in the
Associations pane (1). The total number of configured settings for ALL attributes and symbols
associated with an individual Choice or Option is displayed in the Choice s and Options pane (2).

Configurable Settings for Attribute and Symbol Values

Symbols and attributes can be configured for each Choice or Option with which they are associated.
When you initially associate an attribute or symbol with a Choice or Option, the default settings of the
attribute or symbol are listed in the Settings pane.

Note: Icons for attribute and symbol settings are defined in Object Wizard User Interface Details on page
175.

To override default values, enter the new values in the Settings pane (1). If the attribut e or symbol is
associated with multiple Choices or Options, different overrides can be used for eac h one. These
configured (override) values are saved when you save the template.

215
Application Server User Guide Configure Objects with an Object Wizard

An override is defined as any change from the default symbol configuration. For example, you might
change the default Choice of a Symbol Wizard, or change a custom property or attribute value. Changing
the visibility of a setting is also considered an over ride. By default, symbol settings are visible in derived
objects, while attribute settings are hidden by default.
If the setting is marked as visible, users can enter overrides when they use the Create New Asse t editor
to configure a new instance. If the setting is hidden, it is not exposed to users and therefore the default
value cannot be overridden.
Symbol Wizard overrides are automatically hidden and cannot be changed back to visible, except by
restoring the original setting. The names of configured settings are displayed in bold type, and have an
"X" next to the setting. To restore the original setting, clear the X.
Configured visibility settings have a small x in the upper right quadrant of the visibility icon. To restore the
original, click on the icon twice to clear the override. If the original visibility state was visible, the icon will
cycle through override - hidden, override - visible, and then return to its original state of visible (no
override).
Custom property and attribute overrides are also hidden automatically. However, you can override the
visibility setting for a setting that has an override value and make it visible again.
The total number of configured settings for each individual attribute and symbol is displayed in the
Associations pane (2). The total number of overrides for ALL attributes and symbols associated with a
Choic e or Option is displayed in the Choi ces and Options pane (3).

Add Scripts to an Object Wizard

Scripts can be associated with diffe rent Choices and Options. As a user makes selections from the
Object Wizard, these selections determine if a script will be included in derived instances and templates.

216
Configure Objects with an Object Wizard Application Server User Guide

A template with an Object Wizard may contain more scripts than any single instance deri ved from it. As
each instance is configured through the Object Wizard, unused scripts are automatically evaluated for
trimming from the instance. When you save the instance, unused scripts are discarded.
Overrides do not apply to scripts since scripts do not contain configurable settings. If you need a script to
behave differently for different Choices or Options, create a separate script for each behavior. Scripts
that are not associated with selected Choices and Options are trimmed from the deployed objec t.

Note: Scripts that are not associated with any Choices or Options are always propagated to derived
instances.

Associate a Script with a Choice or Option

After you have added scripts to the object, you can associate them with Object Wiz ard Choices and
Options. Any single script can be associated with multiple Choices and/or Options, and more than one
script can be associated wit h a single Choice or Option.
To associate a symbol with a Choice or Option:
1. Locate the Option, or the Choice within its Choice Group, and highlight it.
2. In the Scripts pane, select the script you want to associate with the selected Choic e.
3. Drag the script to the Associations pane, or select the Add Association button.

When you associate a script with an Object Wizard Choic e or Option, trimming is automatically
enabled, and cannot be disabled.

217
Application Server User Guide Configure Objects with an Object Wizard

Multiple Script Associations

A Choice or Option does not have to have a script associated with it, and a script does not have to be
associated with a Choice or Option. A script that is not associated with any Choices or Options is not
evaluated for trimming, and is propagated to all derived instances. As with attributes and symbols, a
script can be associated wit h more than one Choic e or Option. No overrides are available for scripts. If
you need a script to behave differently between Wizard Choices and Options, create a separat e script.
Only scripts that are associated wit h the Object Wizard can be trimmed. Unlike attributes and symbols,
you cannot disable trimming for scripts. Any script with an Object Wizard association is always a
candidate to be trimmed from derived instances.

Object Wizard Derivation

You can derive child templates from templat es with Object Wizards. Creating a second (or deeper) level
of derivation from a template wit h an Object Wizard lets you extend the functionality of the original Object
Wizard, and make specialized versions for specific applications. See Reasons to Derive a Template from
an Object Wizard on page 220for additional information.

Derive a Child Template from a Template with an Object Wizard

To create a derived template from a template with an Object Wizard:
1. Select the parent template with Object Wizard in the Template Toolbox.
2. Do one of the following:
 Right click on the template and select Derived Template.
 Use the keyboard shortcut: Ctrl + Shift + N.

218
Configure Objects with an Object Wizard Application Server User Guide

You will notice that the child template looks different than the parent templat e.

See Object Wizard Visibility Settings in a Derived Template on page 202 for additional information.

Set Visibility of Choices and Options in a Derived Template

The original Object Wizard cannot be changed in the child derived template. However, you can set the
visibility of Choice Groups, Choices, and Options. You can also set different defaults for Choic e Groups,
and you can turn Options on or off.
To set Object Wizard visibility in a derived template, do any of the following:
1. Select the visibility icon next to a Choice Group, Choice, or Option.
o When you hide a Choice Group, all its Choices are hidden as well.
o When you hide a Choice, the remaining Choices in the Choice Group are still visible.
o When only one Choice is visible in a Choice Group, the entire Choice Group is hidden.

Note: The system applies the default values and actions of hidden Options and Choice Groups when
a user derives an instance from the template. Visibility does not change configuration, it only affects
aspects of the wizard that are visible to the user.

2. Change the default Choice in a Choice Group. This hides the Choice Group.
You can select the visibility icon to make the Choice Group visible again. You can t hen s et visibility of
the Choices individually.
3. Change the default state of an Option. This hides the Option.

219
Application Server User Guide Configure Objects with an Object Wizard

You can select the visibility icon to make the Option visible again.

Reasons to Derive a Template from an Object Wizard

There are t wo main reasons for deriving a child t emplate from a template t hat contains an Object Wizard:
1. To extend the existing Object Wizard and thus, make it more capable. A vailable actions to
accommodate the specific needs of a target solution include:
o Add Choice Groups or Options.
o Add attributes, symbols, or associations.
2. To create specialized versions of templates that preconfigure choices, and thus simplify the task of
configuring instances. For example, you can define common configuration aspects that are
applicable to a set of similar instances, or modify some of the characteristics of the existing Object
Wizard. Available actions to simplify configuration include:
o Change default Choices or settings.
o Hide Choice Groups, Choices, or Options.
o Enter overrides for attribute or symbol settings, or change their visibility settings.
Using derived templates lets you propagat e changes made to a parent template, as l ong as the child
template does not have an override for what has changed. See Propagation of Attribute and Symbol
Settings for additional information.
If you are familiar with using Application Server, you will notice one other advantage of using derived
Object Wizards: there is no need to lock objects. Changes automatically propagate to derived objects
(provided the child template does not have an override for what changed in the parent), without explicitly
locking attributes in the parent object.

Changes to Object Wizards in Derived Templates

After you create a derived templat e from a template with an Object Wizard, you can only make certain
changes to the existing Object Wizard in the derived object.
 You can set overrides for attributes and symbols.
 You can hide or show settings for attributes and symbols.
 You can change visibility and defaults for Choices and Options.
 You can add new Choice Groups and Options (you cannot add new Choices to an existing Choice
Group).
 You can add new attributes, symbols, and scripts, and associate them with the existing Object
Wizard.
 You cannot remove existing associations from the Object Wizard.
 You cannot remove any existing Choice Groups, Choices, or Options.
 You cannot change the order of any existing Groups, Choices, or Options.

220
Configure Objects with an Object Wizard Application Server User Guide

 You cannot change attribute, symbol, or script associations with any existing Choices or Options.

When a Choice or Option is changed from the default, the change is indicated by by an X next the
modified Choice or Option. To revert to the default, select the X.
Similarly, when a visible setting for an associated attribut e or symbol has been changed from the default,
the change is indicated by an X next to the modified setting. To revert to the default, select the X.

Behavior of Object Wizard Components in a Derived Template

The following list summarizes actions that you can and cannot perform in derived templat es that contain
an Object Wizard.
 Inherited Groups, Choices and Options cannot be edit ed.
o Groups, Choices and Options cannot be renamed or deleted.
o Their order cannot be changed (cannot be moved up or down).
o Their prompts, descriptions, and visibility rules cannot be edited.
 You can change the default Choice, or the default state of an Option.
 Associations of inherited items (attributes, symbols, and scripts) with Choices and Options cannot be
changed, and inherited associations cannot be removed.
 You can associate an inherited item with additional inherited Choices and Options
 Inherited attribute and symbol values and visibility settings can be overridden.
 Inherited values and visibility settings with overrides can be overridden.

221
Application Server User Guide Configure Objects with an Object Wizard

Note: E ven if a value is overridden in t he parent object, the value will appear as a default value in the
child object. This is because the override from the parent becomes the default for the child.

Example: Set Visibility of Derived Wizard Choices and Options

The following example illustrates how a derived Object Wizard with hidden Choices and Options is
interpreted in test mode. This simulates instance configuration.

In the example, the following items are hidden:

 Group: Limit Switches
 Choic e: 4-Way (in the Group Valve Type)
 Choic e: Both (in the Groups Limit Switches (2 -Way) and Limit Switches (3-Way))
 Option: State Alarm
 Option: Deviation Alarm - Tuning

Object Wizard Test Mode

Test mode lets you simulate how an Object Wizard will behave when a user configures a derived
instance. Use Test mode as you develop your Object Wizard to ensure that it behaves as expected. For
complex Object Wizards, associated attributes and symbols may not always appear as you had planned.
Test mode lets you verify that derived instances will behave as intended.

222
Configure Objects with an Object Wizard Application Server User Guide

 Select the Test button to enter Test mode.

 Deselect the button to exit Test mode.

Visibility expressions determine which Choice Groups, Choices, and Options are visible or hidden (along
with associated symbols, attributes, settings, and configured overrides), bas ed on previous selections.

Verify Behavior of Visibility Expressions

1. Open the template, containing the Object Wizard to be tested, in the Object Editor.

223
Application Server User Guide Configure Objects with an Object Wizard

2. Select the Test mode button. The background color of the Choi ces and Options and Settings
panes darkens, and the Associations pane is no longer shown. Choice Groups and Options are
displayed, based on their visibility settings.

3. Check that the Choice Groups and Options that you expect to be visible are shown.
o Regardless of the construction of the Object Wizard, the first item (Choice Group or Option) in
the Object Wizard is always visible.
o Choic e Groups are displayed as drop down lists, with only the default Choice visibl e.
4. Check that the expected default Choice for each visible Choice Group is shown.
5. Check that the default state (checked or unchecked) of each visible Option is correct.
6. Cycle through different Choice and Option selections, and verify that subsequent dependent items
are hidden or shown as designed.
7. Verify that the settings for associated attributes and symbols are shown in the Settings pane, and
that settings that should be visible are marked as visible. Verify that settings with visibility turned off
are marked as hidden.

224
Configure Objects with an Object Wizard Application Server User Guide

About Object Wizard Behavior in Test Mode

At the most basic level, you can check that Object Wizard elements (Choice Groups, Choices, and
Options) operate as intended. Choices and Options should appear in their default states. That is, Options
that should be enabled by default should appear with their checkbox checked, and Choice Groups
should show the default Choice. You can change thes e selections while in Test mode, to ensure that
Choic es and Options are correctly configured, including visibility settings and associated attributes,
symbols, and scripts. Attribute and symbol settings that should not be changeable by consumers of the
Wizard should not be visible.
 Check conditional visibility expressions. See Conditional Visibility Expressions for Choice Groups,
Choic es, and Options on page 198 for additional information.
 Check that attributes and symbols are shown in their correct configuration when the corres ponding
Choic e or Option is selected. See Enter Overrides and Set Visibility for Attribute and Symbol Values
(see "Enter Overrides and Set Visibililty for Attribute and Symbol Values " on page 213) for additional
information.
 Check that attributes and symbols are correctly trimmed. See Trimming on page 208 for additional
information.

Example 1: Verify Behavior of Associated Attributes

Here, we examine how the selection of Choices and Options affects attributes that are associated with
them. For an overview of how an Object Wizard behaves in Test mode, see About Object Wizard
Behavior in Test Mode on page 225.
Let's start by creating new attributes and associate them with Options.
1. Create four new attributes.
2. Name the attributes as follows:
o DeviationAlarms
o DeviationAlarmMajor
o DeviationAlarmMinor
o DeviationAlarmTuning
3. Highlight one of the Deviation Alarm Options (1), then select the corresponding attribute and drag it
to the Associations pane (2). For example, with the DEVIA TION ALARMS option highlighted in the
Choice s and Options pane, drag and drop the DeviationAlarms attribute to the Associations
pane.
Make sure that the Trimming checkbox is selected in the Associations pane. See Trimming on
page 208 for additional information.

225
Application Server User Guide Configure Objects with an Object Wizard

4. Repeat for the remaining Deviation Alarms with trimming enabled.

5. Create two more attribut es: Attribute001 and Attribute002. We will leave these attributes
unassociated with any particular Choice or Option. Since they are not a part of the Object Wizard,
these attributes will be included in all objects that are derived from the template; these two attributes
will not be trimmable.

6. To verify attribute behavior, select the Test button.

o With no Object Wizard selections made, the attributes that are not associated with any Wizard
Choic es or Options (Attribute001 and Attribute002) are shown in the Attribute s pane. Attributes
associated with Choices or Options (DeviationAlarm attributes) are not shown.

o Change the Wizard Mode to Advanced. This displays the DEVIA TION ALARMS option
(unchecked). Note that the associated DeviationAlarms attribute is not shown.

226
Configure Objects with an Object Wizard Application Server User Guide

o To display the DeviationAlarm attribute, set the DEVIA TION ALA RMS option to TRUE
(checked). Continue setting the remaining Deviation Alarm options to TRUE. Note that as each
Option is selected, its corresponding attribute is displayed.

o Deselecting an Option (setting it to FALSE) turns off the attribute.

Note: When configuring an instanc e from an Object Wizard, unused attributes that have trimming
enabled are not propagat ed to the instance. Only attributes that are not associated with the Object
Wizard, and attributes with trimming enabled that evaluate as required, are present in the instance after
the instance is saved. Trimming does not occur until after an object is saved. Any configured overrides
for trimmable attributes remain in memory until the us er saves the instance.

Example 2: Verify Behavior of Associated Symbols

Here, we examine how the selection of Choices and Options affects symbols that are associated with
them. For an overview of how an Object Wizard behaves in Test mode, see About Object Wizard
Behavior in Test Mode on page 225.
Start by creating new symbols and associate them with some Object Wizard Choices.
1. Create three new symbols. In this example, each symbol contains an embedded Situal Awareness
Library graphic.
o 2WayValve
o 3WayValve
o 4WayValve
2. Highlight one of the Choices in the Valve Type Choice Group (1), then select the symbol with the
corresponding name and drag it to the Associations pane (2). For example, with the 2-Way valve
type Choice highlighted in the Choice s and Options pane, drag and drop the 2WayValve symbol
from the Symbol s pane to the Associations pane.

227
Application Server User Guide Configure Objects with an Object Wizard

Make sure that the Trimming checkbox (3) is selected in the Associations pane; the default state
for symbols is unselected. See Trimming on page 208 for additional information.

3. Repeat for the remaining valve types (with trimming enabled).

228
Configure Objects with an Object Wizard Application Server User Guide

4. Create two more symbols: Symbol001 and Symbol002. We will leave these symbols unassociated
with any particular Choice or Option. Since they are not a part of the Object Wizard, these symbols
will be included in all objects that are derived from our Object Wizard. It does not matter if t rimming is
enabled for these, since without any Object Wizard association, they are considered to be owned by
the object.

5. To verify attribute behavior, select the Test button.

229
Application Server User Guide Configure Objects with an Object Wizard

o With the default Object Wizard selections made (in this case, 2-Way Valve), the 2WayValve
symbol associated with this choice is shown, along wit h the t wo symbols not associated with any
Wizard Choices or Options (Symbol001 and Symbol002). These can be seen in the Symbol s
pane. Note the message at the bottom of the Symbol s pane that states "3 of 5 displayed." This
is because the 2WayValve and 3WayValve symbols are hidden.

230
Configure Objects with an Object Wizard Application Server User Guide

o Change the Valve Type to 3-Way. This displays the 3WayValve symbol and hides the
2WayValve and 4WayValve symbols.

231
Application Server User Guide Configure Objects with an Object Wizard

o Change the Valve Type to 4-Way. This displays the 4WayValve symbol and hides the
2WayValve and 3WayValve symbols.

Note: When configuring an instanc e from an Object Wizard, unused attributes that have trimming
enabled are not propagat ed to the instance. Only attributes not associated with the Object W izard, and
attributes with trimming enabled that evaluate as required, are present in the instance after the instance
is saved. Trimming does not occur until after an object is saved, and any overrides a user enters for a
trimmable attribute remain in memory until the us er saves the object.

Propagation of Object Wizard Changes to Derived Objects

Most changes made to an Object Wizard propagate through the object hierarchy to all objects derived
from the Wizard. Examples of changes that are propagated include:
 Adding, editing, renaming, changing the order of, or deleting Choice Groups, Choices, or Options.
 Adding, removing, or modifying an association (attribute, symbol, or script) with a Choice or Opt ion
 Changing the default state (setting) of an Option.
 Changing the visibility setting of a Choice or Option.
 Changing the default value or visibility setting of an attribute or symbol associated with a Choice or
Option.
 Changing the visibility setting of a value in the Settings pane.

Important: With the exception of the first two items in the above list, changes DO NOT propagate to
derived templat es if the setting is marked as overridden in the derived template.

232
Configure Objects with an Object Wizard Application Server User Guide

Object Wizard Behavior when a Default Choice is Deleted

If you remove a default Choice from a Choice Group, the topmost Choice aut omatically becomes the new
default, unless you explicitly select a different one. The new default propagates to child objects
(templat es and instances).
You cannot delete a Choice if there are only t wo Choices in the Choice Group; you must delete t he entire
Choic e Group (a Choice Group, by definition, must contain at least two Choices). In this case, any
associated attributes or symbols that were associated with the deleted Choice Group become a part of
the object; they no longer have an association with the Object Wizard. Attributes and symbols that are
not associated with the Object Wizard are not trimmed from derived instanc es.

Limitations Associated with Object Wizard Propagation

You cannot delet e, rename, or change the order of Choice Groups, Choices, or Options in a derived
Object Wizard. However, additional Choice Groups and Options can be added to a derived t emplat e with
an existing Object Wizard. You can also selectively hide Wizard elements in the derived Object Wizard.
Elements that are hidden will invoke a default behavior, or limit the Wizard consumer to choose between
the remaining elements. For example, in a Choice Group with three Choices, you could hide Choice #2,
leaving the Wizard consumer to choose between Choice #1 and Choice #3. See Object Wizard Visibility
Settings in a Derived Template on page 202 for additional information.
See Object Wizard Derivation on page 218 for additional information about derived objects.

Extend an Inherited Object Wizard

You can extend the capabilities of a templat e derived from an Object Wizard by adding different types of
content to it. Actions you can take include:
 Expand the existing Object Wizard by adding new Choice Groups or Options.

Note: You cannot add Choices to an existing Choice Group.

 Associate attributes, symbols, and scripts with existing Choices and Options.
 Enter overrides for attribute and symbol settings.
 Change the default setting for Choice Groups.

Note: When you change an inherited default Choice, the entire Choice Group is automatically
hidden. However, you can turn visibility back on for the Choice Group. After that, you can selectively
hide Choices wit hin the Choice Group, if necessary.

 Selectively hide Choice Groups, Choices, and Options.

 Change the default default state of Options.

Note: When you change an Option's default state, the Option is automatically hidden. However, you
can turn visibility back on.

Add a Choice Group to a Derived Template

To add a new Choice Group to a derived template wit h an Object Wizard:

233
Application Server User Guide Configure Objects with an Object Wizard

1. Select the Add Choice Group button to add a Choice Group.

2. Rename the Choice Group by entering the new name in the Prompt textbox.
3. You can change the relative position of the new Choice Group as needed by using the Move Up and
Move Down buttons.
4. Select the Add Choice Group button to add additional Choic es, if needed. Choice Groups include
two Choices by default.

Choic es within a Choice Group are mutually exclusive; one, and only one, Choice can be selected
from a Choice Group. Choices are chosen by selecting the radio button next to the Choice. For
example, an Object Wizard user must choose Choice #1 OR Choice #2 (but not both or none).
5. Rename the Choice by entering the new name in the Prompt textbox.

Note: You cannot add Choices to an existing Choice Group in a derived template.

234
Configure Objects with an Object Wizard Application Server User Guide

Add an Option to a Derived Template

To add a new Option to a derived template wit h an Object Wizard:
1. Select the Add Option button to add a Choice Group.

2. Rename the Option by entering the new name in the Prompt textbox.

Add an Assocation to an Inherited Object Wizard

To add an association (attribute, symbol, or script) to the inherited Object Wizard:
1. Create a new attribute, symbol or script (as needed) and configure any of its base settings, as
needed.
2. Highlight a Choice or Option in the Choice s and Options pane.
3. Add the new item in the Associations pane.
4. Enter overrides (for attribute and symbol settings) as needed for associated the Choice or Option.

5. Add and configure additional items and associate them with the Object Wizard, as needed.

Note: A Choice or Option does not have to have any associations. An individual attribute, symbol, or
script can be associated with more than one Choice or Option. Symbol and attribute override s ettings
can override the default values of an attribute; the overrides affect only the Choice or Option for
which they are entered. For example, an attribute can have a value of 5 for one Choice, and a value
of 10 for another.

235
Application Server User Guide Configure Objects with an Object Wizard

Add a Script to a Derived Template

As with attributes, you can also add new scripts to existing Choices or Options. The scripts can be
pre-existing within the object, or you can add new scripts to the object, and then associate them with the
Object Wizard.
See the ArchestrA Scripting Guide for additional information about scripts.
To add an script association wit h the Object Wizard:
1. If you need to creat e a new script, select the Scripts tab and then s elect the Add Script button. See
the Application Server User Guide, "Writing and Editing Scripts on page 152," for additional
information.

2. If necessary, select the Scripts button to show the Scripts pane.

3. Highlight a Choice or Option in the Choice s and Options pane.
4. Drag and drop the script from the Scripts pane to the Associations pane.

236
Configure Objects with an Object Wizard Application Server User Guide

No additional configuration is needed for scripts. If you need the script to modify a script for anot her
Choic e or Option, creat e a copy of the script and change it.

5. Add additional scripts and associate them with the Object Wizard, or associate the same script with
other Choices or Options.

Add a Symbol to a Derived Template

To extend or change the functionality of a derived template with an Object Wizard, you can add new
symbols to existing Choices or Options.
You can create a new symbol for the object, and then associate the symbol with the Object Wizard. You
can also link symbols from the Graphics Toolbox to the object. See Link to Shared Content in the Graphic
Toolbox on page 186 for additional information.
See the Application Server User Guide, "Creating and Work ing with Content on page 157," for additional
information about symbols.
To add a new symbol for association with the Object Wizard:
1. Select the Add Symbol button to add a new symbol to the object.
2. Highlight a Choice or Option in the Choice s and Options pane.
3. Drag and drop the symbol from the Symbol s pane to the Associations pane.

237
Application Server User Guide Configure Objects with an Object Wizard

4. If the symbol contains a Symbol Wizard or custom properties, modify the settings as needed for the
Choic e or Option wit h which it is associated.

5. Add additional symbols and associate them with the Object Wizard, or associate the symbol with
other Choices or Options.
6. If applicable, configure Symbol Wizard and custom property values for each symbol association in
the Settings pane.

Note: A Choice or Option does not have to have a symbol associated with it. A symbol can be
associated with more than one Choice or Option. You can override the default Symbol Wizard and
custom property values; the overrides affect only the Choice or Option for which they are entered.

Link to a Symbol in the Graphic Toolbox

To extend or change a derived Object Wizard's functionality, you can link a symbol from the Graphics
Toolbox with the Object Wizard. Once you have linked the symbol, you can associate it with the Object
Wizard.
To link a symbol or other item from the Graphic Toolbox to an Object Wizard:
1. In the Symbol s pane, select the Link Symbol button (1) to link a symbol from the Graphic Toolbox
to the object.

238
Configure Objects with an Object Wizard Application Server User Guide

 The Galaxy Browser opens. Select a symbol or Symbol Wizard from the Graphic Toolbox and
select OK.

2. The symbol is added to the object. The icon (2) next to the symbol name indicates the symbol is
linked to the object.
3. Highlight a Choice or Option in the Choice s and Options pane (3).
4. Drag the symbol from the Symbol s pane to the Associations pane (4).
5. If the symbol is a Symbol Wizard, modify the settings (5) as needed for the Choice or Option with
which it is associated.
6. Turn visibility of the Symbol Wizard settings (6) on or off, as needed. If the settings are visible, users
can override your configuration settings.
7. In the Details pane (7), edit the default name of the symbol as needed. You can also add a
description (optional).

Note: A Choice or Option does not have to have a symbol associated with it. A symbol can be
associated with more than one Choice or Option. You can override the default values of a Symbol
Wizard; the overrides affect only the Choice or Option for w hich they are entered.

239
Application Server User Guide Configure Objects with an Object Wizard

Symbols and Object Wizards

Two different methods are for associating symbols with Object Wizards.
 Add symbols into the template that you have created for that particular templat e. Thes e symbols you
owned by the object. While changes to the symbol in the object will propagate to child objects,
non-related instances and templates that may use copies of the symbol will not be updated when the
original symbol is edited.
 Link an external symbol to the template. Creat e a link from the template to external symbols in the
Graphic Toolbox (GTB ). Linked symbols can be shared between unrelat ed objects (objects that are
not part of the same derivation hierarchy). Changes to the symbol will be reflected to eac h template
and instance that link to the GTB symbol.

Example 1: Add a Symbol to the Object

To add a custom symbol to a template:
1. In the Symbol s pane, select the Add Symbol button.

2. Rename the graphic in the Details pane of the Object Editor. You can also add a description of the
symbol (optional).
3. Select the Edit symbol button. The Graphic Editor will open in a new window.
4. Select the Graphic Editor window and creat e the symbol to be added to the template.
5. Save the symbol and close the Graphic Editor.
6. To associate the symbol with an Object W izard Choic e or Option, see Associate Content with a
Choic e or Option on page 187.

240
Configure Objects with an Object Wizard Application Server User Guide

Example 2: Link to a Symbol in the Graphic Toolbox

To link a Graphic Toolbox (GTB) symbol to an template:
1. In the Symbol s pane, select the Link External Symbol button.

241
Application Server User Guide Configure Objects with an Object Wizard

2. The Galaxy Browser opens and displays the Graphic Toolbox.

3. Select the Graphic Toolbox symbol from the navigation pane that you want to link to the template.
4. Rename the graphic in the Details pane of the Object Editor. This name applies only to the current
object. You can also add a description of the symbol (optional).
5. Select the Edit symbol button. The Graphic Editor will open in a new window.
6. Select the Graphic Editor window and edit the symbol as needed.
7. Save the symbol and close the Graphic Editor. When you save the GTB symbol, changes will be
reflected in every object to which the symbol is linked, including child objects.
8. To associate the symbol with an Object Wizard Choic e or Option, see Associate Content with a
Choic e or Option on page 187.

Configure Instances
You can use the IDE to configure instances from a template with an Object Wizard, or you can
graphically creat e instances using an editor that is started from the Graphic Editor. If you are using
InTouch OMI for your run-time environment, you can also access the editor through the ViewApp Editor
or Layout Editor. See the InTouch OMI online help for more information about these editors.
 From the IDE, the Object Wizard presents a series of prompts or questions, from which you select an
answer to build a representation of a piece of field equipment, such as a pump, valve, PLC, etc.
 If you are using the Graphic Editor or one of the InTouch OMI editors, select a symbol from the
Toolbox tab and drag it onto an overview symbol. See Create a New Instanc e with the Configure
New Asset Editor on page 246 for more information.

Configure an Instance
To configure an instance using an Object Wizard in the IDE:

242
Configure Objects with an Object Wizard Application Server User Guide

1. In the IDE, open the instance you need to configure.

 To create and configure a new instance:
Select the template you want to use, and derive an instance from it. Then, open the instance.
See Create an Instance on page 95 for additional information.
 To change the configuration of an existing instance:
Select the instance you want to use and open it. See Create an Instance on page 95 for
additional information.
2. Start at the top of the Choice s and Options pane. Either select a Choice from the first Choice
Group, or select/deselect the first Option as needed to match the physical asset you are modeling.
Depending on the selections you make, attributes associated with the Choic e or Option may appear
in the Attribute s pane.
 If you change from the default Choice, the override is indicated by an X and the override is
shown in bold type.
 If you change the default state of an Option (selected or not selected), the override is indicated
by an X.
 You can restore a default setting by clearing the X.
3. If an associated attribute contains configurable settings, these are listed in the Settings pane.
Overrides are also indic ated by an X next to the changed setting and are indicat ed by bold type.

4. Continue sequentially down the list of Choices and Options.

5. Save and close the instance, and then deploy it.

View and Configure Symbols

To view and configure symbols associated with an Object Wizard:
1. Select the symbol from the Symbol s pane.

243
Application Server User Guide Configure Objects with an Object Wizard

2. Open the symbol by selecting the Edit button, or by double clicking on the symbol.

3. The Graphic Editor opens.

 If the symbol is inherited, it opens as read -only.
 If the symbol is a Graphic Toolbox templat e, it opens as read-only.
 You can only configure symbols that have been created for the object (object -owned).

4. Configure Symbol Wizard settings and custom property settings as needed.

5. Save and close the Graphic Editor.

244
Configure Objects with an Object Wizard Application Server User Guide

See the Application Server User Guide, "Creating and Work ing with Content on page 157," for additional
information about working with symbols.

Guidelines for Configuring Instances with an Object Wizard

Keep in mind the following behaviors and guidelines when you use an Object Wiz ard to configure
instances:
 Start at the top, with the first item of the Object Wizard.
 The answers you provide to eac h prompt may cause subsequent prompts to change. Therefore, if
you skip selecting a choice or option, the subs equent selections you mak e could be changed or
removed when you return to select a skipped step.
 Some prompts could be added or removed, based on the answers provided to previous prompts.
 If an attribute or symbol is associated with a selected Choice or Option, you may have the option to
override cert ain settings.

Override Default Settings

When you override a default attribute or symbol setting in the Object Wizard, the override is marked by
an X, and the setting and its description are displayed in bold.

245
Application Server User Guide Configure Objects with an Object Wizard

Settings can be different types, including Boolean, integer, string, etc. Settings can be used to turn on or
off a feature for the object, such as I/O, Historization, or Alarms. Changing one setting can cause other
settings to be shown or hidden.

Create a New Instance with the Configure New Asset Editor

Note: You can add an asset configured from an object wizard with a linked symbol wizard directly to
InTouch OMI pane. However, adding an asset configured from an object wizard with a linked symbol
wizard to an InTouch HMI window is not supported. With InTouch HMI, the derived symbol must be
contained in an overview symbol.
The following information is applicable to both InTouch OMI and InTouch HMI.

The Configure New Asset editor lets you quickly and easily add and configure new instances (assets)
and symbols from any template that contains an Object Wizard and at least one graphic. The editor also
lets you configure symbol wizard and custom property settings, if applicable to the symbol you select.
With this editor, you do not need to use the Arche strA IDE to configure object properties, or spend a lot
of time configuring symbol properties in the Graphic Editor.
To start the Configure New Asset editor:

246
Configure Objects with an Object Wizard Application Server User Guide

1. Select a new or existing symbol in the Graphic Toolbox. The Graphic Editor opens.

2. If necessary, use the arrow keys until the Templates tab is shown, then select it.

3. Navigate to the template you want to use. The template you select must contain at least one symbol.

247
Application Server User Guide Configure Objects with an Object Wizard

4. Select the symbol you want to use from the template and drag it onto the canvas.

5. As soon as you drop the image ont o the canvas, the Configure New Asse t editor opens to the
Select Object Options page.

Under Asset Properties (left column) edit the following entries:

o Instance Name (name of the new asset). The Instanc e Name is the same as the object tag
name. Each Instance Name must be unique within the selected Parent Area.
o Description (a description of the new instance).
o Parent Area (select the appropriate parent area for the new instance).
o Configure the Object Options (center column).

248
Configure Objects with an Object Wizard Application Server User Guide

o Configure the properties listed under Refine (right column), then click Next.
Object options determine which graphic options can be used. Only the applicable symbol (or
symbols) will be available. For example, if an object includes options that allow it to be configured as
a pump or as a conveyor belt, you will not be able to add a pump graphic if you have selected a
conveyor belt asset on the Object Options page.
See About Object Options on page 250 for additional information.
6. The Select Select Graphic Options page options. If more than one symbol is displayed, select the
one you want to use, then configure its graphic options. Click Finish when you are done.

Graphics options are symbol wizard options. Select the symbol wizard options applicable to the
asset you are adding to the overview symbol. Once you select the graphic options, you can configure
any applicable custom properties.
7. After you click Finish, the Configure New Asset editor closes. Adjust the size and position of the
symbol on the Graphic Editor canvas as needed. Add additional symbols and graphics as needed.
8. When you have finis hed adding symbols and other edits, select Save and Close to exit from the
Graphic Editor.

249
Application Server User Guide Configure Objects with an Object Wizard

About Object Options

The Select Object Options page consists of three columns for Asset Propertie s, configuration
(Configure), and settings (Refine).

The Asset Propertie s column contains settings for:

 Instance name (what the instance will be named within the Galaxy). The instance name is the
object's tagname, and can be up to 32 alphanumeric characters, with at least one letter and no
spaces. $ cannot be used as the first character.
 Description (of the instance). There are no restrictions on the length or characters in the description.
 Parent area: This is a drop-down selection that lets you move t he instance to the appropriate area of
the Galaxy.
The Configure column contains object property selections, arranged as a series of prompts with
drop-down answers. Start at the top and work down to the end. As you make selections, additional
prompts may appear in the Configure area (always below the current prompt).
The Refine column contains additional settings that you can set. Typically, the settings will include things
like upper and lower limits for scaling and alarms, on/off settings, or other items that further define
settings that were selected in the Configure column. Some configurations do not contain any settings
under the Refine column.

250
Configure Objects with an Object Wizard Application Server User Guide

About Graphic Options

The Select Graphic Options page consists of three columns for Available Graphics, Graphic
Options, and Custom Properties.

The Available Graphics column displays the symbol or symbols that are associated with the object as
configured on the Select Object Options page. If more t han one symbol is displayed, select the one you
want to use. Only one graphic can be selected for eac h asset you configure.
The Graphic Options column cont ains symbol wizard configuration selections that apply to the symbol.
Typically, these are used to control things like orientation of the symbol, whether or not it has a visible
label, to add alarm borders, etc.
The Custom Propertie s column contains additional refinements to set parameters for the symbol. This
includes items like alarm limits and priority levels.

251
Application Server User Guide Configure Objects with an Object Wizard

Add a Configured Asset to a Symbol

1. To add a symbol from a configured instanc e, select the Assets tab in the Graphic Editor.

2. Navigate to the asset you want to add to the open symbol., and drag it onto the canvas.
3. Adjust the size and position of the symbol on the Graphic Editor canvas as needed. Add additional
symbols and graphics as needed.
4. When you have finis hed adding symbols and other edits, select Save and Close to exit from the
Graphic Editor.

Note: InTouch HMI does not support adding a symbol derived from a symbol wizard linked to an object
wizard directly onto an InTouch window. The symbol must be contained in an overview symbol.

252
 Application Server User Guide

C HAPTER 7
Deploying and Running an Application
You can deploy and test your objects at any time during development. When you are ready to test or run
the application in production, you deploy the Galaxy.
You can see what your application looks like in the Deployment view or t he Model view. B oth views show
you the structure of your application. For more information, see IDE Application Views on page 27.
A simulation server, derived from the $OPCClient Device Integration system object, is included with
Galaxies created from the Default.cab file. The simulator can be imported to or created for other
Galaxies. Use the simulator to test a Galaxy prior to deployment.
When you create a Galaxy from the Default.cab file, the Gal axy's assets are automatically assigned to
the simulator's Fast scan group. When you have completed testing and created new Device Integration
objects, move the assets from the simulator to scan groups within the new DI objects.

In This Chapter
Deployment Overview ................................................................................................................. 253
Object, Area, Engine, and Platform Assignments .......................................................................... 255
Data Integration Objects.............................................................................................................. 257
Auto-Build .................................................................................................................................. 257
Determining Galaxy Status .......................................................................................................... 258
Configuring Advanced Communication Management .................................................................... 258
Simulation Server ....................................................................................................................... 262
Deploying Objects....................................................................................................................... 267
Redeploying Objects ................................................................................................................... 270
Undeploying Objects ................................................................................................................... 272
Uploading Run-time Configuration ............................................................................................... 273
Associating All Galaxy Graphics with an InTouchViewApp............................................................. 274

Deployment Overview
The deployment process copies a Project's assets from the development environment to the run -time
environment. Once they are deployed, your assets are "live" and functional.
Configuration changes do not appear in the run-time environment until the changes are deployed.
You must have the appropriate level of permissions to deploy assets.
To view your permissions
1. Select the Galaxy menu from the ArchestrA IDE toolbar.
2. Select Configure > Security.

253
Application Server User Guide Deploying and Running an Application

3. Go the Roles page. Deployment permissions are listed under General permissions.

To deploy an asset from the ArchestrA IDE

1. Highlight the asset or assets you want to deploy in the Deployment or Model view.
2. Select the Object menu from the toolbar
3. Select Deploy...

Deploying Objects from the IDE to Run Time

Objects deploy from the configuration environment to the run -time environment as follows:

IDE Object Viewer

Config Environment Run-Time Environment

Galaxy database  [Does not exist in run-time environment]

Templat es  [Does not exist in run-time environment]
Instance objects  Instance objects [Run-time configuration and behavior]
Security: General permissions  [Does not exist in run-time environment]
Security: Operational  Run-time permissions to acknowledge alarms and
permissions modify attributes
Scripts configuration  Scripts execution

Alarms configuration  Alarms generate and acknowledge

254
Deploying and Running an Application Application Server User Guide

IDE Object Viewer

Config Environment Run-Time Environment

History configuration  History Logs

[Wonderware Historian]

Allocating Run-time Resources

Distribute components across plat forms and engines as you develop your IDE configuration
environment. This will help to balance the I/O, memory, and CP U burden across computing resources at
run time.
The operating system determines engine assignment to individual CP U cores, and attempts to load
balance across CPU and other computing resources. If you need to change how resources are allocated
to improve load balancing, undeploy the objects and reassign them in the IDE configuration environment.
If you are using redundant AppE ngines, you can control how objects are loaded at runtime. For more
information, see CP U Load Balancing on page 473.

Allocating Galaxy Repository Node Memory

The Galaxy database resides on SQL Server, which runs on the Galaxy Repository (GR) node. In some
cases, particularly when a GR node contains less than the recommended RAM amount, system
performance may be impacted as SQL Server will use more CPU to compensat e for the lower amount of
available memory. In some cases, high CPU usage can even occur on systems configured with the
recommended RAM amount. A galaxy with many objects, for example, can use more memory and cause
high CPU usage.
If you notice CP U usage increasing over time to the point that is affecting system performance, we
recommend that you set the SQL Server minimum memory (min server memory) to 1/3 of total physical
memory. Application Server aut omatically configures the max server memory setting, and there is no
need to manually configure it.
Example minimum server memory settings:

Application Level Installed RAM (GB) min server mem (MB)

Minimum 2 GB 682 MB
Sm all
(1 - 25K I/O per Node)
Recommended 4 GB 1365 MB

Minimum 8 GB 2730 MB
Medium
(25k - 50k I/O per Node)
Recommended 12 GB 4096 MB

Minimum 16 GB 5461 MB
Large
(> 50k I/O per Node) Recommended 24 GB 8192 MB

Object, Area, Engine, and Platform Assignments

IDE Overview on page 17 shows the basic Galaxy structure. When you create an application object,
such as a User Defined Object, it must be assigned to an area. When you look at your objects in the
Deployment View on page 31, an area is assigned to an AppE ngine, and an AppEngine is assigned to a
WinPlatform.

255
Application Server User Guide Deploying and Running an Application

The Deployment view uses the WinPlatform as its foundation, and all objects cascade from the
WinPlatform object. The WinPlatform object can be thought of as the node (computer) that hosts the rest
of the objects. The basic hierarchy of objects in the Deployment view is:

Galaxy > WinPlatform > AppEngine > Area > Application Object
DI Object

Data Integration (DI) Objects provide the interface between application objects and PLCs in the physical
environment. DI Objects contain scan groups, and application objects are assigned to scan groups; this
assignment can be done in the IO Device s view.
The relations hip of other objects in the Galaxy to DI Objects is most clearly viewed in the IO Device s
view. All IO bet ween objects in the Galaxy and the PLC is through a DI Object. Scan groups are
configured in the DI Object, and objects are assigned to a scan group.
Galaxy > DI Object > Scan Group > AppEngines
Areas
Application Objects

256
Deploying and Running an Application Application Server User Guide

While objects can be deploy ed from any IDE view, the Deployment view provides the simplest way to
understand the object hierarchy during deployment. The IO Device s view provides the simplest view of
the relationship of each scan group and its assigned objects.

Data Integration Objects

Data Integration Objects (DI Objects) provide the interface bet ween PLCs and Galaxy objects, including
area objects and application objects. DI Objects contain scan groups (topics); application objects a re
assigned to individual scan groups to handle IO between the objects and the PLC.

Auto-Build
Refer to Using Auto-Build in the Wonderware OI Core Communications Driver Help for information
about the Auto-B uild process. Key points to remember include:
 Specify a new Galaxy as the target Galaxy until you are familiar with how Auto-Build works. This will
help to avoid accidentally overwriting objects.
 Always specify a prefix. This will also help you avoid overwriting object s and lets you differentiate
between similarly-named controllers.
 Use pre-check validation to catch illegal object names, such as names that exceed the maximum
number of characters and that contain illegal characters. Note that Auto -Build skips names wit h
errors .

257
Application Server User Guide Deploying and Running an Application

 You can only run one Auto-Build process at a time.

 Auto-Build add two levels of derivation to accommodate different layers of standardization, for
example, corporate standards (global) and local standards.
Auto-Build creates a DI Object for you. The DI Object is derived from the $DDES uiteLink Client template,
and will include the two character prefix that you specify (first character must be alphabetic, the second
character can be a letter or number (alphanumeric). The DI Object must include at least one scan group
(topic).
The Auto-Build process adds the prefix that you specified to all objects it captures. After Auto -Build
completes, you can view, test, and adjust object assignments as needed, using the diff erent IDE views.
 Use the Deployment view to modify object assignments.
 Use the IO Device s view to modify scan group assignments.
 Use the IO Device Mappings view to verify and test IO references.

Determining Galaxy Status

You can see an overview of the condition of your Galaxy before you deploy. This lets you know if you
have objects that are in warning or error status.
To determine the status of a Galaxy
1. Connect to the Galaxy.
2. On the Galaxy menu, click Galaxy Status. The Galaxy Status dialog box appears.

The Galaxy Status dialog box shows the counts of total instances, total templat es, deployed
instances with changes, undeployed instances with changes, objects that have an error or warning
state, objects that are checked out, and object you have checked out.
3. Click OK.

Configuring Advanced Communication Management

Advanced Communications Management minimizes net work traffic and CP U usage of a DI Object and
DAServer when a particular DI attribute is currently subscribed to, but its value is not currently shown.
For example, scanning for updated values from a DI attribute representing pump RPM is suspended
when an operator minimizes the application window containing a pump graphic containing attribute
references that subscribe to the DI Object’s pump RPM attributes.

258
Deploying and Running an Application Application Server User Guide

Note: This dependence on the attribute being referenced by a running application is only the case when
the attribute subscription is not already active due to configuration for history, alarming, or scripting. For
example, if an attribute is configured for history, the subscription to the field device will always be active
regardless of what window is active in InTouch, and regardless of whether InTouch is running at all.

When the items on the current window are no longer active because the window is minimized, a Suspend
operation is performed for each item. Suspending scanning caus es data updates to stop flowing to the
application without deleting the subscriptions for each item. This reduces the overhead of unsubscribing
and subscribing again to items when windows are minimized and restored.
In Advanced Communication Management, applications monitor the number of outstanding references
to attributes that are updated with values from an external source object. When an attribute’s external
reference count reaches zero, the application sends a Suspend message to the s ource object requesting
it to suspend updates. For example, a UserDefined object named PumpRPM has an attribute named
RPM, which has an integer data type. The input source of RPM is plc1.n7:11, where plc1 is an ABPLC DI
object.
When there are no active subscriptions to ud1. RPM, the subscription between input source and
PumpRPM is suspended. When a client like ObjectViewer or a managed application running in
WindowViewer subscribes to ud1. RPM, an Activate message is sent to the DI object to start sending
data bet ween the plc1 object and the PumpRPM object. This enables ObjectViewer or a managed client
application running in WindowViewer to receive current plc1 dat a.
Unlike defined static attributes, some scan groups contain dynamic attributes. Dynamic attributes within
a scan group provide the means for a running application’s objects to dynamically subscribe to data from
an external device. Dynamic attributes are created, activated and added to the scan group usi ng
ArchestrA object attributes or InTouch indirect tags and scripts that include the IOS etRemoteReferences
function.
When a dynamic attribute is poked, the time stamp is updated to the timestamp passed in with the value
if available, or the current time provided by the hosting AppEngine is used. If the data provider passes in
a Value, Time, Quality (VTQ) triplet of data in the callback, the time stamp is associated with the value
and quality used to update the attribute.
To enable Advanced Communication Man agement, you must:
 Select Advanced Communication Management for your Galaxy.
 Set the scan mode for each scan group that belongs to your device integration objects within the
Galaxy.

259
Application Server User Guide Deploying and Running an Application

Selecting Advanced Communication Management

Advanced Communication Management is a Galaxy -wide configuration setting that you set from the
ArchestrA IDE. Advanced Communication Management is disabled by default.
When upgrading a Galaxy or restoring a Galaxy from a .cab file, the configuration setting that was
previously selected is retained.
To configure Advanced Communication Management
1. Connect to the Galaxy.
2. On the Galaxy menu, click Configure and then click Communications Management. The
Configure Communications Management dialog box appears.

3. If necessary, select Enable advanced communication management and click OK.

Note: Any deployed plat form and application engines must be restarted when the Advanced
Communication Management state changes. Restarting should be done by means of the SMC.

Configuring Scan Modes

A scan group is a collection of object attributes with associated data items. Scan group attributes reflect
I/O points in the address space of Dat a Access Server whos e values are polled from devices at a
common update interval. The update interval for each scan group is inherit ed from the scan groups
configured in the source DIObjects.
You can configure scan groups for OP CClient, InTouc hProxy, DDES uiteLink Client, and
RedundantDIObject device integration objects. Within each scan group, you can specify data items to
use as the object attributes. At run time, scan group items are updated with the latest values from the
OPC DAServer according to the updat e interval.
The OP CClient, RedundantDI, DDES uiteLinkClient, and InTouchProxy objects contain a Scan Mode
attribute that can be set for each scan group. The assigned scan mode value determines if objects are
continuously updated wit h current data when an operator minimizes or closes the application window.
You can assign three different scan modes to a scan group:
 Acti ve
o Items are deleted and added to the scan group as requested (referenced) by the clients.
o Items that exist when a scan mode change occurs are not deleted unless the previous mode was
ActiveAll and the items are no longer referenced.
o The Active scan mode polls all points that are referenced, whether active or inactive.
o In Active scan mode an attribut e is always in the active state. When the last reference to the
attribute is unregistered/ unadvis ed, the attribute is deleted.

260
Deploying and Running an Application Application Server User Guide

 Acti veAll
o Scanning is continuous and dynamic attributes are never removed when unsubscribed.
o Items are activated by client requests, but continue to exist even after the client are not
interested in them anymore.
o Items are not removed when the scan mode changes.
o The scan group polls the field devic e for all points irrespective of whether they are currently
active, inactive, or even subscribed to by items.
 Acti veOnDemand
o When the scan mode is configured as ActiveOnDemand, attributes that are not actively being
referenced by any client or object are made Inactive and are not scanned.
o New Items are deleted and added to the scan group as requested (referenced) by clients.
o Items that exist when a scan mode change occurs are not deleted unless the previous mode was
ActiveAll and the items are no longer referenced.
o ActiveOnDemand scan mode polls the field device for currently active items only. Inactive items
are not scanned.
The following table shows scan mode scan states for dynamic attributes based on whether items are
referenced or not.

Scan Mode Scan Mode Scan Mode

Dynamic Attribute State Acti ve Acti veAll Acti veOnDemand

Referenc e/ Some active Scan Scan Scan

Referenc e/All Inactive Scan Scan No Scan

Not Referenced Delet e Scan Delet e

To set a scan mode for a scan group

1. Edit the devic e integration object.
2. Show the editor page containing scan groups by completing one of the following:
 Click the Scan Group tab if you are editing a RedundantDIObject or OPCClient object.
 Click the Topic tab if your are editing a DDESuiteLinkClient object.
 Click the Items Configuration tab if your are editing an InTouc hProxy object.

3. If necessary, add a scan group by clicking the plus sign box above the list of available scan groups.

261
Application Server User Guide Deploying and Running an Application

4. If necessary, set the length of the scan group update interval in milliseconds. The default updat e
interval is 500.
5. Double-click in the Scan Mode box of the scan group to show a drop -down list of available scan
modes. ActiveOnDemand is the default scan mode.
6. Select a scan mode from the list.
7. Save your changes to the devic e integration object and exit from the edit or.

Simulation Server
System Platform includes a simulated dat a access server that lets you develop and test a Galaxy before
deploying it to your production environment.
The simulation server's hierarchy can be viewed in the Operations Integration Server Manager, within
the System Platform Management Console (SMC). To run the SMC, from the Start menu, point to
Wonderware Utilities and select System Platform Management Console .

The simulation server is automatically installed on the Galaxy Repository node for Galaxies derived from
the Default.cab file, and is always available. It mimics the data output from a PLC. The simulation server
sends data to attributes of instances configured for I/O Automatic Assignment in your Galaxy, the same
way that a PLC would.
The simulation server contains all the system objects needed to create a functional test environment for
testing I/O references that use I/O Automatic Assignment. However, some manual configuration is
required before the simulation server can be used. The simulation server includes an Operations
Integration server and a PLC simulator.
The simulation server is based on an OPC client device integration (DI) object. You can add it to Galaxies
that do not contain it by default. If you need to add the simulation server, you will configure it the same
way as you would an OPC client in a normal production environment. Required configuration steps
include choosing the server node and server name, and adding scan groups. This process i s described
in more detail below.
In its default configuration, the simulation server consists of the following elements:
 A channel for OPC communications between your Galaxy and the simulation server. The
communications channel has the default name "Port."

262
Deploying and Running an Application Application Server User Guide

 A PLC simulator to generat e simulated data for your Galaxy. The PLC simulator has the default
name "PLC."
 A device integration (DI) object that is used to link the PLC simulator to the instances in your Galaxy
(OI.Sim.1).

Simulation Server and the OPCClient Object

The simulation server uses the OPCClient object as its basis. If your Galaxy does not include the
simulation server object, you can configure one from the $OPCClient template. The OPCClient object
can be used with the I/O Auto Assignment feature. In simulated environments, application objects in your
Galaxy that contain I/O references are link ed with the simulation server. In a production environment,
these references would be linked to actual PLCs.
To use the simulation server, you must link instances to one of the simulation server's scan groups in the
IO Devices view (the default scan group is Fast). The simulation server will return integer values for all
supported data types. See View Simulated Data on page 265 for the list of supported data types.
When you view simulated run-time data, a snap shot value is provided for each attribute t hat has I/O Auto
Assignment. Since the simulation server tests I/O Auto Assignment references, references verified as
good with the simulation server will automatically reconfigure when you associate the instances with the
appropriate DI object and deploy the Galaxy in your actual environment.

I/O Auto Assignment in the Simulation Server

When using the I/O Auto Assignment feature, the simulation server us es the normal names pace used by
I/O Auto Assignment, that is:
<IODeviceName>.<ScanGroupName>.<ObjectName>.<AttributeName>
You can view I/O assignments for objects in the I/O Device Mapping View . For objects configured with
the simulation server and assigned to a Scan Group, the device and scan group for the I/O res ulting
reference will map as follows:
<IODeviceName> = Simulator

263
Application Server User Guide Deploying and Running an Application

<ScanGroupName> = Fast, Medium, or Slow

The IO Device name for the simulation server must not be changed from its default name, Simulator.
You assign application objects (instances) to the simulator server's scan groups the same way as you
would assign instanc es to an I/O device's scan groups. The default scan group is Fast.

Configure the Simulation Server

The Simulation S erver is automatically installed and configured for Galaxies derived from t he Default.cab
file. You can create a simulator server for Galaxies derived from other cab files that contain the
$OPCClient base template, such as the Default_EMP TY.cab, or you can import the $OP CClient object
after exporting it from another Galaxy.
To configure a new Simulation Server
1. Derive an instance from the $OPCClient object in the Template Toolbox.
2. Rename the new OPCClient instance Simulator.
3. Open Simulator in Object Editor and configure it as follows:
 General page:
a. Enter the Server node name.

264
Deploying and Running an Application Application Server User Guide

b. Select OI.Sim.1 for Server name.

 Scan Group page:

c. Add a scan group called Fast.
d. If desired, you can also add Medium and Slow scan groups. You can leave Update Interval and
Scan Mode at their default settings.

4. Save and close Simulator.

View Simulated Data

Before you can view simulat ed run-time data, your Galaxy:
 Must contain attribut es that are configured to use I/O Auto Assignment.
 Must be deployed along with the Simulator and any instances with I/ O Auto Assignment. If
necessary, you can link instances to the simulator server in the IO Device s view.

265
Application Server User Guide Deploying and Running an Application

Note: When instances are created, they are assigned to the Simulator Fast scan group by default.
To change the scan group assignment of an asset, you must undeploy the inst ance first.

To connect to the Simulation Server

1. In the IO Device Mapping view , select the Validate Reference(s) button. The simulation server
generates simulated numeric data and displays a randomly generated number for attributes that
contain valid input references. Validated references are shown with a green background.
Referenc es that did not validat e are shown with a red background.
2. To refresh the simulated run-time value, select the Validate Reference(s) button again.

Supported Data Types

The simulation server supports the following data types:
 Boolean
 Integer
 Float
 Double
 String
 Time
 ElapsedTime
 InternationalizedString
All supported dat a types are treated as integer and return integer data for validated references.

Unknown Data Types

The simulation server treats attributes with unknown types as integer.

266
Deploying and Running an Application Application Server User Guide

Deploying Objects
You deploy object instances for two reasons:
 Testing.
 Placing the application into production to process field data.
When you are ready to deploy, make sure the following conditions are met:
 Bootstrap software is installed on the target computers.
 The objects being deployed are not in an error state in the Galaxy database.
 You creat ed, configured, and checked in objects to the Galaxy.
 Objects are assigned to a host.
 The object's host is already deployed. A cascade deploy operation, which deploys a hierarchy of
objects, deploys all objects in the correct order. This deploys an object’s host before the object is
deployed.
 Any associated script libraries are ready for use on the target computer. For more information, see
Importing Script Function Libraries on page 105.

Note: DINet work objects have specific configuration limits. For example, whether more than one object
can be deployed to a single WinPlatform. The IDE does not check for these limits. For more information,
see the help file for the DINetwork object for specifics on configuration limits.

You can tell if you have objects that need to be deployed by looking at the icons next to the objects.
Deployment status icons include:

Not deployed

Deployed

Deployed, but pending configuration changes exist that have not been deploy ed.

Deployed, but software modifications exist that have not been deployed.

Applies only to redundant AppEngines. An AppEngine is undeploy ed, but its

redundant pair is deployed.

Applies only to redundant AppEngines. An AppEngine is deployed, but its redundant

pair is not deployed.
Applies only to redundant AppEngines. An AppEngine is deployed, its redundant pair
is not deployed, and pending configuration changes exist that have not been
deployed.

Applies only to redundant AppEngines. An AppEngine is deployed, its redundant pair

is not deployed, and software modifications exist that have not been deployed.

[No icon] Good. No additional icon is displayed for deployed objects running on-scan or off-scan
with a good status.

267
Application Server User Guide Deploying and Running an Application

Warning

Error. The object in an Error state and cannot be deployed.

InTouchViewApp application files are being asynchronously trans ferred to the target
node. This icon is normally visible for only a few moments at the end of an
InTouchViewApp deployment operation, unless the object is deployed on a slow
network.
This icon is larger than the other icons and completely replaces the original while it is
being shown.

To deploy objects
1. Select the objects you want to deploy in an Application view.
2. On the Object menu, click Deploy. The Deploy dialog box appears.

3. Select one or more of the following:

 Cascade Deploy: Select this check box to deploy the object selected for deployment as wel l as
any objects it hosts. This option is selected by default if the object is a host. If you are deploying
an individual host object, clear the check box. Objects being deployed across multiple plat forms
are deployed in parallel.
 Include Redundant Partner: Select this check box to also deploy an AppE ngine’s redundancy
partner object. This option is selected and unavailable when the redundant engine has pending
configuration changes or software updates.
4. In the Currently deployed objects area, select one or more of the following options. These options
are not available if the selected object has not been deployed before.
 Skip: If one of the objects you are deploying is currently deployed, selecting Skip makes no
changes to the already-deployed object.
 Deploy Change s: If one of the objects you are deploying is currently deployed, this option
updates the object in question new configuration data. If you are redeploying an object, it is
updated with new run-time data or new configuration data, depending on whet her a change was
made to a configured value, to a run-time value, and whether or not the Preserve Runtime
Changes option is selected.

268
Deploying and Running an Application Application Server User Guide

– If both Deploy Changes and the Preserve Runtime Changes option are selected, values
changed during run time are loaded as the object is redeployed. The new run-time value is
used, even if you configure a new value in the IDE.
– If Deploy Change s is selected but the the Pre serve Runtime Changes option is NOT
selected, new configured values set in the IDE are used, and will ove rwrite any changes
made during run time.
 Redeploy Original: If one of the objects you are deploying is currently deployed, this option
deploys the same version as previously deployed. For example, use this option to redeploy an
object that is corrupt ed on the target computer. If the Pre serve Runtime Changes option is
selected, the object is deployed wit h the last run time value, even if you change the configured
value in the IDE.
 Force Off Scan: If one of the objects you are deploying is currently deployed, this option s ets the
target object to off scan before deployment occurs.
 Preserve Runtime Changes: Selecting this option will produce different results, depending on
whet her you have chosen Deploy Changes or Deploy Original, if values were changed at run
time, and if configuration values were changed in the IDE.
– If a value was changed in run time and Deploy Change s and this option are checked, the
object is deployed with the last run time value, even if you change the configured value in the
IDE.
– If a value was not changed during run time and Deploy Change s and this option are
checked, the object is deployed wit h the last configured value from the IDE.
– If a value was changed in run time and Redeploy Original and this option are checked, the
object is deployed with the last run time value, even if you change the configured value in the
IDE.
– If a value was not changed during run time and Redeploy Original and this option are
checked, the object is deployed wit h the original configured value from the I DE. If you
configured a new value in the IDE, the prior configured value is used.
5. In the Currently undeployed objects area, select the Deploy New Objects check box to start a
normal deployment.
6. In the Deploy Status Mi smatch area, select the Mark as Deployed check box to mark the object as
deployed in the Galaxy. A mismatch happens when the object is previously deployed to a target
node, but the Galaxy shows the object is undeployed. Clear this option to redeploy the object to the
target node.
7. In the Initial Scan State area, select one of the following:
 On Scan: Sets the initial scan state to on scan for the objects you are deploying. If the host of the
object you are deploying is currently off scan, this setting is ignored and the object is
automatically deployed off scan. When you are deploying multiple objects, the deploy operation
deploys all of the selected objects "off-scan." After all of the objects are deployed, the system
sets the scan-state to "on-scan."
Objects can run only when both the host/engine is "on scan" and the object is "on scan." If either
the host/engine or the object is "off scan," the object cannot run.
Always deploy Areas to their host AppEngines on scan. Because Areas are the primary
providers to alarm clients, deploying Areas off scan results in alarms and events not being
reported until they are placed on scan.
 Off Scan: Sets the initial scan state to off scan for the objects you are deploying. If you deploy
objects off scan, you must use the ArchestrA System Management Console Plat form Manager
utility to put those objects on scan and to function properly in the run-time environment.

269
Application Server User Guide Deploying and Running an Application

Note: The System Management Console cont rols the state of the host/engine. The
ObjectViewer controls the state of th e objects.

The default scan setting is set in the User Default settings in the Configure User Information
dialog box. For more information, see Configure User Information on page 37.
8. Click OK to deploy the objects. The Deploy progress box appears. If you see error messages, see
Deployment Error Messages on page 270. When the deploy is complete, click Close.

Deployment Error Messages

If the object being deployed has configuration problems that were not known during configuration, the
Deploy progress box shows messages.
The Progre ss dialog box also shows the affected instanc es and any error and warning messages. The
target object can take any actions necessary to achieve a valid state, including changing attribut e values
provided during deployment.
WinPlatforms are the only objects whose configuration designat es its deployment location. Deployment
problems unique to WinPlatforms are the following:
 The target computer could not be found on the network. Ensure the WinPlatform was configured
properly and the target computer is properly connected to your network.
 Another WinPlatform is deployed already to the target computer. Resolve this problem by
undeploying the existing WinPlat form before deploying the new one.
 The target plat form is running on the old version of the product. To resolve this problem, the user
must upgrade the remote platform.
 If a WinPlat form object is deployed on a slow net work and it does not respond to the IDE before the
30-second message time-out, a communication error occurs and the object is shown as not
deployed. You may need to adjust the message time-out for t he WinPlat form object to accommodate
the slow net work speed.

Publishing Managed InTouch Applications

You can publish a managed InTouch application using the ArchestrA IDE. As part of this process, you
can create a compressed, self-extracting package file that contains all relevant files and set-up
procedures to install an InTouch application on another computer. For more information, see the InTouch
HMI Application Management and Extension Guide.

Redeploying Objects
Updating assets that are already deployed requires a redeployment of the asset. Redeploying an asset
or a group of hierarc hical assets can be done almost seamlessly, with very little downtime. When you
redeploy an asset, a maximum of t wo scan cycles are ne eded bet ween the time the existing asset
configuration is undeployed and the asset with new configuration information is deployed in its place
(typically, less than one second). This redeployment work flow provides two important benefits:
 Minimized downtime. While an asset is down, it does not provide status updates and does not
respond to scripts or commands.
 Reduced points of failure. The existing configuration remains in effect until the new configuration is
available.

270
Deploying and Running an Application Application Server User Guide

This minimal downtime needed to redeploy assets ensures that uptime is maximized and the impact on
operations is minimized. To ensure against a deployment failure due to communications or other error,
the existing asset configuration remains deployed and onscan until the n ew configuration has been
successfully deployed. Therefore, if a redeploy attempt fails for any reas on, operations are not affected,
as the existing configuration remains available within the production environment. The asset is not
stopped or taken offscan until the new configuration replaces it. Since less than two scan cycles are
needed for a redeploy operation, and this occurs only at the final stage of pushing out the new
configuration, there is little risk of adverse effect on operations.
 Redeploying assets follows the same workflow as deploying assets. See Deployment Overview on
page 253 for additional information. Redeployment occurs when you select and deploy the asset.
When assets with retentive attributes are redeployed, the Application Engine for the assets restores the
retentive attributes to the values previously set at run time, if the Preserve Runtime Changes option is
selected. See Deploying Objects on page 267 and Retentive Attribute Properties and Behavior on page
272 for additional information.
You may have an object with a Pending Update deployment state. The Pending Update state means the
object changed since it last deployment. When you deploy those changes, the new object is marked as
the last deployed version in the Galaxy.
To redeploy
1. On the Object menu, click Deploy.
2. Follow the procedure for Deploying Objects on page 267.

Redeploying the WinPlatform Object

You can redeploy a WinPlatform object without undeploying and redeploying the objects hosted on
WinPlatform. When you make changes to the WinPlatform object, you can propagate the changes by
redeploying WinPlatform alone, without taking AppEngines and other objects hosted on the WinPlatform
off-scan.
To redeploy a WinPlatform without redeploying hosted objects
1. Select the WinPlatform object on the Object menu that has updates pending, then select Deploy.
The Deploy dialog box appears.
2. Clear the Ca scade Deploy check box to prevent other hosted objects from being redeploy ed. By
default, the check box is selected.

Note: It is not necessary to redeploy hosted objects if you are uploading changes only to the
WinPlatform object.

3. In the Currently Deployed Objects area:

 Select the Deploy Change s option. This sends any configuration changes made in the IDE to
the objects being deployed.
 Select the Preserve Runtime Change s option if you want to save overrides to configured
settings that may have been made during run time. See Retentive Attribute Properties and
Behavior on page 272 for more information on preserving run -time changes.
For more information on deploying objects, see Deploying Objects on page 267.
4. Select OK. The Deploy progress box appears. If an error occurs during deployment, an erro r
message appears. For more information on error messages during deployment, see Deployment
Error Messages on page 270.

Important: The WinPlatform object will briefly shut down during the redeploy operation as
checkpoints are synchronized. However, AppEngines and other objects remain deployed.

5. Select Close when deployment is complete.

271
Application Server User Guide Deploying and Running an Application

Note: If the WinPlat form object hosts redundant AppEngines, the AppEngine may automatically fail
over if the failover timeout is detected by the standby engine.

Retentive Attribute Properties and Behavior

Some changes that are made to attributes at run time are automatically tracked and saved. Thes e
attributes are called "retentive attributes." Changes made at run time to retentive attribut es are
automatically retained. If an object with a retentive attribute is undeployed and subsequently redeployed
with the Pre serve Runtime Changes option selected in the Deploy dialog, the last run time value is
loaded int o the retentive attribute. If the Preserver Runtime Changes option is NOT selected, the object
is redeployed with its configured setting, not the value set during run time. See Deploying Objects on
page 267 for additional information.
Changes to retentive attributes are retained as long as the new attribute value is different than the
previous saved value, and data quality of the attribute is good. You do not have t o do anything to mark an
attribute as a retentive attribute. Attributes are automatically set to be retentive if all of the following are
true:
 The attribute is checkpointed.
 The attribute is User- or Object-Writeable.
 The attribute does not contain an input extension or input/output extension.
At every checkpoint period, the AppEngine looks for changes to retentive attributes on objects that it
hosts. A change made at run time to a retentive attribute is saved on the no de where the AppEngine is
running. When any of the retentive attributes associated with the AppEngine have been changed, the
changed values are loaded into memory. After several checkpoint periods have passed, the changed
values in memory are written to disk, and memory is cleared. In this way, only values that have changed
are retained. However, retentive attribute run time changes are not uploaded to the IDE. Therefore, if an
object that contains a retentive attribute is undeployed and moved to a different node or even to a
different AppEngine, the run time changes are not preserved when the object is redeployed.
For redundant pairs, changes will be preserved, even if the redundant partner is on a different engine or
node. If the value of a ret entive attribute changes and it is part of a redundant pair, the changed value will
be sent to the redundant partner during checkpoint synchronization, if the following are both true:
 Attribute data quality is good
 The new attribute value is different than the previ ous value

Undeploying Objects
You may need to undeploy one of more objects. Undeploying removes one or more objects from the
run-time environment.
Before you start, you need to select the object or objects you want to undeploy in the IDE.
Before you delet e or restore a Galaxy, undeploy all objects in the Galaxy.
Undeploying can fail if the target object has objects assigned to it. Make sure you select Ca scade
Undeploy in the Undeploy dialog box.
To undeploy
1. On the Object menu, click Undeploy. The Undeploy dialog box appears.
In the upper right of this dialog box, the Undeploy Object Count box shows the number of objects
being undeploy ed. You can select a single object in Application view and, if you selected Cascade
Undeploy and other objects are assigned to the selected object, the total number of objects appears
in this box.

272
Deploying and Running an Application Application Server User Guide

2. Select one or more of the following. Some of these options might not be available, depending on the
kinds of object you select.
 Cascade Undeploy: Select to undeploy the selected object as well as any objects it hosts.
 Include Redundant Partner: Select to also undeploy an AppEngine’s redundancy part ner
object.

Note: The AppE ngine in a redundant pair t hat was configured as the Primary can be undeployed
alone because objects hosted by it run on the deployed Backup AppEngine, which becomes
Active.

 Force Off Scan: If one of the objects you are undeploying is currently on scan, selecting Force
Off Scan sets the target object to off scan before undeployment. If you do not select Force Off
Scan and the target object is on scan, the undeployment operation fails.
 On Failure Mark as Undeployed: Marks the object as undeployed in the Galaxy when the
object targeted for undeployment is not found.

Uploading Run-time Configuration

You can upload run-time configuration changes to the Galaxy database. This lets you keep any attribute
values that changed during run time.

Note: A node cannot upload run-time changes to the Galaxy if the version of Application Server it is
running is older than the version running on the GR node.

Cert ain attribute values can be set in the configuration environment, but they can also change at run
time. As a result, the values of these attributes can differ between the run-time and configuration
environments. Thes e types of attribute writeability are:

 Calculat ed  Calculat ed Retentive

 Object Writeable  User Writeable
For example, you create an object with a User Writeable attribute called myInteger and specify an
initial value of 30 in the Object Editor.
Then you deploy the object. At run time, you write a new value to myInteger of 31. If you redeploy this
object, the original value of 30 overwrites any value assigned during run time. To avoid losing changes
made during run time, upload changes before redeploying an object.
Run-time configuration changes to auto assigned I/O referenc es are uploaded as overrides to the
original assignments. The I/O referenc e will continue to be auto assigned and the run -time changes are
retained when the object is redeployed. See Uploading Run-Time Configuration Changes for Auto
Assigned Objects on page 149 for additional information.
Objects whose configuration are successfully uploaded have a new version number and a change log
entry for the upload operation. The run-time object’s version number also has a new version number.
That version number matches the version in the configuration dat abase.
To upload run-time changes to the Galaxy
1. Select one or more objects in the Model view or Deployment view. For example, you could select an
entire hierarchy from AppEngine down.
2. On the Object menu, click Upload Runtime Changes. The run-time attributes of the selected
objects are copied over those in the Galaxy database.

273
Application Server User Guide Deploying and Running an Application

Uploading Restrictions
Cert ain run-time changes to the Galaxy cannot be uploaded. Before uploading changes, make sure the
selected objects are:
 Not checked out
 Not edited and checked in since last deployment or upload
 Not in Pending Update state
If you select an object that is currently checked out to you, a warning appears during run-time upload. If
you continue, you lose all configuration changes you made to the checked out object. The Galaxy
performs an Undo Check Out operation on it before the run-time attributes are copied to the Galaxy
database.

Note: You cannot upload run-time changes for objects checked out to other users.

Undeployment Situations
The following situations occur in these specified undeployment scenarios:
 After undeploying a WinPlatform, only the Bootstrap software remains on the target computer. All
other WinPlat forms are notified of the undeployment of the WinPlatform and stop trying to
communicate with it over the network.
 Alarm Clients know immediately that an area is undeployed and is no longer available. They remove
the area from selection lists. Alarms associated directly with the area (not as a result of containment)
are immediat ely removed from current alarm views.
 Undeploying an object that has Pending Updat es status removes that status. It is now marked as
undeploy ed.
 If cascade undeploy fails on one object, then the undeploy continues to the extent possible on ot he r
objects. The entire operation is not terminated because the undeploy fails for one object. However, a
host might not be undeployable if one of its assigned objects cannot be undeployed.
Assume an ApplicationObject is hosted by the Active AppEngine in a redundant pair and a number of
subscriptions is configured in that ApplicationObject that refers to items in a DIObject. If you undeploy the
ApplicationObject in question, the items are not removed immediately from the item count of the
DIObject. How fast those items are removed depends upon the value of the Maximum time to maintain
good quality after failure option (Redundancy.StandbyActivateTimeout attribute) on the Redundancy
page in the AppEngine’s editor. This behavior does not apply to the undeployment of ApplicationObjects
hosted by non-redundant AppEngines.

Associating All Galaxy Graphics with an InTouchViewApp

Associating all Galaxy graphics with an InTouc hViewA pp template enables deployed and published
InTouch applications to execute "show graphic" requests made of any graphic in the Galaxy without
having to embed them in the application.
 The ShowGraphic() function uses the graphic as a parameter. Associating all Galaxy graphics
ensures that the graphic is deployed and available at run time whether or not it is referenced by
InTouchViewApp.
 Associating all Galaxy graphics ensures that templat e symbols reference d by the ShowGraphic()
function are deployed and available at run time.

Note: The term "graphic" includes any symbol or client control present in the Graphic Toolbox, and any
symbols owned or inherited by templates and instances.

274
Deploying and Running an Application Application Server User Guide

About Associating All Galaxy Graphics with an InTouchViewApp

Associating all Galaxy graphics with an InTouc hViewA pp (ITVA) exhibits the following deployment and
publishing behavior:
 The associate all Galaxy graphics option—"Include all Galaxy graphics"—changes only the ITVA
template. The option is inherited by the template instances, and changes the template only if none of
its instances are deployed.
 A deployed ITVA wit h the "Include all Galaxy graphics" option enabled will be marked "pending
change" under the following scenarios

Scenario Operations Performed

Creating graphics Create new graphics in the graphics toolbox

Check in new symbol(s ) in an automation object
Import automation object with symbol(s)
Import graphics toolbox graphics
Create a new derived template or instance object that inherits
symbols
GR Load new symbols into the galaxy

Modifying graphics Edit and check-in symbol(s)

Modifying symbols through an Import operation
Modifying symbol localization through an Import operation

Deleting graphics Delet e graphics from the graphics toolbox

Check in an application object from which symbols have been
deleted
Delet e template or Instance object with symbols
Renaming Rename graphics in the graphics toolbox
graphics
Check in an application object, any of whose symbols have been
renamed

Rename object Rename Instanc e or Template which has owned or inherit ed

symbols
Object Cont ainment of automation objects that own or inherit graphics
containment
 Deploying an ITVA with the "Include all Galaxy graphics" option enabled for the first time will deploy
all checked-in graphics in the Galaxy. Client controls will be deployed whether or not they are
embedded in a symbol. Undeploy behavior does not change.
 Deploying changes with an ITVA that has the "Include all galaxy graphics" option enabled will deploy
the Galaxy graphics changes since the previous ITVA deployment.
 Redeploying the original ITVA that has the "Include all Galaxy graphics" option enabled wil l not
account for graphics that were added, deleted, renamed or modified since the original deployment.
 Publishing an ITVA with the "Include all galaxy graphics" option enabled will copy all the checked -in
galaxy graphics to the published application folder. The ITVA will retain its "pending change" status
as this is not a deploy operation.

275
Application Server User Guide Deploying and Running an Application

 The "Include all Galaxy graphics" enabled setting will persist through a Galaxy backup and restore
operation, but will not persist through an ITVA import or export, or t hrough GR dump and GR load
operations.

Configuring the Include All Galaxy Graphics Option

Access the option through the InTouchViewA pp right-click context menu.
To include all Galaxy graphics with an InTouchViewApp
1. Right -click the InTouchViewA pp template you wish to configure. The InTouchViewApp cont ext menu
appears.
2. Select the Associate Galaxy Graphics menu item. The Associate Galaxy Graphics dialog box
appears.
a. When the Associate Galaxy Graphics dialog appears, the $InTouchViewA pp template will be
checked out.
b. If the $InTouchViewApp templat e is not yet initialized or checked out, the Include all Galaxy
graphics with this application option will be dis abled.
3. Click the check box and click OK. A status box displays check in progress.
If an InTouchViewApp instance is deployed when you attempt to modify the Include all Galaxy
graphics setting, you will see an information message to undeploy all deployed instances.

276
 Application Server User Guide

C HAPTER 8
Working with History
®
You can configure applic ation objects to store process data in the Wonderware Historian (formerly
called IndustrialSQL Server). Historical data from Application Server can be ret rieved and viewed using
standard Wonderware Historian database utilities. Also, you can use historical data to produce reports
shown from your client applications. InTouch includes a set of ActiveX cont rols designed to show
historical data from the Wonderware Historian in trends or graphs that can be embedded in client
application windows.

In This Chapter
Application Server History Components ....................................................................................... 277
Saving Object Attribute Data to the Historian ................................................................................ 278
Configuring Common Historical Attributes .................................................................................... 283
Configuring System Objects to Store Historical Data ..................................................................... 285
Configuring Application Objects to Save Historical Dat a ................................................................ 290

Application Server History Components

To save your process data to a historic al database, you must install the Historian Server. A Historian
Server database can be installed on any computer outside the Galaxy, but on the same net work. In a
production environment, the Historian should be installed on a dedicated computer without other
ArchestrA products running on it.
The following figure shows the major ArchestrA components to save process data from a production
devic e to the Historian.
Application Server
Production Environment Galaxy

AppEngine Wonderware Historian

Process Device PLC Area

DAServer/
Application Storage Run-time
Proxy/
Object Engine Database
DIObject

HCAL

WinPlatform
Store
Forward

A single Historian installation can receive historical data from a single Galaxy. A push model is used to
send and save new historical updates to Historian. Each system object Engine (Plat form, AppEngine,
ViewEngine) includes a historian feature that sends all history updates for all hosted objects to the
historian. The historian feature receives the history updates from objects on the same engine only. All
Engine objects include an attribute to specify the node name of the computer hosting Historian.
The figure shows a single Historian. This may be a common configuration, but other Application Server
configurations support multiple Historian databases for a Galaxy. However, eac h Engine object only
sends its historical data to one Historian.
There is a one-to-one relationship between a historical object attribute and a tag in Historian.

277
Application Server User Guide Working with History

Sending Historical Data Between Application Server and the Historian

Application Server communicates with the Historian through an interface called the Historian Client
Access Layer (HCA L).
HCA L can establish and maintain a connection to one or more historians either synchronously or
asynchronously. If a disconnection from the historian occurs, HCA L attempts to restore the connection.
If HCA L cannot communicate with the historian, all data currently being processed can be stored locally
on the computer running HCAL. This hard drive location is called the store-and-forward path. Historical
data is stored until the threshold capacity of the path is reached or communication to the historian is
restored. In the event that all store forward disk capacity is used to store historical data, no more data is
stored. An error message is logged. Remote store -and-forward paths are not supported.
HCA L can go into store-and-forward mode even if it has never been connected to the historian. After the
tags are configured successfully on the historian, current data will start to be sent, along with the
locally-stored data.
You can specify how disconnects between Application Server and the Historian should be refl ected in
the data until the disconnect period can be backfilled with store-and-forward data.
 If you enable the Reconnect as soon as possible & do not mark disconnects option for an
AppEngine, client-side trends during the disconnect interval are filled in with the last-rec eived value
before the disconnect, and trends do not show a gap.
 If you disable the option, a gap appears in t he client-side t rends during the disconnect interval. NULL
values are injected during the disconnect interval to create the gap.
For more information about HCAL, see the Historian documentation. For more information about the
Reconnect a s soon a s possi ble & do not mark disconnects A ppEngine option, see AppEngine
Reconnect Configuration for Undeploying and Redeploying Objects Link ed to the Telemetry Server on
page 377.

Saving Object Attribute Data to the Historian

Some attribute values can be saved as historical data when values change. Data quality and time are
also associated with attribute values. When available, Application Server uses the attribute’s value, the
timestamp when the value changed, and the calculated quality of the dat a to create a Value, Time,
Quality (V TQ) packet sent to the Historian. If there is no timestamp associated with the attribute value,
the current scan time from the AppEngine hosting the object is used instead.

Saving Process Values as Historical Data

For attribute data to be stored in the historian, a host AppEngine must be configured to send history data
to a Historian node. For each object, you can configure attributes of the following data types to be saved
to the Historian.
 Float (numerical).
 Double (numerical) maps to a Historian float data type. If the value of the double exceeds the range
of a float, its value is clamped to the maximum value for the float and the quality is set to Uncertain.
 Integer (numeric al)
 Boolean (non-numerical)
 String – Unicode (non-numerical). Limited to 512 characters. Characters that exceed the 512
maximum length are truncated. If truncation occurs, the quality value of the packet is set to
Uncertain.
 CustomEnum (non-numeric al) maps to a Historian integer.
 ElapsedTime (numerical) maps to a Historian float and is converted to seconds.

278
Working with History Application Server User Guide

 Arrays or parts of arrays are not supported.

 Enum type attributes are saved as Historian integer ordinal values.
 IEEE NaN values for float and double data types are converted to null values prior to being sent to
the historian. NaN values are associated with a Bad OPC data quality.
 All numerical attributes sent to the Historian are in the engineering units specified for the attribute.
The Historian does not scale numerical values.

Saving Data Quality as Historical Data

The Historian supports the OPC Quality definition. A 16 -bit value for OPC data quality is sent to the
Historian in the VTQ packet. Within the 16-bits, the low-order byte is the standard OPC portion. The high
order byte is reserved and is currently unused. The Good, Bad, Initializing (which is a form of Bad) and
Uncertain quality states are specified in the low -order byte.
Any change in the mapped Historian Quality Detail saves a new record to the Historian, regardless of
whet her the attribute value has changed. If an attribute value remains constant over a period of time with
varying changes in quality, multiple rec ords are stored in the Historian. The OP C quality stored in the
Historian is the actual quality of the attribute in Application Server without modification.
The Historian can create and insert additional (non-A rchestrA generated) V TQ records that modify
quality in the dat abase. These additional V TQ rec ords provide additional information about network
outages or other events to client applications that use historic al data from the Historian.

Additional Quality Data Saved to the Historian

Wonderware Historian also has two additional data quality fields (quality and quality detail) that are
non-OP C compliant. Both fields are stored with each record in addition to the OPC quality. Wonderware
Historian maps the value of these fields in a manner consistent with its qual ity definition for those fields.
The values of those fields are driven by the OP C quality sent by Application Server. For ex ample, an
OPC Good quality results in Wonderware Historian quality detail of Good.
Wonderware Historian Quality is a 1-byte flag that summarizes the quality of the associated data value in
the packet sent by Application Server. Wonderware Historian Quality is an enumerated type with the
following values:

Hex Decimal Name Description

0x00 0 Good Good value.

0x01 1 Bad Value was marked as invalid.

0x10 16 Doubtful Value is uncertain. Only fabricated at retrieval

time.

0x85 133 Initial Value (Good) Initial value for a delta request.

OPC Qualities from Application Server res ult in storage of an Wonderware Historian Quality as follows:

OPC Quality (substatus form ) Wonderware Historian Quality Decimal (1-byte)

Good (any) 0 - Good

Bad (any) 1 - Bad

279
Application Server User Guide Working with History

OPC Quality (substatus form ) Wonderware Historian Quality Decimal (1-byte)

Bad (Initializing form) 1 - Bad

Uncertain (any) 0 - Good

Wonderware Historian QualityDetail contains the det ail of data quality as a 32-bit value. QualityDetail is
derived from OP C quality. Each source is allocated a byte position within the QualityDetail 32-bit word,
which is formatted as:
0x XXRRDDDD
Only the low-order two bytes (DDDD) are mapped to OPC quality for data sent by Application Server and
saved to the historian:

OPC Quality (any Results in any one of these Wonderware Historian Quality
substatus form ) Details

Good (any) 192 - Good value

150 - Initial value (good)
151 - Initial store/forward value (good)
252 - First value received (good)
44 - First good value received by storage after the connection to
HCA L has been restored.
248 - First value in the second stream during a store -and-forward.

Bad (any) 24 (DAServer disconnect)

Bad (Initializing form) 24 (DAServer disconnect)

Uncertain (any) 192

Saving the Data Timestamp as Historical Data

Application Server includes a timestamp in the VTQ packet sent to the historian for each attribute
value/quality update that is saved as a historical record. Application Server propagat es the timestamp
associated with an attribute value. The timestamp is propagated throughout all Application Server
components as UTC in FILE TIME format.
If an object attribute has a Value DeadBand specified, a quality change or value change from previous
scan cycle greater than Value DeadB and causes the attribut e's Value, Tim e and Quality (VTQ) to be
saved as historical data in the Historian. When a Value DeadBand is not specified, any change to the
attribute’s value, timestamp, or quality cause the attribute to be saved as historical data.
When an attribute is configured to periodically save a historical record, the attribute’s current time is used
as the timestamp. If the attribut e does not support a timestamp, the hosting AppEngine's current scan
time is used as timestamp included in the packet.

280
Working with History Application Server User Guide

If slow updates for real -time dat a values are received from an I/O source and an intermittent network
disconnect occurs, the timestamp of the first data value of a historized attribute uses the AppEngine’s
timestamp instead of the source’s timestamp. In the following example, in row n umber 4, the value " 30" is
sent again to the historian, but the timestamp is the AppEngine timestamp and not the actual timestamp
of "2008-11-24 18:50:41. 061" when the value of 30 was generated from the I/O source.

DateTime TagName Value Quality QualityDetail OPCQuality

2008-11-24 Realtime_ 20 133 44 192

18:48: 30.081 Client.ival

2008-11-24 Realtime_ 30 0 192 192

18:50: 41.061 Client.ival

2008-11-24 Realtime_ NULL 1 24 0

18:51: 38.666 Client.ival

2008-11-24 Realtime_ 30 0 192 192 –> Row

18:52: 06.670 Client.ival number 4

2008-11-24 Realtime_ 40 0 192 192

18:53: 22.988 Client.ival

If slow updates for late data values are received from an I/O source and an intermittent net work
disconnect occurs, the timestamp of the first data value of a historized attribute is modified to maintain
the time sequence. In the following example, in row number 4, the value "30" is sent again to the
historian, but the timestamp is modified by adding 5 milliseconds to previous timestamp of the NULL data
value. Note that a QualityDetail of 704 is stored for the data value in row number 4.

DateTime TagName Value Quality QualityDetail OPCQuality

2008-11-24 Latedata_ 20 133 44 192

18:48: 30.081 Client.ival

2008-11-24 Latedata_ 30 0 192 192

18:50: 53.624 Client.ival

2008-11-24 Latedata_ NULL 1 24 0

18:50: 53.625 Client.ival

2008-11-24 Latedata_ 30 0 704 192 –> Row

18:50: 563.630 Client.ival number 4

2008-11-24 Latedata_ 40 0 192 192

18:53: 26.863 Client.ival

Saving Alarms and Events as Historical Data

Alarms and events detected by the Application Server at run time are saved as historical data to the
Historian for the host engine. Alarms are a type of event that can be historized. In addition, alarm -related
events such as Acknowledge are also saved as historical alarm data.

281
Application Server User Guide Working with History

You can save alarm counts by severity level as historical data. For more information about mapping
alarm severities to priority ranges and saving alarm counts aggregat ed by severity level to the Historian,
see Mapping Alarm Severity to Priority.

Deploying and Undeploying Attributes

When an object is deployed with historical attributes, the history feature causes dynamic reconfiguration
of the Historian. Each history feature causes a new tag to be created and configured automatically in the
Historian at deployment time. The Historian storage system that will be used is determined by the
configuration of the host engine object.
This dynamic configuration causes appropriate row/column configuration in the Historian schema.
If the connection to the Historian is down at deploy time, the attempt to dynamically reconfigure Historian
is achieved when the c onnection is restored. In other words, automatic retry is built in. However, any data
generated by the object during the time between deployment and the recovery is lost and cannot be
recovered by store forward.
When an object configured for history is redeployed, changes to an object’s attributes makes the
historian reconfigure storage. For example, if the engineering units string of an object changes from " Deg
F" to "Deg C" when the object is redeployed, the Historian configuration database shows the change.
When an object configured for history is undeploy ed, all history remains in the Historian. The history data
can be viewed in the fut ure even if the object is no longer deployed.

Saving Historical Data During Run Time

While an application is running, data is saved to the historian as follows:
 If no previous historical attribute value exists in the historian, the first value is always saved to the
historian.
 Numerical attributes (double, float or integer): If the value for the attribute changes and that change
is more than the value deadband, or the value's quality changes (for example, from Good to Bad),
the data is saved to the historian.
 If the attribute type is qualitative (enumeration, string, or Boolean) and the attribute’s value or quality
changes.
 If the current time exceeds the last Forced Store period occurred for the attribut e by the time period
that was set as the Force Storage Period. If no last Forced Store occurred since starting the object, a
new store occurs immediately.

Note: If enabled, the Value Deadband mechanism resets itself based on this new stored value.

 All new attributes value, timestamp, and quality are sent to the Historian for storage.
 The Historian stores the historical records to the database.

Advanced Communication Management

To ensure that attribute data saved to the historian is always current and continuous, Application Server
registers a reference to the attribute. By registering a reference to the attribute, it prevents Message
Exchange from suspending historical updat es during the period when the client application has
minimized the window containing the object. Historical data continues to be saved to the Historian even
during the period when the object is in an Advanced Communication Management Suspended state.

Store-and-Forward Mode
If the Historian shuts down or the network connection t o it is lost while an application is running, historical
data continues to be stored locally on the computer hosting the WinPlatform object.

282
Working with History Application Server User Guide

When the Historian node recovers, data is forwarded from the local node to the Historian node at a low
priority.
If an AppEngine loses connectivity to the Historian node, the Historian reports bad data quality to clients.
When you undeploy an object with attributes configured for history, the Historian stores the final data
points with Bad quality.

Buffered Behavior
The buffered data feature enables efficient accumulation and propagation of V TQ (V alue, Time, and
Quality) data updates, without folding and data loss, to data consumers such as objects, alarms, the
Historian, and scripts from field devices that support buffering.
Buffered data is defined as data captured and stored locally on a remote device for later trans fer to a
supervisory system for proc essing, analysis, and long-term storage. The Buffer property is input-only.
When an object is associated with an attribute th at supports buffered dat a (HasBuffer property is true),
the object monit ors and processes the Buffer property of the attribute. Each V TQ entry in the buffer that
meets value deadband criteria is pushed to the Historian.
Attributes that are buffer-enabled are registered to Historian in the same manner as non-buffered
attributes are registered. The Historian does not differentiate a buffered from a non -buffered registered
attribute. An attribute is considered registered after a Historian key is returned from HCAL to the object.
All the buffered V TQs that are received by the parent attribute while Historian registration is pending are
ignored and discarded.
For more information about buffered data, see Work ing with Buffered Data on page 369. For further
reading on historizing events and attributes that are buffering-enabled, see About Buffered Data and
History on page 376.

Configuring Common Historical Attributes

Each application or system object that you select from the Template Toolset include a set of common
attributes you configure to save data to the Historian. These are configured after activating the Hi story
feature in the Attribute s page.

283
Application Server User Guide Working with History

The historical attributes you configure are based on the data type of the object. For example, the
following figure shows the common historical attributes for numeric al attributes (integer, float, or double).

If you are configuring a boolean or string attribute, you see a smaller set of historical attributes. Similarly,
a discrete field attribute will also ha ve this same, smaller set of historical attributes.

This section describes the common historical attributes that you can configure for your system and
application objects. Refer to this section as you complete the procedures to configure your objects.
 Force Storage Period
Interval in milliseconds in which an attribute value is saved to the Historian, regardless of whether the
value exceeds its value deadband setting or not. An attribute value is saved to the Historian at every
Force Storage interval. The default value of zero (0) disables the Force Storage period.
 Value Deadband
Thres hold value in engineering units, which is the absolute differenc e between the current and most
recent saved historical values. The current value must exceed the absolut e deadband to be saved as
historical data.

284
Working with History Application Server User Guide

The Value Deadband filters out small, momentary value changes from being saved to the Historian.
A new value that is within the range of the deadband is not saved to the Historian. The default value
of 0.0 disables the Value Deadband and any change to a value is saved as historical data.
 Trend Hi
Initial maximum trend value in engineering units for clients. The default is 100.
 Trend Lo
Initial minimum trend value in engineering units for clients. The default is 0.0.
 Enable Swinging Door
A flag that indicates whether the swinging door rate d eadband is enabled or disabled. The default is
disabled.
Enable Swinging Door is disabled if the historical attribut e data type is Boolean or a string.
 Interpolation Type
List of methods used by the Historian to int erpolate analog historical data. The interpolation type
determines which analog value is selected during a Historian data ret rieval cycle. Interpolation types
include System Default, Stairstep, or Linear. The default interpolation type is System Default.
o Stairstep
No interpolation occurs. The last known value is returned with the given cycle time. If no valid
value can be found, a NULL is returned to the Historian.
o Linear
The Historian calculates a new value at the given cycle time by interpolating between the las t
known value prior to the cycle time and the first value aft er the cycle time.
o System Default
The Historian system-wide interpolation setting. The system-wide setting must be either
stairstep or linear int erpolated.
 Rollover Value
Positive integer value that represents a tag’s reset limit when the Historian operates in counter
retrieval mode. In counter retrieval mode the Historian uses a tag's rollover value to calculate and
return the delta change between consecutive retrieval cycles. The default val ue is 0.0.
The Rollover value applies only to numeric attributes. The Rollover value is disabled if the historical
attribute data type is Boolean or a string.
 Rate Deadband
Percentage rate of change deadband based on the change in the slope of inc oming data values to
the Historian. For example, specifying a swinging door rate deadband of 10 percent means that data
is saved to the Historian if the percent age change in slope of consecutive data values exceeds 10
percent.
The default is 0.0, which indicat es a swinging door rate deadband is not applied. Any percentage
greater than 0.0 can be assigned to the rate deadband.

Configuring System Objects to Store Historical Data

The following table shows the historical attributes for Application Server system objects.

285
Application Server User Guide Working with History

Application Server System

Objects

InTouchViewApp
WinPlatform

AppEngine

Area

ViewEngine
Hi story Attribute s

Description   

Enable compression   

Reconnect as soon as possible & do not 

mark disconnects

Enable Storage to Historian   

Enable Swinging Door    

Enable Tag Hierarchy   

Engineering units    

Force Storage Period    

Historian   

History store forward directory   

Interpolation Type    

Pre-proc essing buffer size   

Rate Deadband    

Rollover Value    

Store forward threshold   

Store forward minimum duration   

TCP Port   

Throttling network bandwidt h   

Trend High    

Trend Low    

Value Deadband    

Wait to send incomplete packets   

286
Working with History Application Server User Guide

Configuring the WinPlatform Object to Store Historical Data

A WinPlatform object contains attributes to configure how historical store-and-forward data is cached
locally and then pushed to the Historian. Also, you can select the WinPlatform object’ s platform,
scheduler, and engine data to be saved to the Historian. Finally, you can select the WinPlatform’s
attribute values to be saved to the Historian.
To configure a WinPlatform Object to store historical data
1. Double-click on an WinPlatform derived template or instance to open the Object Editor.
2. Click the General tab to show history attributes.

3. In the Network address box, type or select the node name of the computer assigned to the
WinPlatform object.
4. In the Hi story store forward directory box, enter the path to the folder to save store and forward
historical data. The folder must exist on the computer specified in the Network address box.
5. Click the Engine tab to show history attributes.

6. In the Hi story area of the Engine page, configure the attribut es. For more information on each
attribute, see the WinPlat form object Help.

287
Application Server User Guide Working with History

7. Click the Platform Hi story tab to show the attributes to save system data from the computer hosting
the WinPlatform object to the historian.

8. Select the check box next to each attribute whose data you want saved in the historian. For more
information about these historical attributes, see Configuring Common Historical Attributes on page
283.
9. Click the Scheduler History tab to show the attributes to save data to the historian.
10. Select the check box next to each scheduler attribute whose data you want saved in the historian.
11. Click the Engine Hi story tab to show the attributes to save data from AppEngines hosted by the
WinPlatform object.
12. Select the check box next to each engine attribute whose data you want saved in the historian.
13. Save your changes and check in the WinPlatform object.
14. Deploy the object to its target computer in an on scan state.

Configuring an AppEngine Object to Store Historical Data

If an AppE ngine is deployed before Historian is started, history data can be stored locally by HCAL until
the objects successfully register with the Historian.

Note: Except for Late Data, the ViewE ngine object contains the same historical attributes as the
AppEngine object.

To configure an AppEngine object to store historical data

1. Double-click on the AppEngine instance to open it within the Object Editor.

288
Working with History Application Server User Guide

2. Click on the General tab to show history attributes.

3. In the Hi story area of the Engine page, configure the attribut es. For more information on each
attribute, see the AppEngine object Help.
4. Click the Scheduler History tab to show the attributes to save data to the historian.
5. Select the check box next to each scheduler attribute whose data you want saved in the historian.
6. Click the Engine Hi story tab to show the attributes to save data from AppEngines hosted by the
WinPlatform object.
7. Select the check box next to each engine attribute whose data you want saved in the historian.
8. Save your changes to the AppEngine object.

Configuring an Area Object to Save Alarm Counts as Historical Data

An Area object represents a plant area to group objects for modelling and report alarms. You can
configure a set of attributes to save the counts of an area’s alarm states to the historian. An Area object
contains a set of attributes to save the counts of the following alarm states to the historian:
 Active alarms
 Unacknowledged alarms
 Disabled or silenced alarms
To configure an Area object to store historical data
1. Double-click on the Area instance to open it within the Object Editor.

289
Application Server User Guide Working with History

2. Click on the General tab to show attributes for area alarm counts that can be saved as historic al
data.

3. Select the check box next to each alarm state counter that you want to save to the historian.
4. Set the attributes for each alarm count er that you select. For more information about assigning
values to historical attributes, see Configuring Common Historical Attributes on page 283.
5. Save your changes and close the Object Editor.

Configuring Application Objects to Save Historical Data

The following table shows the historical attributes for application objects. These history attributes are
described in Configuring Common Historical Attributes on page 283.

Application Server Application Objects

AnalogDevice

Boolean

DiscreteDevice

Double

FieldReference

Float

Integer

Sequencer

String

Switch

UserDefined

Hi story Attribute s

Enable Swinging Door      

Force Storage Period         

Interpolation Type      

Rate Deadband      

Rollover Value      

Trend High      

290
Working with History Application Server User Guide

Application Server Application Objects

AnalogDevice

Boolean

DiscreteDevice

Double

FieldReference

Float

Integer

Sequencer

String

Switch

UserDefined
Hi story Attribute s

Trend Low      

Value Deadband      

Note: The historical attributes available from the UserDefined object are based on the dat a type
associated with the selected attribute.

To configure an application object to store history

1. Open the application object in the Object Editor.
 If you selected a Us erDefined object, click the Attribute s tab.
 If you selected an AnalogDevic e object, click the History tab. Then, click the General tab to
show the history attributes for the object’s PV value.

2. Enable historization.
 For UserDefined objects, create an attribute and then activate the Hi story feature. Assign
values to the history parameters. For more information about assigning values to the history
feature, see Configuring Common Historical Attributes on page 283.
 For AnalogDevice objects, select the Historize feature to enable the common history attributes
shown in the Hi story area of the page.
The History page includes check boxes to save PV, SP, PV mode, Control mode, and Control
Track Flag data to the historian.
Assign values to the PV history attributes that appear in the Hi story area of the page. For more
information about assigning values to the common history attributes, see Configuring Common
Historical Attributes on page 283.
3. Save your changes and close the Object Editor.

291
 Application Server User Guide

C HAPTER 9
Working with Alarms and Events
You can create A rchestrA applications that generate alarms and events to provide the status of a running
application.
ArchestrA objects include built-in event and alarming reporting capabilities. You must configure alarms
for each object in the IDE to use the event and alarm functions.

In This Chapter
Understanding E vents ................................................................................................................. 293
Understanding Alarms ................................................................................................................. 295
Configuring Alarms ..................................................................................................................... 309
Distributing Alarms and E vents .................................................................................................... 317
Configuring Plant State-Based Alarms ......................................................................................... 322
Configuring Alarm Historization, Mapping, and Shelving Priority Ranges ........................................ 326
Using Aggregated Alarm Information ............................................................................................ 328

Understanding Events
E vents represent normal system, application, or user occurrences that produce status messages. A
typical event occurs when an operator logs on to an application at the beginning of a work shift.
Application Server can detect events, store them as historical data, and report them to client
applications.
An event indicates a significant occurrence that is detected, reported, and saved as historical data.
E vents can be detected by any Application Server component including automation objects and the
SMC.
E vents provide a means for any software component to log information about a system, appli cation, or
operator action. Application Server components use an event API to send event messages to
Alarm/E vent distributors and the Wonderware Historian. Also, events are sent to client applications like
InTouch OMI to be shown in real-time trends or reports.

Types of Events
Application S erver creates several types of run-time event messages, which are saved as historical data.
 System events
E vent messages are logged when a Platform, Engine, Area, DI Network or DI Device start or stop.
Any system action that affects a large number of objects is logged as an event.
A System event message cont ains the following information:
o E vent type, whic h is System.
o Tagname, which is the name of the object generating the event.
o Tag description, which is a short description of the object generating the event.
o Area, which is the name of the area that contains the object generating the event.
o E vent description, which describes the system action and can be either Started or Stopped.
o Timestamp, which is the current system time.
293
Application Server User Guide Working with Alarms and Events

 Security-audit (operator change) events

E vent messages are logged to the Alarms and E vents subsystem when an operator logs on to or
logs off from an application. Also, security-audit events are logged when an operator changes
actions by means of User sets.
A Security-audit event message contains the following information:
o E vent type, whic h is operator change.
o Timestamp, which is the date and time when the operator change event occurred. The
timestamp of the event is the current AppE ngine scan time.
o Tagname, which is the name of object generating the event.
o Prim.attr, which is the referenc e string of the attribute being changed.
o Tag description, which is a short description of the object. For Secured and Verified writes, this
will contain the following:
– Type of write (Secured or Verified)
– Comment from the user, if any
– Reas on description, if any
o FieldAttribut e description, if the attribute is a FieldAttribute and has a description; otherwise, this
is the Object description.
o Area, which is the name of the area that contains the object generating the event.
o UserEngine, which is the name of the view engine or other user engine requesting the operator
change.
o Operator1, which is the full name of the primary operator requesting a change. The full name is
an attribute of the UserProfile.
o Operator2, which is the full name of the secondary operator validating the change, if any.
o Old value, which is the previous value of an attribute.
o New Value, which is the new value of an attribute.
 Application (or process) related events
Application event messages are generated by application objects in response to process actions.
For example, application event messages are created when a process pump starts or stops.
An Application event contains the following information:
o E vent type, whic h is data change.
o Timestamp, which is the date and time when the application event occurred. The timestamp
assigned to the event is the timestamp of the attribute associated wit h the event, if available.
Otherwise, the event timestamp is the current AppEngine scan time.
o Tagname, which is the name of the object generating the event.
o Prim.attr, which is the referenc e string of the attribute being changed.
o Tag description, which is a short description of the object.
o Area, which is the name of the area that contains the object generating the event.
o Old value, which is the previous value of an attribute.
o New Value, which is the new value of an attribute.

294
Working with Alarms and Events Application Server User Guide

Understanding Alarms
Alarms warn about process conditions that can potentially cause problems. Typically, you s et up an
alarm to become active when a process value exceeds a defined limit. For example, you can set an
alarm for a pump that warns when no fluid pressure is detected.
An alarm is an abnormal condition that requires immediate attention. An operator usual ly acknowledges
an alarm. ArchestrA handles the real-time reporting of alarms and provides special clients for viewing
them.
Application and system objects can detect and generate an alarm. To detect an alarm, a system or
application object sets a Boolean Attribute flag to indicate whether the object's alarm condition is
currently true or false.
To report an alarm, the object must contain an alarm feature. The alarm feature makes a referenc e to the
object’s Boolean flag to det ermine whether the alarm condit ion is true. It then combines this information
with the current alarm mode to determine whether to report a this as an active or inactive alarm state. An
alarm feature is dedicated to reporting a single alarm condition’s state. The alarm feature send alarm
notification messages to ArchestrA alarm and event distribut ors.
E very alarm notification includes a set of fields containing data that describes the alarm. Some alarm
notification data is saved as historical data. The following list describes all fields sent with an alarm
notification.
 TagName, which is the name of the object generating the alarm. Saved as historical data.
 Name, which is the name of the alarm. Saved as historical data.
 InAlarm, which is a Boolean value that indicates whether the object’s alarm state is currently active
or inactive. Saved as historical data.
 Quality, which is the current quality of the data upon which the alarm is based. Saved as historical
data.
 OnTimeStamp, whic h is the time when the attribute value transitioned into an alarm state. The
attribute’s value timestamp is used, if available. Otherwis e, the timestamp is the AppEngine scan
time. Saved as historical data.
 OffTimeStamp, which is the time when the alarmed attribute value returns to normal. The attribute’s
value timestamp is used, if available. Otherwise, the OffTimeStamp is the AppEngine scan time. If an
active alarm is disabled, it forces a return to normal and the timestamp is the current time. Saved as
historical data.
 Category, which is an integer between 1 and 14 that identifies the type of alarm and source of the
alarm. These values are associated with Internationalized category labels set by Wonderware.
Alarm category labels can be localized to other languages. Application Server uses the default
Galaxy language to retrieve these strings and send them to InTouch. The alarm category labels
appear in InTouc h and InTouch history as the default Galaxy language strings. Saved as historical
data.
 Priority, which is an integer value from 1 to 999 indicating the severity of the alarm. An alarm priority
of 1 is most urgent and 999 least urgent.
 TargetValueReference, which is an optional field that mak es a reference to the target value of the
alarm. Not saved as historical data.
 ActualValueReference, which is an optional field that makes a reference to the actual attribute value
for the alarm condition. Not saved as historical data.
 TargetValue Snapshot, which is an optional field containing the attribute’s target value at the time
when the alarm became active. Saved as historical data.

295
Application Server User Guide Working with Alarms and Events

 ActualValueS napshot, which is an optional field containing the attribute’s actual value at the time
when the alarm became active. Saved as historical data.
 EngUnitsReference, which is the reference t o the engineering units string for the condition. Saved as
historical data.
 AcknowledgedFlag, which indicates whether the alarm is acknowledged or not. If this flag is FALSE,
the alarm is still unacknowledged. Saved as historical event data.
 AcknowledgeTime, whic h indicates the time when the alarm was acknowledged if the
AcknowledgedFlag is TRUE. Saved as historical data at the time of acknowledgement.
 AcknowledgeUserId, which is the string containing the name of the user who acknowledged the
alarm. Saved as historical data at the time of acknowledgement.
 AlarmMode, which indicates whether the alarm mode is Enabled, Silenced or Disabled. Saved as
historical data at the time when the alarm mode changes.
 Message text describing the alarm, which can be statically or dynamically constructed. The message
typically contains the alarm description, the exceeded limit value, and possibly the variable value.
For an alarm feature, this message is retrieved by means of a reference to a string/international
string attribut e in the object. The reference is setup at ObjectDesigner time for alarms. If none is
specified, then the common feat ure short description attribute is utilized. This field is also provided in
the alarm feature section and can be dynamically generated and scripted. Saved as historic al data.
 Area, which is the name of the area that contains the object generating the alarm. Saved as historical
data.

Types of Alarms
Application Server supports the following types of alarms:
 State alarms, which are also known as Boolean alarms
 Limit alarms
 Target deviation alarms
 Rate of change alarms
The type of alarm that you can configure is based on the dat a type of the attribut e’s value.

State Alarms
A state alarm set on an attribute of Boolean data type corresponds to a discrete tag with two possible
states. When you create a state alarm, you configure whether the active alarm state corresponds to the
TRUE or FALSE state of the attribute.

You can set an alarm category. Valid categories are:

296
Working with Alarms and Events Application Server User Guide

Category Description

Discrete A discrete value event or alarm, such as a change of state.

Value LoLo A continuous value is significantly below the acceptable range.
Value Lo A continuous value is below or is approaching the low acceptable range.
Value Hi A continuous value is above or approaching above the high acceptable range.
Value HiHi A continuous value is significantly above the acceptable range.
DeviationMinor A value has a minor deviation (plus or minus) from the target or setpoint.
DeviationMajor A value has a major deviation (plus or minus) from the target or setpoint.
ROC Lo The rate of change for a value is too slow.
ROC Hi The rate of change for a value is too fast.
SPC A value deviates from the SPC target/range.
Process An alarm or event associated with the physical process/plant has occurred.
System An alarm or event associated with the automation system has occurred.
Batch An alarm or event associated with a batch process has occurred.
Software An alarm or event associated with a software operation or logic (such as
divide by zero in script) has occurred.

You can set an alarm message and Priority for a state alarm. The time deadband sets the length of time
that an attribute value must continuously remain in an alarm or unalarmed state. The time deadband
filters out rapid, transitory value spikes.
The timestamp when a state alarm becomes active or inactive is the most current timestamp of the
corresponding input value. If there is no timestamp associated with the alarmed value, the AppEngine
timestamp is used instead.

Limit Alarms
A limit alarm compares the current value to one or more predetermined alarm limits within the attribute’s
full range of values. If the value exceeds a limit, an alarm occurs.
LoLo Alarm Level Lo Alarm Level Hi Alarm Level HiHi Alarm Level

90
80

20
10

297
Application Server User Guide Working with Alarms and Events

You can individually select and configure values and priorities for the LoLo, Lo, Hi, and HiHi alarm limits.
You can set individual messages for each alarm limit.

You can also configure alarm and time deadbands for limit alarms. The alarm deadband is expressed as
a percentage of the attribute’s full value range. The deadband value sets the percentage of the total
range that the attribute value must change to reset a limit alarm to the inactive state.
For example:
 An attribute's full value range is 0 to 50, and the HiHi alarm limit is 40.
 The alarm deadband is set to 5. Since the attribute's range is 50, the actual alarm deadband value is
2.5 (50 * 5%).
 The attribute value reac hes the HiHi alarm limit (40).
 To reset the HiHi alarm to an inactive state, the attribute value must fall below 37.5 (40 - 2. 5).
The time deadband sets the length of time that an attribute value must continuously remain in an alarm or
unalarmed condition. The process variable must remain above or below the indicated limit for at least the
indicated deadband time before the application object updates the status of the alarm CONDITION
Boolean. Then, standard Alarm feature logic determines whether to take that updated alarm condition
and report changes to the alarm state or not.
The timestamp when a limit alarm becomes active or inactive is the most current timestamp of the
corresponding input value. If there is no timestamp associated with the alarmed value, the AppEngine
timestamp is used instead.

Target Deviation Alarms

A target deviation alarm compares the current attribut e value to a target Engineering Units value. Then,
the absolute value of the difference is compared to one or more alarm de viation limits expressed in
EngineeringUnits.
10 EU Minor 20 EU Major
Target 50 EU No Alarm Deviation Alarm Deviation Alarm

70
5 EU Deadband
60
Target 5 EU Deadband
50
5 EU Deadband
40 5 EU Deadband
30

298
Working with Alarms and Events Application Server User Guide

You can individually select and configure values and priorities for the minor deviation limit and the major
deviation limit. You can set individual messages for the minor and major deviation alarm limits.

The deviation alarm’s settling period is the time allowed for the attribute value to reach an expected
target value after a device starts. No alarm can occur during the settling period.
You can also configure a value for a deviation deadband, whic h is expressed in Engineering Units. The
deadband range sets a threshold that an attribute value must change from a deviation limit to reset the
alarm to the inactive state.
The timestamp when a deviation alarm becomes active or inactive is the most current timestamp of the
corresponding input value. If there is no timestamp associated with the alarmed value, the AppEngine
timestamp is used instead.

Rate of Change Alarms

A rate of change alarm identifies when an attribute value is changing too quickly over time. For example,
you can set a rate of change alarm for a tank level that indicat es when the pump inlet pressure is too
high.
Rate of change is the calculated slope, which is the absolute difference between the current and
previous attribute values divided by a specified interval. When the slope (positive or negative) exceeds a
specified value, a rate of change alarm occurs. For example, if a tank volume increases from 17 to 45
liters over a 5 minute int erval, the calculated slope is 5.6 liters per minute. If you set your rate of change
alarm limit to 5.0 liters per minute, a rate of change alarm condition exists.

15:05:25 15:05:55 15:06:25

70 70 70

60 60 20 60
50 50 50
10
40 40 40

299
Application Server User Guide Working with Alarms and Events

Alarm limits are expressed in the Engineering Units of the attribute’s value over an interval, which can be
per second, minute, hour, or day.

You can select and configure the value and priority for the upward and downward ROC limits. You can
set individual messages for ROC alarms that exceed the upward or downward limits.
The timestamp when a rate of change al arm becomes active or inactive is the most current timestamp of
the corresponding input value. If there is no timestamp associated with the alarmed value, the
AppEngine timestamp is used instead.

Statistical Alarms
A statistical alarm is one in which a statistic is calculated, based upon an attribute. If t he statistic exceeds
some pre-set limit, the object flags the alarm condition as TRUE.

Setting Alarm State with Object Attributes

The Application Server alarm enable/disable mechanism includes four attributes to set an object alarm
mode and report alarm status:
 AlarmModeCmd Attribute on page 300
 AlarmInhibit Attribute on page 300
 AlarmMode Attribute on page 300
 _AlarmModeEnum Attribute on page 301

AlarmModeCmd Attribute
AlarmModeCmd is a writable attribute that sets the current commanded alarm mode for the object. You
set the AlarmModeCmd to enabled, silenced, or disabled with a script, user input, or from an attribute
configured to read from an input source.

AlarmInhibit Attribute
The AlarmInhibit attribute disables one or more alarms when set to TRUE. The value of the AlarmInhibit
attribute is typically set by a script, manually by the user, or from an attribute configured with an input
feature. If the AlarmInhibit attribute is set TRUE, all alarms of the object and of any contained objects are
disabled.
When the AlarmInhibit attribute is set to FALSE, alarms are not inhibited and the object AlarmMode and
parent object AlarmMode determine whether alarming is enabled, silenced, or disabled.

AlarmMode Attribute
The AlarmMode is a calculated attribute that identifies the object alarm mode and is based upon the
current values of an object’s:
 AlarmModeCmd attribute

300
Working with Alarms and Events Application Server User Guide

 AlarmInhibit attribute
 Parent object AlarmMode attribute
Parent Object

Parent AlarmMode

Child Object
AlarmInhibit AlarmMode
Parent AlarmMode

AlarmModeCmd
AlarmInhibit AlarmMode

AlarmModeCmd

Application Server checks the AlarmModeCmd and AlarmInhibit attributes of an object and the
AlarmMode status of the parent object. Application S erver then updates the object's AlarmMode attribute
to reflect the most restrictive setting.
All individual alarms use the object's AlarmMode status to determine whether they are enabled, silenced,
or disabled.

_AlarmModeEnum Attribute
The _AlarmModeE num attribute can be used by any object to obtain an enumeration of permissible
settings for the AlarmModeCmd attribute.

Alarms and Buffered Data

An object with alarms enabled detects the alarm condition and sets an associat ed alarm condition
attribute to true. If the object detects the alarm condition based on an attribute with buffered data
(HasBuffer property set to true), it enables buffer support for the condition attribute and sets the condition
attribute’s Buffer property to a VTQ buffer of true/ false values representing alarm conditions.

Alarm Detection
The Buffered Data feature will pass buffered alarm VTQs to the alarm subsystem in the same manner as
with buffer data not enabled. When enabled, the Bu ffered Data feature can generate multiple alarm
messages in the same scan.
For more information on alarm detection, see About Buffered Data and Alarms and E vents.

Setting Alarm State for Individual Alarms

You can set individual alarms within an object for each type of alarm. For example, you can set alarms for
each of the limits of a level alarm.

301
Application Server User Guide Working with Alarms and Events

The following figure shows an object’s individual alarms for the HiHi and Hi alarm limits.

Parent Object
Parent AlarmMode

AlarmInhibit AlarmMode

HiHi Individual Alarm

AlarmModeCmd Parent AlarmMode

AlarmInhibit AlarmMode

AlarmModeCmd

Hi Individual Alarm
Parent AlarmMode

AlarmInhibit AlarmMode

AlarmModeCmd

The calculated AlarmMode attribut e value of an individual alarm uses the same inputs as an object
alarm. The parent AlarmMode attribute is from the object itself. As with object alarms, the individual
alarm mode is set to the most restrictive input state. For example, if the object’s AlarmMode state is
disabled and the individual alarm’s AlarmInhibit is FALSE, the individual alarm is disabled.
Each individual alarm is autonomous from other individual alarms in an object. The AlarmMode of an
individual alarm is not propagated to ot her alarms. Unlike inhibit for the entire object, inhibit of an
individual alarm does not affect the alarms of any contained objects. You can selectively enable, silence,
or disable an individual alarm and not set other alarms to the same value within the object hierarchy.

Enabling, Silencing, and Disabling Alarms

Alarms can be enabled, disabled, or silenced while an application is running. An object’ s alarm state can
be set at the Area level, at the cont ainer object level, or at the individual object. In addition, individual
alarms within a single object can be enabled, silenced, or disabled.
 Enabled: All alarms for an object are reported to client applications and saved as historical data. The
enabled state is less restrictive than the silenced or disabled alarm states.
 Silenced: All alarms for an object are detected and logged in the Historian alarm and event history
database. Silenced alarms are not logged to the InTouch alarm database, and are not shown in
alarm clients displaying current alarms or recent history alarms. The silenc ed alarm state is more
restrictive than the enabled state, but less restrictive than the disabled state.
 Disabled: No alarms for the object are det ected. The alarm is return -to-normal until the alarm is
re-enabled. The disabled state is more restrictive than the silenc ed and enabled alarm states. A
disabled alarm does not require acknowledgement.
When an alarm state changes from silenced to enabled, the following applies:
 Only the last occurrence of the alarm appears in alarm clients.
 Only the last occurrence of the alarm is logged into the alarm database.

302
Working with Alarms and Events Application Server User Guide

 Only the last occurrence of the alarm is saved to history.

The following figure shows how the different alarm modes affect the different phases of an alarm. In the
case of Alarm Suppressed, selected alarms can be filtered out of the InTouch AlarmViewer display by an
operator, or programmatically by a script.

To ensure that alarmed attributes always have current dat a, the alarm feature always registers a
reference to the alarmed attribute. This guarantees that Message Exchange never suspends updates for
this attribute. E ven if alarms are disabled for a particular attribute, the alarmed attribut e cannot enter an
Advanced Communication Management Suspended state.
The object hierarchy and alarm states determine the final alarm condition of an object.
 An Area object’s alarm state determines the alarm state for all alarms of objects that belong to the
Area.
Area-Disabled
Container Object-Any
Contained Object-Any

Object Alarm State = Disabled

 The most restrictive setting within an object hierarchy determines the object’s alarm state.
Area-Enabled
Container Object-Disabled
Contained Object-Enabled

Object Alarm State = Disabled

 When an individual object alarm is silenced or disabled, it applies only to that alarm and not to other
alarms belonging to the obj ect.
Area-Enabled
Container Object-Enabled
Contained Object-Enabled
Enabled
A Object Alarm State = Enabled

Disabled
B Object Alarm State = Disabled

303
Application Server User Guide Working with Alarms and Events

The alarms on any contained object are not affected. The disabled or silenced s tate of an individual
alarm does not propagate downward through the object hierarchy to the alarms of any contained or
assigned object.

Enabling Alarms
To enable an object’s alarms, you must ensure that the AlarmModeCmd and AlarmInhibit attributes are
enabled for the object, its container, and its area. An event, including the user’s name, is generated
indicating the object’s alarms are enabled.
When object alarms are enabled, you can enable, silence, or disable an individual alarm.

Silencing Alarms
When object alarms are silenced, an individual alarm that is enabled or silenced is forced to be silenced.
When object alarms are silenced, an individual alarm can be disabled.

Disabling Alarms
When object alarms are disabled, an individual alarm that is enabled or silenced is forced to be disabled.
When object alarms are enabled and an individual alarm is enabled or silenced, the individual alarm can
be inhibited. This forces the individual alarm to be disabled.
When object alarms are silenced and an individual alarm is enabled or silenced, the individual alarm can
be inhibited. This forces the individual alarm to be disabled.
When object alarms are inhibited, an individual alarm that is enabled or silenced is forced to be disabled.

Shelving Alarms
You can shelve alarms to temporarily hide them from displays for a fix ed period. Alarms continue to be
historized, even when they are shelved.
Shelving typically is used to reduce alarm "noise", or to temporarily suppress alarms that might be
triggered during system modifications or repairs, allowing you to foc us on correcti ng other more urgent
alarms.
Shelving is similar to silencing an alarm, but shelved alarms differ from silenced alarms in the following
ways:
 Shelved alarms have a built-in associated time-out period. Shelved alarms are automatically
unshelved when the configured shelving period expires. You can also manually unshelve alarms and
return them to an active, displayed state.
 Alarm shelving must be enabled at an area level, but shelving applies only to individual alarms. You
cannot shelve a hierarchy of alarms for an entire area or for an entire object. You cannot propagate
alarm shelving through the Model View hierarchy.
 The system enforces role-based limitations on permission to shelve alarms, alarm severity levels
that can be shelved, and the total number of alarms a user can shelve.
The system tracks who shelved the alarm, from what workstation, the reas on for shelving the alarm,
when shelving began, and when shelving will expire. Shelved alarms aggregate in similar fashion to
silenced alarms. For information about alarm aggregation, see Using Aggregated Alarm Information on
page 328.
A set of seven attributes provide run-time alarm shelving information and control:

304
Working with Alarms and Events Application Server User Guide

AlarmShelveCmd User writeable. Use this attribute to shelve or unshelve an alarm.

Default values: Duration = 0, Reason = ""

AlarmShelved Read-only, Boolean value. Shows True if alarm is shelved, False if

alarm is unshelved.
Default value: False
AlarmShelveStart Time A read-only date/time stamp indicating when alarm shelving began,
based on the engine time when the shelving request was received,
Default value: Blank

AlarmShelveStopTime A read-only date/time stamp equal to the AlarmShelveStart Time plus

the duration for whic h the alarm is to be shelved.
Default value: Blank

AlarmShelveReason A read-only string value providing the reason for which the alarm was
shelved or un-shelved by the Alarm Shelve command.
Default value: Blank (See AlarmShelveCmd attribute.)

AlarmShelveUser Read-only, the name of the user who most recently shelved or
un-shelved the alarm with the Alarm Shelve command.
Default value: Blank
AlarmShelveNode Read-only, the name of the computer node from which the user most
recently shelved or un-shelved the alarm with the Alarm Shelve
command.
If t he node is hosted in a Terminal Server client session, the node and
the TSE ID are both identified.
Default value: Blank

Enabling Alarm Shelving

Alarm shelving is configured from the IDE Configuration menu, and is enabled on the Area object.
To enable alarm shelving
1. Enable at least one security role to configure alarm shelving. Associate the relevant user with that
role, if not already associated, before proceeding to step 2.
2. On the IDE main menu, click Galaxy, then click Configure, then click Alarms and Events
Configuration.

305
Application Server User Guide Working with Alarms and Events

The Alarm s and Events Configuration dialog appears.

3. Select the severity level in the Shelve column. By default, severity levels 3 (medium) and 4 (low) are
enabled.
4. In the IDE, open the relevant Area object editor. Click the Shelve Alarms checkbox to enable
shelving for that area. Shelving is enabled by default.

Shelving Alarms at Run Time

Use a run-time client to shelve and unshelve alarms. From Application Server, you can use Object
Viewer to monitor and control shelved alarm attributes. Shelved alarms can also be monitored and
controlled from an embedded Alarm Cont rol and at least one animation to write to the AlarmS helveCmd
attribute. For information about using the Alarm Control to shelve alarms, , see Shelve and Unshelve
Alarms at Run Time.
To shelve or unshelve an alarm in Object Viewer
1. In Object Viewer, select the object in the Console Tree (left pane) which contains the alarm you
want to shelve. The object attributes display in the Detail s Pane (right pane).
2. In the Attributes list, find the attribut e configured with the alarm y ou want to shelve.
For example, "Inlet_001. Discrete_001".
3. In the Attributes list, below the attribute in step 2, find the AlarmShelveCmd attribute.
For example, "Inlet_001. Discrete.001.AlarmS helveCmd".

306
Working with Alarms and Events Application Server User Guide

4. Double-click the .AlarmShelveCmd attribute. The Modify String Value dialog opens.

a. To shelve an alarm, enter a duration in hours or in decimal fractions if the duration is to be less
than one hour. The duration cannot be blank.
b. Enter a reason between the quotation marks for shelving or unshelving. The reason cannot be
blank. Click Apply.
c. To unshelve a shelved alarm, enter a value of "0".
The six read-only alarm shelving attributes will display the current shelving status information.

Throttling Alarms
Alarm throttling prevents network and message queues from flooding during periods of high alarm
activity. Throttling sets a maximum number of transitions into and out of an alarm state within a defined
period. Alarm transitions that exceed the throttling limit are not reported.
The WinPlatform object includes tuning parameters that specify the maximum alarm rate per second on
an engine. The Alarm t hrottle limit attribute must be used in conjunction with the scan period to determine
the maximum number of alarms that can occur in a scan cycle. You can set the alarm throttle li mit when
you configure the WinPlat form object. For more information about setting the scan period and alarm
throttle limit, see Configuring WinPlatform Object Alarms on page 310.
Alarm messages can be throttled for alarms going int o alarm and out of alarm state. Alarm
acknowledgement messages are not throttled. Users can still acknowledge alarms even when alarm
throttling is active. Users can still disable alarms for objects or areas when the alarm rate causes
throttling to occur. Also, the alarm inhibit and the disable/ enable/silence messages are not throttled.
If an active alarm is disabled, the going out of alarm and disabled messages are sent to the notification
distributor. If alarms are being throttled, the going out of alarm message can be throttled. The disabled
message is accepted regardless of the throttling status. The going out of alarm message is not raised
again. This can result in never logging a message for that alarm indicating it went out of alarm. The final
alarm list in the Notification Distributor still shows the correct alarm state.

307
Application Server User Guide Working with Alarms and Events

Propagating Timestamps with Alarms and Events

An alarm feature always registers a reference to the alarmed attribut e. This registered reference
guarantees that Message Exchange never suspends updates for the alarmed attribute. E ven if alarms
are disabled for a particular attribut e, the Advanced Communication Management feature cannot
suspend the attribut e.
Be aware that the time stamp propagates to all masked bits of an integer attribute, even if only one of the
bits changes.
For example, you have an Integer address in a P LC that represents 16 different alarm states. You assign
ObjA.Attr_Integer to point to the PLC address. You then split the bits to different alarm attribut es, adding
one attribute for each alarm and naming them ObjA.Attr_Alarm00 to ObjA.Attr_Alarm15. Each attribute
has an input source that refers to a different bit of ObjA.Attr_Integer. For example,
ObjA.Attr_00. InputSource -> me.Attr_Int.00, and so on. At run time, when bit 00 is changing in the PLC,
all of the attributes (ObjA.Attr_Alarm00 to ObjA.Attr_Alarm15) get a new time stamp, as all the bits
changed. This can cause incorrect time stamps for alarms.

Alarms or Events Become Active

For alarms or events, if an attribute has no timestamp, the current AppEngine scan time is used instead.
If an attribute has a timestamp, the timestamp of the value that caused the alarm to occur is used as the
value for the object’s AlarmOnTime attribute.
When an alarm is silenced or disabled, and an alarm condition becomes TRUE, when the alarm is later
enabled, the timestamp for AlarmOnTime is the times tamp of the most recent attribute change, not the
time at which the alarm was enabled.
For an event, if an attribute has a timestamp, the timestamp of the value that caused the event to be
reported is used for the E vent Time. A System Event timestamp is the current system time.

Alarms Become Disabled

If an active alarm becomes disabled, the alarm is forced to return to normal. The timestamp corres ponds
to the current time when the alarm became disabled, not the timestamp of the attribute nor of the alarm
condition. Otherwise, the assigned timestamp is the AppE ngine scan time.

Alarms Revert to Normal

If an attribute value has a timestamp, the timestamp of the value that caused the alarm to revert to normal
is used for the AlarmOffTime.
If alarm is based upon several attributes or upon several values of a single attribute, the most recent
timestamp is used when assigning values to the AlarmOnTime or AlarmOffTime.

Alarm Acknowledgement
Alarms are acknowledged by users who view unacknowledged alarms from their client applications like
InTouch HMI. Only alarms of certain priority levels need to be acknowledged.
The basic workflow to acknowledge an alarm consists of the following general steps:
 The alarm is detected and reported to any subscribed alarm clients. The alarm is unacknowledged
unless it is of a priority level that does not require acknowledgement.
 An authorized user attempts to acknowledge the alarm from the client. The user can type an optional
comment when acknowledging the alarm.
 The user’s acknowledge request is sent to the detecting object’s alarm feat ure. The
acknowledgment must pass through standard security checks first. The acknowledge request
contains the user’s name and any alarm comment.

308
Working with Alarms and Events Application Server User Guide

For the alarm utility, the alarm is acknowledged within the alarm feature immediately. The user name,
comment, and acknowledged time are also saved. Alarm comments can be localized into any supported
language.
The acknowledge is considered an alarm state change, which is sent to all subscribed clients. When an
alarm is acknowledged, the current AppE ngine timestamp is used as the acknowledgement time.
After an alarm is acknowledged for the first time, any additional (extra) acknowledgement attempts for
the same alarm are rejected and an error is returned.

Acknowledging Alarms with Signature Required

You can use the SignedAlarmAck( ) script function in Arc hestrA Graphics to require a signature to
acknowledge alarms. Add the script function to a symbol as described in the Creating and Managing
ArchestrA Graphics User’s Guide, and then embed the symbol in the WindowMaker window.
When you acknowledge the alarms at run time, the script function checks for a required signature. If a
signature is required, it checks Galaxy security settings and alarm priority. If any alarm in the list falls
within the configured conditions, you must provide your signature to acknowledge the alarms. You must
sign in to acknowledge the alarms if no user is logged on to the InTouch application.
If any alarm in the list is requires a signature, then a signature is required for the entire list of alarms.

Note: The SignedAlarmAck() script function supports only ArchestrA alarms.

By inspecting the Alarm Viewer or the Alarm Control client, you can determine if the alarm
acknowledgements were successful.

Configuring Alarms
Alarming capabilities are a part of object templates, but they are not implemented until you configure the
object in the IDE. After alarms are configured, you can view Application Server alarms in a client
visualization application like InTouch HMI.
Configuring an object to be an alarm p rovider includes the following general sequence of steps:
 Decide whether alarm notification is needed for each possible alarm condition of an object. For
example, a command time-out alarm for a valve if the output command fails to move the valve.
 Edit the object and set an attribute that specifies alarming.
 Edit the object from the IDE and assign values to alarm attributes.
 Configure the alarm properties. Typically, the fields that require configuration are Category, Priority
and Description.
 Configuring any limit fields to set an alarm. For example, the feedback time-out time limit.
You can add alarm detection and reporting capabilities to objects that were not originally developed to
detect alarms. You do this by configuring alarm features for the object’s attributes.

Configuring Alarming for System Objects

To enable alarming for your application, you need to configure your Galaxy’s WinPlatform and
AppEngine objects as alarm providers. Both system objects report their own alarms.
Client applications subscribe to application object alarms by the area containing the objects. Client
applications can also subscribe to WinPlatforms and AppEngines directly. Thes e are called
"pseudo-areas." They do not need to be assigned to an area for a client to see the alarms, although the
user may want to assign them to an area, such as for simplifying the alarm query in the InTouch Alarm
Viewer or Alarm DB Logger.
The following list shows the alarms for each system object.

309
Application Server User Guide Working with Alarms and Events

 WinPlatform
o Excess CPU load alarm
o Low disk space alarm
o Excessive page faults alarm
o Low memory alarm
o Engine failure alarm
o Engine checkpoint failure alarm
o Object quarantined condition
o Subscription folding condition
o Scheduler scan overrun condition
A WinPlatform object includes a general communication alarm when it loses contact with the areas
to which it is subscribed.
 AppEngine
o Checkpoint failure alarm
o Object quarantined condition
o Subscription folding condition
o Scheduler scan overrun condition
o Redundancy failover alarm
o Redundancy Standby unavailable
o Redundancy Standby not ready
 ViewEngine
o Checkpoint failure alarm
o Object quarantined condition
o Subscription folding condition
o Scheduler scan overrun condition
The Area and InTouchViewApp system objects do not include any alarms.

Configuring WinPlatform Object Alarms

You select the areas of your Galaxy to monitor for alarms from the WinPlatform object. Also, you can
select specific alarms for the status of the WinPlatform itself.
You must specify that the WinPlatform object is an InTouch alarm provider to subscribe to alarms from
the various areas (and pseudo-areas) of the Galaxy and report them to the InTouch Alarm Manager.

Configuring Communication Failure Alarm Priority

InTouch Alarm Provider reports any communication outage to the InTouch Alarm Manager.
Communication alarms are displayed and must be acknowledged. By default, the priority of a
communication failure is "1", the highest priority.
There can be instances when a communication failure is not a high-priority alarm, and should not require
the attention of a high-priority alarm. Shutting down or undeploying a platform as a normal operation can
result in communication failure alarms, for example.

310
Working with Alarms and Events Application Server User Guide

To indicate whet her the alarm is of high or low importance, the communication failure alarm priority is
configurable at design time as an integer of range 1–999. InTouc h Alarm P rovider must be enabled in the
WinPlatform object editor, General tab.

Selecting the Register using "Galaxy_<GalaxyName>" instead of "Galaxy"

option
When you select the Regi ster using "Galaxy_<Galaxy name>" instead of "Galaxy" option, you
enable ITAlarmP rovider contained in WinPlatform to register the ITAlarmSubsystem using a provider
name of Galaxy_GalaxyName.
For example, if your galaxy is named Andromeda, the ITAlarmSubsystem registers as
Galaxy_Andromeda.
This configuration can be useful if you are using an Alarm Client to display ala rms from multiple galaxies.
 This means that all InTouch applications which query alarms from t his platform should be modified to
use Galaxy_GalaxyName!AreaName.
 Select this option when the Arc hestrA Alarm Cont rol, the embedded alarm client or EAC, or the
AlarmViewControl in InTouch queries alarms from different galaxies.
To configure a WinPlatform object to be an alarm provider
1. Open the WinPlatform object in the Object Editor.
2. Click the General tab.

3. Select the InTouch alarm provider check box.

4. Select the Register using "Galaxy_<GalaxyName>" instead of "Galaxy" check box to enable
Galaxy_<GalaxyName> registration for alarm comment language switching. An information box
appears. Click OK on the information box to continue.
5. In the Alarm Areas box, type the names of areas to subscribe to for alarms.
If you leave the Alarm Areas box blank, the WinPlatform subscribes to all areas in the Galaxy.
If you want to subscribe to only selected areas within the Galaxy, insert a space between each area
name. For example:
Area1 Area2 Area3
6. Enter a number from 1 to 999 to configure the Communi cation Failure Alarm Priority.
7. Click the Engine tab to show the Alarm throttle limit box. Either accept the default throttle limit of
2000 alarms per second, or enter anot her value. A value of 0 disables alarm throttling. For more
information about alarm throttling, see Throttling Alarms on page 307.

311
Application Server User Guide Working with Alarms and Events

8. Click the Alarms tab to show platform, engine, and scheduler alarms that can be set for the
WinPlatform object.

9. Select the check box next to each alarm that you want to enable for the WinPlatform object.
10. Set the limit, value deadband, and priority for each alarm you selected.
11. Save and close the Object Editor.
12. Check the object in to the Galaxy.
13. Deploy the object in an on scan state.

Configuring Alarms for an AppEngine Object

You can set AppEngine attributes that determine whether alarms are enabled for an engine, scheduler,
and redundant failover engine.
To configure AppEngine object alarms
1. Open the AppE ngine object in the Object Editor.

312
Working with Alarms and Events Application Server User Guide

2. Click the Alarms tab to show engine, scheduler, an d redundancy alarms that can be set for the
AppEngine object.

3. Select the check box next to each alarm that you want to enable for the AppEngine object.
4. Set the priority for each alarm you selected.
5. Save and close the Object Editor.
6. Check the object in to the Galaxy.
7. Deploy the object in an on scan state.

Configuring Alarms and Events for Application Objects

The following table shows the different types of alarms that can be specified for application objects. The
table shows the application objects containing native alarm attributes.
You can also set bad value and state alarms for an object’s attribut es. For more information about setting
alarms for attributes, see Setting Alarms on the Attributes Page on page 316.

Alarm Types
State

Limit

Deviation
Target

Change
Rate of

Statistical

Application Objects

AnalogDevice    

Boolean

313
Application Server User Guide Working with Alarms and Events

DiscreteDevice  

Double

FieldReference

Float

Integer

Sequencer 

String

Switch 

UserDefined    

The following list shows the types of alarms for each application object in more detail.
 AnalogDevice
o Level alarms (HiHi, Hi, Lo, LoLo) [limit alarms]
o Rate of Change alarms (Up, Down)
o Target Deviation alarms (Minor, Major)
o PV Bad Value alarm [state alarm]
 DiscreteDevice
o Uncommanded change alarm [state alarm]
o Command time-out alarm [state alarm]
o Active1 state alarm [state alarm]
o Active2 state alarm [state alarm]
o Fault state alarm [state alarm]
o Active1 state duration alarm [statistical alarm]
o Active2 state duration alarm [statistical alarm]
 Sequencer
o Execution halted [state alarm]
o Condition trigger failure [state alarm]
o OnEntry out put failure [state alarm]
o OnExit output failure [state alarm]
 Switch
o PV State alarm [state alarm]
 UserDefined (Attributes can be alarmed)
o PV State alarm [state alarm]
o PV Bad Value alarm (that is, bad quality) [state alarm]
o Attribute alarm features
State alarms

314
Working with Alarms and Events Application Server User Guide

Limit alarms (HiHi, Hi, Lo, LoLo)

Rate of Change alarms (Up, Down)
Deviation alarms (Minor, Major)
Bad Value alarm (that is, bad quality)
There are no built-in alarms for these application objects:
 FieldReference
 Boolean
 Double
 Float
 Integer
 String
You can also configure your application objects to generate an event eac h time the object’s PV value
changes. In addition, you can configure an alarm feature on any object for any Boolean attribute.
To configure alarming and events for application objects
1. Open the application object with the Object Editor.
2. For a DiscreteDevic e, click the General tab, enable inputs, and then enable Generate event upon
PV.

For objects that do not include this check box, use the Attribute s page.

Note: If you are using field attributes instead of Attributes, use the Field Attribute s page.

a. Enable the Log change feature.

b. Enable Generate event upon change .

315
Application Server User Guide Working with Alarms and Events

3. Select or clear the c heck box based on whet her y ou want to generate an event each time the object’s
PV value changes.
4. Click the tab that lists alarm attributes.
 For the AnalogDevice object, click Alarms.
 For the DiscreteDevice object, click Alarms.
 For the Sequencer object, click Settings.
 For the Switch object, click General.
 For the UserDefined object, click Attributes (or Field Attribute s, if you are using field
attributes). See Setting Alarms on the Attributes Page on page 316 for more information.
5. Select the check box that enables alarming for the object.
6. Assign values to the attributes for the type of alarm you selected by completing the following steps:
a. Assign values to the alarm limits based on the type of alarm.
b. Assign an alarm priority (1-999) for each limit you set.
c. Accept the default alarm message or include another message for each alarm limit.
d. Assign values to the remaining attribut es based on the type of alarm you selected. For more
information about other alarm attributes, see Types of Alarms on page 296.
7. Save your object changes and close the Object Editor.

Setting Alarms on the Attributes Page

You set alarms for all Application Server objects in the Attributes page in the Object Editor.
To specify alarms for an object’s attributes
1. On the Attribute s page of the Object Editor, select an attribute from the Attribute s Li st.

2. Select the alarm features you want to configure for the attribute. For Boolean data types, you can
select:

316
Working with Alarms and Events Application Server User Guide

 State alarm
 Bad value alarm
For Integer, Float and Double data types, you can select:
 Limit alarms
 ROC alarms
 Deviation alarms
 Bad value alarms
3. For each alarm feature that you activate, enter the settings for each alarm.
a. Assign values to the alarm limits based on the type of alarm.
b. Assign an alarm priority (1-999) for each limit you set.
c. Accept the default alarm message or include another message for each alarm limit.
d. Assign values to the remaining attribut es based on the type of alarm you selected. For more
information about other alarm attributes, see Types of Alarms on page 296.
4. To configure event logging for an object, select the Log change feature and click the checkbox
"Generate event upon change."
5. Save your object changes and close the Object Editor.

Distributing Alarms and Events

After you configure object instances for alarm detection, deploy the instances and put them On scan. The
instances begin checking for alarm conditions.
When an alarm is detected, or an event occurs, a notification is reported to its alarm and event distributor,
which is running on the same AppE ngine.
These alarm and event distributors include:

 Area objects Area objects report detected alarms through the Area, which
distributes them to alarm and event clients.

 WinPlatform objects Report their own alarms and events.

 AppEngine objects Report their own alarms and events.
 Device IntegrationObjects Report their own alarms and events.
The Area object plays a key role in alarm and event distribution. All objects belong to an Area. Areas can
contain sub-Areas. Alarm and event clients are configured to subscribe to a set of A reas.
Areas provide a key organizational role in grouping alarm information and assigning it to users who use
alarm and event clients to monitor their Areas of responsibility.
WinPlatforms, AppEngines and Device Int egration objects do not report their alarms and events to Area
objects even though they belong to Areas. This allows alarm clients to receive alarm notifications without
any dependencies on Area objects. For example, a deployed and running WinPlat form can report alarms
even though its Area is not deployed and running.
Alarm-event distributor objects maintain a list of all currently active alarms and inactive but
unacknowledged alarms. They do not maintain a list of events, which are routed to clients that are
currently subscribed at the time of the event.
You can configure a WinPlatform to act as an InTouc h Alarm Provider in the run-time environment.

317
Application Server User Guide Working with Alarms and Events

The WinPlatform sends an alarm through the InTouch Distributed Alarm System to InTouch clients when
the WinPlatform loses communication wit h an Area that it subscribes to. This condition typically occurs
during a network outage wit h computers hosting those Areas.
In a network outage, the WinPlat form InTouch Alarm Provider sends an alarm for each disconnected
Area that it subscribes to, including all of its alarm distribution hierarchy. Each of these alarms is a high
priority alarm that contains the name of the Area to which communication is lost. These communication
problem alarms must be acknowledged.
Although they still appear in the historic al record, any current alarms from the disconnected Area drop
from the InTouch client’s summary list. They can no longer be acknowledged.
When communication to the disconnected Areas is restored, any unacknowledged alarms generated in
those Areas are sent to the alarm client.

Subscribing to Alarms and Events from a Client

Clients indicate interest in alarms and events by subscribing to an Area. When subscribing to an Area,
the subscription is actually to all notification distributors within that Area.
For example, if an Area contains sub -Areas, those sub-A reas are subscribed to. If WinPlatforms,
AppEngines or Device Integration objects belong to an Area, those objects are also directly subscribed
to.
When a notification distributor receives an alarm and event subscription from a client, the notification
distributor provides the client with the following:
 A list of all current alarm conditions, including unacknowledged return -to-normal conditions.
 An alarm condition state change. A state change includes transitions into or out of alarm (return to
normal) and change in acknowledged flag.
 An event occurrence.
Alarm and event subscription requests do not include filters, for example, only show alarms great er than
a specific priority value. All alarm and event messages received by the notification distributor are sent to
all subscribed clients. Filtering is provided as a display option by clients.

Using InTouch HMI as the Alarm and Event Client

InTouch run-time clients subscribe to event reports from a Galaxy. Application Server reports alarms to
the InTouch Distributed Alarm System, which subscribe to alarm and event reports from a Galaxy.
An InTouch client application can visualize Application Server components. An InTouch alarm client can
show alarm information for new, unacknowledged alarms, including all required fields.
The new alarm is in the unacknowledged state. An operator can view alarms, acknowledge alarms,
disable alarms, and enable alarms from the client application running in InTouch WindowViewer.

Understanding the Syntax of Alarm Queries

InTouch alarm queries subscribe to alarm and event information from objects within a Galaxy. The alarm
and event queries can be in the form of us er input or a script.
Alarm query syntax must be in one of the following forms:
\Provider!Area
or
\\Node\Provider!A rea
You can have one or more references in a query separated by spaces.
You can also optionally append a tagname filter at the end, separated by another exclamation mark:

318
Working with Alarms and Events Application Server User Guide

\Provider!Area!Filter
\\Node\Provider!A rea!Filter
The filter can have a wildcard * character at the beginning or at the end, but not both.
The \\Node at the beginning is only important if you want to query for alarms from a provider on anot her
computer. Otherwise, you can leave it off and the reference is assumed to be a provider on the loc al
computer. The provider name Galaxy refers to alarms and events that get reported by the WinPlat form
configured as an InTouc h alarm provider on that computer node.

Alarm Query Syntax when Register Using Galaxy_<GalaxyName> is Enabled

In the WinPlat form object, when you enable InTouch alarm provider, you can enable Regi ster using
Galaxy_<GalaxyName> instead of Galaxy. This option will register the platform to the alarm
subsystem using the Galaxy name prefixed by "Galaxy_" instead of just the word " Galaxy". This allows
an InTouch application to monitor alarms from multiple Galaxies and avoid name conflicts.
Syntax changes slightly when Galaxy_GalaxyName is enabled:
o Use \\ for computer name.
o Use \ for Galaxy or Galaxy_<GalaxyName>.
o Use ! for Area.
For example: \\Galaxy\MyGalaxy!A rea001.
If Galaxy_GalaxyName is not enabled in WinPlatform, then the default behavior described in the
previous section applies.
You can det ermine if Galaxy_<GalaxyName> has been enabled by monitoring the run -time attribute of
the platform ITAlarmProvider.ProviderNameAsGalaxyNameEnabled.

Examples of Alarm Queries

 You can submit a query to get all alarms from Area1 and all other alarms within A rea1, as reported by
the WinPlatform object on the local computer.

\Galaxy!Area1
The query returns all alarms and events from all objects directly contained in Area1 and any
sub-areas contained by Area1. This hierarchy is determined by what is configured in the Model View
in the IDE.
 If Area1 and Area2 are two separate mutually exclusive areas, you can submit a query for alarms
from both areas.

\Galaxy!Area1 \Galaxy!Area2
 If you're on NodeA and the WinPlat form is on NodeB, you can submit a query for the alarms from the
remot e computer.

\\NodeB\Galaxy!Area1
 You can submit a query for all alarms from objects whose name begins with " Tank" in the
TankFarm1 area.

\Galaxy!TankFarm1!Tank*
The trailing wildcard character matches alarms from all objects with names that begin with " Tank"
like Tank001, Tank002, Tank Upper, or TankLower.

319
Application Server User Guide Working with Alarms and Events

 You can submit a query for specific alarm types. For example, you can submit a query for all HiHi
alarms in the TankFarm1 area.

\Galaxy!TankFarm1!*.HiHi

 You can submit a query for all types of alarms from a specific object within an area.

\Galaxy!TankFarm1!Tank752.*
The trailing wildcard character matches all alarm types for Tank752.

Alarm Requirements for InTouch Client Applications

For Application Server alarming to function, the following conditions must be met:
In Application Server:
 One or more Area objects are deployed and running.
 The source object is on scan.
 The source object’s Area is on scan.
 Alarming must be enabled for the target object.
 An InTouch alarm provider on any WinPlatform in the Galaxy.
In InTouch:
 The InTouch client application is running in WindowViewer.
 An InTouch alarm ActiveX cont rol is placed in a window and configured as an alarm consumer for the
Galaxy.
 The user is logged into InTouch using A rchestrA security and is authorized to acknowledge alarms
for the object that is in the alarm state. If the user only wants to view alarms, security authorization is
not required.
Application Server validates the user has sufficient security privileges to acknowledge the alarm.
If the user does not have privileges to acknowledge alarms, the user can attempt to acknowledge the
alarm, but the Galaxy rejects the acknowledgment request.The alarm remains unacknowledged in the
InTouch Alarm display.
The rejected alarm acknowledge event is recorded in InTouch E vent History if the user attempting the
acknowledgement has a valid Galaxy user account. Otherwise, the rejected acknowledgement is not
recorded as an event.
You can acknowledge multiple alarms by providing a valid signature. At run time, the A rchestrA Graphics
SignedAlarmAck() script function checks a set of alarms and conditions to find out if any alarm from the
list requires a signature in order to acknowledge it. If so, you must provide your user name, password and
domain or your Smart Card det ails and PIN to authenticate yourself and acknowledge the alarms. To be
able to provide the Smart Card det ails, your computer must be configured for Smart Card aut hentication.

Note: Smart Card authentication is not supported in multi-galaxy environments for read/write operations
to remote galaxies.

If even one alarm in the list requires a signature, you must provide a signature to acknowledge the
alarms. The SignedAlarmAck() function will acknowledge ALL the alarms in the list.
With the SignedAlarmAck( ) function, you can provide credentials and acknowledge an alarm or group of
alarms even if you are not the logged-on operator.

320
Working with Alarms and Events Application Server User Guide

Alarms and Events in the InTouch HMI and in Application Server

Both InTouch HMI and Application Server implement alarms and events. The foll owing table shows the
similarities and differenc es between the two products.

Item InTouch Application Server

Alarm Within a tag Within an object

configured or
detected by

Alarm Classes Only certain classes of alarms are No system-wide distinction for
(client column) supported or det ected: DSC, VALUE, classes. Alarms are tied to a
DEV, ROC, SPC. Boolean that can be triggered from
any logic.

Alarm Type Discrete, LoLo, Lo, Hi, HiHi, MinorDev, No sub-class. The Alarm feature
(Sub-class) MajorDev, ROC, SPC. Client column. name is the closest concept. For
(client column) example, ".PVHiAlarm". Mapped
from Cat egory.

Priority 1-999 (1 most urgent) Priority 0-999. 0 most urgent. 0 is

(client column) mapped to 1 in InTouch.

Name Alarm name = Tag name. Object.attribute

(client column)

Comment Separate alarm comment, which is Object short description or alarm

(client different from the tag comment. message where available.
comment)

Group Alarm group allows client-side filtering. No alarm group. But Area provides
Sub-groups must be on same InTouch. mappable concept. Sub-Areas can
be on different nodes.

321
Application Server User Guide Working with Alarms and Events

Item InTouch Application Server

State Four states, which are combinations of Alarm state provides equivalent
ACK/UNA CK and ALARM/ RTN concept and can be mapped.
 UNA CK/ALARM (usually displayed as
UNA CK)
 ACK/ALARM (usually displayed as
ACK)
 UNA CK/RTN (usually displayed as
UNA CK_RTN)
 ACK/RTN (usually displayed as
ACK_RTN)
These states have a 1:1 corres pondence
with states of the Alarm feature, which
keeps track of whether the alarm is
InAlarm and IsAcked.
Alarms in the state ACK/RTN are not
shown in the SUMMA RY alarm display
because they do not need any further
action from the operator. But, all four states
appear in the HIS TORY display, and in the
Alarm Database.

Value, Only static values sent with alarm Static values and dynamic
CheckValue message. references are provided.

Ack All alarms sent to client and require All alarms sent to client and
acknowledgement regardless of priority. require acknowledgement
regardless of priority.

History Alarm state changes are logged to event Alarm state changes are logged to
history and shown on historical client. event history and shown on
historical client.

Configuring Plant State-Based Alarms

You can map alarm modes on a per-Galaxy basis to different plant operational states to control how
alarms are reported. Five plant states are pre-defined, and have default alarm states associated with
them:

Default Alarm
Plant State State Available Alarm States

Running Enable Enable

Maintenance Disable Enable / Silence / Disable

322
Working with Alarms and Events Application Server User Guide

Default Alarm
Plant State State Available Alarm States

Startup Silence Enable / Silence / Disable

Shutdown Disable Enable / Silence / Disable

Testing Silence Enable / Silence / Disable

You can define new plant states, rename plant states, or remove existing plant states, except the
"Running" state (you can, however, rename "Running"). The alarm state for Running is read-only and
cannot be changed from Enable.
After you have defined plant state-based alarm configurations for the Galaxy, you can assign plant
state-based alarming to area objects in the Galaxy. This is done by setting the PlantState attribute for
each area object that will use plant state-based alarming. The area object will automatically update its
PlantAlarmMode attribut e to match the alarm state that is set for the PlantState currently assigned to it.

Attribute Definition

PlantState The name of the currently assigned plant state

(Running, Maint enance, etc.).

PlantStateAlarmMode The alarm state of the assigned plant state

(enable, silence, or disable). This attribute is
read-only at run time.

Mapping Alarm Modes to Plant States

Define plant states and map them to alarm modes in the IDE. To access the configuration dialog:
1. Click Galaxy on the IDE menu.
2. Select Configure, then select Alarm s and Events Configuration. The Alarm s and Events
Configuration dialog opens.

Note: Settings in this dialog are not shared across Galaxies in a multi-Galaxy environment. Each Galaxy
in the environment will have its own Alarm s and Events Configuration.

323
Application Server User Guide Working with Alarms and Events

To use the default values, you do not have to set anything in this dialog. Simply enable plant state-based
alarms for each area object that is to utilize this feature. See Configuring State-Based Alarming on an
Area Object on page 325 for additional information.

Change Alarm Modes and Modify Plant States

 To change the AlarmMode value, click the AlarmMode associated with the Plant State that you want
to change. Then, select the new value (enable, silence, or disable).

Note: AlarmMode for Running is read-only and cannot be changed.

 To add a new Plant State, Click the add button. A new row is created at the bottom of the table.
Enter the name of the new plant state. The maximum name length is 64 characters.
Select a value for the AlarmMode (enable, silence, or disable).
 To delet e an existing Plant State, click the remove button. The selected plant state and its
associated value are removed from the table.

Note: The first row of the Alarm Plant State table is read-only and cannot be deleted. Running is the
default PlantState name in the first row.

 To rename an existing PlantState, double click the plant state you want to rename, then enter the
new name for the plant state. The maximum name length is 64 characters.

Note: All Plant States, including Running, can be renamed.

324
Working with Alarms and Events Application Server User Guide

Configuring State-Based Alarming on an Area Object

State-bas ed alarm modes apply to String attributes, with writeability set to Writeable_US C (these cannot
be changed). To use state-based alarming for one or more areas, you must configure the Plant State
attribute for each area that will use plant state-bas ed alarming.

Configure plant state alarming

1. Open the area object and click the Attributes page.
2. Select the PlantState attribute.
3. Enable the I/O feature and select Read, Read/Write, or Write.
4. Enable the Hi story feature and configure it.
5. Select the PlantStateAlarmMode.
6. Repeat steps 3 and 4 to configure the I/O and Hi story features.

Viewing Plant State-Based Alarms at Run Time

You can view plant state-based alarming at runtime through clients such as Object Viewer and InTouch
applications in WindowViewer.

User Access and Security During Run Time

Operators with the appropriate permissions can change the PlantStat e of an area through a run time
client. An operator may have to change PlantState from Startup to Running, for example. Scripts can
also be used to implement modifications.

325
Application Server User Guide Working with Alarms and Events

To change a PlantState, the operator enters a string to match one of the defined Pl antState values (for
example, "Running"). Before a change to PlantState can be implemented, the system checks that the
user belongs to a role that has the permission "Can Modify Plant State of an Area" and is therefore
authorized to make the change. If the operator enters a string that does not match a defined PlantState,
the change is rejected.
At run time, the AlarmMode attribute is read-only. Therefore, the AlarmMode for a PlantState cannot be
changed through a run time client (for example, changing from enable to silence). It can only be changed
through the IDE.
If an area is assigned to a PlantState and the PlantState is deleted through the IDE, the area will remain
in that PlantState until it is changed. If AlarmMode for the deleted PlantState is anything other than
enable, the AlarmMode will change to enable.

Note: Operators with appropriate permissions can use the AlarmModeCmd attribut e to change
AlarmMode of an area at run time. However, the AlarmModeCmd can only be used to set a more
restrictive condition than the AlarmMode of the area’s corresponding PlantState. For more information
about changing alarm modes, see Enabling, Silencing, and Disabling Alarms on page 302.

Configuring Alarm Historization, Mapping, and Shelving

Priority Ranges
The Alarm s and Events Configuration dialog lets you:
 Map alarm severities to priority ranges.
 Enable alarm shelving by priority range.
 Enable or disable historization of both alarm severities and event types. All alarms are historized by
default.

Default Alarm Mapping and Historization Values

From Priority To Priority

Severity Description Shelve Hi storize Range Range

1 Critical N Y 1 250

2 High N Y 251 500

3 Medium Y Y 501 750

4 Low Y Y 751 999

Shelving, historization and priority ranges are configurable.

Mapping Alarm Severity to Priority
 Severity 1 starts at priority 1 by default. Severities can be mapped to priorities in ascending or
descending order. For example, severity 1 can map to priority range 1–250 or it can map to priority
range 999-751.
 Severity 4 ends at 999 by default, but 999 is not required to be the end-of-range number. For
example, severity 4 can end at 900, leaving a priority range above 900 unmapped to any severity
level.
 A priority outside the configured priority ranges will return severity 0, not mapped. Since the priority is
unmapped, it cannot be historized.

326
Working with Alarms and Events Application Server User Guide

Note: Mapped alarm severities are not shared across galaxies in a multi-galaxy environment. Each
galaxy in the environment has its own priority to severity mapping.

Configuring Historization for Alarms and Events

Historization is configurable for both events and alarms. E vent types and the default historization setting
for each type are:

Default Event Type Hi storization Values

Type s Description Hi storize

1 System Y

2 Application Y

3 User N

Note: In prior versions of Application Server, historization of alarms and events was configured through
the Alarm DB Logger Manager (an InTouch component) and utilized the SQL database "WWALMDB."
The method described here replaces the Alarm DB Logger method.

To configure alarm and event mapping

1. On the IDE main menu, click Galaxy, then click Configure, then click Alarms and Events
Configuration. The Alarm s and Events Configuration dialog appears.

2. Configure alarms:
a. Edit the priority range for each severity level, or accept the default values.

327
Application Server User Guide Working with Alarms and Events

b. Accept the default (enabled) historization or click to clear the check box and disable historization
for each severity level.
3. Configure events: Accept the default historization values, or click to clear the check box and disable
historization for each event type.
If you want to change the default Alarm Border indicator images shown in the Alarms and Events
Configuration dialog, see "Changing Alarm Border Indicator Icons" in the Creating and Managing
ArchestrA Graphics User’s Guide.

Monitoring Alarm Severities at Run Time

Monitor alarms by severity, expressed as integers 1–4, using clients such as Object Viewer and InTouch
OMI ViewApps. You can monitor individual alarms and you can monitor alarms agg regated by
containment level. For more information about aggregating alarm states, see Aggregating Alarm State
Information on page 329.
Typically, alarm priorities and priority to severity mapping are not changed during run time, but it is
possible to change alarm priority configuration and severity mapping without closing the client
application.

Understanding How Alarms are Ranked at Run Time

The most important alarm has the lowest severity number, but other criteria are taken into account when
ranking alarms by urgency at run time.

Alarm Mode Enabled is more urgent than silenced.

Alarm Shelved FALSE (not shelved) is more urgent than TRUE

(shelved).

InAlarm TRUE (InAlarm) is more urgent than FALSE

(normal).

Acked FALSE (unacked) is more urgent than TRUE

(acked).

Severity Level 1 is most urgent; 4 is least urgent.

Using Aggregated Alarm Information

Alarm aggregation lets you see all the active alarms on a containing object, such as an area object, as
well as all the active alarms on its contained objects. This provides an efficient way at run time to identify
if there are any active alarms (in the InAlarm state), and the location and status of alarms, for example,
unacknowledged and unacknowledged - return to normal. This makes it possible t o follow a trail from one
level to the next to find the underlying cause of a complex object’s alarms.
To obtain aggregated alarm severity status information:
1. Map alarm severity levels to priority ranges. For more information, see Configuring Alarm
Historization, Mapping, and Shelving Priorit y Ranges on page 326.
2. Configure alarms on objects. For more information, see Configuring Alarms on page 309.
3. Enable alarm aggregation by Area. For more information, see Configuring Alarm State Aggregation
on page 329

328
Working with Alarms and Events Application Server User Guide

4. View aggregated alarm status information by means of run-time clients and applications. For more
information, see Monitoring Alarm State Information at Run Time on page 335.

Configuring Alarm State Aggregation

Configuring alarm state aggregation consists of normal alarm configuration proc edures plus an added
step of enabling the aggregation feature on each relevant Area object.

Note: Alarm aggregation is enabled by default on Area objects. Alarm aggregation cannot be disabled
on application objects, such User Defined objects.

To configure alarm state aggregation

1. Accept the default settings or configure alarm severities for each of the four severity levels you want
to aggregate. This is a global configuration.
2. Configure an object with one or more alarms. All alarms configured on all objects will be aggregated.
3. Set the AlarmModeCmd of the object to enabled or silenc ed, but not to disabled.
4. Set the AlarmModeCmd of at least one alarm on the object to enabled or sil enced, but not to
disabled.
5. Set the AlarmModeCmd of the Area object to enabled or silenced, but not to disabled.
6. Check the Enable Alarm Aggregation checkbox on the Area object editor to enable alarm
aggregation. This sets the value of the AlarmAggregationStateCmd attribute to True.

Aggregating Alarm State Information

Run-time clients and applications, such as Object Viewer, InTouch OMI ViewApps, and InTouch HMI
applications, can show alarm aggregation statuses.

329
Application Server User Guide Working with Alarms and Events

You can use animations such as the alarm border animation with Situational Awa reness Library symbols
or with ArchestrA symbols in both Managed InTouch applications and InTouch OMI ViewApps, and you
can add alarm aggregation displays to navigation items in InTouc h OMI ViewApps
Alarm aggregation functionality can be described for an object, for an area, and for an attribute.

Object Aggregation represents all alarms on the object, on all contained objects, and on
their descendents down to the lowest level of the model view.
Alarm aggregation values on child objects are added to the values of the parent
object or objects.
All objects have this alarm aggregation functionality.

Area Aggregation represents the alarms on the Area object itself, on all objects assigned
to the area, and on all sub-Areas, down to the lowest level of the model view.
If the Area’s AlarmMode is silenced, all alarms on all Objects in that Area will be
silenced. For more information about setting alarm modes, see the following
topics:
 Understanding Alarms on page 295
 Setting Alarm State with Object Attributes on page 300
 Enabling, Silencing, and Dis abling Alarms on page 302.
Attribute Aggregation repres ents all the alarms on the attribute itself. This is the lowest level
of aggregation.
Alarms are aggregated if they are in one of three states:
 UNA CK_ALM
 ACK_ALM
 UNA CK_RTN
Alarms in the ACK_RTN state are not aggregated.
Alarms in silenced mode are aggregated, even though they do not appear in a run-time client.
A set of five attribut es provide run-time aggregated alarm status information:

AlarmMostUrgentSeverity Displays the severity as an integer 1–4 of the most import ant current
alarms on an object and its descendents. If no alarms are in the
InAlarm state or waiting to be acknowledged, the value is 0.

AlarmMostUrgentMode Displays the mode (enabled or silence d) of the most important

current alarm. Alarms in disabled mode are not aggregated.

AlarmMostUrgentInAlarm Displays the InAlarm status (true or false) of the most import ant
current alarm.

AlarmMostUrgentAcked Displays the acknowledgement status (true or false) of the most

important current alarm.

AlarmCntsBySeverity In InTouch OMI and InTouch HMI run-time client applications, this
attribute is used to show the number of alarms by status and
severity. In the Object Viewer, this attribut e displays an array that
shows:

330
Working with Alarms and Events Application Server User Guide

 The total number of active alarms (UNA CK_A LM +

UNA CK_RTN + ACK_ALM) at each severity level.
 The UNACK _ALM alarm count.
 The UNACK _RTN alarm count.
 A decimal repres entation if any active alarm bits are set on the
local object.

About the AlarmCntsBySeverity Attribute

AlarmCntsBySeverity is a 13 element array, divided int o three groups of four, plus one additional
element to indicate local alarm severity and status. The first group of four elements shows the number of
aggregated active alarms by severity (S1 through S4), the next group shows the aggregated number of
unacknowledged alarms (UNA CK_ALM) by severity, and the third group shows the aggregated number
of return to normal (UNA CK_RTN) alarms by severity. The final element of the array is a bit value that
defines which, if any, of the alarms are on the selected (local) object. See Local Alarm Display Display in
the Object Viewer on page 331 for additional information.
You can det ermine the number of active, acknowledged alarms (A CK_ALM) by subtracting the number
of unacknowledged alarms shown in the second group of elements from the act ive alarm count shown in
the first group of elements.

Local Alarm Display Display in the Object Viewer

The Object Viewer shows thirteen values, separated by commas, for the AlarmCntsBySeverity
attribute. The first twelve values (logically divided into groups of four each) show how many alarms of
each severity and type have been aggregated for the selected object or area:

1. Number of active alarms, by severity.

2. Number of unacknowledged active alarms, by severity.
3. Number of unacknowledged alarms that have returned to normal, by severity.
4. Bit value that shows which alarm severity and status applies to the local object.
This value is a sum of the bit values shown in the following table:

331
Application Server User Guide Working with Alarms and Events

 (LSB) Active (1) UnAck_ALM (2) UnAck_RTN (3) (MS B) 

S1 S2 S3 S4 S1 S2 S3 S4 S1 S2 S3 S4

Bit value 1 2 4 8 16 32 64 128 256 512 1024 2048

In the Object Viewer example shown above, the local object bit value (4) is 34. This is the sum of the
active S2 bit value plus the UnAck_ALM S2 bit value. Other examples:
 If the local object has one or more active S1 alarms that are unacknowledged, the bit value is 17 (S1
Active Alarm = 1; S1 UnAck_ALM = 16).
 If the local object has one or more active S4 alarms that are UnAck_RTN, the bit value is 2056 (S 4
Active Alarm = 8; S4 UnAck_RTN = 2048).
 If there are no local alarms, the bit value is 0.
 If there are multiple local alarms with different severities and unack statuses, the bit value is the sum
of each bit that is set. For example, if there are two unacknowledged S1 alarms, but one has returned
to normal, the bit value is 273 (t wo S1 Active Alarms = 1; one S1 UnAck_ALM = 16; one S1
UnAck_RTN = 256). Note that each bit that is set is only counted once, even if more than one alarm
exists at that severity or status.
When alarm aggregation is shown on a navigation it em in an InTouch OMI ViewApp, the bit value is used
by the navigation item to determine the alarm location (selected object or a contained object). See
Aggregat ed Alarm Display in InTouch OMI Navigation on page 332 for additional information.

Aggregated Alarm Display in InTouch OMI Navigation

The Alarm s and Events Configuration dialog is used to configure which aggregated alarms are
displayed on a Galaxy-wide basis. You can set whether or not display alarm information in individual
InTouch OMI ViewApps by enabling/disabling the ShowAlarms attribute. InTouch OMI ViewA pps
display alarm indicators and alarm counts for aggregated alarms on NavigationApp controls
(NavigationTree and BreadcrumbControl), if the ShowAlarm s attribute is enabled in the ViewApp. To
enable this attribute, select the Show Alarms option when you configure the control in the Layout
Editor.

Note: Alarm indicators ("adorners") used in InTouch OMI navigation are FrameworkElement Adorners,
part of the Microsoft .NET Framework used in creating and configuring apps for InTouch OMI ViewA pps.

The opacity of the alarm indicat or shows if the alarm is on the selected navigation node or on a contained
object. When enabled, the following alarm severities and alarm statuses are shown:
 If the color of the alarm indicator is opaque (solid), the alarm is on the selected (local) object. If
enabled, the severity (S1 to S 4) and status of the alarm (UNA CK_A LM, UNACK _RTN, ACK _ALM) is
shown graphically, along wit h a count for each alarm severity that has been enabled.
 If the color of the alarm indicator has some transparency, the alarm is on a contained object.
 The color of the blinking line under the object name shows the highest -severity (most urgent) alarm.
 An indicator on the NavigationTree or BreadCrumbControl shows if the data quality of the object is
bad. Bad quality may result if communication has been lost with the object.
You can also determine which navigation node or asset contains the alarm by selecting the alarm icon.
This displays a tooltip that indicates the node(s) or asset(s) sending the alarm(s).

332
Working with Alarms and Events Application Server User Guide

Set Alarm Adorner Options in the Alarms and Events Configuration dialog (Galaxy > Alarms and
E vents Configuration) to configure whic h aggregated alarms are displayed on NavigationApp controls
and any custom apps that subscribe to the aggregated alarm count during run time.

The following Alarm Adorner Options are set through the dialog. The corresponding attribute settings
are propagated to run-time nodes (all attribute names are prefixed by MyViewA pp.Alarms). For
additional information about these attributes, see About Alarm Adorner Attributes on page 334.

Alarm Severities Attribute Name Description

to Di splay (Alarm s Namespace)

Critical ShowCriticalAlarms When enabled, the ViewApp dis plays

critical alarms
High ShowHighAlarms When enabled, the ViewApp dis plays
high alarms
Medium ShowMediumAlarms When enabled, the ViewApp dis plays
medium alarms
Low ShowLowAlarms When enabled, the ViewApp dis plays
low alarms

Alarm States Attribute Name Description

to Di splay (Alarm s Namespace)

UNA CK ShowUnacknowledgedAlarm When enabled, the ViewApp dis plays

(Unacknowledged) UNA CK alarms
ACK (Acknowledged) ShowAcknowledgedAlarms When enabled, the ViewApp dis plays
ACK alarms

333
Application Server User Guide Working with Alarms and Events

RTN (Return to Normal) ShowRet urnToNormalAlarms When enabled, the ViewApp dis plays
RTN alarms

Alarm Indicator Appearance

The appearance of alarm indicators is configured through the Element Styles tab of the Galaxy Style
Library dialog, and uses the symbols that are shown in the Alarms and Events Configuration dialog.

About Alarm Adorner Attributes

Alarm Adorner attributes are available only for use in InTouc h OMI ViewApps. All Alarm Adorner
attributes operate in the MyViewApp.Alarms namespace. Attributes for the Alarm Adorner are specified
with the MyViewA pp.Alarms prefix in the form MyViewApp.Alarms.attribute_name. Alarm Adorner
attributes cannot be used in an InTouch application because the MyViewApp.Alarms prefix is regarded
as a configuration error.

Attribute Name Data Type Attribute Default Description

Type Value

ShowCriticalAlarms Boolean Read/ Write True If True, the ViewApp

displays critical alarms
ShowHighAlarms Boolean Read/ Write True If True, the ViewApp
displays high alarms
ShowMediumAlarms Boolean Read/ Write True If True, the ViewApp
displays medium alarms
ShowLowAlarms Boolean Read/ Write True If True, the ViewApp
displays low alarms

334
Working with Alarms and Events Application Server User Guide

Attribute Name Data Type Attribute Default Description

Type Value

ShowUnackedAlarms Boolean Read/ Write True If True, the ViewApp

displays UNA CK alarms
ShowAckedAlarms Boolean Read/ Write True If True, the ViewApp
displays ACK alarms
ShowRet urnToNormal Boolean Read/ Write True If True, the ViewApp
Alarms displays RTN alarms

Monitoring Alarm State Information at Run Time

You can obt ain run-time alarm state information, including aggregated alarm information, using the
Object Viewer or InTouc h Tag Viewer. You can visualize the objects in an InTouch OMI ViewA pp or
InTouch HMI application, using the AlarmApp (for InTouch OMI) or Alarm Client (for InTouch HMI), along
with the alarm border animation to represent the aggregated alarms at each level of containment. You
can also enable aggregated alarm information for the NavTree

Note: AlarmApp is not supported in InTouch HMI applications. Similarly, AlarmClient is not supported in
InTouch OMI ViewApps. Use AlarmApp for InTouch OMI ViewApps to allow alarm aggregation to follow
selected objects and areas.

An alarm border animation applied t o a group of symbols can indicate a priority 1 alarm with a red border,
flashing or solid for different alarms. The alarm border animation can also indicate a return to normal
(RTN) for the same symbols.

335
Application Server User Guide Working with Alarms and Events

Alarm clients configured in InTouch applications will display the severity of each alarm in the User1 field.
You can change "Us er1" to a more descriptive heading, such as "Severity".
For information about configuring alarm animations, see "Configuring an Alarm Border Animation" in the
Creating and Managing ArchestrA Graphics User’s Guide.

336
 Application Server User Guide

C HAPTER 10
Working with Multiple GR Nodes and
Galaxies
This section describes how to pair Galaxy Repositories to configure multi-galaxy communication. This
lets you connect to and configure remote galaxies, and us e standard run-time tools such as the Galaxy
Browser, Object Viewer, and ViewApps to browse and subscribe to attributes across multiple galaxies
deployed across multiple GR nodes.

Important! If you are using an IDE node that includes a local GR to configure galaxies on remote GR
nodes, the enhanced security on Wonderware System Platform 2017 and newer versions will not let you
connect to a remote GR unless you pair to the GR first. You must configure multi -galaxy communication
to allow the connection. See Connecting to a Remote GR from the IDE on page 366 for additional
information.

In This Chapter
Understanding the Multi-Galaxy Environment ............................................................................... 337
Setting up Multi-Galaxy Communication ....................................................................................... 337
Accessing Multiple Galaxies ........................................................................................................ 341
Setting Remote Galaxy References in the Owning Object Property ................................................ 350
Working with ArchestrA Services ................................................................................................. 352
Managing Galaxies in a Multi-Galaxy Environment ........................................................................ 358
Troubleshooting a Remote Galaxy Connection ............................................................................. 360
Fixing Communication Issues with the OS Configuration Utility ...................................................... 367

Understanding the Multi-Galaxy Environment

Multi-Galaxy communication lets you configure a scalable, distributed automation system that spans
multiple galaxies. It also allows you use the IDE to work with galaxies on remote Galaxy Repository (GR)
nodes. You can configure connectivity for multiple GRs, browse attributes in multiple ArchestrA
namespaces, and subscribe to attributes at run time across remote GRs.
A basic multi-galaxy environment consists of an IDE-only node (no GR), and two or more GR-only nodes.
The GR nodes should not have the IDE installed.
As of System Platform 2017, communication from a GR with a local IDE to a remot e GR is blocked by
default. See Connecting to a Remote GR from the IDE on page 366 to configure multi-galaxy
communication bet ween a GR with a local IDE and another GR node, with or without its own local IDE.

Setting up Multi-Galaxy Communication

Multi-Galaxy communication (MGC) lets multiple GR nodes to talk to each other at runtime. MGC is also
required for configuring remote GR nodes.
The functionality of tools such as Object Viewer, Galaxy Browser, ViewApps, and Managed InTouch
applications is very similar in a multi-Galaxy environment as it is when working within a single galaxy.
However, setting up the multi-galaxy environment requires some basic configuration.

337
Application Server User Guide Working with Multiple GR Nodes and Galaxies

The configuration work flow, using a two-galaxy pair as an example, is as follows:

1. Configure a three node system.
o IDE node 0 (no GR)
o GR node 1 (no IDE): contains Galaxy 1
o GR node 2 (no IDE): contains Galaxy 2
2. Prepare the multi-galaxy environment by adjusting galaxy names as necessary. Each galaxy in a
multi-galaxy environment must have a unique name.
3. From the IDE, connect to Galaxy1 on Node1.
4. Configure Service Discovery for Galaxy 1 (Galaxy > Configure > Service Discovery ).
Set Node 1 as both the Local Galaxy Server and the Cross Galaxy Server. See Defining Service
Discovery (see "Defining Service Discovery" on page 352) for additional information about the Local
and Cross Galaxy Servers. You can configure secondary nodes for redundancy if needed.

Important! There can be only one Cross Galaxy Server in a multi-galaxy environment. All GRs in the
environment must point to the same Cross Galaxy Server node. You can specify nodes by name or
by IP address.

5. Configure Multi-Galaxy for eac h Galaxy (Galaxy > Configure > Multi Galaxy).
a. Connect to Galaxy 1 (on GR Node 1) and select the checkbox to enable Remote Pairing. Then,
enter a passphrase. The passphrase must be the same for each galaxy to be paired, and must
meet a minimum complexity standard:
– Minimum length is nine characters, including at least eight alphanum eric characters (with at
least one upper case and one lower case letter and at least one number)

338
Working with Multiple GR Nodes and Galaxies Application Server User Guide

– At least one symbol: ! @ # $ % ^ & * ( )

b. Click OK. A message that pairing has been enabled is displayed.

c. Connect to Galaxy 2 (on GR Node 2) and select Multi Galaxy (Galaxy > Configure > Multi
Galaxy). Then, click the + sign under Paired Galaxies. The Remote Galaxy Repository Pairing
dialog appears.

d. Enter Node 1 as the Target Galaxy Repository, and ent er the same Passphrase as you entered
for Galaxy 1.
Node 1 is now listed as a paired Galaxy Repository in the Multi-Galaxy Configuration dialog.
To change the Cross Galaxy Server
Use this procedure to change the Cross Galaxy Server for a previously paired Galaxy:
1. From the IDE, connect to the Galaxy on a remote node.
2. Configure Service Discover for the Galaxy (Galaxy > Configure > Service Discovery).

339
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Set the node as the Local Galaxy Server. Set the new node as the Cross Galaxy Server. You can
configure secondary nodes for redundancy if needed.

When pairing, the GR node initiating the pairing gets a copy of the primary Cross Galaxy Server
node if none has been configured.

Naming Galaxies in a Multi-Galaxy Environment

Setting up a multi -galaxy environment requires a unique name for each galaxy in the environment. This
may require you to rename existing galaxies if you plan to include galaxies in your multi -galaxy
environment that currently have the same name.
We recommend performing any necessary renaming operations prior to implementing the multi -galaxy
environment.
For more information about creating and backing up galaxies, see IDE Overview on page 17 and
Managing Galaxies on page 455.
For more information about renaming galaxies, see Renaming Galaxies on page 341.

Important: You must create a new galaxy with a new, unique name, from a backup .cab file rather than
by creating a galaxy and performing a restore of the backup .cab file.

Unpairing Galaxies
You can modify your multi-galaxy configuration by unpairing individual galaxies.
To unpair galaxies
1. Click Galaxy on the IDE menu, then click Configure, then click Multi Galaxy.
The Multi-Galaxy Configuration dialog box appears.
2. In the Paired Galaxies area, select the Galaxy Repository you want to unpair, then click the Delete
(x) button.
Under certain conditions, the unpairing operation can fail. For more information, see Troubleshooting a
Remote Galaxy Connection on page 360.

340
Working with Multiple GR Nodes and Galaxies Application Server User Guide

Renaming Paired Nodes

Renaming a node that is paired with other nodes will disable c ommunication with all other nodes to which
the renamed node has been paired.
If a paired node is renamed, particularly if it is the designated Cross Galaxy Server, you must unpair all
paired nodes and re-pair them using the new node name.
If you need to rename a node that is already paired, you should unpair the node first, then re -pair it after
renaming it.
For information about naming Galaxies for use in a multi-galaxy environment, see Naming Galaxies in a
Multi-Galaxy Environment on page 340.

Renaming Galaxies
To rename a galaxy for use in a multi-galaxy environment
1. Select a galaxy you want to rename, undeploy it and back it up to create a .cab file.
2. Use the .cab file as a "template" by placing it in one of the following directories, according to your
operating system:
 (32-bit)
\Program Files\ArchestrA\Framework\Bin\BackupGalaxies
 (64-bit)
\Program Files (x86)\ArchestrA\Framework\Bin\ BackupGalaxies
3. Create a new galaxy based on the backup .cab file, wit h a new name. The name must be unique, not
in use anywhere else in the multi-galaxy environment.
4. Repeat the preceding steps for each galaxy to be renamed with a unique name.
5. Redeploy each newly creat ed galaxy.
6. Delet e the original galaxy from the Galaxy Repository node.
7. Upgrade to ASB-enabled Application Server using the latest System Platform installation program.
Your galaxies can now be configured for use in a multi-galaxy environment.

Accessing Multiple Galaxies

You can browse from one galaxy to another in a multi-galaxy environment through several methods.
 Use the Galaxy Browser, as described in Ref erence Objects Using the Galaxy Browser on page 83.
 Use the Object Viewer, as described in the Object Viewer User’s Guide.
 Use the ArchestrA OPC UA Client Service, as described in the A rchestrA OPC UA Client Service
Guide, and in Brows e with an ArchestrA OPC UA Client on page 85.
 Browse galaxies while configuring and running Managed InTouch applications, as described in the
InTouch HMI Application Management and Extension Guide, the InTouch HMI Data Management
Guide, and ot her InTouch HMI user guides and online help.
 Browse galaxies while configuring and running InTouch OMI View Applications, as described in the
InTouch OMI Online Help.

341
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Using the Galaxy Browser with Multiple Galaxies

Open the Galaxy Browser as usual to display the objects and attributes in your galaxy. For illustration
purposes, this galaxy’s name is Factory2 and you have paired it with Factory1.
The names of all paired galaxies will appear in the Namespace selection box. Select Factory2 to view
the Tagnames and Attribut es in Factory2.

342
Working with Multiple GR Nodes and Galaxies Application Server User Guide

Using the same instanc e of the Galaxy Browser, you can select Factory1 from the Namespace selection
box. The Factory 1 Tagnames and Attribut es will appear.

You can work with the Factory1 Tagnames and Attributes in the same way as with thos e of Factory2.
For example, you are working in the Object Editor scripts tab, and you want to add a reference from
Factory1 in a script. You can open the Galaxy Browser, select Factory1 in the Galaxy Selection box,
select the Tagname "Outlet _001", select the Attribute "udInt3", then click OK. The Attribut e referenc e is
inserted into the script as

Factory1:Outlet_001.udInt3
at your cursor location. This functionality is unchanged except for the addition of the GR node prefix to
the Tagname and Attribute.
Using an instance of the ArchestrA OPC UA Client Service to browse a Galaxy namespace requires the
use of the specific service instance name as a prefix.
For example, using an instance of the UA Client Service named "OP CUA Client _010" to browse the
preceding example would be addressed as follows:

OPCUAClient_010:Factory1:Outlet_001.udInt3

Using Object Viewer with Multiple Galaxies

Open Object Viewer as usual to view data types, quality, values, timestamps, and status of the
Application Objects, to perform diag nostic testing, and to modify selected attributes.
Object Viewer will display the console tree hierarchy of the GR node on which you have opened it. In this
example, open Object Viewer from the Factory2 GR node. The attribute names, values, timestamps, and
other data will display for a selected object. Add and manage attribut e references to the Watch Window
from Factory2 as usual.
In this example, if you want to add the attribute reference "Outlet_001.udInt3". value to the Watch
Window, you must prefix it with the paired galaxy name as follows:

343
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Factory1:Outlet_001.udInt3.value
E verything following the prefix is addressed as usual. Adding the attribute reference to the Watch
Window is the same as usual. The attribute reference will appear in the Watch Window with the GR node
name prefix.

Using an instance of the ArchestrA OPC UA Client Service in Object Viewer requires the use of the
specific service instance name as a prefix.
For example, using an instance of the UA Client Service named "OP CUA Client _010" in the preceding
example would be addressed as follows:

OPCUAClient_010:Factory1:Outlet_001.udInt3.value

Using InTouch with Multiple Galaxies

You can use an InTouch application as a client to access data in a multi-galaxy environment in the same
way you would access data within a single, local galaxy.
You can use the InTouch Tag B rowser t o select an Application Server object as a tag source and browse
the Galaxy database in a multi-galaxy environment in an almost identical fashion to the traditional
browsing workflow described in the InTouch HMI Data Management Guide.
Application Server object attributes or attribut e properties can be used in remote references or as items
for InTouch I/O tags in a multi-galaxy environment.
The address syntax changes for use in a multi -galaxy environment. The following is an example of a
Galaxy referenc e used within a single galaxy:

Galaxy:Pump1.PV
The following is the same reference with the same access name, but used in a multi -galaxy environment
to target a remote galaxy named "Factory2", containing object Pump1 with attribute PV:

Galaxy:"Factory2:Pump1.PV"

344
Working with Multiple GR Nodes and Galaxies Application Server User Guide

The entire expression, enclosed in quotation marks, becomes an item name. This syntax can be used in
ArchestrA Graphics .NE T scripting, and in InTouch scripting.
Using an instance of the ArchestrA OPC UA Client Service in this sc enario requires the use of the
specific service name as a prefix.
Scope Name/Service Name is specified in the ArchestrA UA Client service edit or. This can be the
identifier of the OPC UA server to which it is connecting.
For example, using an instance of the UA Client Service named " TestServer" would be addressed as
follows:

TestServer:Item1

Important: If you manually enter ArchestrA Graphic custom property overrides, do not ent er the double
quotation marks shown in the example. Browsing aut omatically provides the correct syntax, without the
quotation marks, for custom property overrides. This syntax variation applies to custom property
overrides only.

You can define a paired galaxy as a tag source, with an InTouchViewApp leveraging the galaxy pairing
already configured in Application Server.

345
Application Server User Guide Working with Multiple GR Nodes and Galaxies

You can then use the Galaxy Browser to access the Galaxy namespaces of the paired galaxies.

Guidelines for Accessing Multiple Galaxies

Working with multiple Galaxies is basically the same as working with a single Galaxy, but there are some
important variations.
The general guidelines outlined in the sections that follow can help you to understand and work with
those variations.
 Work ing with Security in a Multi-Galaxy Environment on page 346
 Pairing Galaxies wit h Multiple Net work Interface Cards on page 347
 Work ing with IDE E xtensions on a GR Node on page 347
 Work ing with Alarms on page 348

Working with Security in a Multi-Galaxy Environment

The multi-Galaxy environment supports the OS User and OS Group ArchestrA Security models.
The Galaxy ArchestrA Security model is not support ed:
In order for writes to succeed in a multi -galaxy environment:
 The logged-on user must be a member of the domain, either OS User or OS Group.
 Both galaxies in the pair must be configured to use the same security model.
A user with domain security credentials in a galaxy from which a write is initiated can perform writes,
secured writes, and secured and verified writes, depending on configured privilege level —to a remote
galaxy without logging on to the remote galaxy.
 Use InTouch as a client to write to attributes in a remote galaxy whet her or not the user has logged
on to InTouc h.

346
Working with Multiple GR Nodes and Galaxies Application Server User Guide

 Use Object Viewer to write to attributes in a remote galaxy.

 Use the MxAccess client to write to attributes in a remote galaxy.
For more information about security, see Configure Security on page 409.

Pairing Galaxies with Multiple Network Interface Cards

When using more than one Network Interface Card (NIC), galaxy pairing can fail if the NICs are not
properly configured. For more information about configuring multiple NICs, see Using Multiple Net work
Interface Cards on page 465.

Preventing ASB Services Disruptions

Windows includes a power management option to place a NIC into sleep mode to save power during
periods of low activity. When a NIC is placed into sleep mode, ASB services are disrupted and
multi-Galaxy communication is no longer possible.
To prevent ASB Services disruptions
1. On the computer hosting a multi -Galaxy environment, click Start and select Control Panel.
2. Select Device Manager to show the list of installed hardware devices.
3. Click Network Adapters to show a list of installed NICs on the computer.
4. Right -click on a listed NIC and select Properties from the shortcut menu.
5. Click the Power Management tab.
6. Clear the Allow the computer to turn off thi s device to save power option.

7. Click OK.
8. Clear this option for all nodes in your multi-galaxy environment.

Working with IDE Extensions on a GR Node

Multi-Galaxy configuration options are either limited or are not available in the following scenarios:
 IDE running on the GR node

347
Application Server User Guide Working with Multiple GR Nodes and Galaxies

When you run the IDE on the GR node, you can only configure multi-galaxy communication for the
GR on the same node. From the GR node, you can connect the IDE to a different GR to perform
other c onfiguration operations, but any attempts to perform multi-galaxy configuration will result in an
informational message that the functionality is not allowed.
 IDE running on a deployed platform node
When you run the IDE on a deployed plat form node, you can only configure multi -galaxy
communication for the GR the platform is deployed from. From the platform node, you can connect
the IDE to a different GR to perform other configuration operations, but the multi-galaxy configuration
dialogs will be disabled.
 Multiple instance s of the IDE on a stand-alone node
On a stand-alone node, if you or other users run more than one instance of the IDE, multi-galaxy can
only be configured for the GR to which the IDE last connected.
The IDE node automatically pairs with the GR it connects to. While an IDE is connected to a GR
node—and paired with it—if anot her IDE connects to a different GR on the same computer, the IDE
node pairs with the new GR. The previously running IDE will continue to function, but multi -galaxy
configuration dialogs will be disabled.
By default, installing Application Server deploys the ASBGRBrowsing service. Other user -defined
services are not deployed during installation. When you deploy the platform, the ASBMxDataP rovider
and the ASBAuthentication services automatically deploy. These are default instances which you can
modify. You can configure and deploy new instances of each of these services.

Important: The multi-galaxy environment does not support buffered data.

Working with Alarms

All of the available alarm controls are unchanged, and function in a multi-galaxy environment as
described in their individual user guides and online help. See the user guides for information on how to
configure the various controls, how to query alarms, and how to retrieve alarm information.
 ArchestrA Alarm Control Guide
 InTouch HMI Alarm Viewer Control online help
 InTouch HMI Alarm DB View Control online help.
The alarm controls offer varied res ults and functional limits in a multi-galaxy environment.

ArchestrA Alarm Control Function and Results

 Can take several seconds to display the Alarm Statistics dialog box with tens of alarm providers.
Can take longer with 30–60 alarm providers.
 Can subscribe (query and retrieve) up to 20,000 alarms.
 Has an historical alarms limit for the maximum number of records of 32,766. Can show more than
32,766 in historical mode.
 Cons umed high CPU resources at 200 alarms-per-second from 4 providers. During that time, might
not update in a timely manner.

Alarm Viewer Control Function and Results

 Typically requires one second to display the Alarm Statistics dialog box under the same conditions
as the ArchestrA Alarm Control.
 Can subscribe (query and retrieve) more than 20,000 alarms.
 Can refresh the alarm list every second.

348
Working with Multiple GR Nodes and Galaxies Application Server User Guide

Alarm DB View Control Function and Results

 Alarm queries are limited to 1,958 characters. Larger queries are truncated.
 Can generate alarms from 4 providers at 20 alarms per second, then will start to bu ffer alarms.
 Logger can store 20,000 entries, then the cache is full.
We recommend using the ArchestrA Alarm Control under the limits specified. In excess of 20,000
alarms, 20 alarm providers, and 100 alarms per second from multiple providers, we recommend using
the Alarm Viewer Control.

Enhancing Multi-Galaxy Performance

Multi-galaxy communication can compound the volume of run-time subscriptions and data changes,
potentially impacting system resources. You can manage potential performance degradation by creating
and deploying additional ArchestrA Service instances, particularly the ASBMxDataProvider servic e.
Browsing operations typically place less stress on system resources. Operations tend to be fewer in
number than run-time subscriptions and are performed sequentially rather than in volume, in parallel.
The ASBGRB rowsing service can be instantiated and deployed to remedy any browsing performance
issues.
Operations requiring aut hentication, such as secured writes, also tend to place less stress on system
resources than run-time subscriptions. Performance could become a factor in some scenarios, such as
acknowledging a large volume of alarms where the alarm acks require secured writes. The
ASBAuthentication service can be instantiated and deployed to remedy any performanc e issues with
secured writes or other operations requiring authentication.
You can take one of two general approaches to multi-galaxy performance: remedy performanc e issues
after the fact, or plan the multi-galaxy environment before the fact. We recommend scaling the
multi-galaxy environment before the fact, particularly in large systems.

Remedying Performance Issues After the Fact

Remedying performanc e issues as they occur involves monitoring subscriptions for data change rates. If
your system begins to slow down or starts to show communication failures or bad quality data on
subscribed attributes, do the following:
 Create a new ASBMxDataProvider service instance on the publishing side
 Configure the new service instance
 Assign the new service instance to a node and deploy it
Perform the operation on any node in the multi-galaxy environment exhibiting performance issues.
In a smaller multi-galaxy environment, or when you are just starting to implement multi-galaxy
communication, this approach can have the advantage of saving up front configuration time, and can
also serve as a trial period to gather metrics about your system.
The disadvantages of this approach are that you can lose time dealing with a system that is slowing down
at run time.

Scaling the Multi-Galaxy Environment for Optimum Performance

We recommend at least general advance planning of service and node deployment.
As a general guideline, a single instance of the ASBMxDataP rovider service can subscribe up to 20,000
data changes per second. Beyond that number, you should create and deploy a new
ASBMxDataProvider service on the publishing side.

349
Application Server User Guide Working with Multiple GR Nodes and Galaxies

An object running under an AppEngine subscribing to remote attributes or an InTouchViewApp, as a

general guideline, can support up to 20,000 data updates per second from remote galaxies. Beyond that
number, you should create and deploy a new ASBMxDat aProvider service on the publishing side.
You can assign the new service instances to the same node as existing service instances provided each
instance has a unique port number.
You can assign new nodes and deploy the new service instances to those nodes. In that scenario, a new
service instance can have the same port number as an existing service instance on a different node.

Setting Remote Galaxy References in the Owning Object

Property
You can assign a remote galaxy reference to the owning object property of an embedded graphic during
configuration through the Graphic Editor.
If needed, you can use scripting to change the owning object property during run time.
To configure the owning object property in the Graphic Editor
1. Launch the Graphic editor and embed a graphic. Select the graphic.
2. In the Properties pane, under Runtime Behavior, select the Owning Object property. You can set
the owning object property through the Galaxy browser, or by typing the object reference in the field.
Object references use the following format: RemoteGalaxyName:ObjectName.

350
Working with Multiple GR Nodes and Galaxies Application Server User Guide

3. To use the Galaxy Browser to set the owning object (instead of typing the reference), click the
ellipsis button. This launches the browser.

4. From the Galaxy Browser, select the remote galaxy from the Namespace list of galaxy names. The
objects contained in the galaxy are listed by tagname.
5. Select the object you want to set as the owing object and click OK.

351
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Working with ArchestrA Services

The ArchestrA Services provide tools for multi-galaxy communic ation scalability and performance. For
example, you can create additional instanc es of the ASBMxDataProvider Servic e if your run-time
attribute subscription volume increases to a point where it begins to impact performance.
One default instance of each service is provided during the System Platform installation. You can
rename and modify these instances and you can create additional instances.

About the ArchestrA Service Bus

The ArchestrA Service Bus (ASB) is a framework that hosts services based on general principles of a
service-oriented arc hitecture (S OA).
 SOA provides a mesh of interoperable services that can be used wit hin a single system or extended
to external systems based on an established trust relationship bet ween the systems.
 SOA also generally provides a way for services to discover other available SOA -based services.
ASB components are installed with Application Server as part of the System Platform installation. ASB
functionality appears as menu items in the IDE. For information about the ASB components in the IDE,
see Setting Up a Multi-Galaxy Environment.
ASB components include a set of core run -time services, a catalog of user-configurable servic es, and a
scheme that enables connectivity, interoperability and exchange of data among the services as well as
with internal and external applications.

Defining Service Discovery

The discovery servers provide an infrastructure for ASB services to find and communicate with one
another, either on the same local node or on a remote node. Multi-Galaxy communication uses three
tiers of discovery servers.
 Local Discovery Server
The Local Discovery Server provides discovery for a single, local node. All services register with the
Local Discovery Server, and all clients query it. It is not user configurable.
 Local Galaxy Server
The scope of the Local Galaxy Server encompasses the services in an entire galaxy. You can
designate primary and secondary servers running on different nodes for redundancy.
At least one Local Galaxy Server must be configured and online to enable multi -galaxy
communication.
 Cross Galaxy Server
The Cross Galaxy Server encompasses the services available across multiple galaxies. You can
designate primary and secondary servers running on different nodes for redundancy. In any
multi-galaxy environment, there can be only one designated primary and on e designated secondary
Cross Galaxy Server.
The Cross Galaxy Server can reside on any node in the multi-galaxy environment, but all galaxies in
the environment must configure the Cross Galaxy Server to run on the same node.

Defining User-Configurable ASB Services

The following user-configurable services are installed with Application Server as part of the ASB, or are
separately installed, as the case with the E vent Servic e, Event Historization Service, and
ASBOPCUA Client Service. You can begin configuring your ASB services with the default instances of
each service provided as part of the installation.

352
Working with Multiple GR Nodes and Galaxies Application Server User Guide

 ASBMxDataProvider Service
The ASBMxDataP rovider service connects to ArchestrA run -time components and provides access
to run-time data.
 ASBGalaxyBrowsing Service
The ASBGalaxyBrowsing service connects to the ArchestrA namespace to enable browsing of
ArchestrA objects and attributes.
 ASBAuthentication Service
Users are authenticated against Active Directory user accounts. You can configure more than one
ASBAuthentication service instance to point to different domain servers as needed.
 Event Service
The E vent service raises, monit ors, and routes events. The E vent Service is not required to enable
or configure multi-galaxy communication.
 EventHi storization Service
The E ventHistorization service stores events in a configured database. It is not required to enable or
configure multi-galaxy communication.
 ASBOPCUAClient Service
The ArchestrA OPC UA Client Service provides OPC UA data access connectivity to OPC UA
servers. The OP C UA Client is supplied as a separately installed service in the ASB infrastructure.
Multiple instances of the OP C UA Client service are supported within the same ArchestrA Galaxy.

Note: Close the IDE before uninstalling the OPC UA Client Service. If you uninstall the OP C UA
Client Service with the IDE running, the service will not function properly when you re -install it.

Configuring and Deploying ArchestrA Services

The configuration tool and work flow are the same for all user -configurable ArchestrA Services. To
configure an Arc hestrA Service, you will need to perform the following tasks:
1. Create an instance of an ASB service
2. Assign the service instance to a node
3. Deploy the instance
You can make multiple instances of a single service, and deploy them to multiple nodes. You can also
deploy a single instance to multiple nodes. This approach helps reduce service management. On the
same machine, you can have more than one service simply by creating new instances.

Creating an Instance of an ASB Service

You must create an instance of an Arc hestrA Service (for example, ASBGRBrowsin g Service) to
configure the service.

Assigning the Service Instance to a Node

After you create an instance of the ArchestrA Service, you must assign the instance to the desired node.
You must check out the instance before assigning it to a node. You must check in the instance after
assigning it to a node.

Note: For the ASBGRBrowsingService, you can also specify the name of the Galaxy to assign an
instance of the service.

353
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Deploying the Instance

After assigning a service instance to a node, you must deploy the instance. A deployment confirmation
message appears.
For information about configuring specific ArchestrA Services, see the following topics:
 Configuring the ASBGRBrowsing Service on page 355
 Configuring the ASB MxDataProvider Service on page 356
 Configuring the ASBAuthentication Service on page 357

Configuring ArchestrA Service TCP Ports

Important: As of Windows System Platform 2014 R2, there is no need to configure any TCP ports. All
ArchestrA Service Bus communic ation is based on the Microsoft WCF shared port 808. This information
is retained for existing applications built with a version of Windows System Platform prior to the 2014 R2
release that have been assigned custom port numbers.

To configure ports for OPC UA clients and servers, the following requirements apply:
 On the node running the ASBOPCUAClient service, you need to open two ports, one for IData and
one for IBrowse.
 On a node running an OPC UA server, you need to open two ports, one for the OP C UA server and
one for the OPC UA discovery service, if configured.
See the following table for more information about OPC UA port configuration.
The ASB Core Services, installed with the ASB and started by the Watchdog Service, also use specific
ports. The following table lists the default TCP ports assigned to the user-configurable ASB Services and
the ports in use for the ASB Core Services.
 The ASB Core Services port numbers should not be used to configure instances of user servic es.
 The firewall must allow incoming connections to the ports in the following table for their
corresponding services to function.

Arche strA Service Port Numbers in Use

User-configurable ASB Service s

ASBGRBrowsing Service 7500, 7501 (default)

See note following this table.
ASBMxDataProvider Servic e 3572 (default)

ASBAuthentication Service 7779 (default)

E vent Service 3575 (default, configurable)

E vent Historization Service 3586 (default, configurable)

ASBOPCUA Client Service 8666, 4600 (default, configurable)

IData and IB rowse ports can be aut o-assigned or
user-assigned.
OPC UA Server nnnn (configurable, server-dependent)

354
Working with Multiple GR Nodes and Galaxies Application Server User Guide

Arche strA Service Port Numbers in Use

OPC UA Discovery Service 4840

(OPC Foundation service - not an ASB service)

ASB Core Services-Not configurable

Local Discovery Server 9111

Primary Loc al Galaxy Server 9110

Secondary Local Galaxy Server 9210

Primary Cross Galaxy Server 9310

Secondary Cross Galaxy Server 9410

Galaxy Pairing 7085

Configuration Servic e 6332

Cont ent Provider Service 6011

Deploy Agent Service 6533, 6633

Service Manager Service 6111, 6113

System Authentication Service 9876

aaServiceASBSoftwareUpdate 7587

Important: If a Galaxy Repository (GR) has more than one Galaxy, two additional ports must be opened
to enable a remote GR to browse to each additional galaxy. For example, two galaxies would require
ports 7500, 7501, 7502, and 7503 to be open. Three galaxies would require ports 7500 -7505 to be open.

Configuring the ASBGRBrowsing Service

The ASBGRB rowsingS ervice enables you to browse Application Server namespac es.

Important: The ASBGRB rowsing service is configured with one default service instance named
"Default_< GalaxyName> _GRBrowse". Do not change the name of this default service instance or delete
this service instance. The GRBrowsing service will stop working when you undeploy the GR Plat form. If
the default service instance has been renamed, revert the service instance name back to the default
format. If the default service instance has been deleted, creat e a new instance with the correctly
formatted default name.

To configure the ASBGRBrowsing Service

1. In the IDE, click Galaxy on the menu, then click Configure, then click Arche strA Service s.

355
Application Server User Guide Working with Multiple GR Nodes and Galaxies

The Configure Arche strA Services utility opens.

2. Right -click ASBGRBrow singService, and then click Create. You can also type CTRL+N. The new
instance appears in the tree structure.
3. Right -click the instance name and click Check-out
4. Enter the Galaxy name in the Galaxy Name box.
5. In the Assignments area, select the node you want to assign to the instance, and t hen click Update.

Note: The Update button is enabled only when you select a node. You cannot delete a node that is
already assigned to a service instance. To delet e a node, you must first unassign the node from the
service instance and then delete it.

6. On the left-pane, right-click the instance, and then click Check-in.

7. On the left-pane, right-click the instance, and then select Deploy. A message appears indicating
whet her the node is successfully deployed.

Configuring the ASBMxDataProvider Service

The ASBMxDataP rovider Service acts as a gateway providing access to Application Server data.
To configure the ASBMxDataProvider Service
1. In the IDE, click Galaxy on the menu, then click Configure, then click Arche strA Service s.

356
Working with Multiple GR Nodes and Galaxies Application Server User Guide

The Configure Arche strA Services utility opens.

2. Right -click ASBMxDataProviderService, and then click Create. You can also press CTRL+N. The
new instance appears in the tree structure.
3. Right -click the instance name and click Check-out.
4. In the Assignments area, select the node you want to assign to the instance, and t hen click Update.
5. On the left-pane, right-click the instance, and then click Check-in.
6. On the left-pane, right-click the instance, and then select Deploy. A message appears indicating
whet her the node is successfully deployed.

Configuring the ASBAuthentication Service

The ASBAuthenticationService provides user authentication.
To configure the ASBAuthentication Service
1. In the IDE, click Galaxy on the menu, then click Configure, then click Arche strA Service s.
The Configure Arche strA Services utility opens.

2. Right -click ASBAuthenticationService, and then click Create. You can also press CTRL+N. The
new instance appears in the tree structure.

357
Application Server User Guide Working with Multiple GR Nodes and Galaxies

3. Right -click the instance name and click Check-out

4. In the Assignments area, select the node you want to assign to the instance, and t hen click Update.
5. On the left-pane, right-click the instance, and then click Check-in.
6. On the left-pane, right-click the instance, and then select Deploy. A message at the bottom of the
window appears indicating whether the node is successfully deployed.

Note: A run-time node will be offline if its hosted WinPlatform object is undeployed or if there is a pending
software upgrade (S UP state). To change the status of the node to online and deploy new services,
apply any required soft ware upgrades and redeploy the WinPlat form object.

IOMBLSService
The IOMBLSServic e provides services for browsing, configuring, and deploying objects and visual
elements. All the services provided by IOMBLSServic e are hosted in a single executable
(aaS erviceHost32.exe). IOMB LService is not user -configurable, and runs in the background. Do not
delete, duplicate, close, or modify this service in any way.

Managing Galaxies in a Multi-Galaxy Environment

The work flow for backing up and restoring a galaxy in a multi-galaxy environment is unchanged from
those operations in a single-galaxy environment.
There are some important differences in behavior in galaxy management operations performed in a
multi-galaxy environment:
 Uninstalling and Reinstalling Application Server on page 358
 Back ing Up a Galaxy on page 359
 Deleting a Galaxy on page 359
 Restoring a Galaxy on page 359
 Upgrading a Galaxy on page 360
 Migrating a Galaxy on page 360
 Upgrading SQL Server on page 360

Uninstalling and Reinstalling Application Server

When you uninstall Application Server, the ArchestrA Services dat abase is not deleted from the system.
This means that any existing galaxy pairings will persist when you reinstall Application Server on the
same system. The persistent pairing information is automatically available after the reinstallation.
This pairing information, however, can be out of date and multi-galaxy operations not working as the
Discovery Service information is lost in the transition from uninstall to install.
To resolve out-of-date pairing information, you must unpair and re-pair to the required galaxies after
performing uninstall and re-install operations on the same node.
For example:
1. Install the latest Application Server software on two nodes, Node1 and Node2.
2. Create a galaxy with a plat form, and pair the nodes.
3. On Node1, uninstall Application Server and restart the system.
4. On Node1, reinstall Application Server and connect to the same galaxy.

358
Working with Multiple GR Nodes and Galaxies Application Server User Guide

5. Open the Multi-Galaxy Configuration dialog. Notice that all the pairing information has persisted
through t he uninstall -reinstall operation. Also, notice that multi-galaxy operations are not functioning.
You can’t browse to or subscribe from Node2 even though the nodes appear to be paired.
6. Unpair and pair Node1 to get the new Discovery Service and pairing information from Node2.

Backing Up a Galaxy
Use the Galaxy Database Manager in the SMC to perform a galaxy backup. The backup workflow is
unchanged. There are minor differences in some details:
 The .cab file XML (_GalaxyInfo.txt) has changed to include the backup node name.
 The file repository folder of t he .cab file no w contains a file, <gr node name><galaxy name>_S R.cs v,
that lists all nodes and services configured for the galaxy whose backup the .cab file represents. The
galaxy restore process uses this .csv file to recreate ASB nodes and servic es in the target galaxy .
You can back up and restore to a local node. You can back up and restore to a remote node.

Note: Galaxy pairing information is not included in the galaxy backup.

Deleting a Galaxy
Deleting and restoring a galaxy requires that there be no clients connected to it. In a multi -galaxy
environment, any deployed browsing service is considered a connection.
The following preparatory steps occur prior to initiating the galaxy delete operation:
1. Use the Configure Arche strA Services editor to undeploy and delete all service instances. The
ASB Service instances created for a galaxy are not deleted when the galaxy is deleted.
2. Use the Configure Arche strA Services editor t o undeploy all browsing s ervices associated with the
galaxy being deleted. If clients are connected, the delete operation is aborted and all browsing
services that were previously undeploy ed are redeployed.
If the delete operation can proceed, all services, including the browsing services, are deleted.

Restoring a Galaxy
The galaxy restore workflow remains unchanged. You can do the following restore operations:
 Restoring to an E xisting Galaxy on page 359
 Restoring to a New Galaxy on page 360

Restoring to an Existing Galaxy

If the existing galaxy to which you are restoring already has deployed browsing services, the browsing
services are aut omatically undeployed as a first step in the restore process.
These browsing services are redeployed if the galaxy restore operation cannot proceed for any reason.
Reas ons for a galaxy restore operation being aborted:
 There are clients connected to the galaxy.
 The galaxy has a deployed platform.
At the end of the restore process, the service nodes and instances in the existing galaxy are deleted and
replaced by new ones defined in the .cab file.
The node corres ponding to the GR node in the backup replaces the GR node being restored.

359
Application Server User Guide Working with Multiple GR Nodes and Galaxies

The workflow for restoring Galaxy2 to Galaxy1 remains unchanged. Use the SMC to restore the galaxy,
and target the existing galaxy, Galaxy1, to be replaced. The destination galaxy name will remain
unchanged, even though the nodes will be replaced with what is defined in the .cab file.

Restoring to a New Galaxy

Typically, you use the Galaxy Databas e Manager in the SMC to perform a restore operation. Specify the
backup .cab file to be restored, and provide a galaxy name. You are restoring a backup, but the result is
a new galaxy.
The exception to this work flow is when you must rename a galaxy to ens ure that all galaxies in the
multi-galaxy environment have unique names. For information about the renaming scenario and
procedure, see Naming Galaxies in a Multi-Galaxy Environment on page 340.

Upgrading a Galaxy
Back up your galaxies before performing an Applic ation Server software upgrade.
When you restore a non-ASB galaxy from a backup to a later version of the software that includes the
ArchestrA Services and ASB functionality, the restore process will set up the default services and
extensions.
When you back up the upgraded galaxy, the backup .cab file XML will have the node name. The .csv file
will contain the list of services and instances as they exist in the upgraded galaxy.

Migrating a Galaxy
The migration workflow remains unchanged, but has an additional operation at the end of the migration
process specifically for ASB.
Migrating from a non-ASB galaxy to an ASB-enabled galaxy, by default, does not create service
instances and nodes during the migration process.
Creation of ASB service instances and nodes is deferred until the end of the migration proc ess.

Upgrading SQL Server

We recommend undeploying ASB services before you upgrade SQL Server on your computer.
To upgrade SQL Server in an ASB services environment
1. Undeploy the galaxy.
2. On the menu bar, click Galaxy, then Configure, then Arche strA Services. The Configure
Arche strA Service s window appears.
3. Select the galaxy name in the left pane. Right-click and select Undeploy from the context menu, or
click the Undeploy icon on the toolbar.
4. Verify that each service instance is undeployed, then close the configuration window.
5. Follow the relevant Microsoft instructions to install the new version of SQL Server.
6. When complete, you can deploy the ASB services, then deploy the galaxy.

Troubleshooting a Remote Galaxy Connection

Informational and error messages remain the same in a multi-galaxy environment as they are for
single-galaxies. The diagnostic tools already available, such as Object Viewer and the SMC Logger,
continue to function in a multi-galaxy environment as they do in a single-galaxy environment.
Object Viewer displays communication or configuration errors, and displays data quality. The SMC
Logger displays informational messages about system events.

360
Working with Multiple GR Nodes and Galaxies Application Server User Guide

Important: Watchdog and other ASB core services must be running whether or not you are operating in
a multi-galaxy environment. Galaxy deletion, configuration, or run-time operations can fail if ASB
services are not running, even when not operating in a multi-galaxy environment. See Local services in
the following troubleshooting table for more information.

Indications of communic ation or configuration errors can include:

 Galaxies in a multi-galaxy environment do not appear in the Galaxy: list box in the Galaxy Browser.
 Attribute References in an Object Viewer watch list show Bad quality.
 Attribute References in an Object Viewer watch list show communication errors.
 Specifying an Attribute Reference in the Object Viewer text box returns a configuration error.
 Specifying an attribute reference in an InTouch application returns a configuration error or fails to
return run-time data.
 A galaxy in the multi-galaxy environment does not appear in the Browse Node dialog box when
attempting to select a Galaxy Repository with which to pair.
 You cannot connect to a galaxy in the multi-galaxy environment.
 You cannot undeploy or deploy an instance of an ArchestrA Service.
 Writes from InTouch WindowViewer fail when security is enabled.
When communication or configuration issues arise in a multi-galaxy environment, you can perform the
following series of quick checks and remedies to determine if the issues have been caused by a
multi-galaxy configuration error.

Check ... Description Procedure

Local service s The ArchestrA Watchdog service is Do not stop the Watchdog service even if
a utility to start all the ArchestrA you do not plan to use a multi-galaxy
Core Services. The Watchdog environment.
service starts automatically when
These steps use the Windows 2008 R2
you start your operating system.
operating system for illustration.
The Watchdog service and other
1. Click Start, then Admini strative
ASB services are tightly coupled
Tool s, then Component Services.
with Application Server
The Component Services utility
configuration and run-time
opens.
operations.
2. Click Services (Local) to populate
 The Watchdog service must be
the Services (Local) pane.
running in order to create
service instances and nodes, to 3. Click Arche strA Watchdog Service
deploy, undeploy, or delete to view its state.
user-defined ArchestrA
4. If the Watchdog service is not
services.
running, click Start the service.
 The Watchdog service must be
5. Exit the Component Services utility.
running whether or not you are
using a multi-galaxy
environment.

361
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Check ... Description Procedure

Service By default, the Local Galaxy Server Do these steps for each galaxy in the
Di scovery primary node is not configured multi-galaxy environment for which you
configuration (blank), and must be designated are having connectivity issues.
before you can enable galaxy
1. In the IDE main menu, click Galaxy,
pairing.
then click Configure, then click
By default, the Cross Galaxy Server Service Discovery to open the
primary node is not configured Service Discovery Configuration
(blank), and must be set to the dialog box.
designated Cross Galaxy Server
2. Verify or configure the Local Galaxy
before you can enable galaxy
Server Primary node as the local
pairing.
galaxy GR node.
There can be only one Cross Galaxy
3. Verify or configure the Cross Galaxy
Server in a multi-galaxy
Server P rimary node as the node you
environment. All galaxies in the
have defined as the Cross Galaxy
environment must designat e the
Server for all paired galaxies.
same Cross Galaxy Server primary
node.

Multi-Galaxy Multi-Galaxy configuration 1. In the IDE main menu, click Galaxy,

configuration establishes and maintains the trust then click Configure, then click
relationship between paired Multi-Galaxy to open the
galaxies for the duration of the Multi-Galaxy Configuration dialog
pairing session. box.
Remote pairing must be enabled on 2. Verify that the galaxy or galaxies to
each GR to be paired, each of which be paired are listed in the Galaxy
requires the same unique Repository list box.
passphrase.
a. If a particular galaxy is not listed,
click the Add button to open the
Select Galaxy Repository to
pair with dialog box.
b. Enter the Target Galaxy
Repository node in the text box.
c. Enter the Passphra se in the text
box.
3. If pairing fails, ensure that remote
pairing is enabled on the target GR,
and that you have the correct
passphrase entered.

362
Working with Multiple GR Nodes and Galaxies Application Server User Guide

Check ... Description Procedure

Arche strA The user-configurable ArchestrA For more information about configuring
Services Services provide communic ation ArchestrA Services, see Configuring and
configuration channels for attribut e browsing and Deploying ArchestrA Services on page
run-time dat a access. 353.
By default one instance of each For browsing issues, verify the
service is configured and locally ASBGRBrowsing servic e instance.
deployed.
For run-time data subscription issues,
At least one instance of each verify the ASBMxDataP rovider service
service must be deployed on each instance on the publisher side, and
galaxy in the multi-galaxy ensure that the galaxy is deployed.
environment for multi-galaxy
For secured write issues, verify the
communication to function.
ASBAuthentication service instance.
Note: When you set or change the 1. In the IDE main menu, click Galaxy,
Local Galaxy Server or the Cross then click Configure, then click
Galaxy Server, the core ASB Arche strA Service s to open the
services aut omatically restart. This Configure Arche strA Service s
can create a timing issue if you dialog box.
immediat ely deploy a platform. The
ASBMxDataProvider and the 2. Expand the GR node in the hierarchy
ASBAuthentication services can fail pane to view the installed services.
to deploy. Run-time connectivity Expand each service in the hierarchy
would then fail in the multi-galaxy to view the service instances.
environment. a. Select the instance to view its
configuration in the configuration
pane.
b. Verify that the Galaxy Name is
correct (ASBGRBrowsing
service only).
c. Verify that the service instance is
assigned to a node, visible in the
Assignments pane, and that the
node is correct.
d. Verify that the service instance is
deployed.
3. Edit the service instanc e
configurations as necessary.

363
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Check ... Description Procedure

Client The Galaxy Browser, Object Viewer, For Object Viewer communication errors,
configuration and Managed InTouch applications review the Attribute Reference syntax. In
can function as clients to browse particular, ensure that the correct
attributes in the ArchestrA <GalaxyName>: prefix is present and
namespace, or to subscribe to points to the correct galaxy.
run-time dat a.
For Galaxy Browser errors, ensure that
Using these clients in a multi-galaxy you have selected the correct galaxy in
environment is described in the Galaxy: list box.
Accessing Multiple Galaxies on
For Managed InTouch errors:
page 341.
 Ensure that you have selected the
correct galaxy when accessing
tagnames and attributes from the
Galaxy Browser.
 Ensure that syntax is correct,
including the "Galaxy:" access name
prefix, and the full attribute reference
in quotes, with the remote galaxy
prefix as part of the expression.
Correct any incorrect syntax.

Note: If you selected InTouch HMI

Development and Run Time during
installation, you cannot create a
multi-galaxy environment. This
installation does not include a GR,
required for multi -galaxy functionality.

364
Working with Multiple GR Nodes and Galaxies Application Server User Guide

Check ... Description Procedure

Security OS User with domain users only and For information about security
configuration OS Group (supports only domain configuration, see Configure Securit y on
users) are the only ArchestrA page 409.
Security models support ed in a
In the IDE, set the security mode to
multi-galaxy environment.
Galaxy Security.
Security issues, evident wit h failed
In InTouch HMI, set the security mode to
writes, can occur for any of the
Arche strA.
following possible causes:
In the multi-galaxy environment, set local
 Security mode of galaxy is set to
and remote galaxy security to the same
Galaxy Security
mode for each galaxy.
 Security mode of InTouch is not In the multi-galaxy environment, log into
set to ArchestrA each remote galaxy at least one time (for
 User has not logged int o the each user who requires access to those
remot e Galaxy at least once galaxies and has sufficient write
permissions ).
 Security modes of local and
remot e galaxies don’t match In the Configure ArchestrA Services
dialog, verify the ASBAuthentication
 User doesn’t have sufficient service instance.
permissions to perform the write
1. Open the Configure Arche strA
 Default User Authentication Services dialog box.
service is not deployed on the
GR node 2. Expand the GR node in the hierarchy
pane to view the installed services.
Expand the each service in the
hierarchy to view the service
instances.
a. Select the instance to view its
configuration in the configuration
pane.
b. Verify that the service instance is
assigned to a node, visible in the
Assignments pane, and that the
node is correct.
c. Verify that the service instance is
deployed.
3. Edit the service instanc e
configurations as necessary.

365
Application Server User Guide Working with Multiple GR Nodes and Galaxies

Check ... Description Procedure

Unpairing Unpairing galaxies requires that When an unpair operation fails, you will
galaxies communication is established with see the Un-pair operation with remote
the remote node to be unpaired. If Galaxy Repository failed error
communication with a remote message and dialog box.
galaxy is broken, unpairing with that
This dialog box offers you a choice to
node will fail.
force the unpair, or to wait until the
This condition can occur in different remot e GR is back online.
scenarios, including:
 Click Yes to forc e the unpair.
 The remote node is down or not
The forced unpairing occurs only on the
on the network.
local GR. When the remote GR is back
 The System Authentication online, any client running on the remot e
service is not running. GR will be unaware that an unpairing has
occurred, and will still be able to discover
 The Watchdog service is not and connect to the service on the local
running GR from which you performed the failed
 A mismatch or corruption has unpairing operation.
occurred in a security key.  Click No to end the unpairing
operation and wait until the remote
GR is back online.
When you click No, the system takes no
action, and pairing remains as
configured.
You can now troubleshoot why the
remot e GR is offline, then retry the
unpairing operation.

Connecting to a Remote GR from the IDE

As of Wonderware System Platform 2017, communication from a GR wit h a local IDE (single node with
both IDE and GR) is blocked by default to a remote GR. This applies to using the IDE to configure a
Galaxy on a remote GR, as well as runtime.
If the IDE you are running has a GR on the same node and you try to pair with a Galaxy on a remote GR,
you will get an error message that communication with the GR node cannot be established.
Scenario 1
The nodes have the following configuration:
 Node 1: IDE + GR (Galaxy 1)
 Node 2: GR only (Galaxy 2)
 Node 3: IDE only
To establish communication with the blocked GR in Scenario 1
1. Open the IDE on Node 1 and connect to Galaxy 1.

366
Working with Multiple GR Nodes and Galaxies Application Server User Guide

2. Configure Service Discovery for Node 1, and set Node 1 as the Local Galaxy Server and Cross
Galaxy Server (Galaxy > Configure > Service Discovery).
3. Open the IDE on Node 3 and connect to Galaxy 2.
4. Configure Service Discovery for Node 2, and set Node 2 as the Local Galaxy Server. Set Node 1 as
the Cross Galaxy Server (Galaxy > Configure > Service Discovery).
5. Configure Multi-Galaxy for eac h Galaxy. Use the Node 1 IDE to configure Multi-Galaxy for Node 1,
and the Node 3 IDE to configure Multi-Galaxy for Node 3.
Make sure that you use the same Passphrase for both nodes.
Scenario 2
The nodes have the following configuration:
 Node 1: IDE + GR (Galaxy 1)
 Node 2: IDE + GR (Galaxy 2)
To establish communication with the blocked GR in Scenario 2
1. Open the IDE on Node 1 and connect to Galaxy 1.
2. Configure Service Discovery for Node 1, and set Node 1 as the Local Galaxy Server and Cross
Galaxy Server (Galaxy > Configure > Service Discovery).
3. Open the IDE on Node 2 and connect to Galaxy 2.
4. Configure Service Discovery for Node 2, and set Node 2 as the Local Galaxy Server. Set Node 1 as
the Cross Galaxy Server (Galaxy > Configure > Service Discovery).
5. Configure Multi-Galaxy for eac h Galaxy. Use the Node 1 IDE to configure Multi-Galaxy for Node 1,
and the Node 2 IDE to configure Multi-Galaxy for Node 2.
Make sure that you use the same Passphrase for both nodes.

Fixing Communication Issues with the OS Configuration

Utility
The OS Configuration Utility runs automatically as part of the System Platform installation process. In
some cases, you may need to run the utility manually to correct communication issues within Application
Server. Running the OS Configuration Utility may be necessary if you have problems running the IDE,
connecting to a galaxy, or deploying a node. The full pathname of the OS Configuration Utility is (there is
no start menu shortcut to the utility):
<Root drive>:\Program Files (x86)\Common Files\Arche strA\OS ConfigurationUtility.exe

367
Application Server User Guide Working with Multiple GR Nodes and Galaxies

The utility will open ports and change registry values to fix any communication issues it finds. Other than
starting the utility, all updates are automatic. No user interaction is required or allowed, other than
restarting the system after the utility has finished running.

368
 Application Server User Guide

C HAPTER 11
Working with Buffered Data
In This Chapter
About Buffered Data ................................................................................................................... 369
Configuring Buffered Data for an Attribute .................................................................................... 370
Using Object Viewer with Buffered Data ....................................................................................... 371
Using ArchestrA Scripts to Process Buffered Dat a ........................................................................ 373
Buffered Data Run-time Behavior................................................................................................. 375
About Buffered Data and History .................................................................................................. 376
About Buffered Data and Alarms and E vents ................................................................................ 377

About Buffered Data

Buffered data is data captured and stored locally on a remote device for later transfer to a supervisory
system for processing, analysis, and long-t erm storage. The Buffer property is input-only.
Enabling buffered data alters the run -time behavior of some Application Server features such as History
and Alarms. Buffering is essential if the Telemetry Server is installed.
The buffered data feature enables efficient accumulation and propagation of V TQ (V alue, Time, and
Quality) data updates, without folding and data loss, to data consumers such as objects, alarms, the
Historian, and scripts from field devices that support buffering. If the Telemetry Server is used with
Application Server, buffering must be enabled to ensure that all data from the Telemetry Server is
received by Application Server, and then sent to the Historian in its entirety.
Enabling the buffered data feature preserves all intermediate data values. Thus, if an attribute receives
different values during a single scan cycle, the data is not folded or compressed. Data folding occurs
when an attribute value changes multiple times within a single scan, and only the latest value is stored.
With buffered data enabled, the entire subs et of values is propagated to data subscribers such as the
alarm subsystem and the Historian, if the attribut e is configured to be alarmed or historized. Scripts can
also take advantage of processing buffered data. Since the Telemetry Server only sends a data req uest
periodically, and often only onc e per day, enabling buffered data ensures that Application Server
preserves all intermediate data values.

Note: If multiple attribut es with I/O enabled are configured for buffered data from the same data point in
the Telemetry Server, only one attribute will receive the buffered data at run time.

Components that Use Buffered Data

The following table summarizes component functions related to buffered data subscription and
processing.

Subscribing to the Buffer property

369
Application Server User Guide Working with Buffered Data

Attribute User defined attributes with I/O configured to read or read/write data can
support buffered data processing.
When buffered data is enabled, the attribut e subscribes to the buffer
property and rec eives the buffered data via Message Exchange. See
Using Message Exchange and Attributes on page 383 for more
information about Message Exchange.

Scripts A script subscribes to an attribute and receives buffered data from it. A
specific syntax is used to properly proc ess buffered data in scripting.
Scripts can also read the buffer from an attribute or directly from the
DIObject.
For more information, see Using ArchestrA Scripts to Process Buffered
Data on page 373.

Processing buffered data

Operations Operations Integration (OI) Servers, and legacy Data Access (DA)
Integration (OI) Servers, collect and store VTQ data from field devices. OI Server and
Server DAServer functionality is unchanged by the buffered data feature.
Protocol interfaces within the servers allow buffered data from the field
devic es to be processed. The OI Servers and DAServers, in turn, can
pass the buffered data as packets to the Application Engine.

Telemetry Server The Telemetry Server collects and stores VTQ data from RTUs (remote
terminal units) c onnected to field devices. The Telemetry Server typically
only sends data to Application Server when polled. Since polling may be
performed only periodically, there may be a large dataset of intermediate
values that would be lost if buffering is not enabled.
DIObject For attributes with a buffer property that is being subscribed, the
DIObject collects VTQ values from the O I Server, and legacy DAServer,
and packs the VTQ values into buffer collections, based on scan cycle
completion or on end of data received.
Application Engine The Application Engine hosts and executes the ApplicationObjects’
logic.

Data Consumers When buffered data is enabled, data consumers such as the Historian
and alarms subsystems subscribe to the Buffer property of the
configured attribute to receive published buffered data. The buffered
data, a stream of V TQs, is assembled and appended in cac hes to avoid
data folding, and is then published through Message Exchange to
consumers such as the Historian, alarms and scripts. See Using
Message Exchange and Attributes on page 383 for more information.

Note: The buffered data feature does not support out-of-sequence data. Out-of-sequence data occurs
when the time stamps of the VTQ sequence for a specific referenc e is not arranged in incremental order
from older to newer.

Configuring Buffered Data for an Attribute

To configure buffered data for an attribute:
1. Open an object for editing and select the Attribute s page.
2. Select an existing user-defined attribute or add one.

370
Working with Buffered Data Application Server User Guide

Buffered data can be configured for all attribute data types except InternationalizedString.
3. Enable the I/O feature for the attribute and select Read or Read/Write, as appropriate.
4. Click the arrow to expand the Advanced I/O configuration options.

5. Select the checkbox next to Buffered to enable data buffering.

Select and modify other advanced options as needed. See Using the I/O Feature on page 121 for
more information.

Using Object Viewer with Buffered Data

You can use the Object Viewer utility to view the attribute values of a selected object at run time.

371
Application Server User Guide Working with Buffered Data

The Object Viewer Attribute s Li st displays a Has Buffer column to reflect whether an attribute has a
buffer. The value displayed in the column is True if the attribute has a buffer and False if the attribute has
no buffer, as shown in the following illustration.

Add the <attributename>.buffer property to the Object Viewer Watch Window . The Value column
displays the message <<Double-click to display buffer>>. Double-click the attribute to view the buffer
elements. The View Buffer Elements dialog box appears.

The View Buffer Elements dialog box header displays the Attribute Reference, Type, Timestamp, and
Count. A details window displays Value, Timestamp, and Quality (VTQ) columns for each item. The data
is displayed as a snapshot. Refresh the window to ret rieve another snapshot.
The source attribute must also have buffered data enabled. If buffered data is not enabled on the source
attribute, the data quality will return as bad, and a configuration error message is displaye d.

372
Working with Buffered Data Application Server User Guide

See the Object Viewer User’s Guide for more information.

Using ArchestrA Scripts to Process Buffered Data

ArchestrA scripts can be synchronous or asynchronous. The synchronous mode is the default choice
and represents serial script execution by the ApplicationEngine in the course of calling the Execute
method of all ApplicationObjects that are on-scan in the ApplicationEngine.
Synchronous mode requires that all scripts execute deterministically and quickly enough to prevent an
ApplicationE ngine over-scan condition.

Important: For scripts that process buffered data, it is strongly recommended that you configure scripts
as asynchronous execution type. Processing buffered data may be time consuming and exceed the
script execution time limit. See Scripting Tips and Best Practices on page 374 for more information.

Scripting Basic Functions

The following is a collection of basic functions used to read buffer dat a from the script accompanied by
script snippets.

Declaration
dim vtq as ValueTimeQuality;

To access sample s in each buffer

FOR EACH vtq in me.U1.buffer

Note: The only syntax that can be used to process buffers in scripts is FOR EACH.

To write the buffer to text file

Declaration:
dim strWriter as System.IO.StreamWriter;
Usage:
strWriter = System.IO.File.AppendText("C:\\sample.txt");

To write the buffer to Logger (or SMC)

LogMessage();

Sample Script and Output

Read Buffered Data from the VTQ Buffer

dim vtq as ValueTimeQuality;

dim strWriter as System.IO.StreamWriter;

LogMessage("Script Start");
strWriter = System.IO.File.AppendText("C:\\sample.txt");
FOR EACH vtq in me.UD1.buffer
strWriter.WriteLine("DAS value is "+vtq.value);
strWriter.WriteLine("Time stamp of the value is "+vtq.time);

373
Application Server User Guide Working with Buffered Data

strWriter.WriteLine("Quality of the value is "+vtq.quality);

strWriter.WriteLine("--------------------------------------");
‘Below messages will be logged to the Logviewer (or SMC)
LogMessage("DAS value is "+vtq.value);
LogMessage("Time stamp of the value is "+vtq.time);
LogMessage("Quality of the value is "+vtq.quality);

next;
strWriter.Flush();
strWriter.Close();

LogMessage("Script End");
For each VTQ in this script sample, Value, Timestamp, and Quality are written to the sample.txt file.
For purposes of illustration, UD1 in the script sample is a buffer -enabled Integer attribute with input
extended to a DDE item.
Sample Output Text Written to Text File
DAS value is 2

Time stamp of the value is 7/15/2010 11:28:54.880 AM

Quality of the value is 192

Sample Output Text Written to Logger
Info ScriptRuntime UD1.S1: Script Start

Info ScriptRuntime UD1.S1: DAS value is 2

Info ScriptRuntime UD1.S1: Time stamp of the value is 7/15/2010 11:28:54.880

AM

Info ScriptRuntime UD1.S1: Quality of the value is 192

Info ScriptRuntime UD1.S1: Script End

Scripting Tips and Best Practices

Use Asynchronous Scripts for Buffered Data
Synchronous scripts may read buffered data. However, if the buffer is ex pected to take too much time for
processing it would be better to mark the script as asynchronous.

Buffered Data Script Syntax and Configuration

Scripts can process buffered data by using the FOR EACH syntax to iterate over an attribute’ s Buffer
property.
To process all the buffers without any loss, asynchronous scripts need to have the following
configuration:
 Execution type: Execute
 Trigger type: While True
 Expression: True
 Time period: 00:00:00.0000000

374
Working with Buffered Data Application Server User Guide

Using BindTo for Buffered Data

When working with indirect scripts to read the .buffer property of an attribute, the BindTo call needs to be
used in startup instead of using it in execute. Using BindTo in execut e can lead to losing the data in
alternate buffers. The following snippets show an example of using an indirect to process a buffer. In this
example, the BindTo call is in Startup and FOR EACH is in Execute.
When binding to an on-engine attribute, the whole script could be put in Execute. When binding to an
off-engine attribute, use BindTo in startup instead of in ex ecute, as shown in the example.
In Declarations:

dim x as indirect;
In Startup:

x.BindTo("me.attribute1.buffer");
In Execute:

dim vtq as ValueTimeQuality;

for each vtq in x

LogMessage(vtq.value);
next;

Buffered Data Run-time Behavior

This following table describes how enabling buffered data affects the run -time behavior of the Scan
Group, Inputs, and Redundancy for all phases:
o On Startup
o On Scan
o Execute
o Off Scan
o Shutdown
History run-time behavior and Data and Alarms run-time behavior also change when buffered data is
enabled. The run-time behavior of thos e features is described in About Buffered Data and History on
page 376 and About Buffered Data and Alarms and E vents.

Important: Buffered data is not supported in a multi-galaxy environment.

Feature Phase Behavior

Scan Group When the buffer property of a scan group’s dynamic attribute
is subscribed to at run time, the buffer data support is
enabled. The scan group accumulat es all of that item's
updates into a buffer of V TQs.
The scan group supports buffering up to 10,000 V TQs per
item per scan. Higher data throughput rates are not
supported

On Scan When the object is placed On Scan, the system enables all
available items and resets item error count.

375
Application Server User Guide Working with Buffered Data

Feature Phase Behavior

Off Scan When the Scan Group goes Off Scan, it will clear all buffers
associated with each item in the Scan Group.
When buffered data is enabled and the host object goes Off
Scan, a VTQ with Bad Quality is added to the buffer. On a
subsequent scan, the buffer property of the Value attribute is
cleared.
Inputs On Startup When buffer is enabled on the attribute, buffer support for the
input is enabled. No dat a is processed during this phase.

Execute The buffered attribut e is registered, but no data is proc essed

or stored until the buffer reference finishes initializing.

Shutdown Interfaces are unregistered. (No change in behavior for

buffered dat a-enabled.)

Redundancy Application Engine

Buffered attributes are not synchronized with a redundant
partner. When a failover occurs, unprocessed buffered data
is lost.

Redundant DIObject
When buffering is enabled, the Redundant DIObject (RDI)
subscribes to the buffer property of its DI source items.
On failover, all advised items are moved to the backup node,
whet her or not buffered dat a is enabled.
Buffered attributes are not synchronized with a redundant
partner. When a failover occurs, unprocessed buffered data
is lost.

About Buffered Data and History

When an ApplicationObject starts up, if configured to save historical dat a, it registers its configuration
data with the Historian using a Historian supplied interface.
The following table describes buffered data -enabled history behavior.

Hi story Function Behavior

Buffer Monitoring The ApplicationObject monitors and historizes the attribut e value. If the
attribute being historized has a buffer property, the ApplicationObject
monitors the attribute’s buffer instead of its value, and historizes each V TQ
in the buffer.

Attribute Registration Attributes that are buffer-enabled are registered with the Historian in the
with the Historian same manner as non-buffered attribut es are registered.

376
Working with Buffered Data Application Server User Guide

Hi story Function Behavior

Push Attribute After successful registration of an attribute wit h the Historian, the
Changes to the buffer-enabled attribute pus hes the dat a changes to the Historian.
Historian
If the buffer-enabled attribute reads an empty buffer, and if this is the firs t
scan cycle after the attribute was registered, it gets the attribute’s Value,
Time, and Quality properties, and if Quality is Good, sends this VTQ to the
Historian.
If the buffer-enabled attribute reads an empty buffer, and if this is not the
first scan cycle after the attribute was registered, it does nothing.
For more information, see Work ing with History on page 277.

About Buffered Data and Alarms and Events

Application Server’s alarm and event capabilities automate the detection, notification, historization, and
viewing of eit her application alarms and events or system alarms and events.
An attribute, when configured for alarming and buffer-enabled, can receive a packet of V TQs in a single
scan. This packet can contain values that will trigger an alarm condition. Alarm conditions will be
generated based on the V TQs in the buffer.

Important: Alarms are not supported in this release of Telemet ry Server.

AppEngine Reconnect Configuration for Undeploying and

Redeploying Objects Linked to the Telemetry Server
If an object with an attribute linked to a Telemetry Server is undeployed and then redeployed, you may
see a gap in the timestamps that are historized by the Historian for the data collected between the
undeployment and redeployment times. This can happen, even when buffering is enabled. Not e that all
data values are accurately preserved, but the timestamps for the values will not be accurat e. This is a
function of the behavior of the Historian and the default configuration of the AppEngine.
When an AppEngine or objects connected to it are undeployed and then redeployed, all values from the
Telemet ry Server are collected and sent to the Historian upon redeployment. The Historian gives the
current timestamp to the first value received after redeployment. This leaves a gap bet ween
undeployment and redeployment times. The Historian adds 5 ms from the time of redeployment to all
timestamps for values (after the first value) that were collected during the undeployed time. Thus,
subsequent values have timestamps of redeploy time + 5 ms, redeploy time + 10 ms, etc.
To eliminate this gap in timestamp values for dat a collected during undeployment, configure the
Reconnect setting under Data management in the AppEngine that contains the object. When the
Reconnect setting is enabled, all values will be historized with the correct timestamp.
To configure the AppEngine Reconnect setting
1. Locate the AppEngine that contains the object with the Telemetry Server-connected attribute.
2. Open the AppE ngine for editing.

377
Application Server User Guide Working with Buffered Data

3. In the General tab, expand Advanced Settings.

4. Under Data management, enable the setting, "Reconnect as soon as possible & do not mark
disconnects."
5. Save and close the AppEngine object.

Alarm Functions and Buffered Data

The attribute, if configured for alarms, detects the alarm condition and sets an associated alarm condition
attribute according to the base attribute being monitored. If the base attribute is configured with buffered
data enabled, the condition attribute will als o be enabled with buffered data support.
At run time, the condition attribute's buffer property will contain a V TQ buffer of true or false values
representing alarm conditions corresponding to the base attribute buffer contents.
Only the most current alarm condition can be acknowledged.
For more information, see Work ing with Alarms and Events on page 293.
The following table describes buffer-enabled behavior for alarm functions.

378
Working with Buffered Data Application Server User Guide

Alarm Function Behavior

Detection With buffered data enabled for the condition attribute, the alarm condition
change is detected using the buffer property of the condition attributes.
Multiple alarm messages can be generated based on the buffer contents.
The alarm is time-stamped with the time the alarm was recorded at the
field device, not the time at which the values were received and processed
within the object.
A set of alarm messages corresponding to the alarm state transitions are
sent to its Notification Distributor.
The TimeAlarmOff attribute’s value is set to the time of the last off
transition, and TimeAlarmOn to the last on transition.
The InAlarm value, time and quality properties are set to the last alarm
transition’s state, time and quality.

Notification When the Notification Distributor receives a set of alarm messages, it

updates the state of the record for the corresponding alarm. The set of
alarm messages are forwarded to all registered alarm clients.
The Notification Distributor does not send a throttling signal as a result of
receiving multiple alarm messages.
When the Notification Distributor receives a set of event messages from
ApplicationObjects as the result of processing an attribute’s buffer, the set
of event messages are forwarded to all registered event clients.

Throttling Alarm throttling settings are ignored for alarm messages generated based
on buffered data.
Alarms will be generated for all alarm conditions in the buffers. If a
potential throttling point is reached, the current version of Application
Server provides a functionality for all alarms to be processed without
system overload.
Acknowledgement If an alarm is associated with buffered dat a, acknowledging an alarm only
acknowledges the last alarm, and not all alarms contained in the buffer.

Disabled Alarms If an alarm is disabled for a buffered attribute, the alarm’s Buffer property is
not processed. Alarm buffers for disabled alarms are cleared.
If an alarm is silenced for a buffered attribute, the alarm’s Buffer property is
processed. Alarms will be generated but will not be displayed by the alarm
client.

Outages Buffered alarms and events can be lost when there is an out age because
the Notification Distributor will only keep and re -send the last on-alarm
message and the last off-alarm message.

379
Application Server User Guide Working with Buffered Data

Alarm and Event Types and Buffered Data

The following table describes buffered data -enabled behavior of alarm and event types.

Alarm/Event Type Behavior

Data Change E vent Application (data change) E vents have the following fields:
 E vent type – data change (historized)
 Timestamp – date/time of event (historized)
When Log E vent is checked for the buffered data -enabled attribute, a data
change event will be reported for every V TQ in the attribute's buffer
property.
Limit Alarm The limit alarm can provide a buffer of alarms on an attribute with buffered
data enabled.
If the base attribute has an associated Buffer property, then the limit alarm
calculation is performed for each VTQ in the buffer. This results in a buffer
of Boolean alarm conditions with associated time of the V TQ matching the
times of the VTQ in input buffer, which is stored in the respective condition
attribute’s buffer property.
The order of the condition buffer matches the order of the input buffer. The
respective condition value and time reflects the last VTQ in the input
buffer.
Value Deadband: If value deadband is configured for limit alarms, then
the alarm condition is calculated using V TQs in the input buffer. All VTQs
in the buffer are proc essed. Value deadband is used during execution.
Time Deadband: If time deadband is configured for limit alarms, when the
alarm condition is met, the duration of the condition is calculated using the
VTQs in the input buffer. If the last condition change remains undecided
until the end of processing the current buffer, then a late decision will be
made when the next input buffer is processed. If no more input buffer is
received, the last alarm condition change is reported when the time
deadband has elaps ed as engine time.
The time deadband is applied only to the On Rise event of the alarm state.
It is not applied when the alarm state falls outside the limit condition.

State Alarm The state alarm can provide a buffer of alarms on a B oolean attribute when
buffered dat a is enabled.
If the base attribute has an associated Buffer property, then the state
alarm calculation is performed for each V TQ in the input buffer. This
results in a buffer of Boolean alarm conditions with associated time of the
VTQ matching the times of the V TQ in input buffer, which is stored in the
respective Condition attribute’s buffer property.
The order of the condition buffer matches the order of the input buffer. The
respective condition value and time reflects the last VTQ in the input
buffer.

380
Working with Buffered Data Application Server User Guide

Alarm/Event Type Behavior

Rate of Change If the input has an associated Buffer property, then the Rate of Change
Alarm (ROC) calculation is performed for each V TQ in the input buffer. Interval is
calculated using the difference of two successive V TQs. These
calculations result in an array of Boolean alarm conditions with associated
timestamps which are stored in the buffer property of the resp ective
condition alarm attribute. The condition value reflects the last VTQ in the
respective condition buffer.

Deviation Alarm If buffered data is enabled for a deviation alarm’s attributes, buffered data
is also enabled on the configured condition attributes Dev.Minor. Condition
or Dev.Major. Condition or both.
When buffered data is enabled on a deviation alarm’s attributes and the
AppEngine goes Off Scan, the buffers for the configured condition
attributes, Dev.Minor.Condition or Dev.Major. Condition or bot h, are
cleared of all VTQs.
If the input has an associated Buffer property, then the deviation
calculation is performed for each V TQ in the input buffer. These
calculations result in an array of Boolean alarm conditions and associated
timestamps which are stored in the buffer property of the respective
condition alarm attribute. The condition value reflects the last VTQ in the
respective Condition buffer.

381
 Application Server User Guide

C HAPTER 12
Working with References
This section describes the conc ept of referenc es and how to use reference strings in creating your
Application Server application.

In This Chapter
Using Message Exchange and Attributes ..................................................................................... 383
Referenc e Strings ....................................................................................................................... 383
Viewing Attributes in Objects ....................................................................................................... 389
Using Galaxy Referenc es in InTouch ........................................................................................... 392
Telemet ry Server Data References .............................................................................................. 394

Using Message Exchange and Attributes

Referenc es allow identification and communication between objects in the ArchestrA environment.
E very object, every attribute, and every property can be uniquely referenced. Those references are
communicated over the messaging system. The Message Exchange is the object -to-object
communications protoc ol used by ArchestrA and the Application Server.

Note: ArchestrA is the framework for supervisory control and manufacturing information systems. It is an
open and extensible technology based on a distributed, object -based design. For example, if you are
using Application S erver with InTouch, thes e products communicate with each other using the ArchestrA
framework.

All object attributes have properties, such as Value and Quality. Any data read or written to or from these
attributes over ArchestrA Message Exchange is tracked. If an operation cannot be performed, the
requesting client is notified.
Message Exchange provides the following feat ures and information:
 Guarant eed response
 Name signatures
 Status and data quality
 Message order preservation wit hin a priority system
 AppEngine-to-A ppEngine buffering
 Publish-subscribe heartbeats

Reference Strings
Referenc e strings refer to an object or to data within an object’s attributes. A reference string consists of
an object's reference string plus an attribute's reference string.

object Reference + Attribute Reference

A reference string is the object name plus the attribut e name: ObjectName.AttributeName.
In a multi-galaxy environment, a reference string to a remote galaxy is the galaxy name plus the object
name plus the attribute name:

383
Application Server User Guide Working with References

GalaxyName:ObjectName.AttributeName.
Use references and reference strings in a multi-galaxy environment as you would in a single-galaxy
environment, with the exception of the galaxy name prefix, <GalaxyName>, followed by a colon as in the
preceding example. For more information about using referenc es and referenc e strings in a multi-galaxy
environment, see Accessing Multiple Galaxies on page 341.
In TIC101.PV, TIC101 is the object reference and PV is the attribute reference. The AttributeName
can be omitted in a reference string, PV being assumed in such cases.

Note: Some objects have a PV attribute, while others do not.

Referenc e strings are concatenated substrings, each no more than 32 characters separated by periods.
A substring cannot contain a period. Mathematical operator characters are not allowed. At least one
character in each substring must be non -numeric.
A void assigning objects and attributes names such that the same reference string can refer to two
different things. For example, you have two objects named A1 and B2, and inside A1 you create an
attribute named B2 with a data type of Float. A1.B2 refers to the attribut e Float named B2. If you then
assign object B2 so that A1 is a container of object B2, the reference A1.B2 could refer either to the
object B2 or the attribute B2 Float.

Important: The Galaxy resolves referenc e strings. If the GR is not available, resolution is done on a
peer-to-peer level. After initial resolution, an object is provided an alias that handles references to its
location across your net work. If an object is relocated or renamed, the referenc e string res olution is
repeated and a new alias provided.

Relative References
Referenc es that go up the hierarchy to parent objects are called relative references. For more
information about hierarchy, see ApplicationObject Containment on page 55.
Relative references, such as Me, are valid reference strings. A valid reference string must always contain
at least a relative reference or one substring.
The following are valid relative references that refer to the current object:

 Me  MyContainer  MyArea
 MyPlatform  MyEngine  MyHost
Relative referenc es are especially us eful in templates because absolute references typically do not apply
or make sense.
When you use relative references, like MyContainer, you can refer to contained objects within that
container. For ex ample, a reference to MyContainer.InletValve.PV is equivalent to
Tank1.InletValve.PV in the following hierarchy:

Tank1 Cannot reference at this level because this is not contained

Inlet Valve Can referenc e at this level because this object is contained
(InletValve)
Outlet Valve Can referenc e at this level because this object is contained
(OutletValve)

384
Working with References Application Server User Guide

Property References
Cert ain property names are reserved for ArchestrA. If a string has a reserved property name in the
ArchestrA environment, you can still use it. The PROPERTY keyword must be part of the string, for
example, PROPERTY(propertyName). In all other cases, the case insensitive PROPERTY keyword is
not required.
The Value property is assumed if no property reference is specified.
The following are property references:
 .Name
 .Value
 .Type
 .Quality
 .Time
syntax:

obj.int.PROPERTY(quality)
where:
obj = object specifier
int = attribute
PROPERTY = keyword
(quality) = property specifier
For example, you can address the time of an attribute in a scan group for a DIObject from within an
InTouch application, as follows:

Galaxy:"<DIObject>.<scangroup>.<attribute>.Property(Time)"
This is the same as if you used . Time:

Galaxy:"<DIObject>.<scangroup>.Attribute(<attribute>).Time"
You can directly address an item without having an attribute in the scan group. For this example, the item
is MB1:

Galaxy:"<DIObject>.<scangroup>.MB1.Property(Time)"
and

Galaxy:"<DIObject>.<scangroup>.Attribute(MB1).Time"
For objects with a default scan group, you must refer to the .Time, .Value, and .Quality properties using
the .Property(time), .Property(value), and .Property(quality) notation.
The following is an example of the correct use of property:

LogMessage(ATTRIBUTE("MyEngine.tagname.PROPERTY(securityclassification)")
)
The following is an example of the incorrect use of property:

Logmessage(abtcpplc5_001.fast.changingpoint.property(quality));

385
Application Server User Guide Working with References

Handling Time Zones with the Time Pr operty

If you need to share time stamp values across different time zones (Platforms ), use the Time dat a type in
every time zone location. However, if you need to share it as string, remember that when converting the
Time data type to a string (for example, in a script), it is automatically converted to local time, so you lose
the ability to adjust it in a different time zone.
For example, to convert the Time property to a string GMT:

Dim localDateTime As System.DateTime;

localDateTime = System.DateTime.Parse( obj.attr.Time );

obj.udStringGMTfromLocalTime= localDateTime.ToUniversalTime().ToString();
To convert the string GMT to a string of local time:

Dim univDateTime As System.DateTime;

univDateTime = System.DateTime.Parse( obj.udStringGMTfromLocalTime );

Obj.udStringLocalTimeFromGMT = univDateTime.ToLocalTime().ToString();

Preserving Time Stamps from the Publishing Source

In the following cases, if you want to pass only the time stamp, the subscriber gets the time stamp as
converted to the local time zone of the publisher and not the time zone of the data source.
Examples of configurations that do not preserve the original time zone are as follows.
In this configuration, GalaxyB:Object1. TimeAttr shows the time adjusted to the local time zone of the
GalaxyA FSGateway and not the time zone of the PLC:
PLC.Item <= GalaxyA Object1.IntAttr.Time <= FSGateway <= GalaxyB OPCClient <=
Object1. TimeAttr
In this configuration, GalaxyB:Object1. TimeAttr shows the time adjusted to the local time zone of the
InTouch application and not the time zone of the PLC:
PLC.Item <= GalaxyA Object1.IntAttr.Time <= InTouc h App I/O Message Tag <= GalaxyB
InTouchP roxy <= Object1.TimeAttr
To avoid thes e problems, subscribe to the GalaxyA:Object1.IntAttr value property. This way, both the
value and time stamp propagat e to GalaxyB:Object1. IntAttr. You can then use the
GalaxyB:Object1. IntAttr.Time. For example:
PLC.Item <= GalaxyA Object1.IntAttr <= FSGateway <= GalaxyB OPCClient <= Object1.IntAttr
PLC.Item <= GalaxyA Object1.IntAttr <= InTouc h App I/O Integer Tag <= GalaxyB InTouchP roxy <=
Object1.IntAttr
In this configuration, the time property propagates from InTouch to Object.IntAttr.Time:
PLC.Item <= InTouch I/O Integer Tag <= Galaxy InTouchProxy <= Object.IntAttr

Arrays
A reference string can also refer to the Value property of an array attribute with an optional Array Element
Referenc e that includes up to one dimension:
 [i] – individual element
 [] – entire array

386
Working with References Application Server User Guide

The letter i represents an int eger constant.

Formatting Reference Strings

These symbols apply to the reference strings that follow:

This... means...

::= can be replac ed by

| or

[] contents optional

{} contents can be left out, used one time or repeated

Quotation marks are not allowed in tag names, feature names, or attribute names.

Using Literals
Items outside of angle brackets "<>" are literals. For example:
 reference_string ::= <Automation_object_reference><attribute_reference> |
<tag_name>

 Automation_object_reference ::= <absolute_reference>|<relative_reference>

 absolute_reference ::= <tag_name>{.<contained_name>}
 tag_name ::= <identifier>

 contained_name ::= <identifier>

 relative_reference ::= <relative_name> | <relative_contained_reference>

 relative_contained_reference ::= MyContainer.<contained_name> |

MyArea.<contained_name>
 relative_name ::= Me | MyContainer | MyArea | MyHost | MyEngine | MyPlatform
 attribute_reference ::= <value_ref>|<property_ref>
 whole_attribute_ref ::= [.<feature>][.<attribute>] |
[.<feature>][.ATTRIBUTE(attribute)]
 value_ref ::= <whole_attribute_ref>[<array_index>]

 array_index ::= <open_bracket> {<index>} <close_bracket>

[<open_bracket><index><close_bracket>][<open_bracket><index><close_bracke
t>]
 property_ref ::= <whole_attribute_ref>.<property>

 property ::=
Value|Type|Quality|BitField|Dimension1|SecurityClassification|Locked|Cate
gory | propertyref
 propertyref ::=
PROPERTY(Value|Type|Quality|BitField|Dimension1|SecurityClassification|Lo
cked|Category)

387
Application Server User Guide Working with References

 BitField ::= .00, .01, .02, …, .31 (valid ONLY for attributes of type
MxInteger; otherwise Configuration error occurs at run time)
 attribute ::= <static_attribute>|<dynamic_attribute>

 static_attribute ::= [<static_attribute>.]<identifier>

 <dynamic_attribute> ::= <any_char_but>{<any_char_but>}

 feature ::= [<feature>.]<identifier>

 identifier ::= <valid_char>{<valid_char>}
 valid_char ::= <letter>|<digit>|<special_character>

 letter ::= any letter in alphabet of any language

 digit ::= any numerical character

 special_character ::= any graphics char, except the following:

. + - * / \ = ( ) ` ~ ! % ^ & @ [ ] { } | : ; ’ , < > ? " whitespace
 whitespace ::= CR, LF, Tab, Space, FF, as returned by iswspace()

 any_char_but ::= any character except whitespace

 open_bracket := [
 close_bracket := ]

 Galaxy_identifier ::= <letter> | <digit>

Notes
 <tag_name> is an object’s unique name.
 <contained_name> is an object’s optional contained name. It can be specified in a reference when
an object is referred to as a contained child of another object.
 <index> is –1 or a positive integer from 1 to 32767.
 <identifier> is limited to a maximum of 32 characters.
 An <attribute> name or < feat ure> name can contain several <identifier> parts. The lengt h of each
<identifier> part can be up to 32 characters. Each <identifier> part is separat ed by a period. The
maximum total length of the <attribut e> name is 329. This name length applies to both static and
dynamic attribut e names. The maximum total length of the <feature> name is 329.
 <relative_name> and <property> replacements are case insensitive, including PROPERTY().
 If no attribute reference is specified, .PV is assumed. If PV is an attribute of type array, the resulting
reference is invalid. For arrays, the .PV[] part must be explicitly supplied.
The exception to this rule is a reference that is preceded with an @ sign. This reference refers to the
object itself and not any particular attribute or property. Currently, this reference string format is used
only in the Execution Order group on the Object Information page of the Object Editor.
 Do not use Property Names or InTouch Pseudo-P roperty Names for the names of features or
attributes when enhancing an object’s functionality on the Scripts, Attribute s and Field Attribute s
pages.
ArchestrA Property Names include: Locked, Category, HasruntimeS etHandler, Name, Type,
Quality, Dimension1, Value, SecurityClassification, 00, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12,
13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 and 31.

388
Working with References Application Server User Guide

InTouch Pseudo-Property Names include: #VString, #VString1, #VString2, #VString3, #VString4,

#EnumOrdinal, #ReadSts, #WriteSts and #QString. For more information on InTouch
Pseudo-Property Names, see the InTouch® HMI Data Management Guide.
 If the object is a DIObject, use obj.Attribute(attribute)[x] rather than
obj.Attribute[x] to avoid having to resolve the reference at the GR. Resolving an object
reference at the GR can negatively impact performance.

Viewing Attributes in Objects

Within the ArchestrA IDE, you can view the attributes in an object. This lets you see what attributes are
available.
To view the attributes in a selected object
1. Select an object.
2. On the Galaxy menu, click Properties.
3. To see the references for the selected object, click the Attribute s tab.

This page shows you the selected attributes for the object, the current attribute values, and locked
and security status. The information shown depends on whether Configuration and Runtime or
Runtime Only is selected.:
AttributeName
The name of the attribute.
Value
Shows the value of the attribute.
Locked/Unlocked
Shows if the attribut e is locked or unlocked
Security
Shows the current security setting, if any.
4. To filter the view, select one or more of the following:

389
Application Server User Guide Working with References

 Configuration and Runtime: Select to show both configuration and run-time attributes for the
selected object.
 Runtime only: Select to show only run-time attributes for the selected object.
 Include hidden: Select to show hidden attributes for the selected object.
5. When you are done, click Close.

Viewing References and Cross References

Objects have references and cross references.
 Referenc es are the objects the selected object is looking for.
 Cross-references are the objects looking for the selected object.

Cross Reference

Reference

You can view references and cross-references for a selected object.

Some attributes are dynamic attributes. These are attributes that get created during run time and exist
only in run-time. A device integration (DI) reference to a hardware register is a good example.
The attribute referencing a hardware register does not exist at configuration time by default. DI instances
create the attribute dynamically during run time if the hardware register exists in the target device.

Note: References and cross-references shown in the Propertie s dialog box only refer to interobject
communications. Area associations, containment, or host assignments are not shown.

To view references and cross-references

1. Select an object.
2. On the Galaxy menu, click Properties.
3. To see the references for the selected object, click the References tab. You see:
Source Attribute
The attribute in the selected object referencing an attribute in another object in the application
Galaxy.
Attribute Reference
The reference string within the Source Attribute. This is either an absolute reference or a relative
reference.
Target Attribute
The absolute reference of the Attribute Reference. If this is a referenc e to a dynamic attribute, the
Target Attribute only lists the Tagname name of the instance.
4. To see the cross references for the selected object, click the Cross References tab. You see:

390
Working with References Application Server User Guide

Target Attribute
The absolute reference of the Attribute Reference. If this is a referenc e to a dynamic attribute, the
Target Attribute only lists the Tagname of the instance.
Attribute Reference
The reference string within the Source Attribute. This is an absolute reference or a relative
reference.
Source Attribute
The attribut e in the selected object that is referencing an attribute in anot her object in the application
Galaxy.
5. When you are done, click Close.

Finding Objects
Your Galaxy can get very large and can include many objects. It can become difficult to find a specific
object. You can search for templates or instances, and you can search by part or all of a tag name or
hierachical name. You can limit a search by platform and engine. Other search options are:
 Find objects with errors or warnings
 Find checked-out objects
To search for objects
1. On the Edit menu, click Find. The Find dialog box appears.

2. Do some or all of the following:

 In the Find what box, type some or all of the name of the object.
 In the Which name area, select either Tagname or Hierarchical name as the type of name you
entered in the Find what box.
 In the Type area, specify if you are looking for an Instance or a Template. If you select
Template, the Which name and Search scope groups are unavailable.

391
Application Server User Guide Working with References

 In the Search criteria area, specify how to search for the name in the Find what box. The
options are: Contains, Exact match, Starts with or Ends with.
 Search for objects in an error or warning state by selecting Only objects with errors or
warnings.
 Search for objects that are checked out by selecting Onl y Checked-out objects.
 Limit the search scope by selecting from the Search scope lists.
3. When you are done specifying the search criteria, click Find. The searc h results appear in the
bottom pane.
4. Double-click an object in the results pane. The object is located and selected for you in the
Application views area.
If you double-click a Backup AppEngine, the IDE opens the Deployment view and the object is
selected there. See Work ing with AppE ngine Redundanc y on page 474 for more information.

Using Galaxy References in InTouch

You can use Galaxy referenc es in InTouch. Use the InTouch Tag Browser in unlimited selection mode to
browse and include references from an Application Server Galaxy in InTouch applications you are
developing.
You also can use Galaxy references in InTouch in a multi-galaxy environment by using both the Galaxy:
access name and the remote GalaxyName as part of the item name. For more information, see Using
InTouch with Multiple Galaxies on page 344.

Note: You must install the Bootstrap and IDE on the InTouch node to create the TagSource to browse
Galaxy objects.

The following lists the primary ways you can open the Tag Browser in InTouch to see unlimited selection
mode:
 Double-click an animation link tagname or expression input box.
 Double-click an ActiveX or wizard tagname or expression input box.
 Double-click an empty area in any InTouch QuickScript window.
 In the InTouch QuickScript editor, select Tagname on the Insert menu.
 Press the Alt+N keys in the InTouch QuickScript editor.
 Double-click a blank New Name box in the Substitute Tagnames dialog box.

392
Working with References Application Server User Guide

 Double-click the Tagname input box in the SQL Access Bind List Configuration dialog box.

For complete information about using the InTouch Tag Browser, see the InTouch documentation.
Before you can browse Galaxy references, you must define a new tag source.
To define a new tag source
1. In the InTouch HMI Tag Browser, click the Browse button to the right of the Tag Source list. The
Define Tag Sources dialog box appears.

2. Click New to open the Define Tag Source dialog box.

393
Application Server User Guide Working with References

3. Type a Tag Source Name. This name appears in the Tag Source box of the Tag B rowser. For
example: Training1.
4. Select Galaxy from the list for Acce ss Name and Tag Source Type.
5. In the GR node name box, type the Host Name of t he computer on which the Galaxy is located. If the
Galaxy is located on the same comput er, use localhost.
6. In the Galaxy Name list, select the name of your Galaxy. For example: Training. Assuming the
examples given in steps 3 and 5, the Define Tag Sources dialog box appears as follows.

7. Click Close. The Tag Browser appears. Now you can browse the TagNames.
To browse attribute references in a Galaxy
1. Open the InTouch Tag Browser in unlimited selection mode.
2. In the Tag Source box, select the tag source you created in the previous steps (Training1 in the
example). The Attribute Brow ser appears.
3. Select the object and attribute you want to reference in your InTouch application and click OK.

Note: The next time you open the Tag Browser, the Attribute Browser aut omatically opens. To change
that, exit the Attribute Browser without selecting anything by clicking the blue arrow at top right. The Tag
Browser appears and it defaults to the InTouch Tagname Dictionary.

For more information about using the Attribute Browser, see Ref erence Objects Using the Galaxy
Browser on page 83.

Telemetry Server Data References

The Telemetry Server interfaces with Application Server to link data from widely dispersed equipment,
using DNP, IEC-60870, or Modbus protoc ols. This section describes how to create dynamic and static
data references to the Telemetry Server, and is organized as follows:
 Telemet ry Server Dynamic Tags on page 395
 DNP 3 Data References on page 397
 IEC 60870-5 Dynamic Data References on page 401
 Modbus Data References on page 403
 Telemet ry Server Static Data Referenc es on page 406
Dynamic dat a references to the Telemetry Server us e the following syntax:
Telem_S erver_<ScopeName>:%<OutstationFullName>;<Point Type>;<SyntaxSpecificItems>[;<Poi
ntName>]
o The <space> character is valid in Telemetry Server references.
o <ScopeName> is not case sensitive. However, the rest of the reference string is case-sensitive.

394
Working with References Application Server User Guide

o The percent sign (%) that precedes the OutstationFullName indicates that the reference is
dynamic. Static data references do not include the percent sign. See Telemetry Server Static
Data References on page 406 for more information.
Note that Telem_Server_ is always prepended to the ScopeName (computer name) at the beginning of
the reference string. Dynamic tags automatically populat e some of the required fields in the Telemetry
Server dashboard. This helps to reduc e the amount of duplicated configuration data needed for each
point. For information about creating dy namic tags, see Telemetry Server Dynamic Tags on page 395.
Using attributes on UserDefined objects (UDOs) is a recommended best practice to create the I/O
interface to the Telemetry Server. Once you create the attribute and enable I/O, creat e the I/O reference
using the applicable protocol and syntax. See Using the I/O Feature on page 121 for more information
about enabling I/O.

Invalid Characters
The following are invalid characters that cannot be us ed within Telemetry Server OutStationFul lNames
or Point Names.:
< > #%\ "; :?. @ & =+ ${}|^[ ]
The %, . and : characters are used in creating Telemetry Server references.
 The "%" character designates the reference as a dynamic tag.
 The "." character is used to separat e the GroupName and OutstationName within the
OutStationFullName.
 The ":" character is used to separat e the ScopeName from the Telemetry Server tag information.

Telemetry Server Dynamic Tags

Dynamic tags (data references) automatically populat e some of the required fields in the Telemetry
Server dashboard. This helps to reduc e the amount of duplication when creating tags for the Telemetry
Server. A dynamic tag takes the information entered as an I/ O reference in Application Server, and
creates or renames a point on the Telemetry Server.
Include a percent sign (%) in the reference string to designate a dynamic tags. The % character is
inserted after the Scope Name and separat or character (" Telem _Server_<ScopeName>:") in the
reference string.
Note that Telem_Server_ is always prepended to the Scope Name (computer name) at the beginning of
the reference string.

Dynamic Data References vs. Static Data References

Both dynamic data referenc es (tags) and static data referenc es can be used to access the Telemetry
Server.
Dynamic data references are used to create the Telemetry Server points/tags remotely from
Application Server. Use the reference syntax that corresponds with the protoc ol you are using. See
Telemet ry Server Dynamic Tags on page 395 for more information.
Static data references are used when the points/tags (discrete, analog, strings) already exist in the
Telemet ry Server. As such, the reference syntax is specific to the pre-existing tag. Use a static data
reference Syntax to reference t he properties of any object in the database (outstations, channels, points,
etc) that already exist in Telemetry Server, or to invoke methods on these objects. See Telemetry Server
Static Data References on page 406 for more information.

395
Application Server User Guide Working with References

Dynamic Tag Prerequisites

Before a dynamic tag entered in Application Server can function and automatically create a point in the
Telemet ry Server, the following items must be defined through the Telemet ry Server dashboard:
 Group
 Channel
 Outstation Set
 Outstation

Note: Group is a Telemetry Server-specific term that refers to a folder in the configuration hierarchy.
An outstation object is contained within a group. In the Telemetry Server, the configuration hierarchy
is the tree at the left side of the dashboard.

Naming Rules
When ent ering data references for an I/O attribute in Application Server, the following naming rules are
used to creat e or rename points in the Telemetry Server:
 If a point with the specified name and address does not exist in the specified group and outstation, a
new point is created with specified name. If a point name is not specified in the reference, the default
naming convention is used to generate the point name. Typically, this is <PointType> _<Address>.
 If a point with the specified name and address already exists in the specified group and outstation,
the existing point is used.
 If a point with the specified address but a different name is found in the specified group and
outstation, the reference generates a configuration error. The point with specified address is not
changed and a new point is not created. See Configuration Errors on page 396 for more information.
 If a point with the specified name exists in the specified group, but is attached to a different
outstation, the reference generates a configuration error. The named point is not changed and a new
point is not created. See Configuration Errors on page 396 for more information.
 If a point with the specified name exists in the specified group and outstation but has a different point
address, the reference generates a configuration error. The named point is not changed and a new
point is not created. See Configuration Errors on page 396 for more information.
 If any other database object with the specified name exists in the specified group, the reference
generates a configuration error. A new point is not created. See Configuration Errors on page 396 for
more information.
 If the point name is invalid, for example, if it contains invalid characters, is too long, or has some
other error, the reference generates a configuration error and a new point is not created. See
Configuration Errors on page 396 for more information.

Configuration Errors
To resolve configuration errors, refer to the Telemetry Server User Guide for detailed information. The
basic way to resolve an error is to make one or more of the following changes, as applicable:
 Check that the <PointName> in the dynamic tag reference is valid to allow the point to be created in
the Telemetry Server database.

396
Working with References Application Server User Guide

 Check that the <Point Type> and address in the dynamic tag reference are valid for the prot ocol and
correct for the particular outstation. For some point types, such as Modbus digit al points, you must
additional items, such as bit offset and bit count.
o In DNP3, address refers to Point Number.
o In IEC 60870, address refers to IOA.
o In Modbus, address refers to PointAddress
 Check that the<OutstationFullName> in the dynamic tag reference exactly matches the name of the
outstation in the Telemet ry Server database and that this is the correct outstation. The name is case
sensitive.
 Rename, or delete, the object that has the same name in the group, or move the object to a different
group.

DNP3 Data References

A DNP3 point is defined by its outstation name, point type, point number, and optionally, a point name.
When adding points to an outstation, use the following general guidelines:
 All references begin with " Telem_S erver_" prepended to the Scope Name.
 Point numbers are unique within each point type. For example “A nalog Input 1” (A I_1) and “Analog
Output 1” (AO_1) are different points. In the case of binary output points, which contains three
subtypes, the subtype does not provide differentiation. Thus, “Digital Output 1”, “Pulse (NULL) 1” and
“Pulse Trip-Close 1” all refer to the same binary out put point. For example “Digital Out put 1”, “Pulse
(NULL) 1” and “Pulse Trip-Close 1” all refer to the same binary output point.
 Point numbers must be unique within each data type. The range of valid point numbers may vary
between outstations. Point numbers do not need to be c ontiguous.
 The point numbers (in an outstation) are configurable. Refer to the outstation configuration to
determine which point numbers are valid for a particular outstation.
 The valid range of DNP3 point numbers is 0 to 65535. The Telemetry Server does not limit this
range, however, values are device-specific and many devices will impose a much smaller number
than 65535 for their upper limit.
Point Types
A point in DNP3 can be defined as any of the following dat a types:

Point Type I/O Type Details

AI Analog Input DNP 3 Analog Input and Output Points on page

398
AO Analog Output DNP 3 Analog Input and Output Points on page
398
DI Binary Input DNP 3 Binary Input and Output Points on page
399
DO Binary Output DNP 3 Binary Input and Output Points on page
399
DBI Double Binary Input DNP 3 Double-Bit Binary Input Points on page
399
RC Counter DNP 3 Counter Input Points on page 400

397
Application Server User Guide Working with References

Point Type I/O Type Details

OS String DNP 3 String Input Points on page 400

PN Pulse (NULL) DNP 3 Pulse Output Points on page 400

PTC Pulse (Trip/ Close) DNP 3 Pulse Output Points on page 400

Reference Syntax
When creating a Telemetry Server reference, adding a percent sign (% ) before the full outstation name
makes the reference a dynamic reference. The full outstation name includes the group name.
The general syntax for dynamic references is as follows :
Telem_S erver_<ScopeName>:%<OutstationFullName>;<PointType>;<PointNumber>[;<PointNam
e>]
Note that all point types contain all the elements shown in the general syntax, but some point types
contain additional parameters. For example, the syntax for Pulse data types is as follows:
Telem_S erver_<ScopeName>:%<OutstationFullName>;PTC;<PointNumber1>;<Point Number2>[;<
PointName>]
When the <Point Name> parameter is not specified and the point does not already exist, a default name
is automatically assigned to the point. The name is in the format "<PointType>_<PointNumber>."

DNP3 Analog Input and Output Points

DNP3 Analog Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>; AI;<PointNumber>[;{ZSV alue};{FSValue};{DB
Value};{Point Name}]
Telem_S erver_<ScopeName>:%<OutstationFullName>; AO;<PointNumber>[;{ZSValue};{FSValue};{DB
Value};{Point Name}]
 Point type: AI or AO
 Point number: a decimal number from 0 to 65535 that maps to the "Point Number" field in the
Telemet ry Server dashboard. The maximum point number is device -dependent.
 Optional fields: ZSValue, FSValue, DBValue, and PointName. You can enter these fields in any
order. If no value is entered, the default values for these fields are used.
o ZS Value: This value sets the zero scale limit of the tag in the Telemetry Server. The limit of the
zero scale is "Double Min." If the value given is out of the range, the tag creation fails. It can be a
positive or negative numeric value, including floating point.
o FS Value: This value sets the full scale limit of the tag in the Telemetry Server. The limit of the
full scale limit is "Double Max." If the value given is out of the range, the tag creation is failed. It
can be a positive or negative numeric value, including floating point.
o DB Value: This value sets the Significant Change option (deadband) of the tag in the Telemetry
Server. You can enter the deadband as an absolut e or percentage value.
– DB<numeric value>: The Significant Change field is set to Absolute and the Deadband
field is set to the numeric value provided in the tag syntax.
– DB%<numeric value>: The Significant Change field is set to Percentage of Span and the
Deadband field is set to the numeric value provided in the tag syntax.
– Point name: a descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and number,
in the format PointType_PointNumber, for example, AI_100.

398
Working with References Application Server User Guide

Analog Reference Examples

Telem_S erver_Node-12:%Group.DNP3_Outstation;AI;100
Referenc es analog input point 100, which is given the name Group.AI_100
Telem_S erver_Node-12:%Group.DNP3_Outstation;AI;100; Tag_Name
Referenc es analog input point 100, which is named Group.Tag_Name

DNP3 Binary Input and Output Points

DNP3 Binary Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>; DI;<PointNumber>[;<PointName>]
Telem_S erver_<ScopeName>:%<OutstationFullName>; DO;<PointNumber>[;<PointName>]
 Point type: DI or DO

Note: When referencing a binary output point using the DO point type, the Telemetry Server uses
the "latch on/off" operation type.

 Point number: a decimal number from 0 to 65535 that maps to the "Point Number" field in the
Telemet ry Server dashboard. The maximum point number is on the device-dependent.
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and number in the
format PointType_PointNumber, for example, DI_5.
Binary Reference Examples
Telem_S erver_Node-12:%Group.DNP3_Outstation;DI;5
Referenc es binary input point 5, which is given the name Group.DI _5
Telem_S erver_Node-12:%Group.DNP3_Outstation;DI;5; Tag_Name
Referenc es binary input point 5, which is named Group.Tag_Name

DNP3 Double-Bit Binary Input Points

DNP3 Double-Bit Binary Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>; DBI;<PointNumber>[;<PointName>]
 Point type: DB I
 Point number: a decimal number from 0 to 65535 that maps to the "Point Number" field in the
Telemet ry Server dashboard. The maximum point number is device -dependent.
 Point name: an optional, descriptive tag name for the point, for example, LiftStationPump_01. If
point name is not specified, the point is assigned a default tag name that uses point type and number
in the format PointType_PointNumber, for example, DBI_5.
Double-Bit Binary Reference Examples
Telem_S erver_Node-12:%Group.DNP3_Outstation;DBI; 5
Referenc es double-bit binary point 5, which is given the name Group.DBI_5
Telem_S erver_Node-12:%Group.DNP3_Outstation;DBI; 5;Tag_Name
Referenc es double-bit binary point 5, which is named Group.Tag_Name

399
Application Server User Guide Working with References

DNP3 Counter Input Points

DNP3 Counter Point Syntax
Telem_S erver_<ScopeName>:%<GroupName.OutstationName>;RC;<Point Number>[;<PointName>]
 Point type: RC (Running Counter)
 Point number: a decimal number from 0 to 65535 that maps to the "Point Number" field in the
Telemet ry Server dashboard. The maximum point number is device -dependent.
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and number in the
format PointType_PointNumber, for example, RC_3.
Counter Reference Examples
Telem_S erver_Node-12:%Group.DNP3_Outstation;RC; 3
Referenc es running counter point 3, which is given the name Group.RC_3
Telem_S erver_Node-12:%Group.DNP3_Outstation;RC; 3;Tag_Name
Referenc es running counter point 3, which is named Group.Tag_Name

DNP3 String Input Points

DNP3 String Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>;OS;<Point Number>[;<PointName>]
 Point type: OS (Octet String)
 Point number: a decimal number from 0 to 65535 that maps to the "Point Number" field in the
Telemet ry Server dashboard. The maximum point number is device -dependent.
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and number in the
format PointType_PointNumber, for example, OS_6.
String Reference Examples
Telem_S erver_Node-12:%Group.DNP3_Outstation;OS;6
Referenc es octet string point 6, which is given the name Group. OS_6
Telem_S erver_Node-12:%Group.DNP3_Outstation;OS;6;Tag_Name
Referenc es octet string point 6, which is named Group.Tag_Name

DNP3 Pulse Output Points

DNP3 Pulse (NULL) Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>;PN;<PointNumber>[;<PointName>]
 Point type: PN (P ulse-Null)
 Point number: a decimal number from 0 to 65535 that maps to the "Point Number" field in the
Telemet ry Server dashboard. The maximum point number is device -dependent.
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and number in the
format PointType_PointNumber, for example, PN_12.
Pulse Reference Example
Telem_S erver_Node-12:%Group.DNP3_Outstation;PN;12

400
Working with References Application Server User Guide

Referenc es binary output point 12 using "pulse-on" operator type and "NULL" trip-close code, which
is given the name Group.P N_12
Telem_S erver_Node-12:%Group.DNP3_Outstation;PN;12; Tag_Name
Referenc es pulse (null) point 12 using "pulse -on" operator type and "NULL" trip-close code, which is
named Group.Tag_Name

DNP3 Pulse (Trip/Close) Output Points

DNP3 Trip-Close Pulse Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>;PTC;<PointNumber1>;<Point Number2>[;<Poi
ntName>]
 Point type: P TC
 Point number: a decimal number from 0 to 65535 that maps to the "Point Number" field in the
Telemet ry Server dashboard. The actual range of valid point numbers is dependent on th e specific
outstation.
For the Trip-Close P ulse function, two point numbers are defined, one for each action (that is, one
point number for trip and the other for close ). Generally, these two numbers are the same, however,
some non-standard outstations require different point numbers.
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and point numbers in
the format PointType_PointNumber1_PointNumber2, for example, P_5_5. Note that both point
numbers are used for automatic naming.
Pulse (Trip-Close) Reference Example
Telem_S erver_Node-12:%Group.DNP3_Outstation;PTC;5;5
Referenc e binary output point 5 using "pulse-on" operat or type and "trip-close" codes, which is given
the name Group.PTC_5_5
Telem_S erver_Node-12:%Group.DNP3_Outstation;PTC;5;5; Tag_Name
Referenc es binary output point 5 using "pulse-on" operator type and "trip-clos e" codes, which is
named Group.Tag_Name

IEC 60870-5 Dynamic Data References

An IEC60870-5 point is defined by its outstation name, point type, Information Object Address (ioa), and
optionally, a point name. When adding points to an outstation, use the following general guidelines:
 All references begin with " Telem_S erver_" prepended to the Scope Name.
 Each point type (A I, AO, etc.) has its own unique set of point numbers. Note that AI_1 is different
than AO_1.
 Information Object Addresses (IOAs) must be unique across the outstation.
 The valid range of IE C 60870 IOAs is 1 to 16,777,216. The Telemetry Server does not limit this
range, however, values are device-specific and many devices will impose a much smaller number
than 16,777, 216 for their upper limit.
Point Types
A point in IE C 60870-5 can be defined as any of the following data types:

401
Application Server User Guide Working with References

Point Type I/O Type Details

AI Analog Input IEC60870 Analog Input and Out put Points on

page 402
AO Analog Output IEC60870 Analog Input and Out put Points on
page 402
DI Digital Input IEC60870 Digital Input and Output Points on
page 403
DO Digital Output IEC60870 Digital Input and Output Points on
page 403
Reference Syntax
The general syntax for references is as follows, but there are variations bet ween analog and digital point
types:
Telem_S erver_<ScopeName>:%<OutstationFullName>;<PointType>;<IOA>[;<PointName>]
When the optional <pointName> parameter is not specified, a default name is automatically assigned to
the point. The name is in the format "<PointType>_<IOA>."

IEC60870 Analog Input and Output Points

IEC 60870 Analog Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>; AI;<IOA>[;{ZSValue};{FSV alue};{DBValue};{P
ointName}]
Telem_S erver_<ScopeName>:%<OutstationFullName>; AO;<IOA>[;{ZSValue};{FSValue}; {DBValue};{
PointName}]
 Point type: AI or AO
 IOA: Information Object Address. This is a decimal number from 1 to 16,777,216, and maps to the
"IOA" field in the Telemetry Server dashboard. The actual range of valid IOA numbers is dependent
on the specific outstation.
 Optional fields: ZSValue, FSValue, DBValue, and PointName. You can enter these fields in any
order. If no value is entered, the default values for these fields are used.
o ZS Value: This value sets the zero scale limit of the tag in the Telemetry Server. The limit of the
zero scale is "Double Min." If the value given is out of the range, the tag creation fails. It can be a
positive or negative numeric value, including floating point.
o FS Value: This value sets the full scale limit of the tag in the Telemetry Server. The limit of the
full scale limit is "Double Max." If the value given is out of the range, the tag creation is failed. It
can be a positive or negative numeric value, including floating point.
o DB Value: This value sets the Significant Change option (deadband) of the tag in the Telemetry
Server. You can enter the deadband as an absolut e or percentage value.
– DB<numeric value>: The Significant Change field is set to Absolute and the Deadband
field is set to the numeric value provided in the tag syntax.
– DB%<numeric value>: The Significant Change field is set to Percentage of Span and the
Deadband field is set to the numeric value provided in the tag syntax.
– Point name: a descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and number,
in the format PointType_PointNumber, for example, AI_100.

402
Working with References Application Server User Guide

Analog Reference Examples

Telem_S erver_Node12:%Group.IE C60870_Outstation;AI;100
Referenc es analog input point 100, which is given the name Group.AI_100
Telem_S erver_Node12:%Group.IE C60870_Outstation;AI;100; Tag_Name
Referenc es analog input point 100, which is given the name Group.Tag_Name

IEC60870 Digital Input and Output Points

IEC 60870 Digital Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>; DI;<IOA>;<BitCount>[;<PointName>]
Telem_S erver_<ScopeName>:%<OutstationFullName>; DO;<IOA>;<BitCount>[;<PointName>]
 Point type: DI or DO
 IOA: Information Object Address. This is a decimal number from 1 to 16,777,216, and m aps to
Information Object Addre ss in the Telemetry Server dashboard. The maximum IOA number is
dependent on the outstation.
 Bit count: a decimal number between 1 and 3. This number maps to Number of Bits in the
Telemet ry Server dashboard.
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and Information
Object Address in the format PointType_IOA, for ex ample, DI_5.
Digital Reference Examples
Telem_S erver_Node12:%Group.IE C60870_Outstation;DI;5;1
Referenc es 1-bit digital input point 5, which is given the name Group. DI_5
Telem_S erver_Node12:%Group.IE C60870_Outstation;DI;5;1; Tag_Name
Referenc es 1-bit digital input point 5, which is named Group.Tag_Name

Modbus Data References

A Modbus point is defined by its outstation name, point type, point address, and optionally, point name.
When adding points to an outstation, use the following general guidelines:
 All references begin with " Telem_S erver_" prepended to the Scope Name.
 Modbus point addresses have 5 or 6 digits, depending on the Point Address Range setting of the
outstation. The default setting is 5 digits. The range of valid addresses vary by point type.
Point Types
A point in Modbus can be defined as any of the following types:

Point Type I/O Type Details

AI Analog Input Modbus Analog Input and Output Points on

page 404
AO Analog Output Modbus Analog Input and Output Points on
page 404
DI Digital Input Modbus Digital Input and Output Points on page
405

403
Application Server User Guide Working with References

Point Type I/O Type Details

DO Digital Output Modbus Digital Input and Output Points on page

405
STR String Modbus String Points on page 406

Reference Syntax
The general syntax for references is as follows, but there are variations bet ween analog, digital and
string point types:
Telem_S erver_<ScopeName>%<OutstationFullName>;<PointType>;<PointAddress>;<DataType>[
;<PointName>]
When the optional <PointName> parameter is not specified, a default name is automatically assigned to
the point. The name is in the format "<PointType>_<PointAddress>."

Modbus Analog Input and Output Points

Modbus Analog Point Syntax
Telem_S erver_<ScopeName>:%<GroupName.OutstationName>;AI;<PointAddress>;<DataType>[;{ZS
Value};{FSValue}; {DBValue};{Point Name}]
Telem_S erver_<ScopeName>:%<GroupName.OutstationName>; AO;<PointAddress>;<DataType>[;{Z
SValue}; {FSValue};{DBValue};{Point Name}]
Telem_S erver_<ScopeName>:%<OutstationFullName>; AO;<PointAddress>;<DataType>[;<PointNam
e>]
 Point type: AI or AO
 Point address: a 5 or 6 digit decimal number, depending on the Point Address Range setting of the
outstation. The default setting is 5 digits. The range of valid addresses vary by point type and maps
to the "Address" field in the Telemetry Server dashboard.
 Data type: one of the values listed in the following table, for example UINT16.

Data Type Definition

UINT16 Unsigned 16-bit integer

UINT32 Unsigned 32-bit integer

INT16 Signed 16-bit integer
INT32 Signed 32-bit integer
SINGLE Single precision float
DOUBLE Double precision float
 Optional fields: ZSValue, FSValue, DBValue, and PointName. You can enter these fields in any
order. If no value is entered, the default values for these fields are used.
o ZS Value: This value sets the zero scale limit of the tag in the Telemetry Server. The limit of the
zero scale is "Double Min." If the value given is out of the range, the tag creat ion fails. It can be a
positive or negative numeric value, including floating point.
o FS Value: This value sets the full scale limit of the tag in the Telemetry Server. The limit of the
full scale limit is "Double Max." If the value given is out of the rang e, the tag creation is failed. It
can be a positive or negative numeric value, including floating point.

404
Working with References Application Server User Guide

o DB Value: This value sets the Significant Change option (deadband) of the tag in the Telemetry
Server. You can enter the deadband as an absolut e or percentage value.
– DB<numeric value>: The Significant Change field is set to Absolute and the Deadband
field is set to the numeric value provided in the tag syntax.
– DB%<numeric value>: The Significant Change field is set to Percentage of Span and the
Deadband field is set to the numeric value provided in the tag syntax.
– Point name: a descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and number,
in the format PointType_PointNumber, for example, AI_100.
Analog Reference Examples
Telem_S erver_Node-12:%Group.Modbus _RTU;AI;40001;UINT16
Referenc es the analog input point mapped to holding register 40001with UINT16 dat a type, which is
given the name AI_40001
Telem_S erver_Node-12:%Group.Modbus _RTU;AI;40001;UINT16; Tag_Name
Referenc es the analog input point mapped to holding register 0001 wit h UINT16 data type, which is
named Tag_Name

Modbus Digital Input and Output Points

Modbus Digital Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>; DI;<PointAddress>;<BitOffset>;<BitCount>[;<
PointName>]
Telem_S erver_<ScopeName>:%<OutstationFullName>; DO;<PointAddress>;<BitOffset>;<BitCount>[;<
PointName>]
 Point type: DI or DO
 Point address: a 5 or 6 digit decimal number, depending on the Point Address Range setting of the
outstation, which is set through the Telemetry Server dashboard. The default setting is 5 digits. The
range of valid addresses vary by point type and maps to the "Address" field in the Telemetry Server
dashboard..
 Bit offset: a decimal number between 0 and 15. This number maps to the "BitOffset" field in the
Telemet ry Server dashboard. The maximum offs et varies and depends on the bit count.
 Bit count: a decimal number between 1 and 3. This number maps to the "BitCount" field in the
Telemet ry Server dashboard.
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and point address, in
the format PointType_PointAddre ss, for ex ample, DI_30001.
Digital Reference Examples
Telem_S erver_<ScopeName>:%Group.Modbus_RTU;DI;30001;0;1
Referenc es the 1-bit digital input point mapped to the least significant bit of input register 30001,
which is given the name DI_30001
Telem_S erver_<ScopeName>:%Group.Modbus_RTU;DI;30001;0;1; Tag_Name
Referenc es the 1-bit digital input point mapped to the least significant bit of input register 30001,
which is named Tag_Name

405
Application Server User Guide Working with References

Modbus String Points

Modbus string points can function as either input (read) only or input/output (read/ write) points. This is set
by checking the "Write" checkbox in the Telemetry Server dashboard.
Modbus String Point Syntax
Telem_S erver_<ScopeName>:%<OutstationFullName>;STR;<PointAddress>;<Lengt h>;<StringType>[
;<PointName>]
 Point type: S TR
 Point address: a 5 or 6 digit decimal number, depending on the Point Address Range setting of the
outstation. The default setting is 5 digits. The range of valid addresses vary by point type and maps
to the "Address" field in the Telemetry Server dashboard.
 Length: a decimal number from 1 to 247 that sets the maximum string length and maps to
Requested String's Length in the Telemetry Server dashboard.
 String type: one of the values listed in the following table, for ex ample, AS CIILOW. This value maps
to the "StringType" field in the Telemetry Server database.

String Type Definition

ASCIILOW Single byte ASCII, first

character in low byte
ASCIIHIGH Single byte ASCII, first
character in high byte
UNICODE Two byte Unicode
 Point name: an optional, descriptive name for the point, for example, LiftStationPump_01. If point
name is not specified, the point is assigned a default name that uses point type and point address, in
the format Point Type_P ointAddress, for example, STR_30002.
String Reference Example
Telem_S erver_Node-12:%Group.Modbus _RTU;S TR; 30002;20;ASCIILOW
Referenc es the 20-c haracter ASCII string point mapped to a block of input registers starting at
30002, which is given the name STR_30002
Telem_S erver_Node-12:%Group.Modbus _RTU;S TR; 30002;20;ASCIILOW; Tag_Name
Referenc es the 20-c haracter ASCII string point mapped to a block of input registers starting at
30002, which is named Tag_Name

Telemetry Server Static Data References

Static data references are used when the objects have already been defined in the Telemetry Server.
Static data reference syntax is common to all prot ocols in Telemetry Server, whereas dynamic data
reference syntax varies by protocol. Static data references can use any of the following syntaxes:
Telem_S erver_<ScopeName>:<It em>
Telem_S erver_<ScopeName>:<It em>.<Property>
Telem_S erver_<ScopeName>:<It em>.<DatabaseAggregat e>
Telem_S erver_<ScopeName>:<It em>.<DatabaseAggregat e>.<Property>
Telem_S erver_<ScopeName>:<It em>.<Method>
Telem_S erver_<ScopeName>:<It em>.<DatabaseAggregat e>.<Method>

406
Working with References Application Server User Guide

Where
 <ScopeName> is by default the name of the computer where the Telemetry Server instance is
installed. You can customize the "ScopeName" field in the Telemetry Server to accommodate
redundancy.
 <Item> is the location of the dat abase item.
 <Property> is the name of the property tag t hat you want to reference. If you omit <Property>, the tag
uses the default property for the defined database item or aggregate. The default property for an item
or aggregate varies according to the type of item or aggregate. For example, the default property for
a point is CurrentValue.
 <Database Aggregate> is the name of the database aggregate that has the required property.
Database Aggregates are extensions to a table in the database and they have their own name, table,
properties and methods.
 <Method> is the name of the method that you want to reference. Method static tags are write-only.
Attempting to read a method tag generates an error.
o Method static tags are writ e only. Writing to a method tag invokes the method, and thus triggers
the associated action. Attempting to read a method tag generates an error.
o Only methods with zero or one arguments are supported in static tags. When you write to a
method tag with zero arguments, the value being written is discarded. When you write to a
method tag with one argument, the value being written is passed as the argument to the method.
Therefore, the argument must match the value.

Static Data Reference Examples

Example of the static data referenc e syntax:
Telem_S erver_Node12:Group01.Group02. Tank_Level
You can t rigger t he Telemetry Server to call a dial-up outstation by invoking the one shot method. Writing
to this tag invokes the “OneS hot” method on the “PS TN” database aggregate of an outstation called
“Group.Outstation.”
Telem_S erver_XXXXX: Group. Outstation.PS TN.OneShot
You can apply an override to an analog point by invoking the override method. Writing a value to this tag
invok es the “Override” met hod on the point “Group.AI_1” to change the point to the specified value.
Overriding must be enabled on the point:
Telem_S erver_XXXXX: Group.A I_1.Override

407
 Application Server User Guide

C HAPTER 13
Configure Security
This section describes the architecture of A rchestrA security and how to use it to manage access to
configuration and run-time aspects of your Application Server application.
For the latest information about mitigating security threats that can affect Microsoft and Wonderware
products, sign into the AVEVA Global Customer Support website:
https://softwares upport.aveva.com/ http://softwaresupport.aveva.com
Then, navigate to Security Central.

In This Chapter
About Security ............................................................................................................................ 409
Security Model for Galaxies ......................................................................................................... 410
About SQL Server Security.......................................................................................................... 419
Configuring Security.................................................................................................................... 420
About OS Group-based Sec urity .................................................................................................. 429

About Security
Galaxies are created without security. After creating a Galaxy, you can add security to manage access to
it. User permissions are set within the IDE. Adding security to a Galaxy authenticates users across all
editors and interfaces and controls access to the:
 IDE
 ArchestrA System Management Cons ole (SMC)
 Layout Editor
 Screen Profile Editor
 ViewApp Editor
Security lets you set specific permissions for operations within the IDE and SMC, such as:
 Starting the IDE
 Importing, exporting, creating, and modifying instances, derived templates, graphics and ViewA pps
 Deploying and undeploying instances
 Uploading run-time changes
 Managing alarms
 Performing maintenance and system administration functions wit hin the SMC.
You can also configure credentials that InTouch OMI apps can use for connecting to resources that do
not recognize Windows credentials.
While there are not specific permissions that can be set for the Layout, Screen Profile, and ViewApp
Editors, restricting permissions for graphics and objects in the IDE will also restrict a user's ability to
modify objects and graphics in these editors. See Assigning Users to Roles on page 426 for additional
information.

409
Application Server User Guide Configure Security

Security Model for Galaxies

Security settings in the IDE cont rols access to:
 User and editor interfaces in the ArchestrA environment. The signed-in user remains authenticated
across all editors and interfaces. The user does not have to sign in again when switching to a
different editor, for example, when switching from the IDE to the Screen Profile Edit or.

Note: Regardless of the Galaxy security setting, a user must be a member of the aaConfigTool s
group to connect to a Galaxy from the IDE, or the user must launch the IDE using the "Run as
administrator" option. Use the Windows Control Panel to add a user to the aaConfigTools group.
Since aaConfigTools is an OS user group, you cannot use Galaxy Security Configuration to add a
user to the group.

 Object attributes and the data they represent.

 Connection to the SQL Server databas e used for the Galaxy Repository.

Note: For additional information about SQL Server security, see the section on SQL Server Rights
Requirements in the System Platform Installation Guide.

 Credentials that allow a logged-in user to an InTouch OMI ViewApp to access third -party resources
used by the ViewApp.
Each Galaxy in the Galaxy Repository manages its own security model. The security schema managed
in a Galaxy is a three-level configuration model to create and maintain the following:
 Users associated with specific roles
 User roles associated with specific system administration, configuration and run -time (operational)
permissions, which map to security groups
 Security groups associated with specific objects in the Galaxy
The default Galaxy Security model includes:
 Two users: DefaultUser and Administrator, both with full access to everything.

Important: Be sure to change the passwords for the Administrator and DefaultUser accounts aft er
enabling galaxy security. We recommend that you use Microsoft Active Directory to implement your
galaxy password policy because it is the easiest and most effective way to set the policy.

 One security group named Default.

 Two security roles: Default and Administrator, both with full privileges.

Important: We recommend that you set the privileges for the Default role to the minimum level
needed by all users.

410
Configure Security Application Server User Guide

The security matrix defines a cascading model of users associated with specific roles that are associated
with specific security groups that are associated with specific objects. User run-time permissions can
vary from object to object, action to action, and process to process. The security icons associated with
object attribut es map directly to control points in the ArchestrA security model.

About Authentication Modes

You can select from three authentication modes to assign security:
 Galaxy: Uses local Galaxy configuration to authenticate users. All security for the Galaxy is specified
and cont ained at the specific Galaxy level. When the user logs on, security credentials are checked
and access to areas and activities is granted at the Galaxy level.

Note: If you are implementing a multi-Galaxy environment or creating credentials for ViewA pps,
Galaxy Authentication Mode is not supported. Use one of the OS -based authentication modes
instead. See Work ing with Multiple GR Nodes and Galaxies on page 337 and About Credentials on
page 417 for more information.

 OS User Based: Uses the operating system's user authentication system on an individual user level.
All security for the Galaxy is specified and contained in the operating system (OS ) on a user level
basis. When the user logs on, security credentials are checked and access to areas and activities
are decided at the OS user level.
 OS Group Ba sed: Uses the operating system's user aut hentication system on a group basis. All
security for the Galaxy is specified and contained in the user-to-roles mapping you created in t he OS
to assign security. When a user logs on, security credentials are checked and verified at the OS
group level. OS groups are mapped to security roles in the Galaxy to allow access to areas and
activities in the Galaxy. For more information, see About OS Group-based Security on page 429.

Note: If you are using OS user-based security or OS group-based security and you have permissions to
use the IDE, the Log In dialog box does not appear.

Important: Do not use the "Administrator" user account to log in to Application S erver, InTouch
ViewApps, or other System Platform components. "Administrator" is a reserved System Platform name.
Some modules of A pplication Server and System Platform view "Administrator" as a system admin, while
other modules view it as a Galaxy admin.

411
Application Server User Guide Configure Security

Multiple Accounts Per User

Regardless of the security system, a single user can have multiple accounts. For example, a user can
have an account that provides permissions for working with instances but not templat es. The same
person can have another supervisory account for working with templates and managing users in the
ArchestrA environment.
Each account requires a different user name and password. For example:

User Name Password Acce ss

bsmith password Instances, not templates

bobsmith super Instances, templates, not managing users

Robertsmith admin Instances, templates, managing us ers

Changing Security Settings

After you change security for a Galaxy, you see the following behaviors and conditions:
 When you change the authentication mode security, the IDE restarts.

Important! Make sure that you have a valid login for the IDE before changing the authentication
mode, especially if changing from "None." If not, creat e a login before changing authentication
modes.

 To switch users, the person must log on as the new user by clicking Change User on the Galaxy
menu.
 If you previously configured security under one aut hentication mode and then switch authentication
modes, only those users created while configuring the new mode are available. Other users are not
deleted, just unavailable in the new mode.
 Objects that are reassigned to different security groups are marked as "pending update" and require
redeployment for the change in security group to take effect.
 If security was previously configured for an OS -based aut hentication mode, reconfiguring security
synchronizes the user’s full name and OS groups if some data in the OS has changed.

About Security Groups

E very object in the Galaxy belongs to only one security group. You can create and manage security
groups that make sense for your organization. These security groups are mapped to roles on the Roles
page.
Permissions determine what kind of access users have for each attribut e. There are five basic
operational permissions:
 Acknowledge alarms
 Change the value of attributes with security mode Configure
 Change the value of attributes with security mode Operate; this includes also security modes
Secured Write and Verified Write

412
Configure Security Application Server User Guide

 Change the value of attributes with security mode Tune

 Confirm writ es to attributes that require Verified Writes
By default, all currently used objects are assigned to a security group called Default.
A user who is a member of a role assigned to Security Role "Default" has permission to:
 Acknowledge alarms
 Change attribute values with "configure" security mode
 Change attribute values with "operate" security mode, including "secured write" and " verified write"
 Change attribute values with "tune" security mode
 Verify writes to Attributes with " verified write" security mode
For example, you want users in certain roles to only have permission to acknowledge alarms that are
generated from objects contained in Area1. You have a role named Area1Acknowledgers. You need to:
1. Create a new Security Group, for example SecGrpArea001.
2. Assign all objects that are contained in area Area1 to Security Role SecRoleArea001.
3. On the Roles page, select the Area1Acknowledgers role. In the Operational Permissions the
Security Group for SecGrpArea001, select Can Acknowledge Alarms.
4. Any user that belongs to the Area1Acknowledgers role can at least acknowledge alarms of objects
contained in the security group SecGrpArea001. They do not have any other operational
permissions for those objects.

About Roles
You can create and manage user roles that apply to your organization’s processes and work -based
authorities. A role defines a set of permissions. After defining roles, you assign roles to authorized users
as needed to provide the users with the permissions that they need. A user can be given multiple roles.

413
Application Server User Guide Configure Security

Application Server automatically creat es two roles called Admini strator and Default and gives both
roles full permissions to everything. When defining roles, first remove any permissions that are not
needed by all users from the Default role because all configured users will be assigned to the Default
role and you cannot remove the Default role from a user. For example, if the minimum set of permissions
required by all users is the ability to acknowledge alarms and modify "Operate" attributes, remove all
other permissions. Add new roles by selecting the + button above Role s available, then enter a name for
the role and an access level.

You can specify General and Operational Permissions for each role.
 General permissions relate t o application configuration and administration tasks within t he IDE and
the System Management Cons ole (SMC). By default, the Administrator and Default roles have all
general permissions. Remove any unnecessary general permissions from the Default role. Leave
only the permissions that are needed by all users.

414
Configure Security Application Server User Guide

Note: You cannot remove any General permissions from the Administrator role. You can, however,
remove Operational permissions.

415
Application Server User Guide Configure Security

 Operational permissions relate to the security groups listed on the Security Groups page. For
each role, modify security group permissions as needed. The Administrator and Default roles initially
are given all operational permissions for the Default Security Group. If you created any new security
groups on the Security Groups page, the Administrator and Default roles are not automatically
granted any permissions to these security groups. f you do not intend to have us ers with the
Administrator role working with alarms or attributes at run time, you can limit operational permissions
from the Administrator role.

Operational permissions are defined as follows:

o Can Acknowledge Alarms: Allows users to manually acknowledge an alarm in the run -time
environment.
o Can Shelve Alarms: Allows users to manually shelve and unshelve alarms.
o Can Modify Alarm Modes: Allows users to modify the mode of an alarm.
o Can Modify Plant States: Allows users to modify plant states for state-based alarming.
o Can Verify Writes: Allows users to provide an aut hentication signature for attributes configured
with Verified Writes security classification. Only users with this permission can verify a task
performed by users with the Can Modify "Operate" Attribut es permission.
o Can Modify "Operate" Attributes: Allows users with operational permissions to do certain normal
day-to-day tasks like changing setpoint, output and control mode for a PID object, or
commanding a Discrete Device object.
o Can Modify "Tune" Attributes: Allows users to tune the attribute in the run -time environment.
Examples of tuning are attributes that adjust alarm setpoints and P ID sensitivity.
o Can Modify "Configure" Attributes: Allows users to configure the attribute’s value. Requires that
the user first put the object Off scan. Writing to these attribut es is considered a significant
configuration change, for example, a PLC register that defines a Discrete Devic e i nput.
Once you have defined a role by setting operational permissions and general permissions, you can
assign users to that role.

About Users
If you select either OS based authentication mode, users with local accounts are added to the
Authorized Users Available list in the following format: .\<username>. Domain users are added in
the format <domain>\username>.
If you select OS Group Ba sed authentication mode and us e local accounts, the local account must exist
on each node in the Galaxy for successful authentication of that user on any computer in the Galaxy. OS
groups are added in the format <domain>\<groupname>.

416
Configure Security Application Server User Guide

Two users are defined by default when a new Galaxy is created: Administrator and Default User. These
cannot be deleted in an open security setting and both users are associated with the default roles,
Administrator and Default. See About Roles on page 413 for more information.

Important: Do not use the "Administrator" user account to log in to Application S erver, InTouch
ViewApps, or other System Platform components. "Administrator" is a reserved System Platform name.
Some modules of A pplication Server and System Platform view "Administrator" as a system admin, while
other modules view it as a Galaxy admin. When using OS-based security, do not use the local ArchestrA
user account for Application Server user authentication purposes.

About Credentials
The Credentials tab lets you add login credentials that some InTouc h OMI ViewApps may need for
access to third-party data and applications that do not support Windows OS credentials, Active Directory,
OpenID Connect, or other standard authentication met hod. Initially, a galaxy does not include any
credentials. Credentials are created on a galaxy-wide basis, not for individual ViewA pps. Although you
enter credentials as plain text, it is encrypted when it is saved, and the credentials are sent to run -time
nodes as encrypted data.
The credentials you create here are associated wit h an OS group name. When a us er logs into a
ViewApp, the user obtains access to credentials that are associated with t he same OS group of which the
user is a member. For example, if you create credentials that are associated with the OS group
"Operators," a user that is also a member of "Operators" has access to those credentials.
App developers use the GetNamedCredentials() method in the InTouc h OMI S DK to access and use
credentials in their apps.

Note: Credentials are supported only when OS User based or OS Group based authentication mode is
enabled. If authentication mode is set to None or Galaxy, you cannot add or delete credentials, or use
them at runtime, even if the credentials were created while the authentication mode was set to OS User
or OS Group.

The Credentials tab is divided in three columns:

Name: This is the name of credential. The default credential name is "Credential," and subsequent
names are appended by a number that automatically is incremented by one. To rename a credential, just
highlight the name and enter new one. Credential names must contain at least one character and must
be unique. The ViewApp builder (user) will select this name when configuring the InTouch OMI App that
requires this credential to access the resource at runtime.
 Type: Two types of credentials are supported:
o Username and Password.
o Domain, Username and Password.

Note: Null values are valid for all fields, except the credential name.

 Group: Select the ellipses button (...) next to the group name to choose a different group name. You
can also choose a different domain, and then pick a group name from the selected domain. When
you add credentials, you must associate each credential wit h an OS Group name (local or domain).

417
Application Server User Guide Configure Security

To associate a credential with an OS group, simply highlight the group name when you add the
credential. You can change the group at any time. Associations are saved when you click OK. See
Associate an OS Group wit h a Credential on page 418 for more information.

Associate an OS Group with a Credential

To select an OS group to associate with a credential:

418
Configure Security Application Server User Guide

1. Select the the ellipses button (...) next to the group name in t he Credentials tab. The Select Groups
dialog opens.

2. Choose the local machine or a domain from the Select in dropdown list. Or, you can type the OS
group name in the Enter OS Group name text box.
3. Choose an existing OS group from the Available OS Groups window and click the + button above
the list, on the right side. The OS group is added in the Selected Groups window.

Note: Only one OS group is supported per credential.

4. Click OK to close the Select Groups dialog and return the Credentials tab.

About SQL Server Security

SQL Server has its own security settings. When you install Application Server, the following operating
system groups and users and user accounts are creat ed:

419
Application Server User Guide Configure Security

 aaAdministrators group
 ArchestrA user account
 aaGalaxyOwner user account

Caution: aaGalaxyOwner and ASBService are reserved OS user names. aaAdministrators and
ASBSolution are res erved OS group names. Do not creat e users or groups with these names.

The aaA dministrat ors group, ArchestrA user account, and aaGalaxyOwner user account are defined for
use with SQL Server, and are used for Galaxy operations. Do not delete this group or these accounts.
See the section on SQL Server Rights Requirements in the System Platform Installation Guide for
additional information. This section also describes how to set the SQL Server Security Mode wi th the
aaConfig SQL utility.

Configuring Security
Before you open the security editor for a Galaxy, make sure:
 No other user is connected to the Galaxy.
 All objects in the Galaxy are checked in.
 Your user profile has configuration permissions to change Framework Configuration/Modify Security
Model, if security was previously configured.
If you try to open the security editor before these conditions are met, a warning message appears and
you are denied access.

Caution: Do not configure security settings of the IDE while an IDE-managed InTouch application is
opened for editing in WindowMaker.

Other us ers who try to open the Galaxy while you are configuring security are denied access to the
Galaxy.

420
Configure Security Application Server User Guide

To configure Galaxy security

1. On the Galaxy menu, click Configure and then click Security. The Configure Security dialog box
appears.

2. On the Authenti cation Mode tab, select the security type you want: Galaxy, OS User Based, or OS
Group Based.
If you select the OS Group-ba sed authentication mode, you can specify the time -out period for login
attempts and role verification. Allowing a longer interval can be helpful if your network connection is
slow or intermittent.
 Login Time: The time-out period (measured in milli-seconds) during which the system validates
the user’s membership against the OS groups selected as ArchestrA Roles. Minimum value is 0
(zero), maximum is 9,999, 999. The default value is 1,000. If the login time is set to 0 (zero),
which turns this feature off, the operation does not time out. Specify a value, based on the s peed
of your net work and the number of groups configured in ArchestrA. The slower the net work or
the larger the number of groups, the greater the value.
 Role Update: The time between each validation attempt per OS group for the user’s
membership when a log on is attempt ed. The user members hip update is done one role per Role
Update interval to minimize network usage. The minimum allowed value is 0 (zero) and the
maximum is 9,999,999. The default value is 0 (zero), which turns off this feature so the operation
does not pause between validating user membership and groups. This option operates
independently of the Login Time option. E ven if Login Time times out, the role update
operation continues in the background and eventually updates user-to-role relationships for this
user in the local cache.

421
Application Server User Guide Configure Security

3. Select the Security Groups tab to add and configure new security groups. Security groups define
which objects (templates and instances ) the logged-in us er can access. To assign objects to a new
Security Group, select the objects listed under the Default Group and drag them to the new group.
Security Groups are displayed in Roles tab, under "Operational Permissions." See Assigning Users
to Roles on page 426 for more information.

 Create a new security group by clicking the Add button. Type a unique name for the new group
in the Security Groups Available pane. Security group names can be up to 32 alphanumeric
characters, including a period. The name must include at least one letter and cannot start with $.

Note: Security group names are not case sensitive. Admin is the same as admin.

 Objects can only be associated with one security group. To move objects from the Default
security group to the new security group, click the Default group, then drag objects to the new
security group.

422
Configure Security Application Server User Guide

4. Select the Roles tab to set the permissions (general and operational) for each Security Role, and to
create new roles or delete existing roles.

 Remove any unnecessary general and operational permissions from the Default role (you can
also remove operational permissions from the Administrator role). Leave only the permissions
that are needed by all users. See About Roles on page 413 for more information.
 If you selected Galaxy or OS User based authentication mode, you can create new roles by
clicking the Add button. Type a name for the new role in the Roles Available pane. Role names
can be up to 512 alphanumeric characters, including a period.

423
Application Server User Guide Configure Security

 If you selected the OS Group ba sed authentication mode, the Select Groups dialog is
displayed after you click the Add button. This lets you add roles, based on existing OS groups.

– In the "Enter the OS Group name" text box, type the group name (preceded by the domain
name, if not part of the local domain) and click the Add button, or,
– In the "Select in" dropdown, select the domain that has the OS group you want to add as a
role. Then, select the group from the "A vailable OS Groups" dropdown and click the Add
button.
 Select the General and Operational Permissions for the new role. General permissions define
Galaxy configuration and management actions that a user is allowed in the IDE and the SMC.
Operation permissions define the actions a user can take at run time, for example, permission to
acknowledge alarms or modify attribute values.

Important: In the General permissions area, clearing the Can Start SMC check box will still
allow a user assigned to this role to start the SMC, but not to connect to Platform Manager.

Important: In the General permissions area, clearing the Can Start/Stop the
Engine/Platform check box will still allow the user assigned to this role to set the engine or
platform On Scan or Off Scan.

424
Configure Security Application Server User Guide

Important: If a role is given "Can Modify Deployed Instances" permission, make sure "Can
Create/Modify/Delete..." permissions in the System Configuration, Device Integration Objects,
and Application Configuration groups are also selected. This provides the role with check in and
undo checkout abilities.

5. Select the Users tab to associate authorized users with their roles, add new users, or delete existing
users.

Note: Bold red text indic ates that the User or Role is invalid within the selected Authentication Mode.

If you selected Galaxy or OS User based authentication, create a new user by clicking the Add
button. User names can be up to 255 alphanumeric characters with no spac es. To configure user
roles, see Assigning Users to Roles on page 426.

Note: You cannot add users if OS Groups based authentication mode is selected.

While viewing Application S erver events and alarms in InTouch, the ". " appears as the us er’s domain
if it is a local name. Otherwise, it appears as <domain name>\<username>.
6. When you are done, click OK. You are prompted to log on to the currently open Galaxy.

Important: To improve security, do not use the default user accounts (Administrat or or DefaultUs er)
when logging in to the IDE or ot her System Platform components. These are reserved system
names. In general, you should avoid using generic or easily -guessed user names such as "Admin,"
"Administrator," "DefaultUser," or "User." Be sure to change the passwords for these accounts to
prevent malicious or accidental access to the Galaxy.

425
Application Server User Guide Configure Security

Assigning Users to Roles

After you create users and roles, you can assign users to roles. On the Users page, all users in the
Galaxy and the roles they are assigned are listed.
New users are automatically associated with the Default role (every user must belongs to the Default
role). To assign additional roles to a user, select the checkbox for the role w hile the user name is
highlighted.

Note: All users are automatically assigned to the Default role in addition to any new roles you create and
assign to them. The best way to manage permissions is to limit the permissions of the Default role to
those permissions you want every one to have. Then, add us ers to other roles with permissions for other
parts of A pplication Server.

The Administrat or user can log on any aut hentication mode except when security is disabled. When you
are logged in as Administrator on the Galaxy Repository node, you can change the password of any
Galaxy user without providing the old password.
 In Galaxy authentication mode, you can edit the User Name in the Change Password dialog box.
 In OS -based aut hentication modes, the User Name of the OS user is shown. User information
cannot be edited.
You can assign users to more than one role.
To assign a role to a user
1. On the Galaxy menu, click Configure and then click Security. The Configure Security dialog box
appears.
2. Click the Users tab.

426
Configure Security Application Server User Guide

Note: The Change Password button is displayed only if Galaxy authentication mode is selected.

3. Select the user in the Authorized Users available area. Select a role in the Associated Roles for
<user name> area.
E very user is assigned to the Default role. Add ot her roles that they need to perform their job
functions.
4. Provide each user with a password. Make sure that you set new passwords for the Admini strator
and DefaultUser accounts.
 If you are using Galaxy Authentication Mode, click Change Password. The Change Password
dialog box appears.

You can leave the "Old Password" field blank when you initially set the password for the
Administrator and DefaultUser accounts.

427
Application Server User Guide Configure Security

 If you are using an OS-based security mode, use the Windows Cont rol Panel to manage
passwords.

Important: If an OS-based sec urity mode is selected on the Authentication Mode page, changing a
user’s password changes the OS password for the user. Any ArchestrA password may be set to a
maximum of 127 characters.

5. When you have finis hed configuring us ers, click OK. The security information is used in the
configuration, administration and run-time environment to authenticate users.

Deleting Security Groups

You can delete a security group you no longer need. Before you can delete a security group, make sure
no objects are associated with it.
You cannot delet e the Default security group.

Note: The aaA dminstrators group is required. If you accidentally delete it from Windows, you can run
either the Change Network Account utility or the aaConfig SQL utility to restore it. If you delete the
group from SQL Server, you must run aaConfig SQL. See the System Platform Installation Guide for
more information.

To delete a security group

1. On the Galaxy menu, click Configure and then click Security. The Configure Security dialog box
appears. Click the Security Groups page.
2. On the Security page, select the group you want to delete.
3. Click the Delete button.

Deleting Roles
You can delete roles you no longer need. You cannot delet e a role if any users are associated with it.
You cannot delet e the Default and Administrat or roles.
To delete a role
1. On the Galaxy menu, click Configure and then click Security. The Configure Security dialog box
appears. Click the Roles tab.
2. On the Role page, select the role you want to delete.
3. Click the Delete button.

Deleting Users
You can delete users you no longer need.

Note: You cannot delet e a user who is currently logged on.

To delete a user
1. On the Galaxy menu, click Configure and then click Security. The Configure Security dialog box
appears. Click the Users tab.
2. On the User page, select the user you want to delete.
3. Click the Delete button.

428
Configure Security Application Server User Guide

Note: The ArchestrA user account and aaGalaxyOwner account are required. If you accidentally delete
the ArchestrA user account from Windows, you can run either the Change Network Account utility or
the aaConfig SQL utility to restore it. If you delete either account from SQL Server, you must run
aaConfigSQL to restore it. See the System Platform Installation Guide for more information.

About OS Group-based Security

If you use OS Group-based Aut hentication Mode, make sure you understand the Windows operating
system, particularly its user permissions, groups and security features. ArchestrA OS Group -bas ed
security uses these Windows features. For more help, see the Microsoft online help or a 3rd party book
about Windows security.
When you use local OS Groups as Roles, each node within the Galaxy must have the same OS Users,
Groups, and user-group mappings to get the same level of access to the user at each node.

Note: Application Server us es Pre-Windows 2000 Group names for OS Group -bas ed Authentication
Mode, not the Active Directory Common Name.

Connecting to a Remote Node for the First Time

A newly-added user working on a comput er with no access to the Galaxy Repository node cannot write to
an attribute on a remote node if that user has never logged on to the remote node. This is true even if the
user is given sufficient run-time operational permissions to do writes. To enable remote writing
capabilities, log on to the remote node at least one time.
When attempting to access a remote Galaxy Repository node that contains an IDE, the user who is
logging in must have admin privileges.

Cached Data at Log In

If you log on to ArchestrA on a workstation that belongs to Domain A and Domain Controller A fails,
locally cached login data is used on subsequent log on attempts. When the domain controller returns to
operation, your log on fails during the time period that trusts are being reestablished by the controller.
If, during the controller out age, your username/password dat a changed, you can use the old log on data
if you intend to work locally.
If you want to perform remote operations, you should log on with the new log on data. If that fails, the
trusts are being reestablished by the controller, and you should retry at a later time.
The user’s full name is not available to any client (for example, an InTouch window) if the domain
controller is disconnected from the network when the user logs on to ArchestrA for the first time.
If the user previously logged on to ArchestrA when the domain controller was connected, the user’s full
name is still available to the client from data stored in cache even if the domain controller is disconnected
when the user subsequently logs on to ArchestrA.

Mixed or Native Domains

Your unique listing maps to the list of domains and user groups you see when you use the Windows tool
for managing your domain. The list of domains and user groups appears differently in the group browser
depending on whether your domain is configured as a Mixed or Native domain.
The two modes cannot be used interchangeably. We recommend using Native-mode domains for the
mode’s advantages in security and use of domain local groups.

429
Application Server User Guide Configure Security

Using Domain Local Groups

Domain local groups (DLGs) cannot be used in a mixed-mode domain. If you use DLGs to define role
permissions, when group members attempt to access secured content, those group members might see
"access denied" error messages.
This problem can occur if your domain is operating in mixed mode. In mixed mode, the scope of a DLG is
limited to the domain c ontrollers only. The DLG is not valid for member servers. The DLG can still appear
valid as certain applications, such as SharePoint Portal Server resources, do not filter out invalid DL G
entries.
If you grant the necessary role permissions to the domain user accounts individually, those users can
gain access to the secured content, but this approach nullifies one of the advantages of using DLGs.

Using Security and Distribution Domain Configurations

You must select one of two group types when you create a new group.
 Security Group Type
Use security groups to manage user and computer access to shared resourc es and to control which
users receive group policy settings.
 Distribution Group Type
Use distribution groups as email distribution lists with email applications such as Micros oft Exchange
or Microsoft Office Outlook. You cannot use distribution groups to assign permissions or to filter
group policy settings.
For this reas on, a domain group configured as a distribution type rather than a security type cannot
be used for security purposes.

Using InTouch Access Levels Security

The Role s page includes the Acce ss Level column. The Acce ss Level is an InTouch function.
In InTouch, access levels are a schema for prioritizing run -time functions. In the ArchestrA security
model, it only maps to InTouch values and has no prioritizing characteristics.
The maximum value is 9999 and the minimum is 0 (zero). If a user is assigned more than one role with
different access levels, the higher access value is passed to InTouch.

Using Secured and Verified Writes

You can assign Secured Write or Verified Write security classification to a configurable attri bute. Thes e
security classifications require authentication to perform run -time writes to the configured attribute. With
authentication, users can write to such attributes by:
 Any assignment in a script that sets the value of the attribute, such as "A=B";
where A references an attribute that is configured for Secured Write or V erified Write security
classification.
 Any action on an animation graphic that alters the value of an attribute that has Signed Write or
Verified Write security classification, such as a user input, a slider, an up/down button on a counter,
or any other such actions.
 A script that uses the SignedWrite() function.
For information about the SignedWrite() function, see Chapter 2, "QuickScript .NET Functions," in
the Application Server Scripting Guide.

430
Configure Security Application Server User Guide

The operator and verifier provide credentials for authentication by entering a valid security account
(domain name, user name, and password), or by using a Smart Card if a Smart Card reader is attached
to the system.

Note: Smart Card authentication is not supported in multi-galaxy environments for read/write operations
to remote galaxies.

Operators can write to attributes configured with Secured Write or Verified Write security classification
even if another user is logged on. This does not affect the session of the logged -on user.
 The operator must have the Can Modify Operate Attributes operational permission to perform the
Verified Write.
 The verifier must have the Can Verify Writes operational permission to confirm the Verified Write.
For more information, see Set Object Security on page 68 and About Roles on page 413.

Note: The Secured and Verified Write feat ures work only when security is enabled on both the Galaxy
and InTouch applications and do not work if eit her Galaxy or InTouch security is set to None.

Using Configurable Descriptions and Comments for Secured and Verified Writes
At run time, the Secured Write or Verified Write dialog boxes appear when the operat or attempts to write
to an attribute configured for Secured Write or Verified Write. The dialogs enable configurable user input
that can be used to provide information about the Secured or Verified Write.
Use the SignedWrite() script function to configure these inputs. The script function can be used only for
ArchestrA attributes configured wit h Secured Write or Verified Write. It can be used only for symbol
scripts and not for application object scripts.

Reason Description
The reason description is specific to an ArchestrA attribute. It explains the purpose of the attribute and
the impact of changing it. If you do not configure a reason description, the reason description area is
blank.

431
Application Server User Guide Configure Security

It is possible to use a script to directly assign a value t o an attribute or field attribute that requires Secured
or Verified Write. When the script is executed, the Secured or Verified Write dialog box appears and the
reason description area displays an Attribute description, if there is one. If the Attribute does not have a
description, then the reason description area displays the description of the Application Object to which
the attribute belongs.

Predefined Comment List

The predefined Comment list enables the operat or to comment on changing the attribute by selecting
from a predefined list of comments.

Editable Comment Box

You can enable the operator to enter a comment in the Comment box.
For more information on configuring the reason description and the predefined Comment list and box,
see "Working with the SignedWrit e() Function for Secured and Verified Writes" in Chapter 3, "Managing
Symbols," in the Creating and Managing ArchestrA Graphics User’s Guide.

Note The reason message and Comment box and list are displayed in the Sec ured Write or Verified
Write dialog box only in InTouch WindowViewer and not in ObjectViewer.

About Secured and Verified Writes Logged Information

Following a Sec ured or Verified Write a security Event is written to the event log, including the following
information:
 The signee name
 Verifier name, if any
 Type of write: "Secured Write" or "Verified Write"
 Comment, if any entered by user
 Reas on Description, if any provided
 Attribute or field attribute description, if any, or the Short Description of the Application Object, if no
Attribute description exists

432
 Application Server User Guide

C HAPTER 14
Working with Languages
This section describes the feat ures and procedures for configuring languages and enabling run -time
language switching.

In This Chapter
Defining and Configuring Galaxy Languages ................................................................................ 433
Graphics Language S witching ..................................................................................................... 433
Alarm Comment Language S witching ........................................................................................... 434
Workflow .................................................................................................................................... 434
Configuring Languages for a Galaxy ............................................................................................ 434
Exporting Symbol Text for Offline Translation ............................................................................... 438
Translating Exported Symbol Language Files ............................................................................... 442
Importing Translated Symbol Language Files ............................................................................... 443
Exporting Alarm Comments for Offline Translation ........................................................................ 447
Translating Exported Alarm Comment Language Files .................................................................. 451
Importing Translated Alarm Comment Language Files .................................................................. 452
Re-exporting Alarm Comments .................................................................................................... 453
Testing the Language Switching Functionality at Run Time ........................................................... 454

Defining and Configuring Galaxy Languages

Application S erver language feat ures enable y ou to develop applic ations that can be switched to anot her
language at run time. To enable run -time language switching, you must:
 Configure multiple languages for the application.
 Export your application text for offline translation.
 Translat e one or more exported dictionary files.
 Import one or more translated dictionary files.
You can set the Galaxy default language and you can define additional languages for purposes of
switching symbol and alarm comment languages at run time.
The default language is set and languages are added only at the Galaxy level.

Graphics Language Switching

Run-time language switching applies to all portions of the graphics or animations that you create or
configure using the ArchestrA Graphic Editor or InTouch WindowMaker. The language to display is set
when the application is being shown at run time.
You can only view translations at design time for A rchestrA Symbols in the Graphic Editor. You cannot
switch languages in WindowMaker at design time to see the translations.

433
Application Server User Guide Working with Languages

Alarm Comment Language Switching

The alarm comment language switching feature allows you to format and ex port the configured alarm
comments from attributes in a Galaxy to external files. The purpose of exporting the alarm comments to
external files is to produce InTouch-compatible localized files to support language switching of alarm
comments in the InTouch runtime environment.
You can import the alarm comment files back into the Galaxy aft er translation for convenient updating
and re-export.
If you change an alarm comment after exporting the alarm comments, you must re-export the alarm
comments. The translated alarm comments imported into InTouch and displ ayed at run time do not
change dynamically when the alarm comment is edited.

Workflow
A typical workflow for a large Galaxy might consist of the following:
1. Export the Galaxy elements to be translated as a single file that is more manageable by the
translator.
2. Import the translated file back into the Galaxy.
3. Export the translated file by Areas for use by InTouch applications.
4. Import the translated language file into InTouch.
 In stand-alone InTouch, you can perform a single import operation.
 In managed InTouch, you must import the language file into each managed InTouch application.
5. For InTouch applications that only target subareas of the Galaxy, exporting by Area is a more optimal
work flow.

Important: Exporting, translating and importing the translated files back into the Galaxy are important
steps for translating and managing translat ed files. Note that run-time language switching will not
function if you do not import the translated language file as described in number 4.

Configuring Languages for a Galaxy

The language settings of the Galaxy control which languages are available to symbols and alarm
comments. You cannot add a language at the symbol or attribute level. Languages are only added at the
Galaxy level using the IDE.
When you open a symbol for editing using the Graphic Editor or open a managed InTouch application in
WindowMaker, the language settings are retrieved from the Galaxy.
For example, you configure English and French languages for the Galaxy. You open symbol S1 in the
Graphic Editor. Symbol S1 is now configured with English and French languages. Using the IDE, you
add German to the list of configured languages. You must close the Graphic Editor and open symbol S1
again to see the German language available for the symbol.
For more information about language s witching in ArchestrA Symbols, see the Creating and Managing
ArchestrA Graphics User’s Guide.

Adding a Language to a Galaxy

E very Galaxy is associated with a base language. You must configure any additional languages that you
want to support.
To add a language for a Galaxy
1. Using the ArchestrA IDE, open the Galaxy for which you want to add a language.

434
Working with Languages Application Server User Guide

2. On the Galaxy menu, point to Configure, and then click Languages. The Configure Languages
dialog box appears.

The Configure Languages dialog box shows the base (default) language of the Galaxy.
3. Click Add. The Add Language dialog box appears.

4. Specify the language and font for the translated text.

 In the By Name or the Locale ID list, click the language to add. If you select the language by
name, the corres ponding locale ID appears in the Locale ID list, and vic e versa.
 In the Font list, click the name of the font.
5. Click OK to close the Add Language dialog box. The language you configured is listed in the
Configure Languages dialog box.

6. To add more languages, repeat steps 3 through 5.

7. To remove a language, select the row in the list and then click Remove.
8. To specify a particular language as the default, select the row in the list and then click Set Default.
9. When you are done, click OK.

Removing a Language from a Galaxy

You cannot remove the default language. At least one language must be configured for a Galaxy.
To remove a language for a Galaxy
1. Using the ArchestrA IDE, open the Galaxy for which you want to remove a language.

435
Application Server User Guide Working with Languages

2. On the Galaxy menu, point to Configure, and then click Languages. The Configure Languages
dialog box appears.

3. Select the row of the language to remove and then click Remove. A Confirm Delete dialog box
appears.

4. The dialog box provides an additional language deletion option. Select the check box to delete alarm
comment translations for the language selected. Leave the check box empty (unselected) if you want
to keep the alarm comment translations for the selected language.
5. Click Yes to confirm deletion of the selected language as well as the alarm comment translations for
that language if also selected.

Modifying the Font for a Language

The default font for all languages is Arial. You can change the font setting for a language that you have
already added. You cannot edit the font for the default language.
The configured font for a language is used in design time when a specific translation is supplied for a
language. It is also propagated to all translations for secondary languages when the fonts are not
specifically overridden by you.
For example, if you create a text element and provide translation for the secondary language without
modifying the font, the text is shown using the font from the Galaxy. However, if you manually modify the
font, then the text will always use the chos en font. This same behavior also applies to run time.
For an ArchestrA Symbol to show the updated font from the Galaxy, WindowViewer must be restarted.
No notification is provided to WindowViewer when the Galaxy font changes.
All managed InTouch applications are updated to use the new font for the selected language.
To change the font settings for a configured language
1. Using the ArchestrA IDE, open the Galaxy for which you want to change the font for a configured
language.

436
Working with Languages Application Server User Guide

2. On the Galaxy menu, point to Configure, and then click Languages. The Configure Languages
dialog box appears.

3. In the list of languages, select the target language.

4. In the Font column, double-click on the name of the font so that a drop-down arrow appears.
5. Click the name of the new font.
6. Click OK.

Changing the Default Language for a Galaxy

When you change the default language for the Galaxy:
 The new default language is shown when the Graphic Editor opens.
 The base language for translation export is changed to the new default language.
 You cannot import translations for that language.
 Symbols opened in design time use the default language when showing text that does not have a
specific translation in a secondary language.
 Symbols shown at run time use the default language if specific translated values are not provided for
the currently viewed language.
 Thumbnails for symbols are shown using the default language.
The default language for managed InTouch applic ations is always the same as the InTouch installed
language.
To change the default language for a Galaxy
1. Using the ArchestrA IDE, open the Galaxy for which you want to change the default language.
2. On the Galaxy menu, point to Configure, and then click Languages. The Configure Languages
dialog box appears.

The Configure Languages dialog box shows the base language of the Galaxy.
3. In the list of languages, select the target language.
4. Click Set Default.
5. Click OK.

437
Application Server User Guide Working with Languages

Note: Changing the default language does not change the alarm comment default language. Alarm
comments are always stored as the Galaxy Repository default language, which is the locale of the
operating system on which the Galaxy is created.

Exporting Symbol Text for Offline Translation

If your application has many strings, you typically send the text strings for your graphic symbols out for
bulk translation. You can export symbol strings for translation and modify them using a text editor, an
XML editor, or a spreadsheet program like Micros oft Excel.
We recommend that you do not make changes to symbols while symbol text is being translated.
If you make changes to your application after you export your dictionary files, you must export the
dictionary file again. For more information, see E xporting S ymbol Text to an Existing Dictionary File on
page 441.
You can only export the text strings for one language at a time. You cannot export text strings for the
default language.
Each symbol in a Galaxy is only export ed one time, no matter how many times it is referenced.
When you export the text, you specify a folder for the dictionary files. Creating a new folder to export
phrases for each language makes it easy to manage dictionary files. For example, ... \Galaxy1\My
German Files\.
Also, all exported files have the following convention: <GalaxyName>_<LanguageI D>.xml. If you will be
exporting language data for different objects at different times, use separate target directories to prevent
subsequent exports from overwriting the first export.
When you export the dictionary for an application, the files are .xml files that you can edit using Microsoft
Excel.

Types of Language Dictionary Files

A language export creates the following types of dictionary files:
 Dictionary file for all Graphics Toolbox symbols, template symbols, and AutomationObject symbols.
The file naming convention is: <GalaxyName>_<LanguageI D>.xml. For example, if the Galaxy
name is TestSample and the language being ex ported is French (Language ID = 1036) then the file
name is TestSample_1036.xml.
 Dictionary file for each managed InTouch application.
 Dictionary file for each SmartSymbol in managed InTouch applications.

Note: The alarm comment export files are named and formatted differently from symbol dictionary files.
For further information see Exporting Alarm Comments for Offline Translation on page 447.

Exporting Language Data for All Symbols in a Galaxy

You can export language data for all symbols in a Galaxy at one time. The export contains language data
for:
 Graphic Toolbox symbols.
 All symbols contained in AutomationObject templates, except for an $InTouchViewApp template.
 All symbols contained in AutomationObject instances.
The export operation only applies to symbols that are checked in.

438
Working with Languages Application Server User Guide

To export language data for all symbols

1. Using the ArchestrA IDE, open the Galaxy for which you want to export symbol text.
2. On the Galaxy menu, point to Export, and then click All Symbols. The Export Locale Data dialog
box appears.

3. Configure the export settings.

o In the Languages to export list, select the language dictionary to export. The default language
is not listed.
o In the Path box, type the folder to which you want to export the dictionary. Click Brow se to select
an existing folder or create a new folder.
4. Click Export. The export progress is shown.
5. Click Close.

Exporting Language Data for Specific Objects

You can export language data for these types of Galaxy objects:
 Graphic ToolB ox symbols
 AutomationObject templates and instances
 $InTouchViewApp templates and instances.
All symbols in an instance or template are exported.
When you export the language data for a symbol, the language data for all symbols referenced by the
symbol is also exported. The exported symbols can be referenced through direct embedding or through
a show symbol animation.

439
Application Server User Guide Working with Languages

For example, a Galaxy has Symbol1 and Symbol2 defined in the Graphic Toolbox. There are two
instances called UserDefined1 and Us erDefined2. Us erDefined1 includes Symbol1. UserDefined2
includes Symbol1 and Symbol2. The instance symbol UserDefined1.Symbol1 embeds Symbol1 and
Symbol2 from the Graphics Toolbox and one instance symbol UserDefined2.Symbol1. If you select the
instance UserDefined1 and ex port the language data, then the language data wo uld also be exported for
the symbols Symbol1, Symbol2, and UserDefined2.Symbol1.

To export language data for specific objects

1. Using the ArchestrA IDE, open the Galaxy for which you want to export symbol text.
2. Select one or more objects to export.
3. On the Galaxy menu, point to Export, and then click Localization(s). The Export Locale Data
dialog box appears.

4. Configure the export settings.

 In the Language to export list, select the language dictionary to export. The default language is
not listed.
 In the Path box, type the folder to which you want to export the dictionary. Click Brow se to select
an existing folder or create a new folder.
5. Click Export. The export progress is shown.
6. Click Close.

Exporting Symbol Language Data for a Managed InTouch Application

You export language data for a managed InTouch application using the IDE. You cannot export
translations from within the InTouc h HMI.
The export includes strings for:
 All InTouch windows

440
Working with Languages Application Server User Guide

 All SmartSymbols
 ArchestrA Symbols referenced by the $InTouchViewA pp template
The export causes a cascade export of all referenced Arc hestrA Symbols.
When you export language data for a managed InTouch ap plication, the default language for the Galaxy
is ignored. The InTouch default locale is always the installed InTouch locale. If the InTouch installed
locale and the Galaxy default language are not the same, the export is skipped for the selected
InTouchViewApp and a message is logged.
To export language data for a managed InTouch application
1. Using the ArchestrA IDE, open the Galaxy for which you want to export symbol text.
2. Select one or more managed InTouch applications.
3. On the Galaxy menu, point to Export, and then click Localization(s). The Export Locale Data
dialog box appears.

4. Configure the export settings.

 In the Language to export list, select the language dictionary to export. The default language is
not listed.
 In the Path box, type the folder to which you want to export the dictionary. Click Brow se to select
an existing folder or create a new folder.
5. Click Export. The export progress is shown.
6. Click Close.

Exporting Symbol Language Data for a Published InTouch Application

If you export languages for a published InTouch application, the following are not included:
 ArchestrA embedded symbols
 Custom property overrides
 String overrides.
The export only includes native InTouch translations.

Exporting Symbol Text to an Existing Dictionary File

If you change your application after you translate the text strings, you need to ex port the text again. For
more information, see Exporting Symbol Text for Offline Translation on page 438.

441
Application Server User Guide Working with Languages

If you export more than one time to the same directory, a message box appears.

If you click Yes, the existing .xml files are deleted and the current text for symbols in the Galaxy are
exported as a new .xml file.
Any existing translations for a symbol are reflected in the new .xml file.

Translating Exported Symbol Language Files

The procedures and tools for translating the exported language files are similar for both symbol text and
for alarm comment text. However, there are important differences. Procedures for eac h are described in
this section.

Translating Exported Symbol Text Dictionary Files

After you export the dictionary file containing your application text, use Microsoft Excel to edit the text.
To translate an exported dictionary file
1. Open the XML file in Excel. The Open XML dialog box appears.
2. Click As an XML list, then click OK. A message may appear informing you that an XML schema will
be creat ed.
3. Click OK.
The XML file opens in Excel with columns for the:
 Phrases in your application.
 Translat ed phras es from the translator.
 Translat ed font name.
 Translat ed font properties.
 Translat ed font size.
 Base font properties.
 Base font size.
 Cont ext, phrase ID, language ID and foreign language ID.

442
Working with Languages Application Server User Guide

Important: Only modify data in the Translation, TranslatedFontSize, TranslatedFontName, and

TranslatedFontProperty columns. Do not change any column header. Do not insert or delete rows.

4. Type the language-specific text in the Translation column in the row that corresponds with the base
language string in the Phrase column.
5. If necessary, change the font parameters for the translat ed strings. If you only provide a translation,
the Galaxy-configured font for the language is used to render the text after the translation is
imported. If you specify a font, it overrides the Galaxy -configured font.
 In TranslatedFontName column, type the font name.
 In the TranslatedFontP roperty column, type the not ation for the font properties:
B = bold
I = italic
U = underline
For example, if you want to the text to be bold, type B in the TranslatedFontProperty column. If
you want the text to be bold and underlined, type BU in the TranslatedFontProperty column.
6. Save the file using XML Data as the file type.

Important: If you save as another file type, such as XML Spreadsheet, Excel changes the sc hema
and the Galaxy cannot load the file. If you change the name of the XML file, the file will not import
properly into the Galaxy.

Importing Translated Symbol Language Files

You can import alarm comment language files for re -export by area, to facilitate the ex port of new,
untranslated alarm comments, and to facilitate re -export of previously translated alarm comments that
have been changed.
For symbol text, you must import the translat ed dictionary files for each language to enable run -time
language switching for those languages. All dictionary files for a given language should be placed in the
same folder.
You can import files for only one language at a time. When you import, you select the desired language
and specify the files to import.

Importing Translated Symbol Dictionary Files

All affected symbols and relevant objects are checked out before the import begins and are checked in
when the import is done. If an affected symbol or object is already checked out, a message appears in
the progress dialog box, and the import is skipped for the checked out object.
For a published InTouch application, only the native InTouch translations are imported.
You can configure how you want Galaxy and symbol/object mismatches handled during the import.
The import is skipped if:
 If default locale specified in the .xml translation file does not match the current default locale of the
Galaxy.
 An InTouchViewApp’s installed locale does not match the current default locale of the Galaxy.

Important: You cannot cancel the import after it starts.

To import a translated dictionary file

1. Using the ArchestrA IDE, open the Galaxy for which you want to import symbol text.

443
Application Server User Guide Working with Languages

2. Close all editors and check in all Galaxy objects.

3. On the Galaxy menu, point to Import, and then click Localization. When a message appears, click
OK. The Import Locale Data dialog box appears.

4. Configure the import settings.

 In the Language to import list, select the language dictionary to import.
 In the Path box, specify the folder that includes the dictionary file to import.
 In the Select files to Import box, select the .xml files to import. Only files that include the current
Galaxy name and the locale ID for the selected language are shown.
5. Click Import. The Import Locale Preferences dialog box appears.

6. In the Galaxy mismatch area, configure how you want Galaxy mismatches handled. A Galaxy
mismatch occurs when you try to import a translation file that was exported from a different Galaxy.
The Galaxy name in the translation .xml file is used to match the current name of the Galaxy.
 Click Skip file to skip all the files that do not contain the current Galaxy name in the file name.
 Click Import to import all the selected files, regardless of what the Galaxy name is in the .xml
filename.

444
Working with Languages Application Server User Guide

7. In the Symbol/Object Mismatch area, configure how you want symbol and object mismatches
handled. A symbol or object mismatch occurs when the name of the symbol and the internal ID
(GObjectID) of the symbol do not match what is within the .xml file. Objects include
AutomationObjects and InTouc hViewA pp objects.
 Click Skip to skip the symbols and objects that have mismatch names or mismatch IDs in the
.xml file
 Click Import to import a symbol or object only if it has a matching name or matching ID. If the
name resolves to one object, and the ID resolves to another object, then the import is skipped.
For examples, see Examples of Symbol or Object Mismatch Handling during Language Imports on
page 445.
8. Click Import. The import progress is shown.
9. Click Close. The Import Language Dictionary Files dialog box appears.
10. Click Check In. The check in progress is shown.
11. Click Close. A summary of the import is shown.
12. Click OK.

Examples of Symbol or Object Mismatch Handling during Language

Imports
The following table shows an ex ample of handling mismatch conditions for a toolbox symbol. The bold
name/ ID is the matching name/ID in the .xml file and current Galaxy during import.

Symbol Name Symbol Name

and ID in the and ID in the Change made after Skip
Galaxy while Galaxy while export and before Option Import Option
Exporting Importing import Selected Selected

1 S1, 100 S1, 100 No change Import to Import to S1

S1

2 S1, 100 S2, 100 Rename S1 to S2 Skip Import to S2

3 S1, 100 S1, 200 Delet e S1, Skip Import to S1

Create/Import S1

4 S1, 100 S1, 200 Rename S1 to S2 Skip Ambiguous,

skip import
S2, 100 Create/Import S1

5 S1, 100 No S1 and Delet ed S1 Skip Skip import

No 100 in the
Galaxy

The following table shows an ex ample of handling mismatch conditions for an A utomationObject symbol.
The bold name/ID is the matching name/ID in the .xml file and current Galaxy during import.

445
Application Server User Guide Working with Languages

Symbol Symbol Object

Name and Name and Name and
ID in the ID in the ID in the Change made
Galaxy Galaxy Galaxy after export
while while while and before Skip Option Import Option
Exporting Importing Importing import Selected Selected

1 Pump1, 10 S1, 100 Pump1, 10 No change Import to S1 Import to S1

only if Pump1 only if Pump1
has S1 with an has S1 with an
ID of 100 id of 100

2 Pump1, 10 S1, 100 Pump2, 10 Rename Skip Skip import if

Pump1 to S1 and 100
Pump2 pointing to two
different
symbols in
Pump2
(ambiguous)
Import to S1
only if Pump2
has S1 or a
symbol with id
of 100.
3 Pump1, 10 S1, 100 Pump1, 20 Delet e Pump1 Skip Skip import if
S1 and 100
Create and
pointing to two
Import Pump1
different
symbols in
Pump1
(ambiguous)
Import to S1
only if Pump1
has S1 or a
symbol with id
of 100.
4 Pump1, 10 S1, 100 Pump1, 20 Rename Skip Ambiguous,
Pump1 to skip import
Pump2, 10
Pump2
Create and
Import Pump1

5 Pump1, 10 S1, 100 No Pump1 Delet ed Skip Skip import S1

and Pump1
No 10 in the
galaxy

446
Working with Languages Application Server User Guide

Language Data Handling for Galaxy Operations

If you import or export objects, all language dat a within the associated symbols is imported or exported.
You can export all objects in the Galaxy, selected instances/templates, or selected symbols from the
Graphics Toolbox. All language data is export ed as part of the graphics definition, regardless of the
languages configured in the Galaxy.
You can import Galaxy objects that contain language data from the same Galaxy or a different Galaxy.
All language data in the ArchestrA graphics is imported, regardless of what languages are configured for
the target Galaxy.
No A rchestrA Symbol or InTouchViewApp language dat a is read or modified during the import operation.
If you import an unmanaged InTouch application, the configured locales in the Galaxy are applied to the
unmanaged InTouch application. No element translations in the InTouch application are removed during
import, even though languages may no lon ger be visible in the InTouch HMI or available at run time in
WindowViewer.

Exporting Alarm Comments for Offline Translation

As with symbol text export for translation, you typically send the alarm comment text out for bulk
translation. You can export alarm comments and modify them using a text editor or a spreadsheet
program such as Microsoft Excel. Once translat ed the files can be reimported to Application Server and
can be imported by InTouch for run-time alarm comment language s witching.

Guidelines and Recommendations

The following guidelines and recommendations will help you make best use of the alarm comment
language switching feature:

Important: The exported file name is generated automatically and must not be changed.

Organizing Your Export

 You can only export the alarm comment text for one language at a time.
 When you export text, you specify a folder for the language files. We recommend that you create a
separate folder for each language. For example, ...\Galaxy01\ChineseFiles\.
 For large Galaxies, exporting files for each area, after being translated and re -imported in the
Galaxy, will perform faster when the alarm clients access those files.
 For small Galaxies or for InTouch applications, we recommend that you export the entire Galaxy for
translation.

Translation File Formatting and Editing

Microsoft Excel is recommended for translation file formatting and editing, since it supports large
worksheets and provides enhanced formatting capabilities to convert the text file into tabular format. See
Exporting Alarm Comments from Very Large Galaxies on page 448.

Reimporting
 We highly recommend reimporting the translated files to the Galaxy after translation. Although
reimport is not mandatory, you can use the reimport to optimize the export files to be used in the
InTouch application.

447
Application Server User Guide Working with Languages

 If you make changes to your alarm comments after you export comment text, you must export the
alarm comments again. For this reason, we further recommend using the import functionality in
Application Server to reimport the language file after each translation. This practice will avoid the
need to retranslate alarm comments you have already translated.
For further information and procedures, see the following sections in this chapter:
Exporting Alarm Comments from Very Large Galaxies on page 448
Exporting Alarm Comments by Area on page 449
Importing Translated Alarm Comment Language Files on page 452

About the Alarm Comments Language File

The alarm comment language switching feature exports alarm comments to a .txt file. That file can be
edited directly, but working in a text editor typically is more difficult and prone to errors.
 All files export as Unicode. We rec ommend that you save the ex port ed files as Unicode.
 We recommend that you edit the .txt file in Microsoft Excel. Be sure to save the edited file as a .txt
file.
The language file name is not user-configurable. The file naming convention for alarm comment export
is:
Galaxy_<GalaxyName>_<localeID>_Alarm_Comments .txt, or
Galaxy_<GalaxyName>_<AreaName>_<localeI D>_Alarm_ Comments .txt, where the locale ID is
the selected language decimal identification number.
For example, if the Galaxy name is "TestSample" and the exported language is Chinese, the language
file name would be Galaxy_TestSample_2052_Alarm_Comments.txt.
For example, if the Galaxy name is "TestSample" the Area name is "Area001", and the exported
language is German, the language file name would be
Galaxy_TestSample_Area001_1031_Alarm_Comments.txt
See Translating E xported Alarm Comment Language Files on page 451 for further information about
alarm comment language files.

Exporting Alarm Comments from Very Large Galaxies

You can export language data in one operation for all alarm comments in a Galaxy. However, very large
Galaxies with numerous alarm comments require longer export proc essing time and can result in a very
large .txt language file. For handling large Galaxies and a large number of alarm comments, we
recommend that you export alarm comments by Area rather than exporting alarm comments for the
entire Galaxy to a single language file. See Exporting Alarm Comments by Area on page 449.

Exporting All Galaxy Alarm Comments

You can export language data for all alarm comments in a Galaxy at one time. The export operation only
applies to objects that are checked in.
To export all Galaxy alarm comments to a single file
1. Using the ArchestrA IDE, open the Galaxy for which you want to export alarm comments.

448
Working with Languages Application Server User Guide

2. On the Galaxy menu, select Export, then select the Localization menu option, and then select the
All Alarm Messages menu option. The Export Alarm Message s dialog box appears.

3. Configure the export settings:

a. In the Select option to export all alarm message s area, select the Export all alarm
message s to a single file radio button.
b. Check the Export untranslated alarm messages only check box if you have already exported,
translated and re-imported your language file and you want to export only newer, untranslated
messages. Otherwise, leave the check box unchecked.
c. In the Language to export pull-down list, select the language to export. You can export only one
language at a time.
d. In the Path box, type the folder to which you want to export the language file. Click Brow se to
select an existing folder or create a new folder.
4. Click Export. The export progress box appears.
5. Click Close when the export completes.

Exporting Alarm Comments by Area

You can export all alarm comments by Area or you can export Alarm comments for a specific Area.

Using File Names

The Galaxy_<GalaxyName>_<AreaName>_<localeID> _Alarm_ Comments.txt file name convention
applies to specific Area alarm comment exports. Area names will be included t he file name. For example,
given a Galaxy name " TestSystem", an Area name "Area001", and an export to Chinese (language
designation 2052), the language file name would be
Galaxy_TestSystem_Area001_2052_Alarm_Comments.txt.

Exporting Objects Not Assigned to an Area

System Objects typically are not assigned to an Area. These are:
 Platform Objects
 Device Integration Objects
 Engine Objects

449
Application Server User Guide Working with Languages

For purposes of language export, these System Objects form their own "Area" or become notification
distributors for the purpose of sending alarms. Exporting System Objects follows these import ant
conventions:
 System Object can only be exported from the Galaxy menu. They cannot be selected and exported
using a context menu.
 System Objects can only be export ed by exporting alarm comments for all Areas.
To export alarm comments for all Areas.
1. Using the ArchestrA IDE, open the Galaxy for which you want to export alarm comments.
2. On the Galaxy menu, select Export, then select the Localization menu option, and then select the
All Alarm Messages menu option. The Export (Area) Alarm Message s dialog box appears.

3. Configure the export settings:

a. In the Select option to export all alarm message s area, select the Export selected area(s)
only radio button, or select the Include sub-areas radio button to include all sub areas for each
selected Area.
b. Check the Export untranslated alarm messages only check box if you have already exported,
translated and re-imported your language files by Area and you want to export only newer,
untranslated messages. Otherwise, leave the check box unchecked.
c. In the Language to export pull-down list, select the language to export. You can export only one
language at a time.
d. In the Path box, type the folder to which you want to export the language file. Click Brow se to
select an existing folder or create a new folder.
4. Click Export. The export progress box appears.
5. Click Close when the export completes.
To export alarm comments for a selected Area or Areas
1. Using the ArchestrA IDE, open the Galaxy for which you want to export alarm comments.
2. Expand the Application View tree and select the Area(s) you want to export.
3. Right click to view the cont ext menu. Select Export on the context menu, then select Localization,
and then select Alarm message(s) of selected Area(s).
As an alternat e method to using the context menu, you can select the Area you wish to export, then
use the Galaxy menu as in the preceding proc edures.
4. Configure the export settings:

450
Working with Languages Application Server User Guide

a. In the Select option to export all alarm message s area, select the Export selected area(s)
only radio button, or select the Include sub-areas radio button to include all sub areas for each
selected Area.
b. Check the Export untranslated alarm messages only check box if you have already exported,
translated and re-imported your language files by Area and you want to export only newer,
untranslated messages. Otherwise, leave the check box unchecked.
c. In the Language to export pull-down list, select the language to export. You can export only one
language at a time.
d. In the Path box, type the folder to which you want to export the language file. Click Brow se to
select an existing folder or create a new folder.
5. Click Export. The export progress box appears.
6. Click Close when the export completes.

Translating Exported Alarm Comment Language Files

Alarm comments are exported to a .txt file, located in the selected directory. You can edit the files with a
text editor, but we recommend Microsoft Excel as the editor. Using the format -as-table feature in Excel
greatly simplifies editing the specific text to be translat ed.
To translate an exported alarm comment file
1. Open the .txt file in Excel. The Excel Text Import Wizard appears. Follow the wizard instructions to
import the text file in tab delimited, general column data format. The file appears unformatted in
Excel.

2. Format the text as a table in Excel:

a. Select all of the rows containing data in Column A through Column C.
b. Select the Home tab, then select Format as Table.

451
Application Server User Guide Working with Languages

c. Select the color pattern you want and click OK in the Format as Table dialog box. Excel will
format the region to be edited.

The Excel display is divided into four regions:

o Column 1 contains Phrase ID numbers used internally in the language file. Do not edit this
column.
o Column 2 contains the exported alarm messages. Do not edit this column.
o Column 3 contains the alarm message translations. Edit this column with your translation text.
o Below the alarm comment text columns are the alarms and phrase IDs, which map to column 1
and are used internally in the language file. Do not edit this area.
3. Translat e the alarm comment text. Type the alarm comment translations into the appropriate rows in
column 3.

Important: Only edit the text in column 3, translations. No other text in the file may be edit ed. You
can edit the original alarm comment text only within the ArchestrA IDE.

4. Save the file as a .txt file in the directory you originally select ed for export.

Important: Do not change the file name or the file type, otherwise it will not import correctly into the
Galaxy.

Importing Translated Alarm Comment Language Files

You can import translat ed alarm comment language files only from the Galaxy menu, not from the
context menu for specific Areas.
To import alarm comment language files, you must first have exported alarm comments for translation of
some or all of the alarm comments.
To import a translated alarm comment language file
1. Using the ArchestrA IDE, open the Galaxy for which you want to import translated alarm comments.

452
Working with Languages Application Server User Guide

2. On the Galaxy menu, select Import, then select the Localization menu option, and then select the
Alarm Message(s) menu option. The Import Alarm Message s dialog box appears.

3. Configure the import settings:

a. In the Language to import pull-down list, select the language to import. You can import only
one language at a time.
b. In the Path box, type or browse to the folder where you previously exported your language file.
The available language files appear in the Select files to import list.
c. Select a file or files to import.
4. Click Import. The import progress box appears.
5. Click Close when the import completes.

Note: If an alarm name or message do not match, the alarm comment import will display a message
for each failed alarm message import.

To import a translated alarm comment language file into InTouch

1. Open the application in WindowViewer.
2. On the Special menu, select Language, then select the name of the language you want to s witch to.
Information from the corres ponding translated dictionary file (if one exists and has been imported
into InTouch) loads and displays.
3. Click Close when the import completes.

Re-exporting Alarm Comments

After exporting and translating alarm comments, you can re-import them to ArchestrA to help maintain
up-to-date alarm comment language files.
After adding new alarm comments that require translation or after modifying existing, al ready translat ed
alarm comments, you must re-export the language file to update the translations.

453
Application Server User Guide Working with Languages

Exporting New Untranslated Alarm Comments

In the Export Alarm Messages dialog box, select the Export untranslated alarm message s only
check box. This creates a file named _unt ranslated.txt. For example, exporting untranslated alarm
comments in Chinese for a Galaxy name "TestSystem" would create a file named Galaxy_TestSystem_
2052_Alarm_Comment _Untranslated.txt.

Exporting Modified Existing Alarm Comments

You can make changes to alarm comments that you previously exported, translated and imported back
into ArchestrA. You must re-export the alarm comment language file(s) to update the translations.
In the Export Alarm Messages dialog box, select the same language option and folder you selected for
the previous export. When asked, confirm that you want to overwrite the existing file.

Testing the Language Switching Functionality at Run Time

We recommend that you test the run-time language switching functionality. Follow the procedures
outlined in this chapter to enable run -time language switching in your application. Then import the
appropriate language file into InTouch. The import step applies to bot h stand-alone and managed
InTouch applications.
To test the language switching functionality
1. Open the application in WindowViewer.
2. On the Special menu, point to Language, and then click the name of the language to switch to.
The information from the corres ponding translated dictionary file (if one exists and has been
imported into InTouch) loads and appears.
3. When you are done, click Close.

454
 Application Server User Guide

C HAPTER 15
Managing Galaxies
You can back up and restore Galaxies, change the Galaxy you are working with, delete a Galaxy, and
export and import all or part of a Galaxy.
If you want to create a Galaxy, see Create a Galaxy on page 18.

In This Chapter
Backing Up and Restoring Galaxies ............................................................................................. 455
Changing Galaxies ..................................................................................................................... 457
Deleting a Galaxy ....................................................................................................................... 457
Galaxy Object Components Synchronization ................................................................................ 458
Exporting a Galaxy Dump File ..................................................................................................... 459
Editing the Galaxy Dump File ...................................................................................................... 460
Importing a Galaxy Load File ....................................................................................................... 462
Hosting Multiple Galaxies in One Galaxy Repository ..................................................................... 463
Disk Space Requirements ........................................................................................................... 463
Managing Communication between Galaxy Nodes ....................................................................... 463
Mapping Network Drives with User Account Control Enabled......................................................... 464
About ArchestrA Us er Accounts ................................................................................................... 464
Using Multiple Network Interface Cards ........................................................................................ 465

Backing Up and Restoring Galaxies

Periodically, you should back up your Galaxy. Backing up your Galaxy helps if you have a comput er
failure or other problem. If there is a failure, you can restore your Galaxy from the backup.
Use the Galaxy Database Manager to back up and restore your Galaxy. The Galaxy Database Manager
is part of the suite of ArchestrA System Management Console utilities.
The aaConfigSQL utility is another utility that you may need to use when restoring Galaxies.
aaConfigS QL is used to set ArchestrA user permissions for SQ L Server. In most cases, the default level
of permissions is adequate for restoring Galaxies.
However, if you are restoring a Galaxy created with an older version of A pplication Server, you may need
to change the permissions level.
See the section about SQL Server Rights Requirements in the System Platform Installation Guide for
additional information about the aaConfigS QL utility.

455
Application Server User Guide Managing Galaxies

To open the Galaxy Database Manager

 From the Start menu, navigate to Wonderware Utilities, and then select System Platform
Management Console.

See the Galaxy Database Manager documentation for more information about backing up or
restoring your Galaxy.
If Enhanced Security mode is in effect, you will be prompted to enter SQL SysAdmin credentials
before you can restore a Galaxy creat ed in an older version of Application Server.

456
Managing Galaxies Application Server User Guide

Changing Galaxies
You can have many Galaxi es in the Galaxy Repository. If you are a systems integrator, you have at least
one Galaxy for every client.

Galaxy B

Galaxy C
Galaxy Repository Node
Galaxy A

Galaxy D

Active Galaxy

For a Galaxy to deploy objects to other comput ers in the Galaxy, the Galaxy Repository (GR) must host
a platform defined in that Galaxy. Because of this, y ou can only deploy one Galaxy from the Galaxy
Repository at a time to the comput ers on your net work. For more information about deploying, see
Deploying Objects on page 267.
To change from one Galaxy to another
1. On the Galaxy menu, click Change Galaxy. The Change Galaxy dialog box appears.

2. Do one of the following:

 Select another Galaxy from the Galaxy Name list.
 Select another Galaxy Repository node from the GR Node Name list.
3. Click Connect.

Deleting a Galaxy
You can delete a Galaxy. Deleting a Galaxy removes all of the Galaxy information from your computer.
Before you delet e a Galaxy, you must undeploy all objects within it. For more information about
undeploying objects, see Undeploying Objects on page 272.

457
Application Server User Guide Managing Galaxies

Make sure you select the right Galaxy to delete. After you delete a Galaxy, you cannot undelete it. You
can only recreate it by restoring from a backup. For more information, see Back ing Up and Restoring
Galaxies on page 455.
To delete a Galaxy
1. Undeploy all objects from the Galaxy you want to delete.
2. Close any Galaxy and connected IDE you have open.
3. On the File menu, click Change Galaxy. The Connect to a Galaxy dialog box appears.
4. Select the Galaxy you want to delet e, except the connected Galaxy.
5. Click Delete Galaxy.
6. At the prompt, click Yes.
7. When the Galaxy is deleted, click Close.

Galaxy Object Components Synchronization

The Galaxy Object Components Synchroniz ation feature provides a detection and recovery mechanism
when the client is out-of-sync with the server. Synchronization means synchronizing the installed object
components on the client node with respect to the connected GR.
Synchronization of object components as defined in this section is fundamental to the subsequent
functionality. For that reason, it is unnecessary to synchronize script libraries, graphics or
InTouchViewApp-related files, client controls, IDE extensions, run -time components, security, or history
data.
In the case of a run time out-of-synchroniz ation condition, rec overy is accomplished by redeploying the
run-time plat form.

Definitions
The following terms are important in understanding the Galaxy Object Components Synchronization
feature:
 Object Component: Base template-dependent files
 Server: The GR node, which maintains the object component information
 Client: The IDE

Typical Out-of-Sync Scenarios

The GR and the client nodes can become out-of-sync in a number of ways. The following are the typical
causes:
 Re-imaging the client or server node or both
 Restoring a Galaxy from a backup
 Deleting and creating a Galaxy on the server node

Using the Synchronization Feature

The synchronization detection and resolution process is the same for all scenarios. Out -of-sync
conditions between a client and a Galaxy are detected and r esolved at connection time.

458
Managing Galaxies Application Server User Guide

If the system recognizes that the minimum connectivity requirements are met, and there are object
versioning conflicts, then you are prompted about the out-of-sync state with the option either to
synchronize or to reject the synchronization operation.

Select the option you prefer. If you select to synchronize, the synchronization operation will run without
further prompts.
A warning message is placed in the Logger for any out-of-sync detection and synchronization issues.

Exporting a Galaxy Dump File

You can export instances and their configuration data in a Galaxy to a comma-separated values file with
a .csv file name extension. After you export the Galaxy to a .csv file, you can edit it with Microsoft Excel.
This makes it very easy to do large editing changes, such as search and replace.
Exporting only exports instances. Templates cannot be exported in .csv file format.
The .csv file cont ains the configuration for the checked-in versions of the selected instances and the
checked-out instances of the user who does the Galaxy dump. If an instance is checked out by another
user when you export the Galaxy, the checked in version is exported.
The file contains only those attributes that are unlocked and configuration time -writeable, one column per
attribute. The following are not exported:
 Scripts libraries are not export ed. Scripts within an object are exported.
 Attributes that are not text-based are not exported. For example, type QualifiedStruct is not exported.
 Custom object online help files are not exported.

Note: I/O Auto Assignment information is not included in the Galaxy dump file. For information about
manually adding I/O Auto Assignment information to a Galaxy dump file for inclusion in the Galaxy load
process, see Enabling I/O Auto Assignment in the Galaxy Dump File on page 461.
See About the Galaxy Dump File Structure on page 460 for specific information about the structure of the
.csv file. Before you start, make sure you know what instances you want to export to a file.
To export objects to a Galaxy dump file
1. In the Application views area, select at least one instance. Shift+click to select multiple instances.
You can export all instances derived from a template by selecting the template.
2. On the Galaxy menu, click Export and then click Galaxy Dump. The Galaxy Dump dialog box
appears.
3. Browse to the location of the .csv file to which you want to dump the selected instances. Type the
name of the file. Click Save.
4. When the Galaxy export process is done, click Close. A .csv file is created containing the selected
objects and configuration data.

459
Application Server User Guide Managing Galaxies

Editing the Galaxy Dump File

You can open t he .cs v file created by the Galaxy dump process in a t ext editor such as Not epad or in
Microsoft Excel. When you have finished editing the file, s ave it as plain text .csv (comma delimit ed)
file to import back into the Galaxy.

About the Galaxy Dump File Structure

The Galaxy .csv file has a specific structure. This section describes that structure.
Objects are organized in the .csv file based on the template each is derived from. A header row per
template indicates the instance’s columns’ reference.
Other information is organized in columns. This makes it easy for you to read the information and
carefully make any changes you need. You can easily import the .csv file into a text editor or into
Microsoft Excel.

Add comments by adding a line wit h a semi-colon as the first character in the comment.

Host Attributes
Galaxy dump files contain a column for the Host attribute of the objects being dumped. In the case of
Platform objects, Host is always the name of the Galaxy from which the object is being dumped.
This data is ignored in subsequent Galaxy Load operations because the Host for Platform objects is
automatically the name of the Galaxy into which it is being loaded, regardless of the name of the Galaxy
from which it was dumped.

460
Managing Galaxies Application Server User Guide

Using a text editor, you can delete the Host attribute column, like any other dat a in the Galaxy dump file.
This has no effect on Platform objects in subsequent Galaxy Load operations because they take the
Galaxy name as their Host.

About Quotation Marks and Carriage Returns

Carriage returns in scripts associated with dumped objects are replaced with \n in the .csv file. If you
edit the dump file, do not delete the \ n characters. If y ou edit scripts in the dump file, us e \n for a carriage
return. This character set is interpreted as a carriage return when the dump file is used in a Galaxy Load
operation.
When editing a script in a dump file, use \\n if you want to include the backslash character (\) followed by
the letter n in a script. This character set is not converted to a carriage return in a Galaxy Load function.
Be careful when adding or editing quotation marks in the .csv file. Type all single quotation marks as
two single quotation marks and surround the entire string with opening and closing quotation marks.
Make sure the string contains an even number of quotation marks. When the object is loaded in a Galaxy
Load operation, the extra quotation marks are stripped from the string.
For example, if you want to enter 3"Pipe as a Short Description, add a second quot ation mark
(3""Pipe) and then surrounding quotation marks ("3""Pipe").

Time Formats in Excel

If you edit a Galaxy dump file in Microsoft Excel, be careful typing time entries. Excel can change the time
format and the resulting entries do not work when you reload the changed Galaxy.
Galaxy Load accepts two formats:
 DAYS HH:MM:SS:SSSSSS - the number of DAYS is followed by a space.
 HH:MM:SS:SSSSSS - Excel automatically changes the entry to an incompatible format.
When you type time ent ries in Excel, use the following format:
DAYS HH:MM:SS:SSSSSS.
For example:
0000 01:02:12.123: 1
04:03:06.12:120
22:66:88:123456

Enabling I/O Auto Assignment in the Galaxy Dump File

You can use Galaxy dump to convert a Galaxy that contains traditional I/O hard coding to use I/O auto
assignment instead. If you are planning to expand an existing Galaxy by adding many objects, or if you
are upgrading PLCs, converting hard coded I/ O references to auto assignment can save you time. To
convert the references, edit the Galaxy dump file as described below. This bulk edit is faster than
changing each object individually in the IDE object editor.
The Galaxy dump file displays a flag, "---Auto---", for input and out put attribut es that use I/O aut o
assignment. This flag indicates that I/O auto assignment is enabled for the attribute. The actual I/O auto
assignment to a DI Object and scan group is not preserved in the dump file. If you want to preserve
existing I/O auto assignment settings, use the export objects function instead of Galaxy dump. See
Export Objects on page 98 for additional information.
To convert hard coded I/O references, edit the Galaxy dump file to replace the hard coded reference with
"---Aut o---" for each <attribute>.InputSource and/or <attribute>.Output.Dest. Import the edited objects
back into the Galaxy, and then assign the objects in the IO Devices view of the IDE to a DI Object and
scan group.
For more information about I/O auto assignment, see Using I/O Auto Assignment on page 140.

461
Application Server User Guide Managing Galaxies

To convert hard coded I/O references to I/O auto assignment

1. Use Galaxy dump to export the objects with hard coded I/O references that you want to convert.
2. Open the exported .CSV file in a text editor or Excel.
3. In the data row of the Attribute.InputSource column, delete the hard coded I/O assignment. Enter
"---Aut o---" in the dat a row.
4. Repeat for each object that you want to enable for I/O auto assignment.
5. In the data row of the Attribute.OutputDest column, delete the hard coded I/ O assignment. Enter
"---Aut o---" in the dat a row.
6. Repeat for each object that you want to enable for I/O auto assignment.
7. Save your changes.
To complete the process of activating I/O auto assignment
1. Use Galaxy load to import the objects in the edited Galaxy dump file. See Importing a Galaxy Load
File on page 462 for additional information.
Once imported, the objects will appear in the IO Device s view, under the Unassigned IO Device
folder.
2. Drag and drop objects in the IO Device s view to link the objects to the applicable DI Object and scan
group. See Using I/O Auto Assignment on page 140 for additional information.

Importing a Galaxy Load File

After you are done editing a .csv file, you can import it back into your Galaxy.
A load file contains only instances. Templates cannot be dumped or loaded. S ee for more information
about the contents of the .csv file.

Note: A comment line in a .csv file created in Microsoft Excel can create an unintended default -value
object. To avoid this, open the .csv file in Notepad to make sure the comment line does not contain
quotation marks.

To import a .csv file

1. On the Galaxy menu, click Galaxy Load. The Galaxy Load dialog box appears.
2. Browse to find the .cs v file that contains the objects and configuration data you want to import. Select
the file and click Open.
3. The Galaxy Load Conflict Resolution dialog box appears. Use it to resolve conflicts that can occur
if objects you want to load already exist in the Galaxy.

4. Select one of the following:

462
Managing Galaxies Application Server User Guide

 Replace entire instance if an instance of an object with the same name already exists and you
want to replace it entirely with the object in the import file.
 Only update changed attributes if an instance with the same name already exists and you
want to replace only the attributes of the object where the values are different.
 Skip if an instance with the same name already exists and you want to keep the version already
in the Galaxy.
 Stop Galaxy Load if an instance with the same name already exists and you want to cancel the
Galaxy Load.
5. Click OK. A progress box appears showing the Galaxy load process.
When the load is done, all objects changed or creat ed during the Galaxy Load process are checked
in.

Hosting Multiple Galaxies in One Galaxy Repository

You can create and configure multiple Galaxies in a single Galaxy Repository on the same computer.
You can configure one Galaxy from an IDE and then change Galaxies and configure the second one
using the same IDE.

Note: If you try to deploy objects from the second Galaxy to a computer t hat hosts deployed objects from
the first Galaxy, the deploy fails.

Disk Space Requirements

After Application Server is installed, certain operations require at least 100 MB of available disk space.
These operations include
 Creating a Galaxy
 Deploying objects
 Importing and exporting objects
 Loading and dumping a Galaxy
 Restoring and backing up a Galaxy.
This minimum requirement applies to the Galaxy node as well as any remote IDE nodes.
If your computer has less than 100 MB of available hard disk space, running any of these operations can
result in erratic behavior.

Managing Communication between Galaxy Nodes

You can use Application Server in a distributed environment. All computers with ArchestrA -enabled
software installed must be able to communicate with each other.
Two items must be considered to ensure communication bet ween nodes:
 ArchestrA user accounts
 Multiple network interface cards in comput ers
All Platforms communicate with several attributes on the GR Plat form to detect configuration changes.
This communication sends NMX heartbeats from each Platform to the GR Plat form. For example, the
attributes include "time of last deploy," and "time of las t configuration change."
In addition to NMX heartbeats, all Bootstraps on each Platform in the Galaxy send each other
heartbeats. Thes e heartbeats are for Platform status information, occur every two seconds, and are
configurable.

463
Application Server User Guide Managing Galaxies

Mapping Network Drives with User Account Control Enabled

Mapping network drives with Windows Us er Account Control (UA C) enabled can creat e issues with
subsequent access to thos e drives. Windows considers mapping a network drive and later access to that
drive, to import objects from a net work location, for example, as separate logon contexts, and issues
separate credentials. Without correct credentials, the mapped net work drives can becom e inaccessible.
You can ensure that no issues occur with mapped drives by using one of two methods to map the drives:
1. Map drives from the command prompt as an administrator.
From Windows Start/All Program s, click Accessories, then right-click Command Prompt and
select Run as administrator on the context menu.
At the command prompt, type the "net use" command, using the following format:
net use \\<computername>\<sharename> /user:<username>
Example:
net use z: \\MainComputer\ObjectFiles /user:DRoberts
where the drive being mapped is z:, the computer name is MainComputer, the share name is
ObjectFiles, and the user name is DRoberts.
2. Map drives from the IDE using elevated privileges.
For example, you can map drives from the Import Object(s) dialog.

About ArchestrA User Accounts

Communication occurs with an ArchestrA-specific user account set up during the initial installation of
each ArchestrA component on each computer, including the IDE.

WARNI NG! The user account that i s used for Arche strA communication is a standard Windows
operating system account located on the local computer or on a domain. Do not delete this
account with operating system account management tools. If you do, the IDE stops functioning.

If you delete the ArchestrA user account on an IDE node, you must recreate it with the Change Network
Account utility. You must have Administrat or privileges on the computer to make changes with the
Change Net work Account utility.
Before you start, find out the user name and password that is created on all computers wit h
ArchestrA-enabled software installed.

Important! Completing the account change requires a system restart. Once you press OK, you
cannot cancel the account name change or the system restart.

464
Managing Galaxies Application Server User Guide

To recreate an ArchestrA user account

From the Start menu, navigate to Wonderware Utilities, and then select Change Network Account.

1. The domain name or local machine name for the old A rchestrA user account is shown. If you need to
change to a different domain, use the short domain na me. Do not use a fully qualified domain name
(FQDN). For example, use "DomainName" and not "DomainName.com" or "DomainName.local."
2. Do one of the following:
 In a single-node ArchestrA system, enter a new or existing account name.
 In a multi-node ArchestrA system, create the same user account with the same user name and
password on all other ArchestrA computers.
If you are using an existing account name or a domain account, leave the "Create Local Account"
checkbox unchecked.
3. Click OK or Cancel. If you click OK, the system will warn you to shut down all open applications and
that the computer will be restart ed. You cannot cancel the account change or system restart at this
point. After you recreate the user account, the Microsoft Windows security c omponent on your
computer can take several minutes to update this information on the ArchestrA Galaxy node. Until
that happens, your IDE might not function properly. Restarting the Galaxy node applies this update
immediat ely.

Using Multiple Network Interface Cards

You can use nodes with more than one network interface card (NIC). These nodes must be configured
properly so they can communicate wit h other ArchestrA nodes.
If a node contains multiple NICs for redundancy reasons, see W ork ing with Redundancy on page 471 for
more information.
If a multiple NIC computer in your Galaxy uses only one NIC, you need to disable all cards except the
supervisory network.

Defining the Order of the NIC

For any multiple NIC ArchestrA node to communicate wit h all other Galaxy nodes, you must define the
correct order of network connections in the network services of the computer.
Before you start configuring multiple net work cards, you need the IP add ress for the second and
subsequent nodes.

465
Application Server User Guide Managing Galaxies

To define the correct order (Windows 8.1 and Windows Server 2012 and 2012 R2)
1. Open Network Connections through the Control Panel (access Network Connections through
Control Panel > Network and Sharing Center, then select Change adapter settings).
2. Rename each network card with a clearly identifiable function, for example, Supervisory Net and
PLC net.
3. Select Advanced from the menu bar (press the Alt key if the menu bar is not visible), and click
Advanced Settings.
4. In the Advanced Settings dialog box, click the up and down arrows to define the correct order of
Connections.
 The first connection in the list must be the supervisory network card.
 If a computer contains more than two network cards, for example, a supervisory connection, a
PLC connection, and a Redundancy Message Channel (RMC) connection for ArchestrA
redundancy, the supervisory network must be listed first. The others can be listed in any other
position.
5. Click OK to accept the changes.
To define the correct order (Windows 10 and Windows Server 2016)
See Configuring Multiple NICs on page 466 for instructions.

Configuring the IP Address and DNS Settings

After you specify the order of the net work cards, you are ready to configure several ot her paramet ers to
ensure successful node-to-node communications in the ArchestrA environment.
You must configure the IP address and DNS settings as follows for each netw ork card to function
properly.
To configure the IP address and DNS settings
1. In the Network Connections dialog box, right -click the network connection and click Properties in
the shortcut menu. The Propertie s dialog box for this connection appears.
2. In the list of components used by this connection, select Internet Protocol (TCP/IP) and click
Properties. The Internet Protocol (TCP/IP) Properties dialog box appears.
3. For the supervisory network, select Obtain an IP address automatically.
For the ot her network connections, select Use the following IP address. Type the correct IP
address for the secondary and furt her cards. See your network administrator for the proper settings
for the remainder of the parameters in this group.
4. Click Advanced. The Advanced TCP/IP Settings dialog box appears. Click the DNS tab.
5. For the supervisory network, select Register thi s connection’ s addre sse s in DNS.
For the ot her network connections, clear this check box.
6. Click OK.

Configuring Multiple NICs

Network profiles are identified and assigned during computer startup and each time a connection
changes. The three profiles currently in use in the supported Windows operating systems are:
 Domain profile: Active only when the computer can authenticate with a domain controller on all
active interfaces (for example, LA N, wireless, and VPN). The domain profile may be more or less
restrictive than the other two profiles depending on net work security policies.

466
Managing Galaxies Application Server User Guide

 Private profile: Active whenever the network type for all active network connections on the
computer are identified as private networks. The private profile typically is used in a more trusted
environment and is less restrictive than the public profile to allow for net work discovery.
 Public profile: Active in all other circumstanc es. The public profile typically is more restrictive than
the private profile because the comput er often is connected to the Internet in an insecure location.
Network discovery and remote access are dis abled rather than explicitly blocking specific traffic.
All programs allowed to communicate through the firewall are blocked if one or more net work interface
cards (NICs) are configured as "Public Net work." When the IP address of a net work card changes, the
NIC is automatically updated to "Public Net work." If even one NIC in a computer with multiple NICs is
configured as "Public Network", the firewall exceptions are disabled.
This is particularly important for computers configured to run as a redundant pair. I f the TCP/IP properties
for a net work card are set to obtain an IP address automatically, there is a possibility that the network
address will change when the computer restarts. The computer may suddenly change from having a
"Private Network" to having a "Public Network," and potentially block the programs that were previously
allowed to communicate through the firewall.

Note: An exception to this would occur if the NICs are configured and set to the Public Profile before
Application S erver is installed. The Application Server installation would allow the necessary programs to
communicate through the firewall in the current (Public) profile.

The following describes the key NIC settings for a redundant pair. You configure these settings for both
the primary and backup computers. These settings apply if more than two NICs are installed for
redundancy (RMC) or ot her networking purposes, such as networking PLCs.
For detailed instructions on how to configure multiple network interface card binding order settings, see
Defining the Order of the NI C on page 465 and Configuring the IP Address and DNS Settings on page
466.
To configure multiple NICs
1. Under Internet Protocol Version 4 (TCP/IPv4) Propertie s, select the Use the following IP
address option and provide an IP address, subnet mask, and default gateway.
a. For the primary computer, the default gateway should be the IP address that you configure for
the backup computer. For example:
IP address: 100. 100. 100.94
Subnet mask: 255.255. 255. 0
Default gateway: 100.100.100.95
b. For the backup computer the default gateway should be t he IP address that you configure for the
primary computer. For example:
IP address: 100. 100. 100.95
Subnet mask: 255.255. 255. 0
Default gateway: 100.100.100.94
c. A NIC acting as Redundancy Message Contr ol (RMC) does not require a default gateway. The
IP address and Subnet mask can be configured as described for the primary and backup
computers. Windows will identify this NIC and assign it a privat e profile. For example:
IP address 100.100.100.96
Subnet mask: 255.255. 255. 0
2. Under Advanced Settings, check that the Regi ster thi s connection's addre ss in DNS option is
not selected.

467
Application Server User Guide Managing Galaxies

To set the binding order in Windows 8.1 and Windows Server 2012 / 2012 R2
1. Make sure that the primary network adapter is first in the binding order. This plac es it above t he RMC
network in the binding order.
2. Make sure that ALL net work cards are configured as "Private Network."
3. Configure the RMC NIC to have a persistent (across reboots) Private profile.
a. Open a command window and enter the command secpol.msc. The Security Policy window
appears.
b. Select Network List Manager Policies.
c. Select Unidentified Network.
d. Right click, then select Properties, and then change the Location type from Not configured to
Private.
e. Close the command window.
It may be necessary to restart the computer for the changes to take effect.
To set the binding order in Windows 10 and Windows Server 2016
Microsoft has changed how network protocol bindings are handled in its newest operating systems.
Windows now us es an Interface Metric number to determine priority.
To check the existing priorities of your net work cards:
1. Launch the Windows PowerS hell as administrator.
2. To view the current priority, enter the following cmdlet:
Get-NetIPInterface

468
Managing Galaxies Application Server User Guide

This displays the Interface List. An interface metric number is listed for each network interface
card/adapter. Note that the lowest number has the highest priority.
3. Identify the NIC cards and define the binding order (priority). Check the InterfaceIndex numbers for
each NIC. It could be that your cards already have the correct priorities (higher InterfaceIndex
numbers have lower priority).
4. If you need to change the priority of your interface cards, us e the following cmdlet to change the
InterfaceIndex for one or more network cards. For example:
Set-NetIPInterface -InterfaceIndex 2 -InterfaceMetric 100 (lower priority)
Set-NetIPInterface -InterfaceIndex 5 -InterfaceMetric 10 (higher priority)

5. Close the PowerShell.

If the two computers are set up properly, you can install the Wonde rware software and the
OSConfigurationUtility sets up the firewall exceptions appropriately.

469
Application Server User Guide Managing Galaxies

If you install the Wonderware software before configuring the NICs properly, configure the NICs as
described in this section and then run the OS ConfigurationUtilit y again. To do this, run the
OSConfigurationUtility.exe, located in the C:\Program Files (x86)\Common Files\Arche strA folder.

To verify that the firewall exceptions are set, open Control Panel and then open the Windows Firewall
application. Verify that the executables for the Wonderware products you have installed are allowed to
communicate through the firewall.

470
 Application Server User Guide

C HAPTER 16
Working with Redundancy
You can set up and run Application Server in a redundant environment. For more information about
redundancy, see the AVEVA Software Global Customer Support website.

In This Chapter
About Redundancy ..................................................................................................................... 471
Working with AppEngine Redundancy.......................................................................................... 474
Troubleshooting.......................................................................................................................... 480
Working with Data Acquisition Redundancy .................................................................................. 482

About Redundancy
A failover is the condition during which run-time operations are moved from one critical component to
another. Failover can occur due to failure conditions or it can be forced manually, called a forced failover.
Application Server provides redundancy in two critical functions:
 AppEngine: You must configure both an AppEngine and two WinPlatforms.
 Data acquisition: You must configure two DIObjects (data sources) and a Redundant DIObject.

Configuring AppEngine Redundancy

The Primary/Backup AppE ngines form a redundant pair. The ArchestrA infrastructure will generat e the
backup AppE ngine automatically when redundancy is enabled for an AppE ngine. Hierarchy of
ApplicationObjects can only be assigned to the primary AppE ngine. The primary and backup engines
need to be assigned to redundancy enabled plat forms, and they can be deployed separately.
For data acquisition, the Primary/Backup DIObjects (the data sources) must be separately created,
configured, and deployed. Also, you must create, configure, and deploy a RedundantDIObj ect to control
failovers bet ween the two data source objects.
In a redundant system, install and configure the primary OPC server on the backup engine node.

471
Application Server User Guide Working with Redundancy

When you configure redundancy, you configure the Primary object and the Backup object.

 Primary object: The main or cent ral object that provides the functionality during run time. For
AppEngines, this is the object you enable for redundancy. For data acquisition, this is the DIObject
you intend to use first as your data source in run time.
 Backup object: The object that provides the functionality of the Primary object when the Primary
object fails. For AppEngines, this is the object created by the Arc hestrA infrastructure when the
Primary object is enabled for redundancy. For data acquisition, this is the DIObject you do not intend
to use first as your data source in the run-time.

Redundancy during Run Time

When you deploy these objects to a run -time environment, the configuration objects become the Active
object and the Standby object.

 Acti ve object: The object that is currently executing functions. For AppE ngines, it is the object that is
hosting and executing ApplicationObjects. For data acquisition, it is the object that is providing field
devic e data through the RedundantDIObject.
 Standby object: The object that is waiting for a failure in the Active object or for a force-failover. For
AppEngines, it is the object that monitors the status of the Active AppEngine. For data acquisition, it
is the object that is not providing field device data through the R edundant DIObject.

472
Working with Redundancy Application Server User Guide

In the AppEngine redundancy environment, the Active and Standby objects monitor each ot her’s
statuses and switch during a failover situation.
During a failover, when an Active engine fails, it restarts and the Standby engine becomes active. The
Active engine then turns to the standby mode. In the data acquisition environment, the
RedundantDIObject monitors the status of the two DIObject data sources, and handles the switching
from Active to Standby objects.
The relations hip bet ween the configuration time (P rimary/Backup) and run-time (Active/Standby) object
pairs is not static. In the run time, either the Primary or Backup object can be the Active object at any
particular time. Whenever one becomes the Active object, the other automatically becomes the Standby.

Engine Restart After Failure

An AppEngine will restart automatically aft er an engine failure such as a crash or hang. If the engine is
redundant, it will synchronize with its redundant partner, and running applications will resume.
Engine restart on failure is automatic and cannot be disabled.

CPU Load Balancing

CPU load balancing for redundant AppE ngines can be used to maint ain system stability by limiting high
CPU usage during AppEngine startup after failover. When CP U usage by a core is close to 100%, other
processes can be starved and startup times can extend as a res ult. When CPU load balancing is
enabled, objects are loaded in discrete chunks, thus improving CPU utilization.
Application Server includes a registry key that you can use to configure CP U load balancing for
redundant engines. CPU load balancing is disabled by default, and the configuration of each node is
independent. That is, you can enable CP U load balancing on some nodes and not on others, and have
different settings for each node.

Note: CPU load balancing will only work on run-time nodes with redundant engines.

 Registry Subt ree – 64-bit:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ArchestrA\Framework
 Registry Subt ree – 32-bit:
HKEY_LOCAL_MACHINE\SOFTWARE\ArchestrA\Framework

 Registry Key:
EngineFailoverStartup
Subkey entries used for enabling and tuning CPU load balancing are:

Default
Subkey Name Value Description

EnableCP UBalancing 0 Turns CP U load balancing on or off (0 = OFF, 1

= ON)

LoadObjectsNumberP erGroup 50 Specifies the number of objects loaded at a time

during startup. If set to 0, this function is
disabled.
LoadObjectsTimeToSleep 200 Specifies in milliseconds, the time between
loading groups of objects (end of load to start of
next load). If LoadObjectsNumberP erGroup is
0, sleep is disabled.

473
Application Server User Guide Working with Redundancy

Default
Subkey Name Value Description

FirstScanCycleNumberPerGroup 25 Specifies the number of objects to be initialized

during the first scan cycle after failover. If set to
0, this function is disabled.
FirstScanCycleTimeToSleep 100 Specifies in milliseconds, the time between
initializing groups of objects (end of first cycle to
start of second). If
FirstScanCycleNumberPerGroup is 0, sleep is
disabled.

Working with AppEngine Redundancy

You enable AppEngine redundancy in the Primary AppE ngine. You must also configure two
WinPlatforms for redundancy, one to host the Primary AppEngine and one t o host the Backup
AppEngine.

Important: WinPlatforms hosting redundancy-enabled AppEngines must be deploy ed to computers

running the same operating system.

The configuration of bot h WinPlatforms should be the same. At a minimum, the store-forward directory
configurations must be common to bot h WinPlatforms:
During configuration, you can assign Primary and Backup AppEngines to the same WinPlatform. To
deploy, you must assign the Primary and Backup AppEngines to different WinPlatforms.
Supervisory Network

Redundancy Message
Channel (RMC)
AppEngine A AppEngine A
(Backup)
Requires dedicated
NIC on each computer
WinPlatform 1 WinPlatform 2

Each production computer hosting a redundancy-enabled AppE ngine must have a minimum of two
network cards. One NIC is for the supervisory network and P LC network, if the computer has only two
network cards. The other must be for a dedicated Ethernet connect ion between computers for the
redundancy message channel (RMC).
For information about distributed networks, see Using Multiple Net work Interface Cards on page 465.
The RMC handles redundancy monitoring, message handling and data synchronization bet ween
redundant pairs.

Configuring the Redundancy Message Channel

For the redundant pair of AppE ngines to successfully communicate with each other, you must define the
correct order of network connections in the network services of each computer.
We recommend that you name each card with a clearly identifiable function (for example, "Supervisory
Net" and " Redundant Message Channel" ).
You must configure at least the following paramet ers:
 Redundancy Message Channel IP Address

474
Working with Redundancy Application Server User Guide

 Redundancy Message Channel Port

 Primary Message Channel
To configure network cards
1. Open the Network Connections dialog box in Windows. The specifics about opening this dialog box
varies, depending on the version of Windows you are working on.
2. Click Advanced Settings. If the computer name is used in the platform's "node name" box, the first
connection in the list must be the supervisory network card. Use the up and down arrows to define
the correct order.
3. Connections.
If a computer contains more than two net work cards, the supervisory net must be listed first and the
RMC connection can be listed in any other position. For example, your computer might have a
supervisory connection, a field device connection, and a RMC connection.
4. Configure the DNS settings for the supervisory network card to function properly.
 On the DNS page of the Advanced TCP/IP Settings dialog box, select the Register thi s
connection’ s addre sse s in DNS check box.
 For the RMC network card to function properly, clear the Regi ster thi s connection's
addresse s in DNS check box. For more details on these settings, see Using Multiple Net work
Interface Cards on page 465.
5. In Application Server, open the WinPlat form in the Object Editor f or the computer you just
configured.
6. Change the Redundancy Message Channel IP Address to the IP address of the RMC connection.
See the WinPlatform Help for more information about these parameters.
7. Save and close.

Configuring Redundancy
You configure redundancy in AppE ngine/WinPlatforms objects using their Object Editors.
The redundancy-related parameters in the AppEngine Object Editor are located on the Redundancy
and General tabs.
An AppEngine that is part of a redundancy pair has a deployment status indicating its own status and that
of its partner object. These statuses are visually indicated in the Application views.
You can set the status of a redundancy pair to one of the follo wing states:

Pair Deployed Both Primary and Backup AppEngines are deployed.

Pair Undeployed Both Primary and Backup AppEngines are undeployed.

Partial Deployed Either the Primary or Backup AppEngine is deployed and its partner is
not deployed. If an AppE ngine has a Partial Deployed status, its partner
has a Partial Undeployed status.

Partial Undeployed Either the Primary or Backup AppEngine is undeployed and its partner is
deployed. If an AppEngine has a Partial Undeployed status, its partner
has a Partial Deployed status.

475
Application Server User Guide Working with Redundancy

To create AppEngine redundancy

1. In the Primary AppE ngine, select the Enable Redundancy check box on the Redundancy tab.
2. Configure the remaining redundancy parameters as needed. See the help file for the AppEngine for
specific information about these parameters.
3. On the General tab, set the Engine Failure Timeout option to 2000 milliseconds. You may need to
tune this parameter bet ween 2000 ms and the default 10000 ms, depending on the requirements of
your application.
When the Active engine fails during a failover, it restarts automatically and becomes the Standby
engine.

Note: The actual engine failure time-out is three times the value of this parameter. If you set the
parameter to 2000 ms (2 seconds), a failover occurs if the AppEngine fails to communicate with the
computer’s Bootstrap for 6 seconds. A setting of 10000 ms (10 seconds) can be too long a wait period
(30 seconds) for a well-functioning redundancy operation.

After you save the configuration of the object and check it into the Galaxy, the icon for the object
changes. A Backup AppEngine is created with the same configuration as the Primary object.

Icon Object

Primary AppE ngine

Backup AppEngine

Configuring Redundancy in Templates

You can create a redundancy-enabled AppEngine template. When you create an instance of the
template, bot h the Primary and Backup instances are created.
The Backup AppE ngine is hosted by the Unassigned Host or the default WinPlatform if you s pecified one
in the Configure User Information dialog box.
If you change the configuration and check in the Primary AppE ngine, the Backup AppEngine:
 Is checked out in the background
 Updates the configuration
 Is checked in without notification to connected clients

Deleting Redundant AppEngines

You can disable redundancy in an AppE ngine after the ArchestrA infrastructure creates the Backup
object. If you disable redundancy and check in the Primary AppEngine, the Backup is deleted from the
Galaxy. The exception is when the Backup is already deployed. In that case the newly configured
Primary object cannot be checked in.
To delet e a Backup AppE ngine from the Galaxy, you must undeploy it first.
There is no redundancy-related configuration required on ApplicationObjects hosted by an AppE ngine
configured for redundancy. When a system failure occurs, the ApplicationObjects and their attribute
values are duplicated on the Standby AppEngine, which becomes the Active AppE ngine. For more about
failover functionality, see During Deployment on page 478.

476
Working with Redundancy Application Server User Guide

If the Plat form hosting the redundant AppEngine is shutdown in SMC, the AppEngine cannot be flagged
as "On failure mark as undeployed" when you undeploy the AppE ngine. You see an engine
communication error in the Deploy dialog box.

Deploying AppEngine Objects

Primary and Backup AppEngines can be deployed together or individually.
 When they are deployed together, regardless of which object is actually selected for deployment, the
Primary always becomes the Active and the Backup becomes the Standby.
 When they are deployed individually, the first one deployed becomes the Active.
Hosted ApplicationObjects are always deployed to the Active AppE ngine. When deploying the first of a
redundant pair of AppEngines, you can cascade deploy all objects it hosts. This operation can be paired
with deploying both the P rimary and Backup AppEngines at the same time.

Important: If you deploy the Backup AppE ngine first and then deploy hosted objects to that AppEngin e,
make sure the network communication to both target comput ers is good before deploying the Primary
AppEngine. Otherwise, errors occur.

In the run-time environment, either the Primary or Backup AppEngine can become the Active or Standby
depending upon failure conditions on either computer.

Configuration Requirements
Before deploying the Primary and Backup AppEngines, all c onfiguration requirements must be met.
 Each AppEngine must be assigned to a separate WinPlat form.
 A valid redundancy message channel (RMC) must be configured for each WinPlatform.
 To deploy the Primary and Backup together, select Include Redundant Partner in the Deploy
dialog box. This option is not available when doing the following operations:
o Cascade deploy from the Galaxy
o Multiple object selection deploy
o Deploying the WinPlatform that hosts the Primary or Backup AppEngine
The following table shows a matrix of allowed operations based on specific conditions.

Deploy Both
Primary and Cascade Deploy
Condition Backup Objects Allowed

Backup AppEngine's host WinPlatform configured Yes Yes

for failover and deployed
Backup AppEngine in error state Yes Yes
Backup AppEngine's host WinPlatform not No Yes
deployed
Backup AppEngine's host WinPlatform not Yes Yes
configured for failover and deployed
Deploy from Galaxy node No Yes

Deploy from WinPlatform hosting Primary No Yes

AppEngine

477
Application Server User Guide Working with Redundancy

Deploy Both
Primary and Cascade Deploy
Condition Backup Objects Allowed

Multiple object selection deploy No No

Backup AppEngine's host WinPlatform not No Yes
configured for failover and not deployed

Deploy from Backup AppEngine Yes Yes

Deploy from Primary AppEngine Yes Yes

Undeploying AppEngine Objects

Undeploying redundant pairs of AppEngines is just like undeploying any regular object.
You can undeploy the Active and Backup AppEngines separat ely or as a pair.

Important: Undeploying any objects, including redundant AppEngine pairs, does not uninstall c ode
modules for that object from the hosting computer. Code modules are uninstalled only when the
WinPlatform is undeployed.

To undeploy as a pair
1. Select one of the objects in an Application view.
2. On the Object menu, click Undeploy. The Undeploy dialog box appears.
3. Select Include Redundant Partner in the Undeploy dialog box and click OK.

During Deployment
During initial deployment of a redundant pair of AppEngines, files are deployed in the following order:
 Code modules and other files for the Primary AppEngine are deployed
 Those files for its assigned ApplicationObjects
 All of these files are deployed to the Standby AppE ngine by the Active engine’ s WinPlatform using
the redundancy message channel (RMC)

Note: If some or all of thes e files already exist on the Standby AppE ngine’s WinPlatform, perhaps,
assigned to another AppEngine on that plat form, only the delta files are deployed to the Standby
AppEngine.

Objects at Run Time

Objects are always assigned to the Primary AppEngine in the configuration environment.
During run time, objects are always deployed to the Active AppEngine whet her or not it was initially
configured as the Prim ary object.
All files are deployed by the Active AppEngine’s WinPlatform to the Backup AppEngine as described in
the previous section.

478
Working with Redundancy Application Server User Guide

During Run Time

In the run-time environment, the Active and Standby AppEngines first attempt to establis h
communication across the RMC. This occurs when an AppE ngine belonging to a redundant pair first
starts. Therefore, if one AppE ngine is relocated later to a different WinPlatform, this communication
between AppEngines can be reestablished.
During run time, the Active and Standby engines communicat e with each other and monitor each other's
status.
In the case of a hardware or software failure on the Active computer, the Standby AppE ngine becomes
the Active one. To move the new Standby AppE ngine from its hosting computer, undeploy this
AppEngine by selecting the On failure mark as undeployed option on the Undeploy dialog box.
Reassign and redeploy it to a WinPlatform that is configured for redundancy on another computer.

AppEngine Redundancy States

Redundant pairs of AppEngines can have one of the following states at a time:
 Acti ve: The state of an A ppEngine when it has communication with its partner object, its partner is in
Standby-Not Ready, Standby-Sync’ing with Active, or Standby-Ready state. A Standby AppEngine
transitions into this state when a failover c ondition is detected. In this state, an AppEngine schedules
and runs deployed objects, sends checkpoint data and sends subscriber list updates to the Standby
AppEngine.
 Acti ve - Standby not Available: The state of an Active AppEngine when it determines it cannot
achieve communications with its partner object. This could mean that checkpoint, subscription and
alarm state changes are not successfully transmitted to the Standby object because the partner
AppEngine is not deployed, number of heartbeats missed from standby objects exc eeds the
configured max consecutive number of heartbeats missed, or notification is received that the
Standby AppE ngine shutdown or is not running. If an AppEngine is in this state, it 1) continues
normal execution of hosted objects, 2) cannot be manually switched to Standby state, and 3) while
continuing to attempt communicate with the Standby, does not attempt to send data to the Standby
object.
 Determining Failover Status: The initial state of a redundancy-enabled AppEngine when it is first
started. It has not determined yet whether it is the Active or Standby AppEngine. Communication
between the two AppEngines is attempted first over the RMC and then over the primary network to
make this determination. If communication cannot be made after a certain time-out period, an
AppEngine assumes the Active role if it has all of the code modules and c heckpoint file data t o do so.
Continued attempts are made at communicating with its part ner.
 Standby - Mi ssed Heartbeats: The state of an AppE ngine when 1) the heartbeat pings are not
received from its Active partner through the RMC, but the number of missed beats haven't reached
the maximum consecutive number of heart beats missed, or 2) the heartbeats from active engine
have been missed through the primary channel. When in this state, the Standby object attempts to
determine whet her or not the Active object failed. If a manual failover is started by using the
ForceFailoverCmd attribut e, it is processed only if the heartbeats were missed over the primary
network and not missed over the RMC.
 Standby - Not Ready: The state of an AppE ngine when one of several conditions occurs: 1) its lost
communications with its partner object or it maintains communications with its part ner but missed
checkpoint updates or alarm state changes from the Active AppEngine, 2) new objects are deployed
to the Active AppEngine and necessary files are not installed on the Standby AppEngine yet, or 3)
the Standby AppE ngine lost communications over the RMC before it completed synchronizing data.
Typically, the AppE ngine’s part ner is in one of the following states: Active-Standby not A vailable, or
Active.

479
Application Server User Guide Working with Redundancy

 Standby - Ready: The state of an AppE ngine when it completed synchronizing code modules and
checkpoint data with the Active AppEngine. In this state, the AppEngine monitors for Active
AppEngine failure by verifying heartbeat pings received from the Active engine and checks that all
files required for execution are in sync with the Active engine. It receives the following from the Active
AppEngine: checkpoint change dat a, subscription -related notifications, alarm state changes, and
history blocks.
 Standby - Sync'ng with Acti ve: The state of an AppEngine when it is synchronizing code modules
with the Active object. If code modules exist on the Standby computer that do not exist on the Active
node, they are uninstalled, and likewise, any code modules that exist on the Active node but not on
the Standby node are installed. After all code modules are synchronized, the AppE ngine transitions
to Standby-Sync’d Code state.
 Standby - Syncing Code: The state of a Standby AppEngine that successfully synchronized all
code modules with the Active object.
 Standby - Syncing Data: The state of a Standby AppEngine when all object-relat ed data, including
checkpoint and subscriber information, are synchronized with the Active object. An object in this
state typically transitions to Standby -Ready state.
 Switching to Acti ve: A transitional state when a Standby AppEngine is commanded to become
Active.
 Switching to Standby: A transitional state when an Active AppE ngine is commanded to become
Standby. When the active engine is switched to standby, the engine will be restarted. This transition
state can be switched off by the user changing the attribut e of the engine.
 Failed: The state of a redundant partner when its process crashes or is terminated by the user. The
AppEngine process can be restarted using System Management Console/PlatformManager.
 Unknown: The state of a redundant partner when a communication loss occurs between
AppEngines or when the partner AppEngine is stopped, shutdown, or undeployed.
For examples on redundant configuration, see the AVEVA Soft ware Global Customer Support website.

Troubleshooting
Most troubleshooting happens in the System Management Console. For more information about using
the System Management Cons ole, see the System Management Console User’s Guide.
Cert ain requirements are validated by the system infrastructure. For example, the order in which you
configure an object pair for redundancy is validated.
The following problems can occur when you are using redundancy:
 You can configure an AppEngine for redundancy before configuring its associated WinPlatform. If
you do this, you see an error message that the Platform (specifically, the RMC) is not configured yet.
 If the RMC IP Addre ss parameter is not configured in both hosting WinPlatforms, then the
configuration state of bot h Primary and Backup AppEngines changes to Error. You also see a
message indicating that the host WinPlatform is not configured with the network adapter required for
redundant communications. When the RMC IP Address is configured and the WinPlat forms are
checked in, the hosted A ppEngines are automatically revalidated and the Error state is resolved. If
hosted AppE ngines are checked out, they are not revalidated.
 If both Primary and Backup AppE ngines are assigned to the s ame WinPlat form and you try to deploy
both engines, both the Primary and Backup fail to deploy. You see a message that the Primary and
Backup objects must be hosted by different WinPlatforms. Reassign the Backup object to another
WinPlatform and deploy it separat ely.
 If both the Network Addre ss and RMC IP Addre ss parameters in the WinPlatform’s editor refer to
the same net work card, you get a warning message when you save the configuration. These
parameters must refer to different net work cards.

480
Working with Redundancy Application Server User Guide

 Before restarting a comput er that hosts one of a redundant pair of AppEngines (either the Active or
Backup), ensure that the Primary Network is connected. A restart while the Primary Network is
disconnected makes the Primary Net work bind to the RMC’s IP address. An incorrect redund ancy
state occurs, indicating that redundancy functionality is good. Any time you restart a
redundancy-enabled comput er, check for proper net work connections afterwards. For more
information, see Using Multiple Net work Interface Cards on page 465.
 When scripting is used to activate attributes, attributes displayed in the watch window may appear to
remain in an initializing state after deployment or engine failover. This happens because the script is
capturing the attributes while they are still initializing on one of the redundant engines, before the
engines are able to synchronize. The attributes will move to active state, but unless there is retry
logic in the script, that information will not be returned. This situation can be avoided by ensuring that
your scripts contain ret ry logic to capture the updated state of the attributes.

Generating Alarms
When failover conditions occur, the ArchestrA system reports alarms to subscribed alarm cl ients like
InTouch.
These alarms contain the following information:
 The name of the AppEngine reporting the alarm.
 The node name of the AppEngine reporting the alarm.
 The state of the AppEngine.
 The node name of the AppEngine’s partner object.
Depending on what caused the failover, the Standby AppE ngine can become the Active AppEngine in an
Off scan state and alarms might not be generated.
If the Active AppEngine is shutdown off scan, the checkpointer can trans fer that state to the Standby.
When the Standby becomes the Active, it starts off scan. When the AppEngine is put on scan, alarms
then are generated.
Reported alarms include the following:

Previous Alarm Raised Alarm Cleared Alarm Reported

Alarm State Current State When When By

Standby Active Standby Not Standby Not Entering Standby Active Engine
Not Ready Ready Ready Ready
*

Standby Active Active Active Entering Active Active Engine

Not Standby Not Standby Not
A vailable A vailable A vailable

Failover Standby During the next Active Engine

Occurred becomes scan of the Active
Active engine

* The Active AppEngine monitors the status of the Standby through the RMC to determine w hen to raise this
alarm. Also, if the Active AppEngine is in Active-Standby not Available state, this alarm is not generated.

481
Application Server User Guide Working with Redundancy

When a failover occurs, the Standby AppE ngine that becomes active carries alarms outstanding from the
old Active AppE ngine. The state of those old alarms, though, will change to reflect the new partner's
status.
Timestamps are preserved for alarms, including when:
 The alarm was acknowledged
 The alarm condition went true
 The alarm condition went false
Finally, the following information is preserved for alarms:
 An alarm was acknowledged
 The message input by the operator when the alarm was acknowledged
All alarm state information is collected and sent to the Standby AppEngine at the end of a scan cycle and
before being sent to alarm clients.
The sequenc e of reporting alarms ensures that alarm clients do not report alarms in states that are
different from those reported by the Standby AppE ngine if the Active AppEngine fails.

Generating History
All active objects (AppEngine and hosted objects) report history data as they normally do in the run -time
environment.
Historical dat a is reported to the historian only from the Active AppEngine.
Losing connectivity with the historian does not cause a failover. The Active AppE ngine goes into
store-forward mode and caches data every 30 seconds. Store-forward data is synchronized with the
Standby AppE ngine.
When failover conditions occur, no more than 30 seconds of history data is lost in the transition from
Standby to Active status. For more information, see the AVEVA Soft ware Global Customer Support
website.

Working with Data Acquisition Redundancy

The Redundant DIObject monitors and controls the redundant DIObject data sources at the object level.
Unlike redundant AppEngines, individual DIObject data sourc es do not have redundancy -related states.
For all practical purposes, they function as standalon e objects.
Only one DIObject data source provides field device data through the RedundantDIObject at a time. Both
data sources must have commonly -configured DAGroups. These must be reflected in and channeled
through the Redundant DIObject, which monitors the t wo DIObject data sources. It also determines which
one is Active at any given time. Both data sources must also have the same item address space.
After deployment or engine failover, attributes may appear to remain in an initializing state when scripting
is used to activate the attributes. The script may capture the attributes while still initializing, before the
engines are able to synchronize with each other. When synchronization occurs, the attributes will move
to active state, but unless there is retry logic in the script, that information may not be returned. This
situation can be avoided by ensuring that your scripts contain retry logic to capture the updated state of
the attributes.

Configuring Data Acquisition Redundancy

Data acquisition redundancy objects involve t wo DIObjects and the RedundantDIObject. In dat a
acquisition redundancy, you must configure all three components:
 Primary DIObject data source

482
Working with Redundancy Application Server User Guide

 Backup DIObject data sourc e

 Redundant DIObject dat a source
Because data acquisition redundant components are essentially standalone objects, all valid operations
that apply to any other ApplicationObjects apply to the three objects.
All IDE commands, Galaxy Dump and Load functions, and import and export operations are valid on the
two DIObject data sources and the RedundantDIObject.
See the online help associated with each DIObject for help in configuring its Object Editor. Also see the
help associated with the RedundantDIObject.
Before you can deploy the Redundant DIObject, you must configure at least one scan group. Also,
configure only scan, block read, and block write groups shared by the Primary and Backup DIObjects in
the RedundantDIObject.
To configure the Redundant DIObject
1. On the General tab of the Object Editor, set the Primary DI Source and Backup DI Source.
2. Set up the common scan groups.
3. Set up the common block read and block write groups on the tabs of the Object Editor.

Deploying Redundant DIObjects

Deployment for data acquisition redundancy is the same as individually deploying unrelated objects. No
special conditions apply to each DIObject data source and the RedundantDIObject.
See Deploying and Running an Application on page 253 for more information about deploying objects.

What Happens in Run Time

The three objects in the data acquisition redundancy scheme (Redundant DI Object and its two DIObject
data sources) work like any other ArchestrA object when deploying, alarming, and historizing. They have
no special redundancy-related states or restrictions.
During run time, the Redundant DIObject monitors the status of the DIObject data sourc es, and handles
the switching from Active to Standby object if failure conditions occur.

RedundantDIObject and PLC Connectivity

For the RedundantDIObject, you can use the scan group PingItem attribute to monitor the connecti on
status of the PLC at run time. If you are using the redundancy feature of the RedundantDIObject to
communicate with DIObjects, you should configure the PingItem attribute for each scan group.

483
 Application Server User Guide

A PPENDIX A
Glossary
application
A collection of objects in a Galaxy Repository that performs automation tasks. Synonymous with
Galaxy. There can be one or more applications within a Galaxy Repository.
Application Engine (AppEngine)
A scan-based engine that hosts and executes the run -time logic contained within
AutomationObjects.
ApplicationObject
An AutomationObject that represents some element of your production environment. This can
include things like
o An automation process component. For example, a thermocouple, pump, motor, valve, reactor,
or tank
o An associated application component. For example, function block, PID loop, Sequenti al
Function Chart, Ladder Logic program, batch phas e, or SPC dat a sheet
Application Server
The supervisory control plat form. Application Server uses existing Wonderware products such as
InTouch for visualization, the Wonderware Historian for data storage, and the device Integration
product line like an Operations Integration Server (OI Server) for device communications.
An Application Server can be distributed ac ross multiple computers as part of a singl e Galaxy
namespace.
Application view
The Applications view shows the object-related contents of the Galaxy in four different ways: Model
view, Deployment view, Derivation view, and Operations view. The Model view appears when the
IDE is opened for the first time.
Arche strA
The distributed architecture for supervisory control and manufacturing information systems. It is an
open and extensible technology based on a distributed, object-based design.
Arche strA Object Toolkit
A programmer’s tool to create new ApplicationObjects and Devic e Integration Object (DIObjects)
templates, including configuration and run-time implementations. Includes a tool to build DI Objects
and create unique Domain Objects that interact with DIObjects in the ArchestrA environment.
Arche strA S ymbol
A graphic you create and us e to visualize data in an InTouch HMI system. You use the ArchestrA
Graphic Editor to create ArchestrA Symbols from basic elements, such as rectangles, lines, and text
elements.
area
A logical grouping of AutomationObjects that represents an area or unit of a plant. It is used to group
related objects for alarm, history, and security purposes. It is represented by an area
AutomationObject.
area object
The system object that represents an area of your plant within a Galaxy. The Area Object acts as an
alarm concentrator, and places other Automation Objects into proper context with respect to the
actual physical automation layout.

485
Application Server User Guide Glossary

assignment
The designation of a host for an AutomationObject. For example, an AppEngine object is assigned to
a WinPlatform object.
attribute
An externally accessible data item of an AutomationObject.
attribute reference string
A text string that references an attribut e of an AutomationObject.
AutomationObject
An object type that represents permanent things in your plant, such as ApplicationObject or Device
Integration Object (DIObjects), with user-defined, unique names within the Galaxy. It provides a
standard way to create, name, download, execute, and monitor the represented component.
Backup Application Engine
The object created by the ArchestrA infrastructure when the Primary object is enabled for
redundancy. See redundancy for further details.
base template
A root template at the top of a derived hierarchy. Unlike ot her templates, a base template is not
derived from another template but developed with the ApplicationObject Toolkit and imported into a
Galaxy. All base templates names start with a dollar sign ($).
Block Read Group
A DAGroup that is triggered by the user or another object. It reads a block of data from the external
data source and indicates the completion status.
Block Write Group
A DAGroup that is triggered by the user or another object after all the required data items are set.
The block of data is sent to the external dat a device. When the block write is complete, it indicates
the completion status.
Bootstrap
The base ArchestrA service which is required on all ArchestrA computers. It provides the base
software environment to enable a platform and allows a computer to be included in the Galaxy
Namespace.
Buffered Data
Data capt ured and stored locally on a remote device for later transfer to a supervisory system for
processing, analysis, and long-term storage. Can be configured within the I/O feature in the
Attributes page.
change log
The revision history that tracks the life cycle activities of ArchestrA Objects, such as object creation,
check in/check out, deployment, and import/export.
change propagation
The ability to create templates whic h allows each component templat e to support changes such that
a change in one of the elements can be automatically propagated to all — or select, related — object
instances.
check in
IDE operation for making a configure d object available for other users to check out and use.
check out
IDE operation for the purpose of editing an object. It makes the item unavailable for other users to
check out.
Checkpoint
The act of saving to disk the configuration, state, and all associated data necessary to support
automatic restart of a running AutomationObject. The restart ed object has the same configuration,
state, and associated data as the last checkpoint image on disk.

486
Glossary Application Server User Guide

compound object
An ApplicationObject that contains at least one other ApplicationObject.
contained name
An alternate naming convention that when combined with the TagName of the root container object,
results in the hierarc hical name. For example, for a given object, its Hierarchical Name =
Line1.Tank1.InletValve and its Contained Name= InletValve.
containment
A hierarchical grouping that allows one or more AutomationObject to exist within the name spac e of
a parent object and be treat ed like parts of the parent object. Allows for relative referencing to be
defined at the template and instance level.
DAGroup
A data access group associated wit h Device Integration Object (DIObjects). It defines how
communications are achieved with external data sources. It can be a Scan Group, Block Read Group
or Block Write Group.
DAServer Manager (DAS Manager)
The System Management Console (SMC) snap-in supplied by the Operations Integration Server (OI
Server) that provides the required interfac e for activation, configuration, and diagnosis of the OI
Server.
Data Acce ss Server (DAServer)
See Operations Integration Server (OI Server).
Data Acce ss Server Toolkit (DAS Tool kit)
A developer tool that can build an Operations Integration Server (OI Server).
Deployment
The operation which instantiates an AutomationObject instance in the ArchestrA run time. This
action involves installing all t he necessary software and instantiating the object on the target platform
with the object’s default attribut e data from Galaxy Repository.
Deployment view
The part of the Application view in the IDE that shows how objects are phy sically dispersed across
Platforms, areas and Engines. This is a view of how the application is spread across computing
resources.
derivation
The creation of a new template based on an existing Templat e.
Derivation view
The part of the Application view in the IDE that shows the parent-child relationship between base
templates, derived templates and derived instances. A view into the genealogy of the application.
derived template
Any template with a parent template. Derived templates inherit the attribut es of the parent template.
You can changes these attributes in the derived template.
Device Integration Object (DIObjects)
An AutomationObject that represents the communication with external devices or software.
DIObjects run on an Application Engine (AppEngine), and include DINet work Objects and DIDevice
Objects.
DHCP
Dynamic Host Configuration Protocol. A network configuration protocol for hosts on IP networks.
DIDevice Object
An object that repres ents the actual external device (for example, a PL C or RTU) that is associated
with a DINetwork Object. It can diagnose and browse data registers of the DAGroups for that device.

487
Application Server User Guide Glossary

DINetwork Object
An object that repres ents the network interface port to the device through the Data Access Server
(DAServer) or the object that represents the communications path to another software application. It
provides diagnostics and configuration for that specific network card.
element
Basic shapes, such as rectangles, lines, and text elements, and cont rols y ou can use to create an
ArchestrA Symbol to your specifications.
Element Style
An Element Style defines one or more visual fill, line, text, blink, outline, and status properties of
ArchestrA graphic elements. You can apply an Element Style to set preconfigured values to the
visual properties of a graphic element.
Engine Object
An ArchestrA system-enabled object that contains Local Message Exchange and provides a host for
ApplicationObjects, Device Integration Object (DIObjects) and area objects.
event record
The data that is transferred about the system and logged when a defined event changes state. For
example, an analog crosses its high level limit, an acknowledgement is made, or an operator logs in
to the system.
export
The act of generating a package file (.aaPKG) extension from persisted data in t he Galaxy database.
You can import the resulting .aaPK G file into anot her Galaxy.
FactorySuite Gateway
A Microsoft Windows applic ation program that acts as a communications protocol convert er. Built
with the ArchestrA DAS Toolkit, FS Gateway links clients and data sources that communicate using
different data access protocols.
Galaxy
The entire application. The complete ArchestrA system consisting of a single logical name space
(defined by the Galaxy database) and a collection of plat form objects, Engine Objects and other
objects. One or more net worked computers that constitute an automation system. This is referred to
as the Galaxy Namespace.
Galaxy database
The relational database containing all persistent configuration information like templates, instances,
and security in a Galaxy Repository.
Galaxy Database Manager
A utility to manage your Galaxy. It can back up and restore Galaxies if they become corrupt or to
reproduce a Galaxy on another computer. The Galaxy Database Manager is part of the System
Management Console (SMC).
GalaxyObject
The object that represents a Galaxy.
Galaxy Repository
The soft ware sub-system consisting of one or more Galaxy databases.
Graphic Toolbox
The part of the IDE main window that shows a hierarchy of graphic toolsets, which contain ArchestrA
Symbols and client controls.
hierarchical name
The name of the object in the context of its container object. For example, Tank1.OutletValve, where
an object called Tank1 contains the OutletValve object.

488
Glossary Application Server User Guide

Hi storical Storage System (Hi storian)

The time series data storage system that compresses and stores high volumes of time series data for
later retrieval. The standard historian is the Wonderware Historian.
host
The parent of a child instance in the deployment view. Example: a Platform instance is a Host for an
Application Engine (AppE ngine) instance.
import
The act of reading a package file (.aaPKG) and using it to create Aut omationObject instances and
templates in the Galaxy Repository.
instance
An object derived from a template. You deploy instances to the run-time environment.
instantiation
The creation of a new instance based on a corres ponding templat e.
Integrated Development Environment (I DE)
The Integrated Development Environment (IDE) is the interface for the configuration side of
Application Server. In the IDE, you manage templates, create instances, deploy and un -deploy
objects, and other functions associated with the development and maintenance of the system.
InTouch View
InTouch View clients are InTouch run -time clients that solely use of the Application Server for its data
source. In addition, standard InTouch run times can also leverage Application Server.
InTouchViewApp object
Represents an InTouch application in the A pplication Server environment. The InTouchViewApp
object manages the check-in, check-out, and deployment of an InTouch application.
I/O count
Number of I/O points being accessed within a Galaxy. I/O points are real I/ O and are not equivalent
to InTouch tags. I/O count is based on the number of I/O points that are configured through an OPC
Server, I/O S erver, Data Access Server (DAServer) or InTouch Proxy Object, over the whole
Application Server namespace, regardless of how many computers are in the system.
Message Exchange
The object to object communications prot ocol used by Application Server. Message Exchange
includes
LMX communication bet ween objects
NMX communication bet ween Galaxy nodes.

Model view
The area in the Application view in the IDE that shows how objects are arranged to describe the
physical layout of the plant and supervisory process being controlled.
object
Any template or instance in a Galaxy database. A common characteristic of all objects is they are
stored as separate components in the Galaxy Repository.
Object Viewer
A utility in which y ou can view the attribut e values of the s elected object in run time. This utility is only
available when an object is deployed. Object Viewer shows you diagnostic information on
ApplicationObjects so you can see performanc e paramet ers, resource consum ption and reliability
measurements. In addition to viewing an object’s data value, data quality and the communication
status of the object, you can also modify some of its attributes for diagnostic testing. Modifications
can include adjusting timing parameters and setting objects in an execution or idle mode.

489
Application Server User Guide Glossary

OffS can
The state of an object that indicat es it is idle and not ready to execut e its normal run -time proc essing.
Operations Integration Server (OI Server)
The server executable that handles all communications between field devices of a certain type and
client applications. Similar to I/O Servers but with more advanced capabilities. Also called a
DAServer.
OnScan
The state of an object in which it is performing its normal run-time processing based on a configured
schedule.
Operations view
The area in the IDE that shows the results of validating the configuration of objects.
package definition file (.aaPDF)
The standard description file that cont ains the configuration dat a and implementation code for a base
template. File extension is .aaPDF.
package file (.aaPKG)
The standard description file that contains the configuration data and implementation code for one or
more objects or templates. File extension is .aaPKG.
Platform Count
Number of computers in the Galaxy. Each Workstation or Server communicating directly with the
Application Server requires a platform to be part of the Galaxy Namespace. This includes each
InTouch and InTouch View client.
Platform Manager
This utility is an extension snap-in to the ArchestrA System Management Console (SMC).Provides
Galaxy application diagnostics by allowing you to view the run-time status of some system objects
and to perform actions upon those objects. Actions include setting platforms and engines in an
executable or idle mode and starting and stopping platforms and engines.
platform object
An object that repres ents a single computer in a Galaxy, consisting of a system wide message
exchange component and a set of basic services. This object hosts all Application Engines.
Primary Application Engine
The object created by the ArchestrA infrastructure when the Backup object is created through
redundancy. See redundancy for further details.
properties
Data common to all attributes of objects, such as name, value, quality, and data type.
proxy object
An AutomationObject that represents an actual product for the purpose of device integration wit h the
Application Server or InTouch HMI. For ex ample, a Proxy object enables the Application Server to
access an OPC server.
redundancy
Two computers: One executes objects. The ot her is a stand by.
RedundantDIObject
Monitors and controls the redundant Device Integration Object (DIObjects) data sources. Unlike
redundant AppEngines, individual DIObject data sources do not have redundancy -related states.
They function as stand-alone objects.
Redundant Message Channel
A dedicated Ethernet connection which is required bet ween the platforms hosting redundant
engines. The RMC is vital to keep both engines synchronized with alarms, history, and checkpoint
items from the engine that is in the Active Role. Each engine also uses this Message Channel to
provide its health and status information to the other.

490
Glossary Application Server User Guide

reference
A string that refers to an object or to data within one of its attributes.
relative reference
Objects may refer to thems elves, containers, hosts or to child objects elsewhere in the parent/child
hierarchy using special reserved keywords such as "Me" or "MyContainer". Relative references
continue to work properly ven if the object that is referenc ed is renamed. Examples of relative
references are "Me", "MyArea", "MyContainer", "MyHost", and "MyPlatform".
remote reference
The ability to redirect ArchestrA object references or references to remote InTouch tags. The new
script function that redirects remote references at run time is IOSet RemoteReferences.
SCADA
Supervisory Control and Data Acquisition (S CADA ) is a centralized industrial control system that
controls and monitors sites or systems which are spread over large areas - an entire industrial plant
or a country.
Scan Group
A DAGroup that requires only the update interval be defined. The data is retrieved at the requested
rate.
Scan State
The Scan State of an object in run time. This can be either OffScan or OnScan.
security
Application Server security is applied to IDE, System Management Console (SMC), and the run-time
data level. At the run-time data level which centralizes the definition of all permissions to the
ApplicationObjects. These ApplicationObjects can be accessed by a variety of clients but the
security is centrally defined, allowing ease of maintenance. Users that are allowed to modify these
ApplicationObjects at run time are mapped to the objects by user-defined roles. These roles can be
mapped directly to existing groups in a Microsoft Domain or workgroup.
System Management Console (SMC)
The central run-time system administration/management product where you perform all required
run-time administration functions.
system object
An object that repres ents an area, plat form or engine.
TagName
The unique name given to an object. For example, for a given object, its TagName = V1101 and its
HierarchicalName = Line1. Tank1.InletValve.
template
An object containing configuration information and soft ware templates us ed to create a derived
template or instance.
Template Toolbox
The part of the IDE main window that shows Toolsets containing templat es. The Template Toolbox
shows a tree view of template categories in the Galaxy.
Tool set
A named collection of templates shown together in the IDE Templat e Toolbox.
ViewEngine object
Hosts InTouchViewApp objects. The ViewEngine object supports common engine features such as
deployment, undeployment, startup, and shutdown.
WinPlatform object
An object that repres ents a single computer in a Galaxy. A WinPlatform object consists of a
system-wide message exchange component and a set of basic ArchestrA services. The WinPlatform
object hosts the Application Engine (AppEngine).

491
Application Server User Guide Glossary

492
 Application Server User Guide

Index
severity • 328
. statistical type • 300
.csv files
subscribing • 318
characters in • 461 aliases
editing • 459 rules for locking in scripts • 156
importing • 462 using in scripts • 154
structure • 460 analog device objects, output extensions • 128
time formats • 461 AppEngine objects
description • 45

A history configuration • 285

aaAdministrators group • 419 redundancy • 474
aaConfig SQL utility • 419 applications
aaGalaxyOwner user account • 419 ArchestrA architecture, ArchestrA • 383
active object • 472
templates • 45
active object, redundancy • 472 ArchestrA
adding custom help to objects • 76
messaging system • 383
Advanced Communication Management
ArchestrA user account • 419
configuring scan modes • 260 Area object, description • 45
description • 258 Attribute naming conventions • 118
saving historical dat a • 282 attributes
setting for Galaxy • 260 adding to objects • 115
Alarm Comment Language S witching • 434 and scripting • 119
Alarm Comments Language File • 448
dynamic • 390
Alarm configuration • 327
hardware register • 390
alarms
hidden • 118
aggregating • 329
historizing • 278
AlarmInhibit attribute • 300
locking in child objects • 115
AlarmMode attribute • 300
locking in instances • 65
Area AutomationObjects • 317
locking in templates • 65
definition • 293
locking locking attributes • 65
disabled • 302
property, finding • 83
extensions • 133, 134, 135, 137, 138
runtime • 390
grouping • 317
search • 69
plant state • 322
security • 68
setting categories • 316

493
Application Server User Guide Index

security locked in parent • 68 contained objects

unlocking in instances • 65 naming conventions • 59, 62

unlocking in templates • 65 viewing • 62

Attributes page • 120 containment
auto-bound referenc e • 140 definition • 54
names, scripting • 55
B naming conventions • 59, 62
backup object relationships, viewing • 29, 59
description • 471 templates • 54
redundancy • 471 creating
backup server, redundancy • 471 contained templates • 54
base templates Galaxy, security restrictions • 18
creating derived templ ates • 43 object extensions • 120
description • 42 scripts • 154
importing • 101 creating user accounts • 464
modifying • 27 customizing
bit field access • 85 derived templat es • 52
Boolean information for a Galaxy • 37
alarm extensions • 133, 134, 135, 137, 138 object help • 76
data types • 128
Buffered Data and History • 376
D
data
C types and bit field access • 85
changing, users • 39 data types, configure history • 278
check-in comments, setting • 37 default, templates • 42, 43
components in Galaxies • 17 deploy host objects first • 267
configure user information • 37 deploying
Configuring
history • 282
history • 278
imported objects • 112
objects to store history • 290
instances • 41
WinPlatforms and AppEngines for history •
templates • 41
285
deployment
configuring bit field access • 85
configuring computers for redundancy • 471 redundancy • 483
configuring redundancy deployment status

AppEngine • 475 pair undeploy ed • 475

ordering net work connections • 474 partial deployed • 475

connecting partial undeployed • 475
existing Galaxy • 21 redundancy objects • 482
contained Deployment view
names • 54, 59, 96 assignment relationships • 31
templates, creating new • 53 Derivation view

494
Index Application Server User Guide

parental relationships • 32 script function libraries • 100

derivation, viewing objects • 32 script libraries • 459
derived locked scripts • 156
scripts • 98
derived templat es • 43, 46
exporting templates • 459
contained names • 59 extension inherit ance • 120
creating • 52 extensions, deleting • 120
customizing • 52
nesting • 53 F
Deviation Alarms Feature Parameters • 135 failover and redundancy • 471
devic e integration templates • 45 field referenc e object • 128
DIDevice objects, definition • 45 finding
DINet work objects
object attribut es • 83
configuration limits • 31 floating
definition • 45 areas • 35
deploying • 267 views • 35
DIObject data sources • 482 fonts, languages • 436
disabled alarms • 304
disabling
G
redundancy • 476
Galaxies
disk space requirements • 463
DNS settings, configuring • 466 adding a language • 434
Domain local groups (DLGs) • 430 changing • 457
dynamic attribut es • 390 changing the default language • 437
components of • 17
E default users • 410
editing .cs v files • 460 definition • 17
editing .cs v files, characters in • 461
deploying components • 17
enabled alarms • 302, 304
disk space requirements • 463
event
Galaxy Repository • 17
Configuration • 327
distributors • 317 language settings • 433, 434
events location on the net work • 17

definition • 293 logging in to • 38

types • 293 managing multiple • 457
E vents, turn on/off historization • 327 naming conventions • 18
execution order of objects, setting • 75 opening with security • 21
expanding tabs • 36
removing a language • 435
exporting
reserved names • 18
Galaxy dump file • 459
restoring • 455
instances • 98, 459
specifying GR node name • 18
object help • 459
validating • 95
objects • 98, 459
Galaxy Browser • 83

495
Application Server User Guide Index

Galaxy Dump File, editing • 460

Galaxy dump files
I
characters • 461
I/O Advanced Property • 121
importing • 462 I/O Auto Assignment
time formats • 461 Upload Runtime Changes • 149
group I/O auto-binding • 140
lock icons • 69 icons, deployment status • 267
IDE objects in runtime • 254
IDE, views • 22
H importing
hardware register attributes • 390
.csv files • 462
HCA L
base templates • 101
historizing data • 278
objects • 101
using • 278
heartbeats • 463 objects and deploying • 112
hidden attributes, Attributes objects and security groups • 112
hidden attributes • 118 script function libraries • 105
hiding individual alarms • 301
areas • 36 inheriting attributes, parent and child
relationships • 41
views • 36
Input extensions, dat a quality • 129
hierarchical
InputOut put
names • 54, 59, 96
attributes in scripts • 126
names, viewing • 29
extension • 124
Historization
InputOut put extensions, data quality • 129
alarm • 327 installing Wonderware Historian • 277
configuration • 327 instances
E vent • 327 creating • 95
E vents, turn on/off • 327 defined • 42
historized data
deploying • 41
store forward • 282
exporting • 98, 459
when dat a is stored • 282 locking attributes • 65
historizing
naming conventions • 95
attributes • 278
on other computers • 31
data, installing Wonderware Historian • 277
reserved names • 96
history
unlocking attributes • 65
deploying • 282
IP address, network settings • 466
undeploying • 282
History Feature Attribut es • 130
history, data types, configuring • 278 L
HTML editors for customizing object help • 76 Language Features • 433
languages
changing default for a Galaxy • 437

496
Index Application Server User Guide

configuring for a Galaxy • 433, 434 scripts • 154

configuring for Galaxy • 434 templates • 52
dictionary files • 438 toolsets • 50
exporting dat a for all symbols • 438 nesting templates • 42, 54
network
exporting dat a for specific objects • 439
configuring DNS settings • 466
exporting for managed InTouch application
• 440 configuring IP address • 466
network cards
fonts • 436
redundancy • 474
removing from a Galaxy • 435
setting • 465
translating symbol text • 438
Limit Alarm Parameters • 133 specifying the order • 465
limit alarms • 297 Network drives, mapping • 464
locked scripts in child objects • 156
locking O
aliases in scripts • 156 object
attributes • 115 derivation, viewing • 32
scripts • 156 properties, viewing • 47
template attributes • 65 relationships, viewing • 29
logging object attribut es, finding • 83
in to disconnected networks • 429 Object Editor
in to Galaxies • 38 getting help • 64
in to Galaxies, security enabled • 38 opening • 63
object help

M adding images • 76

managed InTouc h applic ation, exporting exporting • 459

language dat a • 440 HTML editors for customizing • 76
manually Object Information page • 75
initializing scripts • 119 objects

validating objects • 95 checking in • 93

Message Exchange and attributes • 383 checking out • 93
moving deleting • 97
objects, undeploying • 29 exporting • 98, 459
views • 35 exporting language data • 439
multiple Galaxies • 457
importing • 101
in runtime • 254
N inheriting extensions • 120
naming conventions
opening Object Editor • 63
Attributes • 118
specific information • 128
containment • 59, 62
undeploying • 272
Galaxies • 18
validating manually • 95
instances • 95

497
Application Server User Guide Index

Operations view, opening • 34 resetting

ordering net work cards • 465 the workspace • 36
Output restoring Galaxies • 455
functionality • 128 return views to the default locations • 36
Output extensions, data quality • 129 reusing existing objects • 101
ROC Alarms Feature Parameters • 134
rules for locking
P
aliases in scripts • 156
parent and child, relationships, viewing • 32
passwords, changing • 38 scripts • 156
Primary AppE ngine, viewing attributes • 85 runtime
primary object, redundancy • 471 and bit field access • 85
primary server, redundancy • 471 attributes • 390
propagating changes, templates • 43
how objects deploy from the IDE • 254
published InTouch application, exporting
runtime environment, scripting • 153
language dat a • 441

R S
script function libraries
rate of change alarms • 299
reassigning objects, undeploying • 29 exporting • 100
recreating ArchestrA user account • 464 importing • 105
redundancy script libraries, exporting • 459
alarm generation • 481 scripting

ApplicationObjects configuration • 476 Attributes • 119

configuring templates • 476 containment names • 55

scripts
during deployment • 478
aliases, using • 154
history generation • 482
automatically starting • 119
pair • 471
execution types • 154
runtime • 472
exporting • 98
setting network cards • 474
Redundancy, page • 475 initializing Startup scripts • 119
redundant engines, undeploying • 478 InputOut put attribut es • 126
RedundantDIObject • 471 locked in child objects • 156
reference
locking rules • 156
auto-bound • 140
manually initializing • 119
references in scripts, validating • 94
naming conventions • 154
relationships, viewing parent/child • 32
renaming timing • 154

contained objects, updating references • 62 validating • 94, 153

reorganizing the workspace • 36 Scripts page • 74
reserved names Search • 69
Search Current Attributes • 69
instances • 96
security
list of • 18
Galaxy users • 410
templates • 52, 53

498
Index Application Server User Guide

groups, default • 410 alarm extensions • 133, 134, 135, 137, 138
groups, importing objects • 112 application • 45
icon not available • 68 base • 42, 43
icons • 69 classes • 43
opening Galaxies • 21 configuring redundancy • 476
options in attributes • 69 contained names • 59
restricting access to attributes • 68 containment • 54
restrictions, creating new Galaxies • 18 creating derived • 52
security roles • 410 default • 42, 43
Security Mode • 419 defined • 42
setting network cards • 465
deploying • 41
setting prompts for check-in comments • 37
derived • 43, 46
silenced alarms • 302, 304
single scan cycles • 128 devic e integration • 45
Situational A wareness Library symbol • 162 exporting • 459
SmartSymbols, exporting language data • 440 inheriting extensions • 120
standby object, redundancy • 472
naming conventions • 52
Startup scripts, initializing • 119
state alarms • 296 nesting • 42
Statistics Feature Paramet ers • 138 nesting levels • 54
store forward, historized data • 282 propagating changes • 43
storing history, configuring • 290 reserved names • 52, 53
subscribing to alarms • 318
system • 45
suppressed alarms • 302
time formats, .csv files • 461
switch objects • 128
timestamps
Symbol Wizard
saving as historical data • 278
Cons umer workflow • 162
toolsets
creating multiple configuration symbols •
creating • 50
163
naming conventions • 50
Designer workflow • 162
embedding symbols into an InTouch
application • 164 U
symbols undeploying
exporting language data • 438 history • 282
translating text • 438 objects before moving • 29
system templates • 45 undeploying redundant engines • 478
unlocking, template attributes • 65
Upload Runtime Changes
T
I/O Auto Assignment • 149
tagnames • 54, 59, 96
User Account Control • 464
tagnames, containment • 55
user accounts • 464
target deviation alarms • 298
user defaults, setting • 37
Templat e Toolbox, location • 22
users
templates

499
Application Server User Guide Index

default • 410
deleting • 428

V
validating
Galaxies • 95
object manually • 95
objects • 94
objects, viewing results • 34
references in scripts • 94
scripts • 94, 153
viewing
object properties • 47
object relationships • 29
objects, assignment relationships • 31
views in the IDE • 22

W
Windows
user accounts • 464
WinPlatform object, configuring for
redundancy • 474
WinPlatform, object • 45
WinPlatforms, history configuration • 285
Wonderware Historian, installing • 277
writing
to attributes in runtime, attribut es
in runtime, writing to attributes • 65

500