Omron Indusoft Web Studio v7.0 Technical Reference

InduSoft® is a registered trademark of InduSoft, Inc.

InduSoft Web Studio™, EmbeddedView™, and CEView™ are trademarks of InduSoft, Inc.

Windows, Windows, Windows XP, Windows XP Embedded, Windows Embedded Standard 7,

Windows Embedded Compact, Windows 2003 Server, Windows 2008 Server, Windows Vista, Windows 7, Windows CE,

and Internet Explorer are registered trademarks of Microsoft Corp. in the United States and other countries.

Other brand or product names are trademarks or registered trademarks of their respective owners.

This document shall not be reproduced or copied in any manner without expressed written authorization from InduSoft.

The information contained within this document is subject to change without notice.

InduSoft, Inc. does not guarantee the accuracy of the information.

Contents

InduSoft Web Studio Page 1

Contents

INTRODUCTION.......................................................................................................................................................................... 12

CONVENTIONS USED IN THIS DOCUMENTATION.................................................................................................................. 14

ABOUT THIS APPLICATION.......................................................................................................................................................15

Product Overview.................................................................................................................................................................. 16

Product Features................................................................................................................................................................... 17

How the Software Works....................................................................................................................................................... 19

Internal Structure and Data Flow....................................................................................................................................19

Executing/Switching Modules.........................................................................................................................................20

Executing/Switching the Background Task.................................................................................................................... 24

INSTALLATION............................................................................................................................................................................ 26

System requirements.............................................................................................................................................................27

Installing the Software........................................................................................................................................................... 29

Starting the Software............................................................................................................................................................. 32

Uninstalling the Software.......................................................................................................................................................33

LICENSING.................................................................................................................................................................................. 34

Protection Types....................................................................................................................................................................35

License Settings.................................................................................................................................................................... 36

Execution Modes................................................................................................................................................................... 37

Product Versions................................................................................................................................................................... 39

Installing a New Hardkey License......................................................................................................................................... 40

Upgrading the Current Hardkey License............................................................................................................................... 41

Installing a Softkey License................................................................................................................................................... 43

Invalid Licenses..................................................................................................................................................................... 45

Installing or Upgrading a CEView License (Locally)..............................................................................................................46

Installing or Upgrading a CEView License (Remotely)..........................................................................................................49

THE DEVELOPMENT ENVIRONMENT.......................................................................................................................................51

Application button.................................................................................................................................................................. 52

Recent Projects.............................................................................................................................................................. 52

New................................................................................................................................................................................ 52

Open Project.................................................................................................................................................................. 54

Open...............................................................................................................................................................................54

Save............................................................................................................................................................................... 54

Save As.......................................................................................................................................................................... 55

Save All.......................................................................................................................................................................... 55

Save All as HTML...........................................................................................................................................................55

Save as HTML................................................................................................................................................................55

Save Screen Group as HMTL........................................................................................................................................ 55

Print................................................................................................................................................................................ 55

Print Preview.................................................................................................................................................................. 55

Print Setup......................................................................................................................................................................56

Close.............................................................................................................................................................................. 56

Close All......................................................................................................................................................................... 56

Exit................................................................................................................................................................................. 56

Quick Access Toolbar............................................................................................................................................................ 57

Ribbon................................................................................................................................................................................... 59

Home tab........................................................................................................................................................................59

View tab..........................................................................................................................................................................59

Insert tab........................................................................................................................................................................ 60

Project tab...................................................................................................................................................................... 60

Graphics tab................................................................................................................................................................... 60

Format tab...................................................................................................................................................................... 61

Help tab.......................................................................................................................................................................... 61

Contents

Page 2 InduSoft Web Studio

Project Explorer..................................................................................................................................................................... 62

Global tab....................................................................................................................................................................... 62

Graphics tab................................................................................................................................................................... 63

Tasks tab........................................................................................................................................................................ 63

Comm tab.......................................................................................................................................................................64

Screen/Worksheet Editor.......................................................................................................................................................65

Database Spy........................................................................................................................................................................ 66

Output (LogWin).................................................................................................................................................................... 67

Title Bar................................................................................................................................................................................. 69

Status Bar..............................................................................................................................................................................70

CREATING A NEW PROJECT.................................................................................................................................................... 71

Creating a New Project..........................................................................................................................................................72

Configuring additional project settings...................................................................................................................................74

Information tab............................................................................................................................................................... 74

Options tab..................................................................................................................................................................... 75

Viewer tab.......................................................................................................................................................................82

