Connection Functions

Connection functions allow you to manage connections on the inSCADA platform with script/expression. With these functions you can run, stop and check the status of connections.

Get Connection Status

String ins.getConnectionStatus(String connectionName)

Provides information about the status of a connection.

connectionName: The connection name.

Return Value: Returns a string containing information about the connection status. ("Connected","Disconnected")

Syntax

var status=ins.getConnectionStatus("Connection_01");
if (status==="Disconnected") {
    ins.notify("error","Connection 01","Connection 01 is fail");
}

String ins.getConnectionStatus(Integer connectionId)

Returns information about a connection status.

connectionId: The ID of the connection.

Return Value: Returns a string containing information about the connection status. ("Connected","Disconnected")

Syntax

var connectionId=1;
var status=ins.getConnectionStatus("Connection_01");
if (status==="Disconnected") {
    ins.notify("error","Connection 01","Connection 01 is fail");
}

Start Connection

startConnection(String connectionName)

Starts a connection.

connectionName: The connection name.

Return Value: Does not return any value.

if (ins.getConnectionStatus("Connection_01")==="Disconnected") {
    ins.startConnection("Connection_01");
}

Stop Connection

stopConnection(String connectionName)

Stops a connection.

connectionName: The connection name.

Return Value: Does not return any value.

Syntax

if (ins.getConnectionStatus("Connection_01")==="Connected") {
    ins.stopConnection("Connection_01");
}

Last updated