Web Studio Help
Web Studio Help
Introduction
Installation
Licensing
The Development Environment
Creating a New Project
Tags and the Project Database
Alarms, Events, and Trends
Collaboration and Source Control
Project Security
Project Localization
Thin Clients and Mobile Access
Troubleshooting
Appendix: Built-in Scripting Language
Appendix: VBScript
Web Studio Help
Appendix: Built-in Scripting Language
Multimedia functions
Multimedia functions
These functions are used to play external audio and video files.
Play
Plays a specified WAV audio file.
Parent topic:
Appendix: Built-in Scripting Language
Multimedia functions
Web Studio Help > Multimedia functions
Introduction
Conventions used in this documentation
About this software
Internal structure and data flow
Executing and switching modules
Executing and switching the Background Task
Installation
Comparison of InduSoft Web Studio software components
Install the full InduSoft Web Studio software
Install EmbeddedView or CEView on a target device
Licensing
License Settings
Product Versions
Execution modes
Hardkey Licenses
Install a new hardkey license
Upgrade an existing hardkey license for InduSoft Web Studio
Upgrade an existing hardkey license for EmbeddedView or CEView
Softkey Licenses
Install or upgrade a softkey license for InduSoft Web Studio
Install or upgrade a softkey license for EmbeddedView or CEView (Local)
Install or upgrade a softkey license for EmbeddedView or CEView (Remote)
License Server
Configure CodeMeter Runtime to serve licenses
Configure Protection Manager to get license
The Development Environment
Application button
Recent Projects
New
Open Project
Open
Save
Save As
Save All
Save All as HTML
Save as HTML
Save Screen Group as HMTL
Print
Print Preview
Print Setup
Close
Close All
Exit
Quick Access Toolbar
Ribbon
Home tab
View tab
Insert tab
Project tab
Graphics tab
Format tab
Help tab
Project Explorer
Global tab
Graphics tab
Tasks tab
Comm tab
Screen/Worksheet Editor
Database Spy
Output (LogWin)
Title Bar
Status Bar
Creating a New Project
Creating a new project
About target platforms and product types
Changing the product type of an existing project
Configuring additional project settings
Information tab
Options tab
Alarm History and Events
Default Database
Database Configuration
Performance Control
Viewer tab
Communication tab
Preferences tab
Configuring your project's default email settings
Configuring your project's default FTP settings
Starting Modules on the Target System
Run a project as a Windows service
Tags and the Project Database
About Tags and the Project Database
Project Tags Folder
Extending the Project Tags datasheet
Classes Folder
Shared Database Folder
System Tags Folder
Designing a Tag
Naming the Tag
Choosing the Tag Type
Choosing the Tag Data Type
Choosing the Tag Scope
Creating Database Tags
Adding Tags to the Datasheet
Creating Tags "On-the-Fly"
Tag Properties
Tag Properties: Parameters
Tag Properties: Alarms
Tag Properties: History
List of tag properties
Change how out-of-range tag values are handled
Using Tags in Your Project
Deleting a tag from the project database
Sort or filter the rows in a worksheet
Using the Tags Toolbar
Global Replace
Replace
Remove unused tags
Reset tags database
Tag Name text box
Object Finder
Cross Reference
Properties
Using the Import Wizard
...Other Studio Databases
...OPC Server Databases
...CSV Databases
...ODBC Databases
...RSLogix 5000 CSV Databases
...PanelBuilder32 Databases
...PanelMate Plus Databases
...TwinCAT PLC Databases
...OMRON CX Programmer Databases
...Studio XML Screen
Tag Integration
Edit the tags database during run time
Screens folder
Screen Attributes dialog
Modifying a screen's background color or image
Screen Group Folder
Layout
Using Screen Objects and Animations
Editing
Selection
Properties
Grid Settings
Shapes
Line object
Open Polygon object
Closed Polygon object
Rectangle object
Rounded Rectangle object
Ellipse object
Bitmap object
Change the properties of multiple screen objects
Active Objects
Text object
Text Box object
Button object
Pushbutton object
Check Box object
Radio Button object
Combo Box object
List Box object
Libraries
Symbols library
Save your own project symbols
ActiveX Control object
.NET Control object
Linked Picture object
Animations
Command animation
Hyperlink animation
Bargraph animation
Text Data Link animation
Color animation
Visibility/Position animation
Set the tab order of screen objects
Bring to front / Send to back
Group
Align
Rotate
Flip Vertical
Flip Horizontal
Size
Fill Color
Line Color
Fonts
Multi-Touch
Project and Screen Settings
Configure the default Multi-Touch settings for all screens
Configure the Multi-Touch settings for a specific screen
Gestures
…in Project Screens
…in Data Objects
…in Animations
Touch Events
Add a Touch Event to a screen object
Add a Touch Event to a project screen
OnTouch
OnTouchStart
OnTouchDelta
Alarms, Events, and Trends
Alarms
Alarm Worksheet Header
Email Settings for Alarm Worksheet
Format of the alarm history
Events
Format of the event log
Alarm/Event Control object
Connect to a Wonderware Historian database
Converting Trend History Files from Binary to Text
Converting Trend History Files from Text to Binary
Creating Batch History
Trend Control object
About the trend control runtime interface
Object Properties: Trend Control
Points
Pen Style
Options
Modify the pen style of a point during run time
SPC
Axes
Toolbar
Data Sources
Legend
Advanced
Using the Data Source Text File
Using the Data Source Database
Grid object
Data dialog
Columns dialog
Advanced dialog
Trends
Recipes
Reports
ODBC
Math
Script
Startup Script worksheet
Scheduler
TwinCAT
Export a symbol file from your TwinCAT project
CoDeSys
Configure your CoDeSys 3.x project for tag integration
RSLogix 5000 Family
Export symbol file for RSLogix 5000 Family
Allen-Bradley PLC5, SLC500
Schneider Unity Modbus
Export I/O configuration file for Schneider Unity Modbus
AutomationDirect Koyo
Export CSV file for AutomationDirect Koyo
AutomationDirect PAC 3000
Export CSV file for AutomationDirect PAC 3000
Use the Object Finder to select integrated tags
How integrated tags may be renamed in your project
Drivers
Main Driver Sheet
Standard Driver Sheets
Driver Error Codes
OPC DA 2.05
OPC UA Client
Connect to an OPC UA server using self-signed certificates
Connect to an OPC UA server using CA-signed certificates
List of read/write status codes and messages for OPC UA
OPC .NET Client
OPC XML/DA
TCP/IP
Collaboration and Source Control
Connect to your collaboration server
Add a project to source control
Check out project files for editing
View, undo, or check in pending changes
Branch a project in source control
Open a project from source control
Get the latest version of a project
Get a specific version of a project
Apply a label to a project
Project Security
About security modes
About security access levels
Using the security system configuration wizard
Configuring server settings for security modes
Extending the LDAP schema to allow saving of security rights
Creating and configuring groups
Creating and configuring users
Managing an existing security system
Backing up the security system configuration
Logging on/off
Blocking or unblocking a user
Password Protection of Project Files
Project Localization
Add a target language to the Translation Table
Configure fonts for a target language
Examples of font configuration
Set the project's language at startup
Set the project's language during run time
Using the LogWin Module
Using Remote Tools
Using Remote Database Spy
Using Remote LogWin
Enable security in Remote Agent and add users
Download your project to the target device
Run or stop your project on the target device
Configure Remote Agent to autorun a project
Thin Clients and Mobile Access
Web
Building a Simple Application
The Underlying Technology
ISSymbol Control Layer
Examples of Client/Server Architecture
Configuring the Data Server
Configuring the web server
Installing the web tunneling gateway
Configuring the Thin Client
Implementing Security
Port Usage
Exercise: Viewing Your Project on the Web
Mobile Access
List of supported features
Tips for development and run time
Installation
Turn on Microsoft IIS
Enable SSL encryption
Install the Mobile Access Runtime software
Specify the address of the network router
Configuration
Insert a new area
Configure the area settings
Configure the global settings
Navigation
Log on to the web interface
Use the Alarm control
Use the Process Values control
Use the Trend control
Use the Screens control
Link directly to a project screen
Troubleshooting
Open the browser console
Use the activity log
Database Troubleshooting
Appendices
Using ODBC Databases
Using Microsoft SQL Server
Using ORACLE Databases
Using Microsoft Access Databases
Using SQL Server CE
Installing SQL Server on a Windows Embedded device
Using Sybase
Using Microsoft Excel
Using MySQL
Troubleshooting
General Troubleshooting
Technical Reference
Communication Drivers
License Agreement
Home Page
Release Notes
System Information
Support Information
About
Appendix: Built-in Scripting Language
Logic and arithmetic operators
How to read function descriptions
Log Message functions
Trace
Arithmetic functions
Abs
Div
Format
GetBit
Mod
Pow
ResetBit
Round
SetBit
Sqrt
Swap16
Swap32
Trunc
Statistical functions
Avg
Max
Min
Rand
Logarithmic functions
Exp
Log
Log10
Logical functions
False
If
Toggle
True
String functions
Asc2Str
CharToValue
CharToValueW
ClassMembersToStrVector
NCopy
Num
Str
Str2Asc
StrCompare
StrCompareNoCase
StrFromInt
StrFromReal
StrFromTime
StrGetElement
StrLeft
StrLen
StrLower
StrRChr
StrRight
StrSetElement
StrStr
StrStrPos
StrTrim
StrTrimAll
StrUpper
ValueToChar
ValueWToChar
Date & Time functions
ClockGetDate
ClockGetDayOfWeek
ClockGetTime
DateTime2Clock
DateTime2UTC
GetClock
GetTimeZone
GetTimeZoneCount
GetUTC
Hour2Clock
SetSystemDate
SetSystemTime
SetTimeZone
UTC2DateTime
Trigonometric functions
ACos
ASin
ATan
Cos
Cot
Pi
Sin
Tan
Screen functions
Close
Open
OpenPrevious
ShowInplaceInput
ShowMessageBox
Security functions
BlockUser
CheckESign
CheckSecurityLevel
CreateUser
ExportSecuritySystem
GetSecuritySystemStatus
GetUserFullName
GetUserNames
GetUserPwdAging
GetUserState
ImportSecuritySystem
RemoveUser
SetPassword
UnblockUser
Module Activity functions
AppActivate
AppIsRunning
AppPostMessage
AppSendKeys
CleanReadQueue
CloseSplashWindow
DisableMath
EnableMath
EndTask
ExitWindows
IsScreenOpen
IsTaskRunning
IsViewerInFocus
KeyPad
LogOff
LogOn
Math
PostKey
Recipe
Report
RunGlobalProcedureAsync
RunGlobalProcedureAsyncGetStatus
RunGlobalProcedureOnFalse
RunGlobalProcedureOnServer
RunGlobalProcedureOnTrigger
RunGlobalProcedureOnTrue
RunVBScript
SecureViewerReload
SendKeyObject
SetAppPath
SetViewerInFocus
SetViewerPos
ShutDown
StartTask
ViewerPostMessage
WinExec
WinExecIsRunning
File functions
DeleteOlderFiles
DirCreate
DirDelete
DirLength
DirRename
FileCopy
FileDelete
FileLength
FileReadFields
FileReadMessage
FileRename
FileWrite
FileWriteFields
FileWriteMessage
FindFile
FindPath
GetFileAttributes
GetFileTime
GetHstInfo
GetLine
Hst2Txt
HST2TXTIsRunning
ImportXML
LookupContains
LookupGet
LookupLoad
PDFCreate
Print
RDFileN
WebGetFile
Graphic functions
AutoFormat
ExecuteCustomCall
GetScrInfo
PrintSetup
PrintWindow
ResetDecimalPointsTable
RGBColor
RGBComponent
SaveScreenShot
SetDecimalPoints
SetDisplayUnit
SetTagDisplayUnit
Translation functions
Ext
SetLanguage
SetTranslationFile
TranslationLoad
TranslationLookupClose
TranslationLookupGet
TranslationLookupLoad
Multimedia functions
Play
System Info functions
DBVersion
GetAppHorizontalResolution
GetAppPath
GetAppVerticalResolution
GetComputerIP
GetComputerName
GetCursorX
GetCursorY
GetDisplayHorizontalResolution
GetDisplayVerticalResolution
GetFreeMemoryCE
GetHardKeyModel
GetHardKeySN
GetIPAll
GetLicenseGracePeriod
GetMemoryCE
GetNetMACID
GetOS
GetPerformanceMetric
GetPrivateProfileString
GetProductPath
GetRegValue
GetRegValueType
GetServerHostName
GetTickCount
InfoAppAlrDir
InfoAppHstDir
InfoDiskFree
InfoResources
IsActiveXReg
IsAppChangedOnServer
NoInputTime
ProductVersion
RegSaveCE
ReloadAppFromServer
SaveAlarmFile
SetAppAlarmPath
SetAppHstPath
SetDateFormat
SetKeyboardLanguage
SetRegValue
SetWebConfig
SNMPGet
SNMPSet
WritePrivateProfileString
Tags Database functions
ExecuteAlarmAck
ForceTagChange
GetAlarmCount
GetAlarmInfo
GetTagValue
SetTagValue
TagsDBAddClass
TagsDBAddClassMember
TagsDBAddTag
TagsDBBeginEdit
TagsDBEndEdit
TagsDBGetAlarm
TagsDBGetClassMember
TagsDBGetClassMemberCount
TagsDBGetFirstClass
TagsDBGetFirstClassMember
TagsDBGetFirstTag
TagsDBGetNextClass
TagsDBGetNextClassMember
TagsDBGetNextTag
TagsDBGetTagCount
TagsDBGetTagProperty
TagsDBGetTrend
TagsDBRemoveAlarm
TagsDBRemoveClass
TagsDBRemoveClassMember
TagsDBRemoveTag
TagsDBRemoveTrend
TagsDBSetAlarm
TagsDBSetTagProperty
TagsDBSetTrend
Loop functions
For…Next
ODBC functions
ODBCBeginTrans
ODBCBindCol
ODBCCanAppend
ODBCCanTransact
ODBCCanUpdate
ODBCClose
ODBCCommitTrans
ODBCDelete
ODBCExecuteSQL
ODBCInsert
ODBCIsBOF
ODBCIsDeleted
ODBCIsEOF
ODBCIsFieldNULL
ODBCIsFieldNullable
ODBCMove
ODBCMoveFirst
ODBCMoveLast
ODBCMoveNext
ODBCMovePrev
ODBCOpen
ODBCQuery
ODBCRollBack
ODBCSetFieldNULL
ODBCSetFilter
ODBCSetSort
ODBCUnbindCol
ODBCUpdate
Email functions
CnfEmail
GetStatusSendEmailExt
SendEmail
SendEmailExt
Dial-up functions
DialError
DialGetClientIP
DialGetServerIP
DialStatus
DialUp
DialUpToCE
FindAllDevices
FindModem
HangUp
PhoneDialUp
PhoneDisableListen
PhoneEnableListen
PhoneHangUp
PhoneStatus
ActiveX and .NET Control functions
XGet
XRun
XSet
Event Logger functions
SendEvent
FTP functions
CnfFTP
FTPGet
FTPPut
FTPStatus
Database/ERP functions
DBCursorClose
DBCursorColumnCount
DBCursorColumnInfo
DBCursorCurrentRow
DBCursorGetValue
DBCursorMoveTo
DBCursorNext
DBCursorOpen
DBCursorOpenSQL
DBCursorPrevious
DBCursorRowCount
DBDelete
DBExecute
DBInsert
DBSelect
DBUpdate
SyncAlarm
SyncAlarmStatus
SyncEvent
SyncEventStatus
SyncTrend
SyncTrendStatus
Appendix: VBScript
VBScript Interfaces in the Software
Global Procedures
Graphic Module
Language Reference
Operators
Constants
Objects and Collections
Properties
Statements
Methods
Functions
Keywords
Errors
Tips & Tricks
VBScript Editor IntelliSense
VBScript Compared to VBA
Screen Events
MsgBox and InputBox Functions
VBScript Procedures
Creating Constants
Declaring Variables
Scope and Lifetime of Variables
Boolean tags and Boolean variables
Writing Real Values to Integer Tags
Precedence of VBScript Operators
Logical Operator NOT
Using Conditional Statements
Looping Through Code
Support for ActiveX Controls
Support for VBScript on Windows Embedded
Debugging VBScript
About the Debug tab
Set break points in your VBScript code
Run your project in Debug mode
Observe the current state in the Database Spy window
Step through your VBScript code
Web Studio Help
en