Communication tab........................................................................................................................................................ 84

Web tab.......................................................................................................................................................................... 85

Preferences tab.............................................................................................................................................................. 88

Enabling mobile access to your project................................................................................................................................. 90

Configuring your project's default email settings................................................................................................................... 94

Configuring your project's default FTP settings.....................................................................................................................95

Starting Modules on the Target System.................................................................................................................................96

Running a Project Under Windows Services.........................................................................................................................98

TAGS AND THE PROJECT DATABASE...................................................................................................................................104

About Tags and the Project Database.................................................................................................................................105

Project Tags Folder...................................................................................................................................................... 105

Classes Folder............................................................................................................................................................. 107

Shared Database Folder.............................................................................................................................................. 109

System Tags Folder......................................................................................................................................................109

Designing a Tag...................................................................................................................................................................110

Naming the Tag............................................................................................................................................................ 110

Choosing the Tag Type.................................................................................................................................................110

Choosing the Tag Data Type........................................................................................................................................ 112

Choosing the Tag Scope.............................................................................................................................................. 113

Creating Database Tags...................................................................................................................................................... 114

Adding Tags to the Datasheet...................................................................................................................................... 114

Creating Tags "On-the-Fly"...........................................................................................................................................114

Editing Tags..................................................................................................................................................................115

Creating Classes................................................................................................................................................................. 117

Setting Tag Properties......................................................................................................................................................... 118

Understanding Tag Properties and Parameters........................................................................................................... 118

Using Tag Properties: Alarms.......................................................................................................................................119

Using Tag Properties: History.......................................................................................................................................121

List of Tag Properties....................................................................................................................................................121

Using Tags in Your Project...................................................................................................................................................126

Deleting a tag from the project database.............................................................................................................................127

Using the Tags Toolbar........................................................................................................................................................ 128

Global Replace.............................................................................................................................................................128

Replace........................................................................................................................................................................ 128

Remove unused tags................................................................................................................................................... 129

Reset tags database.................................................................................................................................................... 130

Tag Name text box....................................................................................................................................................... 130

Object Finder................................................................................................................................................................131

Cross Reference.......................................................................................................................................................... 131

Properties..................................................................................................................................................................... 132

Importing an External Database.......................................................................................................................................... 133

Using the Import Wizard...............................................................................................................................................133

Importing from.............................................................................................................................................................. 135

Integrating the project database with a TwinCAT PLC........................................................................................................ 147

SCREENS AND GRAPHICS......................................................................................................................................................148

Contents

InduSoft Web Studio Page 3

Working with Screens..........................................................................................................................................................149

Screens folder.............................................................................................................................................................. 149

Screen Group Folder....................................................................................................................................................152

Web Pages Folder........................................................................................................................................................153

Mobile Access.............................................................................................................................................................. 154

Layout...........................................................................................................................................................................158

Using Screen Objects and Animations................................................................................................................................159

Editing.......................................................................................................................................................................... 159

Shapes......................................................................................................................................................................... 161

Active Objects.............................................................................................................................................................. 166

Libraries........................................................................................................................................................................183

Animations....................................................................................................................................................................200

Formatting Screen Objects..................................................................................................................................................211

Move to Front and Move to Back................................................................................................................................. 211

Move Backward and Move Forward.............................................................................................................................212

Group........................................................................................................................................................................... 212

Align............................................................................................................................................................................. 212

Rotate...........................................................................................................................................................................214

Size.............................................................................................................................................................................. 215

Fill Color....................................................................................................................................................................... 216

Line Color..................................................................................................................................................................... 216

Fonts............................................................................................................................................................................ 216

DATA LOGGING AND DISPLAY............................................................................................................................................... 217

Alarms................................................................................................................................................................................. 218

Alarm Worksheet Header............................................................................................................................................. 219

Alarm Worksheet Body.................................................................................................................................................222

Setting the Alarm Database......................................................................................................................................... 223

Events..................................................................................................................................................................................226

Setting the Event Database..........................................................................................................................................228

Alarm/Event Control object..................................................................................................................................................230

Trends..................................................................................................................................................................................236

Converting Trend History Files from Binary to Text......................................................................................................237

Converting Trend History Files from Text to Binary......................................................................................................238

Creating Batch History................................................................................................................................................. 239

Setting the Trend Database......................................................................................................................................... 241

Trend Control object............................................................................................................................................................ 242

Object Properties: Trend Control dialog....................................................................................................................... 242

