Appendix: Built-in Scripting Language

This section describes the functions that make up the built-in scripting language. Each function description includes complete syntax, possible returned values, and examples of usage.

  • Logic and arithmetic operators
    The built-in scripting language supports the following logic and arithmetic operators.
  • How to read function descriptions
    This is a key to reading the descriptions of the built-in scripting functions.
  • Log Message functions
    These functions are used to display status and debug messages in the Output window (for local runtime) or Remote LogWin window (for remote runtime).
  • Arithmetic functions
    These functions are used to perform advanced arithmetic operations and bit manipulation on numeric values.
  • Statistical functions
    These functions are used to get certain statistics — such as average, maximum, and minimum — from two or more numeric values.
  • Logarithmic functions
    These functions are used to perform logarithmic operations on numeric values.
  • Logical functions
    These functions are used to perform logical operations (e.g., if/then, true/false) on tags and expressions.
  • String functions
    These functions are used to manipulate text strings or convert them into numeric values.
  • Date & Time functions
    These functions are used to interact with the system clock or manipulate timestamps.
  • Trigonometric functions
    These functions are used to perform trigonometric operations (e.g., sine, cosine, tangent) on numeric values.
  • Screen functions
    These functions are used to open and close project screens.
  • Security functions
    These functions are used to manage users and groups in the project’s security system.
  • Module Activity functions
    These functions are used to manage a project’s various runtime modules — such as background tasks, the data server, and the project viewer — as well as those modules’ interactions with the operating system.
  • File functions
    These functions are used to read from, write to, print, move, and delete external files.
  • Graphic functions
    These functions are used to manipulate and print project screens.
  • Translation functions
    These functions are used to access the translation tool during runtime.
  • Multimedia functions
    These functions are used to play external audio and video files.
  • System Info functions
    These functions are used get information about the computer that is running the project (either server or client, depending on the function), as well as to change some project settings on that computer.
  • Tags Database functions
    These functions are used to directly change the values of project tags.
  • Loop functions
    These functions are used to implement repeating, incrementing loop within a script.
  • ODBC functions
    These functions are used interact with an external database via Open Database Connectivity (ODBC).
  • Email functions
    These functions are used to configure and send email from within a project.
  • Dial-up functions
    These functions are used to configure the computer’s modem (if any) and establish dial-up connections to other computers.
  • ActiveX and .NET Control functions
    These functions are used to directly run ActiveX and .NET Control objects in the project, as well as to get and set property values on those objects.
  • Event Logger functions
    These functions are used to send events and comments to the Event Logger.
  • FTP functions
    These functions are used to configure the FTP settings for the project, as well as to get files from and put files on a remote server.
  • Database/ERP functions
    These functions are used interact with external databases and ERP systems using SQL-like commands.
InduSoft Web Studio -Technical Reference

Appendix: Built-in Scripting Language