Intouch(R) Reference Guide - maha-net.co.kr

1 Wonderware FactorySuite intouch Reference GuideRevision ALast Revision: September 2002 Invensys Systems, 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 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.

2 This software may be used or copied only in accordance with the terms of these agreements. 2002 Invensys Systems, Inc. All Rights Systems, Commercial StreetFoxboro, MA 02035(949) 727-3200 a de m ar k sAll 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 Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DTAnalyst, FactoryFocus, FactoryOffice, FactorySuite, hotlinks, InBatch, InControl, IndustrialRAD, IndustrialSQL Server, intouch , InTrack, MaintenanceSuite, MuniSuite, QI Analyst, SCADA larm, SCADAS uite, 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 Reference GuideContents Introduction.

3 15 Document Conventions .. 15 About this Manual .. 16 Technical 17 Your FactorySuite License .. 17 CHAPTER 1: System Tagnames ..19$AccessLevel .. 19$AlarmPrinterError .. 20$ 20$AlarmPrinterOffline .. 21$AlarmPrinterOverflow .. 21$ 22$ 22$ChangePassword .. 23$ 23$Date .. 24$ 24$DateTime .. 24$Day .. 25$ 25$ 26$InactivityTimeout .. 26$InactivityWarning .. 27$ 27$ 28$Month .. 28$Msec .. 28$NewAlarm .. 29$ 29$ObjVer .. 29$ 30$ 30$OperatorDomainEntered .. 31$OperatorEntered .. 31$OperatorName .. 31$PasswordEntered .. 32$Second .. 32$StartDdeConversations .. 324 ContentsInTouch Reference Guide $System ..33$Time ..33$ $ $Year ..34 CHAPTER 2: Dotfields ..35 Tagname Type Type Discrete, Indirect Analog, Indirect Type Tagnames ..37 Tagname Type vs. Dotfield Usage Matrix ..66 Contents5 intouch Reference .. 996 ContentsInTouch Reference ..133 Contents7 intouch Reference .. 1678 ContentsInTouch Reference ..170 CHAPTER 3: intouch QuickScript ().

4 172 Ack() ..172 ActivateApp()..173 AddPermission() ..173almAckAll() ..174almAckDisplay() ..174almAckGroup() ..174almAckPriority() ..176almAckRecent() ..176almAckSelect()..177almAckSelectedGr oup()..177almAckSelectedPriority()..178a lmAckSelectedTag() ..178almAckTag() ..179almDefQuery() ..180almMoveWindow() ..180almQuery() ..181almSelectAll() ..182almSelectGroup() ..182almSelectionCount() ..183almSelectItem() ..183almSelectPriority() ..184almSelectTag() ..185almSetQueryByName()..185almShowStat s() ..186almSuppressAll() ..186almSuppressGroup() ..187almSuppressDisplay() ..188almSuppressPriority() ..188almSuppressRetain() ..189almSuppressSelected() ..189almSuppressTag()..190almSuppressSel ectedGroup()..191almSuppressSelectedPrio rity()..192almSuppressSelectedTag() ..192almUnSelectAll() ..193 Contents9 intouch Reference GuidealmUnSuppressAll().. 193 ArcCos() .. 194 ArcSin() .. 194 ArcTan() .. 195 AttemptInvisibleLogon().. 195 ChangePassword().

5 196 Cos() .. 197 DialogStringEntry().. 197 DialogValueEntry() .. 199 DText() .. 201 EnableDisableKeys().. 201 Exp().. 201 FileCopy() .. 203 FileDelete().. 204 FileMove().. 205 FileReadFields() .. 207 FileReadMessage().. 208 FileWriteFields() .. 209 FileWriteMessage() .. 210 GetNodeName() ..211 GetPropertyD()..211 GetPropertyI() .. 212 GetPropertyM() .. 212 Hide .. 213 HTGetLastError().. 214 HTGetPenName().. 215 HTGetTimeAtScooter().. 215 HTGetTimeStringAtScooter() .. 216 HTGetValue() .. 217 HTGetValueAtScooter().. 218 HTGetValueAtZone().. 219 HTScrollLeft().. 220 HTScrollRight() .. 220 HTSelectTag() .. 221 HTSetPenName() .. 221 HTUpdateToCurrentTime().. 222 HTZoomIn() .. 222 HTZoomOut() .. 223 InfoAppActive() .. 224 InfoAppTitle() .. 224 InfoDisk() .. 225 InfoFile() .. 22610 ContentsInTouch Reference GuideInfoInTouchAppDir() ..227 InfoResources() ..227 Int()..227 InvisibleVerifyCredentials()..228 IOGetApplication() ..228 IOGetNode().