Runtime Interface......................................................................................................................................................... 254

Using the Data Source Text File...................................................................................................................................255

Using the Data Source Database.................................................................................................................................258

Grid object........................................................................................................................................................................... 263

Columns dialog.............................................................................................................................................................264

Data dialog................................................................................................................................................................... 266

Advanced dialog...........................................................................................................................................................267

BACKGROUND TASKS............................................................................................................................................................ 270

Alarms................................................................................................................................................................................. 271

Trends..................................................................................................................................................................................273

Recipes................................................................................................................................................................................275

Reports................................................................................................................................................................................ 277

ODBC.................................................................................................................................................................................. 279

Math.....................................................................................................................................................................................281

Script................................................................................................................................................................................... 282

Startup Script worksheet.............................................................................................................................................. 283

Scheduler............................................................................................................................................................................ 284

Database/ERP worksheet................................................................................................................................................... 286

COMMUNICATION WITH OTHER DEVICES............................................................................................................................ 290

Drivers................................................................................................................................................................................. 291

Main Driver Sheet.........................................................................................................................................................296

Standard Driver Sheets................................................................................................................................................ 298

OPC.....................................................................................................................................................................................300

OPC UA...............................................................................................................................................................................303

Contents

Page 4 InduSoft Web Studio

OPC .Net............................................................................................................................................................................. 308

TCP/IP................................................................................................................................................................................. 313

DDE..................................................................................................................................................................................... 315

PROJECT SECURITY................................................................................................................................................................317

About security modes.......................................................................................................................................................... 318

About security access levels............................................................................................................................................... 319

Using the security system configuration wizard.................................................................................................................. 321

Configuring server settings for security modes................................................................................................................... 324

Extending the LDAP schema to allow saving of security rights................................................................................... 326

Creating and configuring groups......................................................................................................................................... 333

Creating and configuring users............................................................................................................................................337

Managing an existing security system.................................................................................................................................338

Backing up the security system configuration..................................................................................................................... 340

Logging on/off......................................................................................................................................................................342

Blocking or unblocking a user..............................................................................................................................................343

Password Protection of Project Files...................................................................................................................................344

AUTOMATIC TRANSLATION.................................................................................................................................................... 346

Adding a language to the Translation Table........................................................................................................................ 347

Setting the project's language at startup............................................................................................................................. 349

Setting the project's language during runtime..................................................................................................................... 350

Disabling translation of selected screen objects................................................................................................................. 351

TESTING AND DEBUGGING.................................................................................................................................................... 352

Debugging from the Output Window................................................................................................................................... 353

Debugging from the Database Spy..................................................................................................................................... 355

Using the LogWin Module................................................................................................................................................... 356

Using Remote Tools............................................................................................................................................................ 357

Using Remote Database Spy....................................................................................................................................... 357

Using Remote LogWin................................................................................................................................................. 357

DEPLOYING AS A WEB APPLICATION.................................................................................................................................. 359

Introduction to Thin Clients..................................................................................................................................................360

Building a Simple Application.............................................................................................................................................. 362

The Underlying Technology................................................................................................................................................. 370

ISSymbol Control Layer.......................................................................................................................................................371

Examples of Client/Server Architecture...............................................................................................................................373

Configuring the Data Server................................................................................................................................................ 377

Configuring a Web server to host your project pages......................................................................................................... 380

Configuring the Web Tunneling Gateway............................................................................................................................382

Configuring the Thin Client.................................................................................................................................................. 383

Implementing Security.........................................................................................................................................................387

Port Usage...........................................................................................................................................................................390

Exercise: Viewing Your Project on the Web........................................................................................................................ 391

DOWNLOADING TO A REMOTE DEVICE............................................................................................................................... 393

Configuring the Target System............................................................................................................................................ 394

Configuring the Development Station..................................................................................................................................396

Automatically Running a Project..........................................................................................................................................398

DATABASE INTERFACE........................................................................................................................................................... 399

SQL Relational Databases.................................................................................................................................................. 400

Linking the Database Through a Remote DB Provider....................................................................................................... 402

Studio Database Gateway...................................................................................................................................................403

Database Configuration.......................................................................................................................................................408

Configuring a Default Database for All Task History........................................................................................................... 411

Database Troubleshooting...................................................................................................................................................412

Contents

InduSoft Web Studio Page 5

Appendices..........................................................................................................................................................................415

Using ODBC Databases...............................................................................................................................................415

Using Microsoft SQL Server.........................................................................................................................................416

