Wonderware ® FactorySuite™ InTouch ® Reference Guide Revision C Last Revision: August 2005 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 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, 2005 Invensys Systems, Inc. All Rights Reserved. Invensys Systems, Inc. 26561 Rancho Parkway South Lake Forest, CA 92630 U.S.A. (949) 727-3200 http://www.wonderware.com Trademarks All terms mentioned in this documentation 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 documentation should not be regarded as affecting the validity of any trademark or service mark. Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DT Analyst, FactoryFocus, FactoryOffice, FactorySuite, FactorySuite A 2 , 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 Reference Guide Contents Introduction 17 Document Conventions 17 About this Manual 18 Technical Support 19 Your FactorySuite License 19 CHAPTER 1: System Tagnames 21 $AccessLevel 22 $ApplicationChanged 23 $ApplicationVersion 23 $ChangePassword 24 $ConfigureUsers 24 $Date 25 $DateString 25 $DateTime 25 $Day 26 $False 26 $HistoricalLogging 26 $Hour 27 $InactivityTimeout 27 $InactivityWarning 28 $Language 28 $LogicRunning 29 $Minute 29 $Month 29 $Msec 30 $NewAlarm 30 $ObjHor 30 $ObjVer 31 $Operator 31 $OperatorDomain 31 $OperatorDomainEntered 32 $OperatorEntered 32 $OperatorName 32 $PasswordEntered 33 $Second 33 $StartDdeConversations 33 $System 34 $Time 34 4 Contents InTouch Reference Guide $TimeString 34 $VerifiedUserName 35 $Year 35 CHAPTER 2: Dotfields and Properties 37 Tagname Types 37 Memory Type Tagnames 38 I/O Type Tagnames 38 Indirect Discrete, Indirect Analog, Indirect Message 39 Miscellaneous Type Tagnames 39 Tagname Type vs. Dotfield Usage Matrix 40 .Ack 46 .AckDev 47 .AckDsc 48 .AckROC 49 .AckValue 50 .Alarm 51 .AlarmAccess 52 .AlarmAckModel 53 .AlarmClass 54 .AlarmComment 55 .AlarmDate 56 .AlarmDev 57 .AlarmDevCount 58 .AlarmDevDeadband 58 .AlarmDevUnAckCount 59 .AlarmDisabled 59 .AlarmDsc 60 .AlarmDscCount 61 .AlarmDscDisabled 61 .AlarmDscEnabled 62 .AlarmDscInhibitor 63 .AlarmDscUnAckCount 64 .AlarmEnabled 64 .AlarmGroup 65 .AlarmGroupSel 65 .AlarmHiDisabled 66 .AlarmHiEnabled 66 .AlarmHiHiDisabled 67 .AlarmHiHiEnabled 67 .AlarmHiHiInhibitor 68 .AlarmHiInhibitor 69 .AlarmLimit 70 Contents 5 InTouch Reference Guide .AlarmLoDisabled 70 .AlarmLoEnabled 71 .AlarmLoInhibitor 72 .AlarmLoLoDisabled 73 .AlarmLoLoEnabled 73 .AlarmLoLoInhibitor 74 .AlarmMajDevDisabled 75 .AlarmMajDevEnabled 75 .AlarmMajDevInhibitor 76 .AlarmMinDevDisabled 77 .AlarmMinDevEnabled 78 .AlarmMinDevInhibitor 79 .AlarmName 80 .AlarmOprName 81 .AlarmOprNode 82 .AlarmPri 83 .AlarmProv 84 .AlarmROC 85 .AlarmROCCount 86 .AlarmROCDisabled 86 .AlarmROCEnabled 87 .AlarmROCInhibitor 88 .AlarmROCUnAckCount 89 .AlarmState 89 .AlarmTime 90 .AlarmTotalCount 90 .AlarmType 91 .AlarmUnAckCount 91 .AlarmUserDefNum1 92 .AlarmUserDefNum2 93 .AlarmUserDefStr 94 .AlarmValDeadband 95 .AlarmValue 95 .AlarmValueCount 96 .AlarmValueUnAckCount 96 .Caption 97 .ChartLength 98 .ChartStart 99 .Comment 99 .DevTarget 100 .DisplayMode 100 .Enabled 101 .EngUnits 102 6 Contents InTouch Reference Guide .Freeze 102 .HiHiLimit 103 .HiHiSet 103 .HiHiStatus 104 .HiLimit 104 .HiSet 105 .HiStatus 105 .ListChanged 106 .ListCount 106 .ListIndex 107 .LoLimit 108 .LoLoLimit 108 .LoSet 109 .LoLoSet 109 .LoLoStatus 110 .LoStatus 111 .MajorDevPct 111 .MajorDevSet 112 .MajorDevStatus 113 .MaxEU 114 .MaxRange 115 .MaxRaw 116 .MinEU 117 .MinorDevPct 118 .MinorDevSet 118 .MinorDevStatus 119 .MinRange 120 .MinRaw 121 .Name 121 .NewIndex 123 .NextPage 123 .Normal 124 .NumAlarms 125 .OffMsg 125 .OnMsg 126 .PageNum 126 .Pen1 Pen8 127 .PendingUpdates 130 .PrevPage 131 .PriFrom 131 .PriTo 132 .ProvidersReq 132 .ProvidersRet 133 Contents 7 InTouch Reference Guide .Quality 134 .QualityLimit 138 .QualityLimitString 138 .QualityStatus 139 .QualityStatusString 139 .QualitySubstatus 140 .QualitySubstatusString 141 .QueryState 141 .QueryType 142 .RawValue 143 .ReadOnly 144 .Reference 144 .ReferenceComplete 145 .ROCPct 145 .ROCSet 146 .ROCStatus 147 .ScooterLockLeft 148 .ScooterLockRight 148 .ScooterPosLeft 149 .ScooterPosRight 150 .Successful 151 .SuppressRetain 151 .TagID 152 .TimeDate 152 .TimeDateString 152 .TimeDateTime 153 .TimeDay 153 .TimeHour 153 .TimeMinute 154 .TimeMonth 154 .TimeMsec 154 .TimeSecond 155 .TimeTime 155 .TimeTimeString 155 .TimeYear 156 .TopIndex 156 .TotalPages 157 .UnAck 158 .UpdateCount 159 .UpdateInProgress 160 .UpdateTrend 161 .Value 162 .Value 163 .Visible 164 8 Contents InTouch Reference Guide CHAPTER 3: InTouch QuickScript Functions 165 Abs() 166 Ack() 166 ActivateApp() 167 AddPermission() 168 almAckAll() 169 almAckDisplay() 169 almAckGroup() 170 almAckPriority() 171 almAckRecent() 171 almAckSelect() 172 almAckSelectedGroup() 172 almAckSelectedPriority() 173 almAckSelectedTag() 173 almAckTag() 174 almDefQuery() 174 almMoveWindow() 175 almQuery() 176 almSelectAll() 177 almSelectGroup() 177 almSelectionCount() 178 almSelectItem() 178 almSelectPriority() 179 almSelectTag() 180 almSetQueryByName() 180 almShowStats() 181 almSuppressAll() 181 almSuppressDisplay() 182 almSuppressGroup() 182 almSuppressPriority() 183 almSuppressRetain() 183 almSuppressSelected() 184 almSuppressSelectedGroup() 184 almSuppressSelectedPriority() 185 almSuppressSelectedTag() 185 almSuppressTag() 186 almUnSelectAll() 187 almUnSuppressAll() 187 AnnotateLayout() 188 About APU Functions 188 APUFindAlarmGroupInstance() 189 Contents 9 InTouch Reference Guide APUFindFileInstance() 190 APUFindPrinterInstance() 191 APUGetAlarmGroupText() 192 APUGetConfigurationFilePath() 193 APUGetInstanceCount() 194 APUGetPrinterJobCount() 195 APUGetPrinterName() 196 APUGetPrinterStatus() 197 APUGetQueryAlarmState() 198 APUGetQueryFromPriority() 198 APUGetQueryProcessingState() 199 APUGetQueryToPriority() 200 APUIsInstanceUsed() 200 APUSetAlarmGroupText() 201 APUSetQueryAlarmState() 201 APUSetQueryFromPriority() 202 APUSetQueryToPriority() 203 APUSetTimeoutValues() 204 APUStartInstance() 205 APUStartQuery() 206 APUStopInstance() 207 APUStopQuery() 207 APUTranslateErrorCode() 208 ArcCos() 208 ArcSin() 209 ArcTan() 209 AttemptInvisibleLogon() 210 ChangePassword() 211 ChangeWindowColor() 212 Cos() 213 DateTimeGMT() 213 DialogStringEntry() 213 DialogValueEntry() 215 DText() 217 EnableDisableKeys() 217 Exp() 218 FileCopy() 218 FileDelete() 219 FileMove() 220 FileReadFields() 222 FileReadMessage() 223 FileWriteFields() 224 FileWriteMessage() 225 10 Contents InTouch Reference Guide GetAccountStatus() 226 GetNodeName() 227 GetPropertyD() 227 GetPropertyI() 228 GetPropertyM() 228 Hide 229 HideSelf 229 HTGetLastError() 230 HTGetPenName() 231 HTGetTimeAtScooter() 231 HTGetTimeStringAtScooter() 232 HTGetValue() 233 HTGetValueAtScooter() 234 HTGetValueAtZone() 234 HTScrollLeft() 236 HTScrollRight() 236 HTSelectTag() 237 HTSetPenName() 237 HTUpdateToCurrentTime() 238 HTZoomIn() 238 HTZoomOut() 239 InfoAppActive() 240 InfoAppTitle() 240 InfoDisk() 241 InfoFile() 242 InfoInTouchAppDir() 243 InfoResources() 243 Int() 244 InTouchVersion() 244 InvisibleVerifyCredentials() 245 IODisableFailover() 245 IOForceFailover() 246 IOGetAccessNameStatus() 246 IOGetActiveSourceName() 247 IOGetApplication() 247 IOGetNode() 248 IOGetTopic() 248 IOReinitAccessName() 249 IOReinitialize() 249 IOSetAccessName() 249 IOSetItem() 251 IOSetRemoteReferences() 252 IOStartUninitConversations() 253 [...]... Messages 401 Index 403 InTouch Reference Guide 16 Contents InTouch Reference Guide Introduction 17 Introduction This reference guide provides you with an alphabetic detailed reference for each tagname dot field (.field), windows controls property, alarm object property, system tagname and QuickScript function included in the InTouch product suite Including the InTouch add-on products; Recipe... accessing online Help InTouch Reference Guide Introduction 19 Technical Support Wonderware Technical Support offers a variety of support options to answer any questions on Wonderware products and their implementation Prior to contacting technical support, please refer to the relevant chapter(s) in your InTouch User's Guide for a possible solution to any problem you may have with your InTouch system If... Your FactorySuite License Your FactorySuite system license information can be viewed through the license viewing utility that is launched from the WindowMaker Help About dialog box To open license utility program 1 On the WindowMaker Help menu, select the About command 2 Click View License The License Utility - LicView dialog box appears InTouch Reference Guide 20 Before You Begin InTouch Reference Guide. .. (WindowViewer), see your InTouch Runtime User's Guide For details on the add-on program, SPC Pro, see your SPC Pro User's Guide For details on the add-on program, Recipe Manager, see your Recipe Manager User's Guide For details on the add-on program, SQL Access Manager, see your SQL Access Manager User's Guide Online manuals are also included in your FactorySuite software package for all FactorySuite components... 1 System Tagnames InTouch provides several pre-defined system tagnames These tagnames are built into InTouch and can be identified by a preceding dollar sign ($) During runtime, InTouch acts upon the values of these tagnames in response to system events System tagnames can be used anywhere an InTouch tagname can be used, such as in animation links or QuickScripts InTouch Reference Guide 22 Chapter 1... WWStringFromTime() 369 CHAPTER 4: OLE Automation and InTouch 371 Elements of OLE Automation 371 InTouch OLE Automation Client Extensions .372 InTouch Automation Expressions 372 Creating an Object: OLE_CreateObject 375 Managing an Object: OLE_ReleaseObject .375 Testing for a Valid Object: OLE_IsObjectValid 376 InTouch Reference Guide Contents 15 Getting a Property Value ... Remarks Contains the year in the following format: 2002 Data Type Integer (read only) Example(s) CurrentYear = $Year; NoYrsTill2010 = 2010 - CurrentYear; See Also $Day, $Month InTouch Reference Guide 36 Chapter 1 InTouch Reference Guide ... languages are defined for an InTouch application, $Language reflects the value of the Language ID for the currently displayed language By default this is the language ID (locale ID) of the base InTouch system (E/F/G/J/SC) Setting this to another ID causes strings with defined values in the new language to be switched Category system Data Type Integer (read / write) InTouch Reference Guide System Tagnames... $OperatorDomain will contain "ArchestrA." If InTouch securty is selected, the $OperatorDomain tag contains the string "InTouch. " If "None" is selected, it is an empty string "" Remarks N/A Data Type Message (read only) Example(s) IF $OperatorDomain == "PRODUCTION" THEN {Allow change to setpoint } ELSE {Change denied} ENDIF; See Also $Operator InTouch Reference Guide 32 Chapter 1 $OperatorDomainEntered... This reference guide consists of: • Chapter 1, "System Tagnames" details all InTouch pre-defined system tagnames Note All system tagnames begin with a dollar sign ($) • Chapter 2, "Dot Fields" details the tagname fields for tagnames, alarms, distributed alarms, windows controls, system, historical trending and other miscellaneous • Chapter 3, "InTouch QuickScript Functions" details the built-in InTouch . 401 Index 403 16 Contents InTouch Reference Guide Introduction 17 InTouch Reference Guide Introduction This reference guide provides you with an alphabetic detailed reference for each tagname. Wonderware ® FactorySuite InTouch ® Reference Guide Revision C Last Revision: August 2005 Invensys Systems, Inc. All. and methods. Introduction 19 InTouch Reference Guide Technical Support Wonderware Technical Support offers a variety of support options to answer any questions on Wonderware products and their