inSCADA
EN
EN
  • Introduction
  • Getting started
  • User Interface
    • Home
    • Development
      • Projects
      • Connections
      • Devices
      • Animations
        • Get
        • Color
        • Rotate
        • Move
        • Opacity
        • Bar
        • Click
        • Tooltip
      • Alarm Groups
      • Alarms
      • Scripts
      • Expressions
      • Variables
      • Reports
      • Processes
      • Mail
      • Import/Export
    • Wizards
      • Gas Metering
      • HPP Unit
      • Device Library
    • Visiualisation
    • Processes
    • Control Panel
    • Project Map
    • Variable History
    • Alarm History
    • Alarm Monitor
    • Trend Graphics
    • Reports
    • Logs
    • Auth Logs
    • Jobs
    • Users
    • Help
    • About
    • License
  • Mimic Design
  • Communication Protocols
    • MODBUS
      • Modbus TCP
      • Modbus UDP
      • Modbus RTU Over TCP
      • Modbus TCP Server
      • Modbus RTU Slave Over TCP
    • DNP3
      • DNP3 Master
      • DNP3 Outstation
    • PROFINET
    • IEC-104
    • SNMP
    • OPC
      • OPC UA Client
  • Programing
    • APIs
      • Variable Functions
      • Connection Functions
      • Project Functions
      • Alarm Functions
      • Script Functions
      • In-Memory DB Functions
      • System Functions
      • User Functions
      • Date-Time Functions
      • String Functions
      • Notification Functions
      • Confirmation Functions
      • Database Functions
      • Other Functions
  • Database
  • Usefull Features
  • Update Logs
  • Architectures and Applications
  • Development Roadmap
  • Migration to inSCADA
  • Licensing Policies
  • FAQ
  • Screenshots
  • Auxiliary Tools
  • Installations
    • Requirements
    • Installation on Linux
Powered by GitBook
On this page
  • Get Script Status
  • Activate a Script
  • Deactivate a Script
  1. Programing
  2. APIs

Script Functions

Script functions allow you to manage scripts on the inSCADA platform with script/expression. With these functions, you can run scripts, stop them and check their status.

Get Script Status

ins.getScriptStatus(String scriptName)

Provides information about the status of a script.

scriptName : Name of the script.

Return Value: Returns a string of information about the status of the script.

Syntax

var status=ins.getScriptStatus("Script_01");
if (status==="Scheduled") {
    ins.notify("info","Script_01","Script_01 is scheduled");
}

Activate a Script

ins.activateScript(String scriptName)

Enables a script to run periodically by activating it. It schedules the script.

scriptName : Name of the script.

Return Value: Does not return any value.

Syntax

ins.activateScript("Script_01");

Deactivate a Script

ins.deactivateScript(String scriptName)

Deactivates a script and stops it from running periodically.

scriptName : Name of the script.

Return Value: Does not return any value.

Syntax

ins.deactivateScript("Script_01");
PreviousAlarm FunctionsNextIn-Memory DB Functions

Last updated 5 years ago