Using ORACLE Databases.......................................................................................................................................... 417

Using Microsoft Access Databases..............................................................................................................................419

Using SQL Server CE.................................................................................................................................................. 420

Using Sybase............................................................................................................................................................... 422

Using Microsoft Excel...................................................................................................................................................422

Using MySQL............................................................................................................................................................... 425

TROUBLESHOOTING............................................................................................................................................................... 427

General Troubleshooting..................................................................................................................................................... 428

Frequently Asked Questions............................................................................................................................................... 430

Help Menu........................................................................................................................................................................... 437

Technical Reference.....................................................................................................................................................437

License Agreement...................................................................................................................................................... 437

Release Notes..............................................................................................................................................................437

Home Page.................................................................................................................................................................. 437

Communication Drivers................................................................................................................................................438

Support Information......................................................................................................................................................438

About............................................................................................................................................................................ 439

APPENDIX: BUILT-IN SCRIPTING LANGUAGE......................................................................................................................440

Logic and arithmetic operators............................................................................................................................................ 441

How to read function descriptions....................................................................................................................................... 443

Log Message functions........................................................................................................................................................445

Trace............................................................................................................................................................................ 445

Arithmetic functions............................................................................................................................................................. 446

Abs............................................................................................................................................................................... 446

Div................................................................................................................................................................................ 446

Format.......................................................................................................................................................................... 447

GetBit........................................................................................................................................................................... 449

Mod.............................................................................................................................................................................. 450

Pow.............................................................................................................................................................................. 450

ResetBit........................................................................................................................................................................451

Round...........................................................................................................................................................................451

SetBit............................................................................................................................................................................452

Sqrt...............................................................................................................................................................................452

Swap16........................................................................................................................................................................ 453

Swap32........................................................................................................................................................................ 453

Trunc............................................................................................................................................................................ 454

Statistical functions..............................................................................................................................................................455

Avg............................................................................................................................................................................... 455

Max...............................................................................................................................................................................455

Min................................................................................................................................................................................456

Rand.............................................................................................................................................................................457

Logarithmic functions...........................................................................................................................................................458

Exp............................................................................................................................................................................... 458

Log............................................................................................................................................................................... 458

Log10........................................................................................................................................................................... 458

Logical functions..................................................................................................................................................................460

False.............................................................................................................................................................................460

If................................................................................................................................................................................... 460

Toggle...........................................................................................................................................................................461

True.............................................................................................................................................................................. 461

Contents

Page 6 InduSoft Web Studio

String functions....................................................................................................................................................................463

Asc2Str.........................................................................................................................................................................463

CharToValue.................................................................................................................................................................463

CharToValueW............................................................................................................................................................. 464

ClassMembersToStrVector...........................................................................................................................................464

NCopy.......................................................................................................................................................................... 465

Num..............................................................................................................................................................................466

Str.................................................................................................................................................................................466

Str2Asc.........................................................................................................................................................................467

StrCompare.................................................................................................................................................................. 467

StrCompareNoCase..................................................................................................................................................... 468

StrFromInt.................................................................................................................................................................... 468

StrFromReal................................................................................................................................................................. 469

StrFromTime.................................................................................................................................................................470

StrGetElement..............................................................................................................................................................470

StrLeft...........................................................................................................................................................................471

StrLen...........................................................................................................................................................................471

StrLower....................................................................................................................................................................... 472

StrRChr........................................................................................................................................................................ 472

StrRight........................................................................................................................................................................ 472

StrSetElement.............................................................................................................................................................. 473

StrStr............................................................................................................................................................................ 473

StrStrPos...................................................................................................................................................................... 474

StrTrim..........................................................................................................................................................................474

StrTrimAll......................................................................................................................................................................475

StrUpper....................................................................................................................................................................... 475

ValueToChar.................................................................................................................................................................476

ValueWToChar............................................................................................................................................................. 476

Date & Time functions......................................................................................................................................................... 478

ClockGetDate............................................................................................................................................................... 478

ClockGetDayOfWeek................................................................................................................................................... 478

ClockGetTime...............................................................................................................................................................479

DateTime2Clock........................................................................................................................................................... 479

GetClock.......................................................................................................................................................................480

Hour2Clock...................................................................................................................................................................480

SetSystemDate............................................................................................................................................................ 481

SetSystemTime............................................................................................................................................................ 481

Trigonometric functions....................................................................................................................................................... 482

ACos.............................................................................................................................................................................482

ASin..............................................................................................................................................................................482

