Wonderware ® FactorySuite™ InTouch™ User’s Guide For Version A Last Revision: September 2002 Invensys Systems, Inc. All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of the Invensys Systems, Inc. No copyright or patent liability is assumed with respect to the use of the information contained herein. Although every precaution has been taken in the preparation of this documentation, the publisher and the author assume no responsibility for errors or omissions. Neither is any liability assumed for damages resulting from the use of the information contained herein. The information in this documentation is subject to change without notice and does not represent a commitment on the part of Invensys Systems, Inc. The software described in this documentation is furnished under a license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of these agreements. © 2002 Invensys Systems, Inc. All Rights Reserved. Invensys Systems, Inc. 33 Commercial Street Foxboro, MA 02035 (949) 727-3200 http://www.wonderware.com Trademarks All terms mentioned in this book that are known to be trademarks or service marks have been appropriately capitalized. Invensys Systems, Inc. cannot attest to the accuracy of this information. Use of a term in this book should not be regarded as affecting the validity of any trademark or service mark. Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DTAnalyst, FactoryFocus, FactoryOffice, FactorySuite, hotlinks, InBatch, InControl, IndustrialRAD, IndustrialSQL Server, InTouch, InTrack, MaintenanceSuite, MuniSuite, QI Analyst, SCADAlarm, SCADASuite, SuiteLink, SuiteVoyager, WindowMaker, WindowViewer, Wonderware, and Wonderware Logger are trademarks of Invensys plc, its subsidiaries and affiliates. All other brands may be trademarks of their respective owners. Contents 3 InTouch User’s Guide Contents Welcome to InTouch 15 System Requirements 16 Installing InTouch 16 About this Manual 17 Technical Support 19 Your FactorySuite License 19 Running InTouch for the First Time 20 Using the InTouch Application Manager 21 The Application Manager's Tools 26 CHAPTER 1: WindowMaker Program Elements 29 The WindowMaker GUI 30 The Application Explorer 31 Navigating in the Application Explorer 32 Adding Applications to the Application Explorer 40 The WindowMaker Toolbars 42 Working with the Floating/Docking Toolbars 42 The WindowMaker Ruler 53 The WindowMaker Status Bar 54 The WindowMaker Color Palette 54 Using the Standard Color Palette 54 Creating a Custom Color Palette 55 Popup Menus 58 Common Window Dialog Box Features 60 Miscellaneous Mouse Short Cuts 63 Short Cuts and Accelerators 63 Moving Objects with the Arrow Keys 64 Using WindowMaker Help 65 CHAPTER 2: Using WindowMaker 67 Simple Objects 68 Complex Objects 69 Customizing Your Development Environment 72 Working with WindowMaker Windows 76 Creating a New Window 76 Creating a Window to Hide the Title and Menu Bars 80 Opening Windows 81 Saving Windows 81 Closing Windows 82 4 Contents InTouch User’s Guide Deleting Windows 82 Duplicating a Window 83 Exporting Windows 83 Importing Windows 85 Working with Graphic Objects 88 Selecting and Sizing Objects 89 Undoing Object Edits 91 Duplicating Objects 92 Cutting Objects to the Windows Clipboard 94 Copying Objects to the Windows Clipboard 95 Pasting Objects from the Windows Clipboard 96 Cutting and Pasting Object Links 97 Deleting Objects 97 Increasing or Decreasing a Rounded Object's Radius 98 Reshaping a Polyline or Polygon Object 99 Arranging Objects in your Window 101 Aligning Objects 101 Layering Objects 108 Controlling Horizontal and Vertical Spacing 110 Rotating Objects 111 Mirroring Objects 113 Creating Cells and Symbols 114 Snapping Objects to the Grid 116 Working with Images and Bitmaps 117 Pasting a Bitmap from the Windows Clipboard 119 Editing a Bitmap 121 Creating a Transparent Bitmap 121 Working with Text Objects 123 Formatting Text Objects 124 Displaying Numeric Values 125 Editing Text Objects 128 Replacing a Portion of a Text Object 128 Working with Lines and Outlines 130 Working with Wizards 131 InTouch Windows Control Wizards 135 Using InTouch Windows Control Wizards 136 Configuring a Windows Control Wizard 141 Windows Control Wizard Properties 142 Windows Control Wizard Functions 144 Working with ActiveX Controls 144 Configuring an ActiveX Control 149 Configuring ActiveX Control Properties 151 Using ActiveX Control Methods 154 Using ActiveX Control Event Parameters 158 Reusing ActiveX Event Scripts 162 Importing ActiveX Event Scripts 164 Customizing Your Runtime Environment 165 Setting WindowViewer's General Properties 165 Contents 5 InTouch User’s Guide Setting WindowViewer's Window Configuration Properties 169 Selecting WindowViewer's Home Windows 172 Enabling Key Filters 174 EnableDisableKeys() 175 Running WindowViewer as an NT Service 175 Working with WindowViewer Windows 178 Common Dialog Box Features 178 Opening Windows 181 Closing Windows 181 Transferring to WindowMaker 181 Executing InTouch QuickScripts 182 Initializing I/O Conversations 182 CHAPTER 3: Using InTouch Security 185 Using InTouch-Based Security 185 Using the Security Internal Tagnames 186 Configuring the User and Security Levels 188 Changing a Security Log On Password 189 Logging on to an InTouch-Secured Application 189 Logging Off an InTouch-Secured Application 190 Automatically Logging Off the System 190 Using Operating System-Based Security 192 Setting Up Operating System-Based Security 192 $OperatorDomain 193 $OperatorDomainEntered 193 $OperatorName 194 $VerifiedUserName 194 Setting Up User Groups 194 Setting Up Access Levels for Groups in WindowMaker 200 InTouch Operating System Security Functions 201 Logging on to an Operating System-Secured Application 201 Using ArchestrA-Based Security 201 About ArchestrA Authentication and Authorization 201 Setting Up ArchestrA-Based Security 202 InTouch ArchestrA Security Functions 202 Logging on to an ArchestrA-Secured Application 202 Creating a Custom Security Log on Window 203 Security and Alarms 204 Full Name Expansion in Alarm Records 204 InTouch Security Script Functions 204 InvisibleVerifyCredentials() 204 PostLogonDialog() 205 AttemptInvisibleLogon() 205 IsAssignedRole() 206 QueryGroupMembership() 206 AddPermission() 207 ChangePassword() 207 6 Contents InTouch User’s Guide Logoff() 209 InTouch Security System Tags 209 $OperatorName 209 $OperatorDomain 209 $OperatorDomainEntered 210 210 CHAPTER 4: Using InTouchView 211 About InTouchView 211 Differences between InTouchView and InTouch 211 Starting Up InTouchView 211 The InTouchView License 212 Creating a New InTouchView Application 212 Running an InTouchView Application 213 Using the InTouchView Menus 213 Converting InTouchView Applications 214 Converting an InTouchView Application to an InTouch Application 214 Converting an InTouch Application to an InTouchView Application 215 CHAPTER 5: Building a Distributed Application 217 Network Architectures 218 Stand-alone Application 218 Client-Based Architecture 219 Server-Based Architecture 220 Network Application Development (NAD) 220 Configuring Network Resources 222 Configuring UNC Paths for Files 222 Wonderware SuiteLink Communication Protocol 223 Troubleshooting Networks 223 Configuring InTouch for Common Data Sources 225 InTouch Access Names 225 Configuring an InTouch Application for NAD 231 Customizing NAD Update Function 235 Manually Notifying Clients of Application Changes 235 The Application Copying Process 236 Application Editing Locks 236 Dynamic Resolution Conversion (DRC) 236 Working with Multiple Monitor Systems 239 Distributed Applications and Time Zones 240 Distributed Alarms 240 Distributed History 240 Contents 7 InTouch User’s Guide CHAPTER 6: Tagname Dictionary 243 Tagname Dictionary Special Features 244 Tagname Types 245 Memory Type Tagnames 245 I/O Type Tagnames 245 Miscellaneous Type Tagnames 246 SuperTags 249 Extended Tagname Support 249 Defining a New Tagname 250 Defining Tagname Details 254 Defining Memory Discrete Tagname Details 255 Defining Memory Analog Tagname Details 255 Defining Memory Message Tagname Details 257 Defining I/O Discrete Tagname Details 257 Defining I/O Analog Tagname Details 259 Defining I/O Message Tagname Details 261 Defining SuperTag Member Tagname Details 262 Defining Tagname Alarm Conditions 263 Alarm Inhibitor Tagnames 263 Defining Discrete Tagname Alarm Conditions 264 Defining Analog Tagname Alarm Conditions 266 Tagname Alarm Comments 269 Creating InTouch SuperTags 270 InTouch SuperTag Syntax 271 Creating a SuperTag Template Structure 272 Creating Indirect SuperTags 282 Editing SuperTag Templates and Member Tagnames 283 Defining SuperTag Template Instances 284 Alternative Methods for Creating SuperTags 286 Using the Tagname Dictionary to Create SuperTags 287 Remote Tagname Referencing 289 Creating a Tagname Server Application 293 Using Remote Tagname References 294 Dynamic Reference Addressing (DRA) 295 Using Dynamic References 296 Using IOSetItem Function to Change References 297 Using the .ReferenceComplete to Verify References 298 Using Indirect Tags With Local Tagnames 298 Using Indirect Tagnames With Remote References 299 The Tag Browser 302 Tag Browser Selection Modes 303 Tag Browser Views 305 Defining Tag Sources 307 Defining Tag Browser Filters 311 InTouch Cross Reference Utility 313 Viewing the Cross Reference Search Results 315 Changing the Cross Reference Search Criteria 318 8 Contents InTouch User’s Guide Saving Cross Reference Files 322 Printing Cross Reference Files 323 Printing Tagname Dictionary Details 324 Deleting Tagnames from the Dictionary 325 Updating Use Counts 326 Deleting Unused Tagnames 327 Displaying the Tagname Usage Count 327 Substituting Tagnames 329 Converting Placeholder Tagnames 331 Converting Tagnames to Remote References 332 Scaling I/O Tagnames 338 Instrument Failure Monitoring 339 Internal System $Tagnames 339 Tagname Dotfields 342 Addressing Bit Fields for Analog Tagnames 356 Tagname Dictionary Utilities 356 DBDump Utility Program 357 DBLoad Utility Program 359 Creating a Database Input File 361 Database Input File Format 361 Creating SuperTag Instances 362 Database Input File Operating Modes 364 Creating Database Record Templates 367 CHAPTER 7: Creating Animation Links 379 Common Animation Link Features 379 Object Type Dialog Box 380 Animation Link Selection Dialog Box 380 Assigning Key Equivalents 381 Applying Color Links 382 Accessing the Tag Browser 383 Accessing Tagname Dotfields 384 Animating Objects 385 Creating Touch Links 387 Creating User Input Touch Links 387 388 390 Creating Slider Touch Links 391 Creating Touch Pushbuttons Touch Links 393 Creating Display Links 397 Creating Color Links 397 Creating Object Size Links 403 Creating Location Links 404 Creating Percent Fill Links 406 Creating Miscellaneous Links 408 Creating Value Display Links 415 Contents 9 InTouch User’s Guide CHAPTER 8: Creating QuickScripts in InTouch 419 InTouch QuickScripts 420 Using the InTouch QuickScript Editor 421 The QuickScript Editor Toolbar 421 QuickScript Editor Common Procedures 422 Application Scripts 428 Window Scripts 430 Key Scripts 432 Touch Pushbutton Action Scripts 434 Assigning a Key Equivalent to a Script 435 Condition Scripts 436 Data Change Scripts 438 ActiveX Event Scripts 440 QuickFunctions 443 Asynchronous QuickFunction Scripts 448 Using Local Variables 450 Creating FOR-NEXT Loop Scripts 452 Script Editing Styles and Syntax 458 Required Syntax for Expressions and Scripts 458 Simple Scripts 458 Complex Scripts 464 Importing QuickScripts 467 Printing Scripts 471 Script Functions 472 String Functions 472 Math Functions 473 System Functions 474 Misc Functions 476 Script Editor Error Messages 482 Error Messages for Windows Controls and Distributed Alarms 486 CHAPTER 9: Alarms/Events 487 Introduction 488 Support for Non-InTouch Alarm Providers 489 General Background on Alarms 489 Alarms and Events 491 Summary Alarms versus Historical Alarms 491 Terminal Services Alarm Support 492 Support for Other Alarm Sources 492 Alarm Types 493 Event Types 493 Alarm Priorities 494 Alarm Groups 494 10 Contents InTouch User’s Guide Distributed Alarm Group Lists 500 Alarm Acknowledgment Models 502 Expanded Summary Alarms 503 Using Expanded Summary Alarms 503 Publish/Subscribe Mechanism 504 Alarm Provider 504 Alarm Consumer 504 Alarm Data Storage 505 Tagname Alarm Configuration 505 Alarm Dotfields 507 Alarm Visibility Controls 514 Configuring the Alarm System 517 Alarm/Event General Properties 518 Attaching Comments to an Alarm Ack Function 519 Displaying Alarm Statistics 520 Acknowledging Local Alarms 521 Timestamps in the Distributed Alarm System 522 Migrating from an Older InTouch Standard Alarm System to the Distributed Alarm System 522 Migrating from Older Master/Slave Alarms to the Distributed Alarm System 523 Hot Backup and Synchronization 523 Notes Regarding Hot Backup Pairs 524 Hot Backup Configuration 525 Setting Key Fields for Alarm Records 531 Mapping Alarm Records 533 Hot Backup Usage Example 536 Ack Synchronization Example 542 Distributed Alarm Database Views 544 Introduction to Views and Stored Procedures 544 View and Stored Procedure Column Definitions 545 Alarm History Database Views 547 Event History Database Views 549 Alarm-Event History Database View 550 AlarmCounter Database Stored Procedure 552 Viewing the Definition of a Stored Procedure in Enterprise Manager 553 EventCounter Database Stored Procedure 554 AlarmSuite Alarm Log Database View 554 CHAPTER 10: Alarm/Event Clients 557 Alarm Viewer ActiveX Control Guidelines 557 Alarm Viewer ActiveX Display Guidelines 558 Installing the Alarm Viewer ActiveX Control 558 Uninstalling the Alarm Viewer ActiveX Control 559 [...]... xiii Glossary of Terms xv Index xxxvii InTouch User’s Guide Welcome to InTouch 15 Welcome to InTouch Welcome to Wonderware InTouch , the quickest and easiest way to create human-machine interface (HMI) applications for the Microsoft Windows 2000 and Windows XP operating systems InTouch is a component of the Wonderware FactorySuite InTouch applications span the globe in a multitude of vertical... implement the distributed functionality of InTouch, Wonderware NetDDE must be installed and operational Note Wonderware FactorySuite InTouch Version 8.0 (or later) does not support the Microsoft Windows 3.x or Microsoft Windows for Workgroups or Windows 9x operating systems Installing InTouch The Wonderware FactorySuite installation program is used to install InTouch InTouch runs on Microsoft Windows 2000... complete InTouch installation instructions, read the InTouch Release Notes (ITRELNOTES.TXT) For complete FactorySuite installation instructions, read the FactorySuite Release Notes (FSRELNOTES.TXT) Additionally, your online FactorySuite System Administrator's Guide provides you with detailed installation instructions for most products included your FactorySuite software package InTouch User’s Guide Welcome... viewing utility, see your online FactorySuite System Administrator's Guide InTouch User’s Guide 20 Before You Begin Running InTouch for the First Time The first time you run INTOUCH. EXE, the INTOUCH. INI file is automatically created This file contains the default configuration settings for your application As you configure your application, your settings are written to the INTOUCH. INI file Once you have... WindowViewer executes InTouch QuickScripts, performs historical data logging and reporting, processes alarm logging and reporting, and can function as a client and a server for both DDE and SuiteLink communication protocols Contents • System Requirements • Installing InTouch • About this Manual • Technical Support • Your FactorySuite License InTouch User’s Guide 16 Before You Begin • • Running InTouch for the... directory To view an application's properties 1 Select the application in the list InTouch User’s Guide 24 Before You Begin 2 On the File menu, click Properties The Properties dialog box appears To view a node's properties On the Tools menu, click Node Properties The Node Properties dialog box appears InTouch User’s Guide Welcome to InTouch 25 Tip To quickly access the Node Properties dialog box, right-click... Dynamic Resolution Conversion (DRC) For more information, see Chapter 5, "Building a Distributed Application." InTouch User’s Guide 28 Before You Begin InTouch User’s Guide WindowMaker Program Elements C H A P T E R 29 1 WindowMaker Program Elements WindowMaker is the development environment for InTouch The WindowMaker graphical user interface adheres to Windows 2000 and Windows NT GUI standards WindowMaker... following sources are recommended: The Windows Interface: An Application Design Guide, Microsoft Press, 1992 Dreyfuss, Henry Symbol Sourcebook: An Authoritative Guide to International Graphic Symbols Van Nostrand Reinhold, 1984 Laurel, Brenda The Art of Human-Computer Interface Design AddisonWesley, 1990 InTouch User’s Guide Welcome to InTouch 19 Norman, Donald A The Design of Everyday Things Doubleday, 1990... Using HistData with InTouch 762 Using HistData with Excel 767 Common HistData Error Messages 768 768 CHAPTER 13: I/O Communications 769 Supported Communication Protocols 769 Wonderware SuiteLink 770 The InTouch I/O Address Convention 771 The InTouch I/O Address 772 InTouch Access Names 772 Defining an I/O Item in InTouch 775... application's icon that appears when the application is listed in the InTouch Application Manager window 6 In the Description box, type a description of the application (The description is optional However, if you do type a description, it can be a total of 255 characters.) InTouch User’s Guide Welcome to InTouch 21 7 Click Finish The InTouch - Application Manager reappears displaying an icon with the . your online FactorySuite System Administrator's Guide. 20 Before You Begin InTouch User’s Guide Running InTouch for the First Time The first time you run INTOUCH. EXE, the INTOUCH. INI file. x Troubleshooting InTouch Services xi InTouch Services Fail to Install or Start Up xii Registry Keys for the InTouch Services xiii Glossary of Terms xv Index xxxvii Welcome to InTouch 15 InTouch User’s Guide Welcome. Requirements • Installing InTouch • About this Manual • Technical Support • Your FactorySuite License 16 Before You Begin InTouch User’s Guide • Running InTouch for the First Time • Using the InTouch Application