6 229 IOGetTopic() ..229 IOReinitialize() ..229 IOSetAccessName()..230 IOSetItem() ..231 IOStartUninitConversations() ..232 IsAnyAsynchFunctionBusy()..232 IsAssignedRole()..233 Log()..233 LogMessage()..234 LogN()..234 Logoff() ..234Pi()..235 PlaySound()..235 PostLogonDialog()..236 PrintHT() ..236 PrintScreen() ..237 PrintWindow()..239 QueryGroupMembership()..241 RecipeDelete() ..241 RecipeGetMessage() ..241 RecipeLoad()..243 RecipeSave() ..244 RecipeSelectNextRecipe() ..245 RecipeSelectPreviousRecipe() ..246 RecipeSelectRecipe() ..247 RecipeSelectUnit() ..248 ReloadWindowViewer()..249 RestartWindowViewer()..249 Round() ..250 SendKeys ..251 SetPropertyD() ..252 SetPropertyI()..253 SetPropertyM()..253 Sgn().. () .. Reference GuideShowTopLeftAt() .. 256 Sin() .. 257 SPCC onnect().. 257 SPCD atasetDlg() .. 258 SPCD isconnect() .. 258 SPCD isplayData() .. 259 SPCL ocateScooter() .. 259 SPCMoveScooter().. 260 SPCSaveSample() .. 260 SPCS electDataset().

7 261 SPCS electProduct() .. 261 SPCSetControlLimits() .. 262 SPCSetMeasurement() .. 262 SPCSetProductCollected() .. 263 SPCSetProductDisplayed() .. 263 SPCSetRangeLimits() .. 264 SPCSetSpecLimits().. 264 SQLA ppendStatement() .. 265 SQLC learParam().. 265 SQLC learStatement() .. 265 SQLC learTable() .. 266 SQLC ommit().. 266 SQLC onnect() .. 268 SQLC reateTable() .. 270 SQLD elete() .. 270 SQLD isconnect().. 272 SQLDropTable().. 272 SQLEnd() .. 272 SQLE rrorMsg() .. 273 SQLE xecute().. 273 SQLF irst() .. 274 SQLGetRecord() .. 274 SQLI nsert().. 274 SQLI nsertEnd() .. 275 SQLI nsertExecute().. 276 SQLI nsertPrepare() .. 276 SQLLast().. 277 SQLLoadStatement() .. 277 SQLM anageDSN().. 278 SQLNext() .. 278 SQLNumRows().. 278 SQLP repareStatement() .. 279 SQLPrev() .. 28012 ContentsInTouch Reference GuideSQLR ollback() ..280 SQLS elect()..281 SQLSetParamChar() ..284 SQLSetParamDate()..284 SQLSetParamDateTime() ..284 SQLSetParamDecimal()..286 SQLSetParamFloat().

8 286 SQLSetParamInt()..286 SQLSetParamLong()..288 SQLSetParamNull() ..288 SQLSetParamTime()..290 SQLSetStatement() ..290 SQLT ransact() ..292 SQLU pdate() ..292 SQLU pdateCurrent()..294 Sqrt() ..294 StartApp ..295 StringASCII() ..296 StringChar()..297 StringFromIntg() ..298 StringFromReal() ..299 StringFromTime() ..300 StringFromTimeLocal() ..301 StringInString() ..302 StringLeft()..303 StringLen() ..304 StringLower() ..304 StringMid()..305 StringReplace() ..306 StringRight() ..307 StringSpace()..308 StringTest()..309 StringToIntg()..310 StringToReal()..311 StringTrim() ..312 StringUpper() ..313 Tan() ..313 Text() ..314 Trunc()..314 TseGetClientId()..315 TseQueryRunningOnConsole()..315 TseQueryRunningOnClient() ..316wcAddItem() ..316 Contents13 intouch Reference GuidewcClear() .. 317wcDeleteItem().. 317wcDeleteSelection() .. 318wcErrorMessage() .. 319wcFindItem() .. 320wcGetItem() .. 321wcGetItemData() .. 322wcInsertItem() .. 323wcLoadList().

9 324wcLoadText() .. 325wcSaveList().. 326wcSaveText().. 327wcSetItemData().. 328 WWControl() .. 329 WWExecute().. 330 WWPoke().. 331 WWRequest().. 332 CHAPTER 4: OLE Automation and intouch 333 Elements of OLE 333 intouch OLE Automation Client Extensions .. 333 intouch Automation 334 Creating an Object: OLE_CreateObject .. 337 Managing an Object: 337 Testing for a Valid Object: OLE_IsObjectValid .. 338 Getting a Property 338 Setting a Property .. 340 Calling a Method .. 341 intouch Error 343 Frequent Automation Object Errors .. 346 APPENDIX A: Troubleshooting QuickScript Functions ..347 Error Messages for Windows Controls and Distributed Alarms .. 347 Troubleshooting Recipe Script Functions .. 348 SPC DDE Item Names .. 350 SPC Control and Display DDE 350 SPC Current Sample DDE Items .. 352 SPC Manual Input DDE Items .. 356 SPC Selection DDE Items .. 357 Troubleshooting SQL Script Functions .. 360 Specific Database Error Messages.

10 36214 ContentsInTouch Reference Guide Index ..365 Introduction15 intouch Reference GuideIntroductionThis 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 Manager, SPC Pro and SQL Access Manager. 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 QuickScript functions (string, math, system, historical, windows controls, distributed alarms and miscellaneous functions).