ATan..............................................................................................................................................................................482

Cos............................................................................................................................................................................... 483

Cot................................................................................................................................................................................483

Pi.................................................................................................................................................................................. 484

Sin................................................................................................................................................................................ 484

Tan................................................................................................................................................................................484

Screen functions..................................................................................................................................................................486

Close............................................................................................................................................................................ 486

Open.............................................................................................................................................................................486

OpenPrevious...............................................................................................................................................................488

ShowInplaceInput.........................................................................................................................................................489

ShowMessageBox........................................................................................................................................................490

Contents

InduSoft Web Studio Page 7

Security functions................................................................................................................................................................ 491

BlockUser..................................................................................................................................................................... 491

CheckESign..................................................................................................................................................................491

CreateUser................................................................................................................................................................... 492

ExportSecuritySystem.................................................................................................................................................. 493

GetUserFullName.........................................................................................................................................................493

GetUserNames.............................................................................................................................................................494

GetUserPwdAging........................................................................................................................................................495

GetUserState................................................................................................................................................................495

ImportSecuritySystem.................................................................................................................................................. 496

RemoveUser................................................................................................................................................................ 497

SetPassword................................................................................................................................................................ 497

UnblockUser.................................................................................................................................................................498

Module Activity functions..................................................................................................................................................... 500

AppActivate.................................................................................................................................................................. 500

AppIsRunning...............................................................................................................................................................501

AppPostMessage......................................................................................................................................................... 502

AppSendKeys...............................................................................................................................................................503

CleanReadQueue.........................................................................................................................................................503

CloseSplashWindow.................................................................................................................................................... 503

DisableMath................................................................................................................................................................. 504

EnableMath.................................................................................................................................................................. 504

EndTask........................................................................................................................................................................505

ExitWindows.................................................................................................................................................................505

IsScreenOpen.............................................................................................................................................................. 506

IsTaskRunning..............................................................................................................................................................506

IsViewerInFocus...........................................................................................................................................................507

KeyPad.........................................................................................................................................................................507

LogOff...........................................................................................................................................................................508

LogOn...........................................................................................................................................................................509

Math............................................................................................................................................................................. 509

PostKey........................................................................................................................................................................ 510

Recipe.......................................................................................................................................................................... 510

Report...........................................................................................................................................................................511

RunGlobalProcedureOnServer.................................................................................................................................... 512

RunVBScript.................................................................................................................................................................512

SecureViewerReload....................................................................................................................................................513

SendKeyObject............................................................................................................................................................ 514

SetAppPath.................................................................................................................................................................. 515

SetViewerInFocus........................................................................................................................................................ 515

SetViewerPos...............................................................................................................................................................516

ShutDown.....................................................................................................................................................................517

StartTask...................................................................................................................................................................... 517

ViewerPostMessage.....................................................................................................................................................518

WinExec....................................................................................................................................................................... 518

WinExecIsRunning....................................................................................................................................................... 520

Contents

Page 8 InduSoft Web Studio

File functions....................................................................................................................................................................... 521

DeleteOlderFiles...........................................................................................................................................................521

DirCreate...................................................................................................................................................................... 521

DirDelete...................................................................................................................................................................... 522

DirLength......................................................................................................................................................................522

DirRename................................................................................................................................................................... 523

FileCopy....................................................................................................................................................................... 523

FileDelete..................................................................................................................................................................... 524

FileLength.....................................................................................................................................................................525

FileRename.................................................................................................................................................................. 525

FileWrite....................................................................................................................................................................... 525

FindFile.........................................................................................................................................................................526

FindPath....................................................................................................................................................................... 527

GetFileAttributes...........................................................................................................................................................528

GetFileTime.................................................................................................................................................................. 528

GetHstInfo.................................................................................................................................................................... 529

GetLine.........................................................................................................................................................................529

HST2TXT..................................................................................................................................................................... 531

HST2TXTIsRunning..................................................................................................................................................... 532

LookupContains........................................................................................................................................................... 533

LookupGet....................................................................................................................................................................533

LookupLoad..................................................................................................................................................................534

PDFCreate................................................................................................................................................................... 534

Print.............................................................................................................................................................................. 535

RDFileN........................................................................................................................................................................536

WebGetFile.................................................................................................................................................................. 537

Graphic functions.................................................................................................................................................................538

AutoFormat...................................................................................................................................................................538

GetScrInfo.................................................................................................................................................................... 538

PrintSetup.....................................................................................................................................................................539

PrintWindow................................................................................................................................................................. 539

ResetDecimalPointsTable............................................................................................................................................ 541

RGBColor..................................................................................................................................................................... 541

RGBComponent........................................................................................................................................................... 541

SaveScreenShot.......................................................................................................................................................... 542

SetDecimalPoints......................................................................................................................................................... 543

SetDisplayUnit..............................................................................................................................................................544

SetTagDisplayUnit........................................................................................................................................................ 545

Translation functions............................................................................................................................................................546

Ext................................................................................................................................................................................ 546

SetLanguage................................................................................................................................................................ 546

SetTranslationFile.........................................................................................................................................................547

Multimedia functions............................................................................................................................................................548

Play.............................................................................................................................................................................. 548

Contents

InduSoft Web Studio Page 9

System Info functions.......................................................................................................................................................... 549

DbVersion.....................................................................................................................................................................549

GetAppHorizontalResolution........................................................................................................................................ 549

GetAppPath..................................................................................................................................................................549

GetAppVerticalResolution............................................................................................................................................ 550

GetComputerIP............................................................................................................................................................ 550

GetComputerName...................................................................................................................................................... 550

GetCursorX.................................................................................................................................................................. 551

GetCursorY.................................................................................................................................................................. 551

GetDisplayHorizontalResolution...................................................................................................................................551

GetDisplayVerticalResolution....................................................................................................................................... 552

GetFreeMemoryCE...................................................................................................................................................... 552

GetHardKeyModel........................................................................................................................................................553

GetHardKeySN.............................................................................................................................................................553

GetIPAll.........................................................................................................................................................................554

GetMemoryCE..............................................................................................................................................................554

GetNetMACID.............................................................................................................................................................. 555

GetOS.......................................................................................................................................................................... 555

GetPrivateProfileString.................................................................................................................................................556

GetProductPath............................................................................................................................................................556

GetRegValue................................................................................................................................................................ 557

GetRegValueType........................................................................................................................................................ 557

GetServerHostName.................................................................................................................................................... 558

GetTickCount................................................................................................................................................................558

InfoAppAlrDir................................................................................................................................................................ 559

InfoAppHSTDir............................................................................................................................................................. 559

InfoDiskFree................................................................................................................................................................. 559

InfoResources.............................................................................................................................................................. 560

IsActiveXReg................................................................................................................................................................560

IsAppChangedOnServer.............................................................................................................................................. 561

NoInputTime................................................................................................................................................................. 561

ProductVersion............................................................................................................................................................. 562

RegSaveCE..................................................................................................................................................................562

ReloadAppFromServer.................................................................................................................................................563

SaveAlarmFile.............................................................................................................................................................. 563

SetAppAlarmPath.........................................................................................................................................................564

SetAppHSTPath........................................................................................................................................................... 564

SetDateFormat............................................................................................................................................................. 565

SetKeyboardLanguage.................................................................................................................................................565

SetRegValue................................................................................................................................................................ 566

SetWebConfig.............................................................................................................................................................. 567

SNMPGet..................................................................................................................................................................... 568

SNMPSet......................................................................................................................................................................569

WritePrivateProfileString.............................................................................................................................................. 570

Tags Database functions..................................................................................................................................................... 572

ExecuteAlarmAck......................................................................................................................................................... 572

ForceTagChange..........................................................................................................................................................572

GetTagValue.................................................................................................................................................................573

RunGlobalProcedureOnFalse...................................................................................................................................... 574

RunGlobalProcedureOnTrigger....................................................................................................................................574

RunGlobalProcedureOnTrue........................................................................................................................................575

SetTagValue................................................................................................................................................................. 576

Loop functions..................................................................................................................................................................... 577

For … Next................................................................................................................................................................... 577

Contents

Page 10 InduSoft Web Studio

ODBC functions...................................................................................................................................................................578

ODBCBeginTrans.........................................................................................................................................................578

ODBCBindCol.............................................................................................................................................................. 578

ODBCCanAppend........................................................................................................................................................ 579

ODBCCanTransact.......................................................................................................................................................580

ODBCCanUpdate.........................................................................................................................................................580

ODBCClose..................................................................................................................................................................580

ODBCCommitTrans......................................................................................................................................................581

ODBCDelete.................................................................................................................................................................581

ODBCExecuteSQL.......................................................................................................................................................582

ODBCInsert.................................................................................................................................................................. 582

ODBCIsBOF.................................................................................................................................................................583

ODBCIsDeleted............................................................................................................................................................583

ODBCIsEOF.................................................................................................................................................................584

ODBCIsFieldNULL....................................................................................................................................................... 584

ODBCIsFieldNullable................................................................................................................................................... 585

ODBCMove.................................................................................................................................................................. 585

ODBCMoveFirst........................................................................................................................................................... 586

ODBCMoveLast........................................................................................................................................................... 586

ODBCMoveNext...........................................................................................................................................................587

ODBCMovePrev...........................................................................................................................................................587

ODBCOpen.................................................................................................................................................................. 587

ODBCQuery................................................................................................................................................................. 588

ODBCRollBack.............................................................................................................................................................589

ODBCSetFieldNULL.....................................................................................................................................................589

ODBCSetFilter..............................................................................................................................................................590

ODBCSetSort............................................................................................................................................................... 590

ODBCUnbindCol.......................................................................................................................................................... 591

ODBCUpdate............................................................................................................................................................... 591

Email functions.................................................................................................................................................................... 593

CnfEmail.......................................................................................................................................................................593

GetStatusSendEmailExt...............................................................................................................................................594

SendEmail.................................................................................................................................................................... 595

SendEmailExt...............................................................................................................................................................596

Dial-up functions..................................................................................................................................................................598

DialError....................................................................................................................................................................... 598

DialGetClientIP.............................................................................................................................................................602

DialGetServerIP........................................................................................................................................................... 603

DialStatus..................................................................................................................................................................... 605

DialUp...........................................................................................................................................................................606

DialUpToCE..................................................................................................................................................................607

FindAllDevices..............................................................................................................................................................609

FindModem.................................................................................................................................................................. 609

HangUp........................................................................................................................................................................ 610

PhoneDialUp................................................................................................................................................................ 610

PhoneDisableListen..................................................................................................................................................... 611

PhoneEnableListen...................................................................................................................................................... 611

PhoneHangUp..............................................................................................................................................................612

PhoneStatus.................................................................................................................................................................613

ActiveX and .NET Control functions.................................................................................................................................... 614

XGet............................................................................................................................................................................. 614

XRun............................................................................................................................................................................ 614

XSet..............................................................................................................................................................................615

Event Logger functions........................................................................................................................................................616

SendEvent....................................................................................................................................................................616

FTP functions...................................................................................................................................................................... 617

CnfFTP......................................................................................................................................................................... 617

FTPGet.........................................................................................................................................................................618

FTPPut......................................................................................................................................................................... 619

FTPStatus.................................................................................................................................................................... 620

Contents

InduSoft Web Studio Page 11

Database/ERP functions..................................................................................................................................................... 621

DBCursorClose............................................................................................................................................................ 621

DBCursorColumnCount................................................................................................................................................621

DBCursorColumnInfo................................................................................................................................................... 622

DBCursorCurrentRow.................................................................................................................................................. 623

DBCursorGetValue....................................................................................................................................................... 623

DBCursorMoveTo......................................................................................................................................................... 624

DBCursorNext.............................................................................................................................................................. 625

DBCursorOpen.............................................................................................................................................................625

DBCursorOpenSQL......................................................................................................................................................627

DBCursorPrevious........................................................................................................................................................628

DBCursorRowCount.....................................................................................................................................................628

DBDelete...................................................................................................................................................................... 629

DBExecute................................................................................................................................................................... 630

DBInsert....................................................................................................................................................................... 631

DBSelect...................................................................................................................................................................... 632

DBUpdate.....................................................................................................................................................................633

SyncAlarm.................................................................................................................................................................... 634

SyncAlarmStatus..........................................................................................................................................................635

SyncEvent.................................................................................................................................................................... 636

SyncEventStatus.......................................................................................................................................................... 636

SyncTrend.................................................................................................................................................................... 637

SyncTrendStatus.......................................................................................................................................................... 638

APPENDIX: VBSCRIPT............................................................................................................................................................. 639

Overview..............................................................................................................................................................................640

VBScript Interfaces in the Software.....................................................................................................................................641

Global Procedures........................................................................................................................................................642

Graphic Module............................................................................................................................................................ 644

Background Task..........................................................................................................................................................649

Language Reference...........................................................................................................................................................652

Operators..................................................................................................................................................................... 652

Constants..................................................................................................................................................................... 652

Objects and Collections................................................................................................................................................655

Properties..................................................................................................................................................................... 655

Statements................................................................................................................................................................... 656

Methods........................................................................................................................................................................657

Functions......................................................................................................................................................................658

Keywords......................................................................................................................................................................658

Errors............................................................................................................................................................................659

Tips & Tricks........................................................................................................................................................................ 662

VBScript Editor IntelliSense......................................................................................................................................... 662

VBScript Compared to VBA......................................................................................................................................... 663

Screen Events.............................................................................................................................................................. 665

MsgBox and InputBox Functions..................................................................................................................................665

VBScript Procedures....................................................................................................................................................665

Creating Constants.......................................................................................................................................................666

Declaring Variables...................................................................................................................................................... 667

Scope and Lifetime of Variables...................................................................................................................................667

Boolean Tags and Boolean Variables...........................................................................................................................667

Writing Real Values to Integer Tags............................................................................................................................. 668

Precedence of VBScript Operators.............................................................................................................................. 668

Logical Operator NOT.................................................................................................................................................. 669

Using Conditional Statements......................................................................................................................................670

Looping Through Code.................................................................................................................................................671

Support for ActiveX Controls........................................................................................................................................ 673

Windows Embedded Support.......................................................................................................................................673

Introduction

Page 12 InduSoft Web Studio

Introduction

This User Guide and Technical Reference was designed to help you get the best results from your InduSoft

Web Studio™ software. This document provides technical information and step-by-step instructions for all

the tasks you need to create Web-enabled HMI/SCADA programs.

Who should read this

This User Guide and Technical Reference is a comprehensive document designed to provide useful

information for both novice and advanced users of IWS.

•New Users: This publication uses a step-by-step, hands-on approach to the project development

process. Be sure to read the introductory chapters describing the product's features and development

environment.

•Experienced Users: This publication offers advanced instructions, tips, and troubleshooting

information to help you get the most out of your projects.

Note: We assume you are familiar with working in a Windows environment, and we do not

attempt to explain Windows navigation, file management, and so forth. If you are unfamiliar

with any of these procedures, we recommend using the Windows Help feature (Start > Help) or

consulting your Microsoft Windows documentation.

Contents

The information in this document is organized into the following chapters:

• This chapter: Describes the purpose, content, and organization of the User Guide and Technical

Reference. In addition, this chapter contains the following information:

• Explains the formatting, mouse, and Windows conventions used

• Lists other publications providing information about IWS

• Explains how to contact a technical support representative

•About This Software: Provides a high-level overview of the product's uses, features, and functions.

•Installing and Uninstalling: Provides step-by-step instructions for installing, licensing, starting, and

uninstalling InduSoft Web Studio and CEView.

•Navigating the Development Environment: Describes the IWS interface (or development

environment), and explains some basic skills and techniques you must understand before creating a

new project.

•How the Software Works: Describes the internal structure of IWS, including how data flows through

the runtime modules and how these modules are executed.

•Creating and Configuring a New Project: Provides step-by-step instructions for creating and

configuring a new project.

•Working with Tags: Explains basic concepts about the product database, tag types (arrays, classes,

and pointers), tag values and parameters. Following the concepts discussion, this chapter provides

instructions for creating and editing tags for your projects.

•Creating Screens and Graphics: Explains how to use the different IWS development tools to create

your project screens and graphics.

•Configuring Background Tasks: Explains how to create and configure the different IWS task

worksheets for your projects.

•Event Settings: Describes the logging and event-retrieval features.

•Communicating with Other Devices: Describes how to configure your project to read from and write

to a device's registers. The information includes instructions for configuring drivers and OPC, TCP/IP,

and DDE communication.

•Configuring a Security System: Explains how to set-up and manage a security system for your

projects.

Introduction

InduSoft Web Studio Page 13

•Testing and Debugging Your Project: Discusses how to test and debug projects using tools such as

the Database Spy and Output windows. This chapter includes a list of possible error messages and

methods for correcting those errors.

•Configuring a Web Solution: Explains how configure and run your projects on the Web.

•Downloading to a Remote Device: Explains how to download, monitor, and debug projects from a

remote runtime workstation.

•Using the Translation Tool: Explains how to use the Translation Tool to translate the text in your

projects from one language to another.

•Database Interface: Explains how to connect IWS to compatible databases.

•Scripting Languages: Describes IWS's built-in scripting language, as well as the support for VBScript

in IWS.

•Troubleshooting and FAQs: Provides instructions for verifying projects, describes some common

development errors, and explains what to do if you need to contact a support representative.

Omron Indusoft Web Studio v7.0 Technical Reference

Omron Indusoft Web Studio v7.0 Technical Reference

Related papers

Other documents