Class Config

The class used for programmatically modifying or creating an OAS configuration. Every aspect of an OAS server can be configured through this class.
Most operations include several overloads to allow for specification of NetworkNode as well as RemoteSCADAHostingName so you can perform the operation against both remote OAS instances, and even Live Data Cloud connected servers.

Inheritance

System.Object

Config

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OASConfig

Assembly: OASConfig.dll

Syntax

public class Config

Constructors

Config()

Default constructor

Declaration

public Config()

Properties

TCPPortNumber

Port number for TCP communications. Defaults to 58725

Declaration

public int TCPPortNumber { get; set; }

Property Value

Type	Description
System.Int32

Methods

AddAEOPCServer(String)

Declaration

public int AddAEOPCServer(string Server)

Parameters

Type	Name	Description
System.String	Server

Returns

Type	Description
System.Int32

AddAEOPCServer(String, String)

Declaration

public int AddAEOPCServer(string Server, string NetworkNode)

Parameters

Type	Name	Description
System.String	Server
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddAEOPCServer(String, String, ref String)

Declaration

public int AddAEOPCServer(string Server, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Server
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddAEOPCServer(String, String, ref String, String)

Declaration

public int AddAEOPCServer(string Server, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Server
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddAlarmLoggingGroup(String)

Declaration

public int AddAlarmLoggingGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

AddAlarmLoggingGroup(String, String)

Declaration

public int AddAlarmLoggingGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddAlarmLoggingGroup(String, String, ref String)

Declaration

public int AddAlarmLoggingGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddAlarmLoggingGroup(String, String, ref String, String)

Declaration

public int AddAlarmLoggingGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddAlarmNotificationGroup(String)

Declaration

public int AddAlarmNotificationGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

AddAlarmNotificationGroup(String, String)

Declaration

public int AddAlarmNotificationGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddAlarmNotificationGroup(String, String, ref String)

Declaration

public int AddAlarmNotificationGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddAlarmNotificationGroup(String, String, ref String, String)

Declaration

public int AddAlarmNotificationGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddAlarms(String[], String[], String[], Int32[], String[], Boolean[], Double[], DateTime[], Int32[], Boolean[], Boolean[])

Declaration

public void AddAlarms(string[] AlarmIDs, string[] AlarmTypes, string[] AlarmGroups, int[] AlarmPriorities, string[] AlarmText, bool[] AlarmActive, double[] AlarmValues, DateTime[] AlarmTimeStamps, int[] AlarmTimeDelays, bool[] AcknowledgeImmediately, bool[] ForceNewAlarm)

Parameters

Type	Name	Description
System.String[]	AlarmIDs
System.String[]	AlarmTypes
System.String[]	AlarmGroups
System.Int32[]	AlarmPriorities
System.String[]	AlarmText
System.Boolean[]	AlarmActive
System.Double[]	AlarmValues
System.DateTime[]	AlarmTimeStamps
System.Int32[]	AlarmTimeDelays
System.Boolean[]	AcknowledgeImmediately
System.Boolean[]	ForceNewAlarm

AddAlarms(String[], String[], String[], Int32[], String[], Boolean[], Double[], DateTime[], Int32[], Boolean[], Boolean[], String)

Declaration

public void AddAlarms(string[] AlarmIDs, string[] AlarmTypes, string[] AlarmGroups, int[] AlarmPriorities, string[] AlarmText, bool[] AlarmActive, double[] AlarmValues, DateTime[] AlarmTimeStamps, int[] AlarmTimeDelays, bool[] AcknowledgeImmediately, bool[] ForceNewAlarm, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	AlarmIDs
System.String[]	AlarmTypes
System.String[]	AlarmGroups
System.Int32[]	AlarmPriorities
System.String[]	AlarmText
System.Boolean[]	AlarmActive
System.Double[]	AlarmValues
System.DateTime[]	AlarmTimeStamps
System.Int32[]	AlarmTimeDelays
System.Boolean[]	AcknowledgeImmediately
System.Boolean[]	ForceNewAlarm
System.String	NetworkNode	the network node to connect - leave null for localhost

AddAlarms(String[], String[], String[], Int32[], String[], Boolean[], Double[], DateTime[], Int32[], Boolean[], Boolean[], String, ref String)

Declaration

public void AddAlarms(string[] AlarmIDs, string[] AlarmTypes, string[] AlarmGroups, int[] AlarmPriorities, string[] AlarmText, bool[] AlarmActive, double[] AlarmValues, DateTime[] AlarmTimeStamps, int[] AlarmTimeDelays, bool[] AcknowledgeImmediately, bool[] ForceNewAlarm, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	AlarmIDs
System.String[]	AlarmTypes
System.String[]	AlarmGroups
System.Int32[]	AlarmPriorities
System.String[]	AlarmText
System.Boolean[]	AlarmActive
System.Double[]	AlarmValues
System.DateTime[]	AlarmTimeStamps
System.Int32[]	AlarmTimeDelays
System.Boolean[]	AcknowledgeImmediately
System.Boolean[]	ForceNewAlarm
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

AddAlarms(String[], String[], String[], Int32[], String[], Boolean[], Double[], DateTime[], Int32[], Boolean[], Boolean[], String, ref String, String)

Declaration

public void AddAlarms(string[] AlarmIDs, string[] AlarmTypes, string[] AlarmGroups, int[] AlarmPriorities, string[] AlarmText, bool[] AlarmActive, double[] AlarmValues, DateTime[] AlarmTimeStamps, int[] AlarmTimeDelays, bool[] AcknowledgeImmediately, bool[] ForceNewAlarm, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	AlarmIDs
System.String[]	AlarmTypes
System.String[]	AlarmGroups
System.Int32[]	AlarmPriorities
System.String[]	AlarmText
System.Boolean[]	AlarmActive
System.Double[]	AlarmValues
System.DateTime[]	AlarmTimeStamps
System.Int32[]	AlarmTimeDelays
System.Boolean[]	AcknowledgeImmediately
System.Boolean[]	ForceNewAlarm
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

AddDataLoggingField(String, String, String, Int32, String)

Declaration

public int AddDataLoggingField(string FieldName, string TagName, string DataType, int StringLength, string Group)

Parameters

Type	Name	Description
System.String	FieldName
System.String	TagName
System.String	DataType
System.Int32	StringLength
System.String	Group

Returns

Type	Description
System.Int32

AddDataLoggingField(String, String, String, Int32, String, String)

Declaration

public int AddDataLoggingField(string FieldName, string TagName, string DataType, int StringLength, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	FieldName
System.String	TagName
System.String	DataType
System.Int32	StringLength
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddDataLoggingField(String, String, String, Int32, String, String, ref String)

Declaration

public int AddDataLoggingField(string FieldName, string TagName, string DataType, int StringLength, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	FieldName
System.String	TagName
System.String	DataType
System.Int32	StringLength
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddDataLoggingField(String, String, String, Int32, String, String, ref String, String)

Declaration

public int AddDataLoggingField(string FieldName, string TagName, string DataType, int StringLength, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	FieldName
System.String	TagName
System.String	DataType
System.Int32	StringLength
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddDataLoggingFields(String[], String[], String[], Int32[], String)

Declaration

public int AddDataLoggingFields(string[] FieldNames, string[] TagNames, string[] DataTypes, int[] StringLengths, string Group)

Parameters

Type	Name	Description
System.String[]	FieldNames
System.String[]	TagNames
System.String[]	DataTypes
System.Int32[]	StringLengths
System.String	Group

Returns

Type	Description
System.Int32

AddDataLoggingFields(String[], String[], String[], Int32[], String, String)

Declaration

public int AddDataLoggingFields(string[] FieldNames, string[] TagNames, string[] DataTypes, int[] StringLengths, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	FieldNames
System.String[]	TagNames
System.String[]	DataTypes
System.Int32[]	StringLengths
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddDataLoggingFields(String[], String[], String[], Int32[], String, String, ref String)

Declaration

public int AddDataLoggingFields(string[] FieldNames, string[] TagNames, string[] DataTypes, int[] StringLengths, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	FieldNames
System.String[]	TagNames
System.String[]	DataTypes
System.Int32[]	StringLengths
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddDataLoggingFields(String[], String[], String[], Int32[], String, String, ref String, String)

Declaration

public int AddDataLoggingFields(string[] FieldNames, string[] TagNames, string[] DataTypes, int[] StringLengths, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	FieldNames
System.String[]	TagNames
System.String[]	DataTypes
System.Int32[]	StringLengths
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddDataLoggingGroup(String)

Declaration

public int AddDataLoggingGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

AddDataLoggingGroup(String, String)

Declaration

public int AddDataLoggingGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddDataLoggingGroup(String, String, ref String)

Declaration

public int AddDataLoggingGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddDataLoggingGroup(String, String, ref String, String)

Declaration

public int AddDataLoggingGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddDataLoggingTagAlias(String, String, String)

Declaration

public int AddDataLoggingTagAlias(string TagName, string TagAlias, string Group)

Parameters

Type	Name	Description
System.String	TagName
System.String	TagAlias
System.String	Group

Returns

Type	Description
System.Int32

AddDataLoggingTagAlias(String, String, String, String)

Declaration

public int AddDataLoggingTagAlias(string TagName, string TagAlias, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	TagName
System.String	TagAlias
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddDataLoggingTagAlias(String, String, String, String, ref String)

Declaration

public int AddDataLoggingTagAlias(string TagName, string TagAlias, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	TagName
System.String	TagAlias
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddDataLoggingTagAlias(String, String, String, String, ref String, String)

Declaration

public int AddDataLoggingTagAlias(string TagName, string TagAlias, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	TagName
System.String	TagAlias
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddDataLoggingTagAliases(String[], String[], String)

Declaration

public int AddDataLoggingTagAliases(string[] TagNames, string[] TagAliases, string Group)

Parameters

Type	Name	Description
System.String[]	TagNames
System.String[]	TagAliases
System.String	Group

Returns

Type	Description
System.Int32

AddDataLoggingTagAliases(String[], String[], String, String)

Declaration

public int AddDataLoggingTagAliases(string[] TagNames, string[] TagAliases, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	TagNames
System.String[]	TagAliases
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddDataLoggingTagAliases(String[], String[], String, String, ref String)

Declaration

public int AddDataLoggingTagAliases(string[] TagNames, string[] TagAliases, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	TagNames
System.String[]	TagAliases
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddDataLoggingTagAliases(String[], String[], String, String, ref String, String)

Declaration

public int AddDataLoggingTagAliases(string[] TagNames, string[] TagAliases, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	TagNames
System.String[]	TagAliases
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddGroup(String)

Declaration

public int AddGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

AddGroup(String, String)

Declaration

public int AddGroup(string Group, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup

Returns

Type	Description
System.Int32

AddGroup(String, String, String)

Declaration

public int AddGroup(string Group, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddGroup(String, String, String, ref String)

Declaration

public int AddGroup(string Group, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddGroup(String, String, String, ref String, String)

Declaration

public int AddGroup(string Group, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddRecipeGroup(String)

Declaration

public int AddRecipeGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

AddRecipeGroup(String, String)

Declaration

public int AddRecipeGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddRecipeGroup(String, String, ref String)

Declaration

public int AddRecipeGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddRecipeGroup(String, String, ref String, String)

Declaration

public int AddRecipeGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddReportGroup(String)

Declaration

public int AddReportGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

AddReportGroup(String, String)

Declaration

public int AddReportGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddReportGroup(String, String, ref String)

Declaration

public int AddReportGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddReportGroup(String, String, ref String, String)

Declaration

public int AddReportGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddSecurityGroup(String)

Declaration

public int AddSecurityGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

AddSecurityGroup(String, String)

Declaration

public int AddSecurityGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddSecurityGroup(String, String, ref String)

Declaration

public int AddSecurityGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddSecurityGroup(String, String, ref String, String)

Declaration

public int AddSecurityGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddSecurityUser(String)

Declaration

public int AddSecurityUser(string UserName)

Parameters

Type	Name	Description
System.String	UserName

Returns

Type	Description
System.Int32

AddSecurityUser(String, String)

Declaration

public int AddSecurityUser(string UserName, string NetworkNode)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddSecurityUser(String, String, ref String)

Declaration

public int AddSecurityUser(string UserName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddSecurityUser(String, String, ref String, String)

Declaration

public int AddSecurityUser(string UserName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AddTag(String)

Declaration

public int AddTag(string Tag)

Parameters

Type	Name	Description
System.String	Tag

Returns

Type	Description
System.Int32

AddTag(String, String)

Declaration

public int AddTag(string Tag, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup

Returns

Type	Description
System.Int32

AddTag(String, String, String)

Declaration

public int AddTag(string Tag, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

AddTag(String, String, String, ref String)

Declaration

public int AddTag(string Tag, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

AddTag(String, String, String, ref String, String)

Declaration

public int AddTag(string Tag, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

AEOPCServersCSVExport()

Gets an array of comma-separated Strings, each String representing all Alarm and Event Servers that are in the Alarm and Event Servers configuration. This method is to be used in conjuction with AEOPCServersCSVHeaderString.

Declaration

public string[] AEOPCServersCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AEOPCServersCSVExport(String)

Declaration

public string[] AEOPCServersCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AEOPCServersCSVExport(String, ref String)

Declaration

public string[] AEOPCServersCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AEOPCServersCSVExport(String, ref String, String)

Declaration

public string[] AEOPCServersCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AEOPCServersCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the AEOPCServersCSVExport Function

Declaration

public string AEOPCServersCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AEOPCServersCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the AEOPCServersCSVExport Function

Declaration

public string AEOPCServersCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AEOPCServersCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the AEOPCServersCSVExport Function

Declaration

public string AEOPCServersCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AEOPCServersCSVImport(String[])

Used to import comma-separated strings to the Alarm and Event OPC Servers configuration

Declaration

public string AEOPCServersCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AEOPCServersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the AE OPC Server column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AEOPCServersCSVImport(String[], String)

Used to import comma-separated strings to the Alarm and Event OPC Servers configuration

Declaration

public string AEOPCServersCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AEOPCServersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the AE OPC Server column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AEOPCServersCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Alarm and Event OPC Servers configuration

Declaration

public string AEOPCServersCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AEOPCServersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the AE OPC Server column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AEOPCServersCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Alarm and Event OPC Servers configuration

Declaration

public string AEOPCServersCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AEOPCServersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the AE OPC Server column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmBufferingIsActive(String, ref String, String)

Gets a boolean indicating if Alarm data buffering is currently active

Declaration

public bool AlarmBufferingIsActive(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Boolean	True if active, False if inactive

AlarmBufferingSeconds(String, ref String, String)

Gets the amount of time Alarm data buffering has been active

Declaration

public int AlarmBufferingSeconds(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32	Number of seconds data buffering has been active

AlarmLoggingCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Alarm Logging Group. This method is to be used in conjuction with AlarmLoggingCSVHeaderString.

Declaration

public string[] AlarmLoggingCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmLoggingCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Alarm Logging Group. This method is to be used in conjuction with AlarmLoggingCSVHeaderString.

Declaration

public string[] AlarmLoggingCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmLoggingCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Alarm Logging Group. This method is to be used in conjuction with AlarmLoggingCSVHeaderString.

Declaration

public string[] AlarmLoggingCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmLoggingCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Alarm Logging Group. This method is to be used in conjuction with AlarmLoggingCSVHeaderString.

Declaration

public string[] AlarmLoggingCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmLoggingCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the AlarmLoggingCSVExport Function

Declaration

public string AlarmLoggingCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AlarmLoggingCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the AlarmLoggingCSVExport Function

Declaration

public string AlarmLoggingCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AlarmLoggingCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the AlarmLoggingCSVExport Function

Declaration

public string AlarmLoggingCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AlarmLoggingCSVImport(String[])

Used to import comma-separated strings to the Alarm Logging configuration

Declaration

public string AlarmLoggingCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Alarm Logging Group Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmLoggingCSVImport(String[], String)

Used to import comma-separated strings to the Alarm Logging configuration

Declaration

public string AlarmLoggingCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Alarm Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmLoggingCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Alarm Logging configuration

Declaration

public string AlarmLoggingCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Alarm Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmLoggingCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Alarm Logging configuration

Declaration

public string AlarmLoggingCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Alarm Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmNotificationCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of an Alarm Notification Group. This method is to be used in conjuction with AlarmNotificationCSVHeaderString.

Declaration

public string[] AlarmNotificationCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmNotificationCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of an Alarm Notification Group. This method is to be used in conjuction with AlarmNotificationCSVHeaderString.

Declaration

public string[] AlarmNotificationCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmNotificationCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of an Alarm Notification Group. This method is to be used in conjuction with AlarmNotificationCSVHeaderString.

Declaration

public string[] AlarmNotificationCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmNotificationCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of an Alarm Notification Group. This method is to be used in conjuction with AlarmNotificationCSVHeaderString.

Declaration

public string[] AlarmNotificationCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

AlarmNotificationCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the AlarmNotificationCSVExport Function

Declaration

public string AlarmNotificationCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AlarmNotificationCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the AlarmNotificationCSVExport Function

Declaration

public string AlarmNotificationCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AlarmNotificationCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the AlarmNotificationCSVExport Function

Declaration

public string AlarmNotificationCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

AlarmNotificationCSVImport(String[])

Used to import comma-separated strings to the Alarm Notification configuration

Declaration

public string AlarmNotificationCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmNotificationCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Notification Group Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmNotificationCSVImport(String[], String)

Used to import comma-separated strings to the Alarm Notification configuration

Declaration

public string AlarmNotificationCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmNotificationCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Notification Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmNotificationCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Alarm Notification configuration

Declaration

public string AlarmNotificationCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmNotificationCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Notification Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

AlarmNotificationCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Alarm Notification configuration

Declaration

public string AlarmNotificationCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the AlarmNotificationCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Notification Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

CheckTagAccessRead(String, String, String[])

Declaration

public string[] CheckTagAccessRead(string UserName, string Password, string[] Tags)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags

Returns

Type	Description
System.String[]

CheckTagAccessRead(String, String, String[], String)

Declaration

public string[] CheckTagAccessRead(string UserName, string Password, string[] Tags, string NetworkNode)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

CheckTagAccessRead(String, String, String[], String, ref String)

Declaration

public string[] CheckTagAccessRead(string UserName, string Password, string[] Tags, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

CheckTagAccessRead(String, String, String[], String, ref String, String)

Declaration

public string[] CheckTagAccessRead(string UserName, string Password, string[] Tags, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

CheckTagAccessWrite(String, String, String[])

Declaration

public string[] CheckTagAccessWrite(string UserName, string Password, string[] Tags)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags

Returns

Type	Description
System.String[]

CheckTagAccessWrite(String, String, String[], String)

Declaration

public string[] CheckTagAccessWrite(string UserName, string Password, string[] Tags, string NetworkNode)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

CheckTagAccessWrite(String, String, String[], String, ref String)

Declaration

public string[] CheckTagAccessWrite(string UserName, string Password, string[] Tags, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

CheckTagAccessWrite(String, String, String[], String, ref String, String)

Declaration

public string[] CheckTagAccessWrite(string UserName, string Password, string[] Tags, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String[]	Tags
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

ClearAllCustomObjectValues()

Removes all custom objects in the service

Declaration

public void ClearAllCustomObjectValues()

ClearAllCustomObjectValues(String)

Removes all custom objects in the service

Declaration

public void ClearAllCustomObjectValues(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

ClearAllCustomObjectValues(String, ref String)

Removes all custom objects in the service

Declaration

public void ClearAllCustomObjectValues(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

ClearAllCustomObjectValues(String, ref String, String)

Removes all custom objects in the service

Declaration

public void ClearAllCustomObjectValues(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

CurrentUser()

Returns the current user that is logged in to the application.

Declaration

public string CurrentUser()

Returns

Type	Description
System.String	Username

DataBufferingIsActive(String, ref String, String)

Gets a boolean indicating if data buffering is currently active

Declaration

public bool DataBufferingIsActive(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Boolean	True if active, False if inactive

DataBufferingSeconds(String, ref String, String)

Gets the amount of time data buffering has been active

Declaration

public int DataBufferingSeconds(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32	Number of seconds data buffering has been active

DataLoggingCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Data Logging Group. This method is to be used in conjuction with DataLoggingCSVHeaderString.

Declaration

public string[] DataLoggingCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DataLoggingCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Data Logging Group. This method is to be used in conjuction with DataLoggingCSVHeaderString.

Declaration

public string[] DataLoggingCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DataLoggingCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Data Logging Group. This method is to be used in conjuction with DataLoggingCSVHeaderString.

Declaration

public string[] DataLoggingCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DataLoggingCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Data Logging Group. This method is to be used in conjuction with DataLoggingCSVHeaderString.

Declaration

public string[] DataLoggingCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DataLoggingCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the DataLoggingCSVExport Function

Declaration

public string DataLoggingCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

DataLoggingCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the DataLoggingCSVExport Function

Declaration

public string DataLoggingCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

DataLoggingCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the DataLoggingCSVExport Function

Declaration

public string DataLoggingCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

DataLoggingCSVImport(String[])

Used to import comma-separated strings to the Data Logging configuration

Declaration

public string DataLoggingCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DataLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

DataLoggingCSVImport(String[], String)

Used to import comma-separated strings to the Data Logging configuration

Declaration

public string DataLoggingCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DataLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

DataLoggingCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Data Logging configuration

Declaration

public string DataLoggingCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DataLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

DataLoggingCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Data Logging configuration

Declaration

public string DataLoggingCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DataLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

DeleteAllTags()

Declaration

public int DeleteAllTags()

Returns

Type	Description
System.Int32

DeleteAllTags(String)

Declaration

public int DeleteAllTags(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

DeleteAllTags(String, ref String)

Declaration

public int DeleteAllTags(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

DeleteAllTags(String, ref String, String)

Declaration

public int DeleteAllTags(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

DeleteCustomObjectValue(String)

Removes a custom object in the service

Declaration

public void DeleteCustomObjectValue(string ObjectName)

Parameters

Type	Name	Description
System.String	ObjectName	The object name to delete

DeleteCustomObjectValue(String, String)

Removes a custom object in the service

Declaration

public void DeleteCustomObjectValue(string ObjectName, string NetworkNode)

Parameters

Type	Name	Description
System.String	ObjectName	The object name to delete
System.String	NetworkNode	the network node to connect - leave null for localhost

DeleteCustomObjectValue(String, String, ref String)

Removes a custom object in the service

Declaration

public void DeleteCustomObjectValue(string ObjectName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ObjectName	The object name to delete
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

DeleteCustomObjectValue(String, String, ref String, String)

Removes a custom object in the service

Declaration

public void DeleteCustomObjectValue(string ObjectName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ObjectName	The object name to delete
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

DriverInterfaceCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Driver Interface Group. This method is to be used in conjuction with DriverInterfaceCSVHeaderString.

Declaration

public string[] DriverInterfaceCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DriverInterfaceCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Driver Interface Group. This method is to be used in conjuction with DriverInterfaceCSVHeaderString.

Declaration

public string[] DriverInterfaceCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DriverInterfaceCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Driver Interface Group. This method is to be used in conjuction with DriverInterfaceCSVHeaderString.

Declaration

public string[] DriverInterfaceCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DriverInterfaceCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Driver Interface Group. This method is to be used in conjuction with DriverInterfaceCSVHeaderString.

Declaration

public string[] DriverInterfaceCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

DriverInterfaceCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the DriverInterfaceCSVExport Function

Declaration

public string DriverInterfaceCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

DriverInterfaceCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the DriverInterfaceCSVExport Function

Declaration

public string DriverInterfaceCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

DriverInterfaceCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the DriverInterfaceCSVExport Function

Declaration

public string DriverInterfaceCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

DriverInterfaceCSVImport(String[])

Used to import comma-separated strings to the Driver Interface configuration

Declaration

public string DriverInterfaceCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DriverInterfaceCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

DriverInterfaceCSVImport(String[], String)

Used to import comma-separated strings to the Driver Interface configuration

Declaration

public string DriverInterfaceCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DriverInterfaceCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

DriverInterfaceCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Driver Interface configuration

Declaration

public string DriverInterfaceCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DriverInterfaceCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

DriverInterfaceCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Driver Interface configuration

Declaration

public string DriverInterfaceCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DriverInterfaceCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

GetAEOPCServerNames()

Declaration

public string[] GetAEOPCServerNames()

Returns

Type	Description
System.String[]

GetAEOPCServerNames(String)

Declaration

public string[] GetAEOPCServerNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAEOPCServerNames(String, ref String)

Declaration

public string[] GetAEOPCServerNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetAEOPCServerNames(String, ref String, String)

Declaration

public string[] GetAEOPCServerNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAlarmLogging_Parameter_Value(String, String)

Declaration

public object GetAlarmLogging_Parameter_Value(string Parameter, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group

Returns

Type	Description
System.Object

GetAlarmLogging_Parameter_Value(String, String, String)

Declaration

public object GetAlarmLogging_Parameter_Value(string Parameter, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetAlarmLogging_Parameter_Value(String, String, String, ref String)

Declaration

public object GetAlarmLogging_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetAlarmLogging_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetAlarmLogging_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetAlarmLogging_Parameter_Values(String)

Declaration

public object[] GetAlarmLogging_Parameter_Values(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Object[]

GetAlarmLogging_Parameter_Values(String, String)

Declaration

public object[] GetAlarmLogging_Parameter_Values(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetAlarmLogging_Parameter_Values(String, String, ref String)

Declaration

public object[] GetAlarmLogging_Parameter_Values(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetAlarmLogging_Parameter_Values(String, String, ref String, String)

Declaration

public object[] GetAlarmLogging_Parameter_Values(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetAlarmLoggingNames()

Declaration

public string[] GetAlarmLoggingNames()

Returns

Type	Description
System.String[]

GetAlarmLoggingNames(String)

Declaration

public string[] GetAlarmLoggingNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAlarmLoggingNames(String, ref String)

Declaration

public string[] GetAlarmLoggingNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetAlarmLoggingNames(String, ref String, String)

Declaration

public string[] GetAlarmLoggingNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAlarmLoggingParameterStrings()

Declaration

public string[] GetAlarmLoggingParameterStrings()

Returns

Type	Description
System.String[]

GetAlarmLoggingParameterStrings(String)

Declaration

public string[] GetAlarmLoggingParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAlarmLoggingParameterStrings(String, String)

Declaration

public string[] GetAlarmLoggingParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAlarmNotification_Parameter_Value(String, String)

Declaration

public object GetAlarmNotification_Parameter_Value(string Parameter, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group

Returns

Type	Description
System.Object

GetAlarmNotification_Parameter_Value(String, String, String)

Declaration

public object GetAlarmNotification_Parameter_Value(string Parameter, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetAlarmNotification_Parameter_Value(String, String, String, ref String)

Declaration

public object GetAlarmNotification_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetAlarmNotification_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetAlarmNotification_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetAlarmNotification_Parameter_Values(String)

Declaration

public object[] GetAlarmNotification_Parameter_Values(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Object[]

GetAlarmNotification_Parameter_Values(String, String)

Declaration

public object[] GetAlarmNotification_Parameter_Values(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetAlarmNotification_Parameter_Values(String, String, ref String)

Declaration

public object[] GetAlarmNotification_Parameter_Values(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetAlarmNotification_Parameter_Values(String, String, ref String, String)

Declaration

public object[] GetAlarmNotification_Parameter_Values(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetAlarmNotificationNames()

Declaration

public string[] GetAlarmNotificationNames()

Returns

Type	Description
System.String[]

GetAlarmNotificationNames(String)

Declaration

public string[] GetAlarmNotificationNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAlarmNotificationNames(String, ref String)

Declaration

public string[] GetAlarmNotificationNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetAlarmNotificationNames(String, ref String, String)

Declaration

public string[] GetAlarmNotificationNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAlarmNotificationParameterStrings()

Declaration

public string[] GetAlarmNotificationParameterStrings()

Returns

Type	Description
System.String[]

GetAlarmNotificationParameterStrings(String)

Declaration

public string[] GetAlarmNotificationParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAlarmNotificationParameterStrings(String, String)

Declaration

public string[] GetAlarmNotificationParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAllAlarmGroups()

Declaration

public string[] GetAllAlarmGroups()

Returns

Type	Description
System.String[]

GetAllAlarmGroups(String)

Declaration

public string[] GetAllAlarmGroups(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAllAlarmGroups(String, ref String)

Declaration

public string[] GetAllAlarmGroups(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetAllAlarmGroups(String, ref String, String)

Declaration

public string[] GetAllAlarmGroups(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAllAlarms()

Declaration

public object[] GetAllAlarms()

Returns

Type	Description
System.Object[]

GetAllAlarms(String)

Declaration

public object[] GetAllAlarms(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetAllAlarms(String, ref String)

Declaration

public object[] GetAllAlarms(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetAllAlarms(String, ref String, String)

Declaration

public object[] GetAllAlarms(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetAllTagNames()

Declaration

public string[] GetAllTagNames()

Returns

Type	Description
System.String[]

GetAllTagNames(String)

Declaration

public string[] GetAllTagNames(string ReferenceGroup)

Parameters

Type	Name	Description
System.String	ReferenceGroup

Returns

Type	Description
System.String[]

GetAllTagNames(String, String)

Declaration

public string[] GetAllTagNames(string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAllTagNames(String, String, ref String)

Declaration

public string[] GetAllTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetAllTagNames(String, String, ref String, String)

Declaration

public string[] GetAllTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAllTrendPointTagNames()

Declaration

public string[] GetAllTrendPointTagNames()

Returns

Type	Description
System.String[]

GetAllTrendPointTagNames(String)

Declaration

public string[] GetAllTrendPointTagNames(string ReferenceGroup)

Parameters

Type	Name	Description
System.String	ReferenceGroup

Returns

Type	Description
System.String[]

GetAllTrendPointTagNames(String, String)

Declaration

public string[] GetAllTrendPointTagNames(string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetAllTrendPointTagNames(String, String, ref String)

Declaration

public string[] GetAllTrendPointTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetAllTrendPointTagNames(String, String, ref String, String)

Declaration

public string[] GetAllTrendPointTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetAssemblyVersion()

Returns a string containing the assembly version number

Declaration

public string GetAssemblyVersion()

Returns

Type	Description
System.String	Assembly version number null if unreachable

GetAssemblyVersion(String)

Returns a string containing the assembly version number

Declaration

public string GetAssemblyVersion(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Assembly version number null if unreachable

GetAssemblyVersion(String, ref String)

Returns a string containing the assembly version number

Declaration

public string GetAssemblyVersion(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String

GetAssemblyVersion(String, ref String, String)

Returns a string containing the assembly version number

Declaration

public string GetAssemblyVersion(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String

GetAvailableVersionsFromDownloadServer()

Returns a sorted list of available versions from a download server.

Declaration

public string[] GetAvailableVersionsFromDownloadServer()

Returns

Type	Description
System.String[]	Sorted array of available versions.

GetAvailableVersionsFromDownloadServer(String)

Returns a sorted list of available versions from a download server.

Declaration

public string[] GetAvailableVersionsFromDownloadServer(string CustomServerFilePath)

Parameters

Type	Name	Description
System.String	CustomServerFilePath	Will allow you to use your own hosting server as an http or ftp file path to download. When left blank the OAS download server will be used.

Returns

Type	Description
System.String[]	Sorted array of available versions.

GetAvailableVersionsFromDownloadServer(String, String, String)

Returns a sorted list of available versions from a download server.

Declaration

public string[] GetAvailableVersionsFromDownloadServer(string CustomServerFilePath, string FTPUser, string FTPPassword)

Parameters

Type	Name	Description
System.String	CustomServerFilePath	Will allow you to use your own hosting server as an http or ftp file path to download. When left blank the OAS download server will be used.
System.String	FTPUser	The user for your own download server when using ftp.
System.String	FTPPassword	The password for your own download server when using ftp.

Returns

Type	Description
System.String[]	Sorted array of available versions.

GetClientUsers()

Declaration

public string[] GetClientUsers()

Returns

Type	Description
System.String[]

GetClientUsers(String)

Declaration

public string[] GetClientUsers(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetClientUsers(String, ref String)

Declaration

public string[] GetClientUsers(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetClientUsers(String, ref String, String)

Declaration

public string[] GetClientUsers(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetCustomObjectNames()

Gets the list of names defined as custom objects in the service

Declaration

public string[] GetCustomObjectNames()

Returns

Type	Description
System.String[]	The list of object names An empty string array will be returned if the server cannot be reached

GetCustomObjectNames(String)

Gets the list of names defined as custom objects in the service

Declaration

public string[] GetCustomObjectNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	The list of object names An empty string array will be returned if the server cannot be reached

GetCustomObjectNames(String, ref String)

Gets the list of names defined as custom objects in the service

Declaration

public string[] GetCustomObjectNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	The list of object names An empty string array will be returned if the server cannot be reached

GetCustomObjectNames(String, ref String, String)

Gets the list of names defined as custom objects in the service

Declaration

public string[] GetCustomObjectNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	The list of object names An empty string array will be returned if the server cannot be reached

GetCustomObjectValue(String)

Gets the value for the custom object name that is previously stored with the CustomObjectSetValue

Declaration

public object GetCustomObjectValue(string ObjectName)

Parameters

Type	Name	Description
System.String	ObjectName

Returns

Type	Description
System.Object	The object value Returns null if object does not exist

GetCustomObjectValue(String, String)

Gets the value for the custom object name that is previously stored with the CustomObjectSetValue

Declaration

public object GetCustomObjectValue(string ObjectName, string NetworkNode)

Parameters

Type	Name	Description
System.String	ObjectName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object	The object value Returns null if object does not exist

GetCustomObjectValue(String, String, ref String)

Gets the value for the custom object name that is previously stored with the CustomObjectSetValue

Declaration

public object GetCustomObjectValue(string ObjectName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ObjectName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object	The object value Returns null if object does not exist

GetCustomObjectValue(String, String, ref String, String)

Gets the value for the custom object name that is previously stored with the CustomObjectSetValue

Declaration

public object GetCustomObjectValue(string ObjectName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ObjectName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object	The object value Returns null if object does not exist

GetDatabaseData(Config.DBProviderTypes, String, String, String, Boolean, String, String, String[], Config.FieldDataTypes[], Boolean, String, DateTime, DateTime, String)

Returns a DataTable of values from the local or remote service by obtaining database values where the service is running.

Declaration

public DataTable GetDatabaseData(Config.DBProviderTypes DBProvider, string DBServer, string Database, string TableOrView, bool MSSQLWindowsAuthentication, string DBUser, string DBPassword, string[] FieldNames, Config.FieldDataTypes[] DataTypes, bool UseDates, string DateTimeFieldName, DateTime StartDate, DateTime EndDate, string QueryString)

Parameters

Type	Name	Description
Config.DBProviderTypes	DBProvider	database provider type to use
System.String	DBServer	database server to connect
System.String	Database	name of the database
System.String	TableOrView	name of the table
System.Boolean	MSSQLWindowsAuthentication	use Windows authentication for security
System.String	DBUser	database user - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String	DBPassword	database password - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String[]	FieldNames	list of columns to return from the database table
Config.FieldDataTypes[]	DataTypes	list of data types mapped to fields
System.Boolean	UseDates	use StartDate and EndDate for filtering when set to true
System.String	DateTimeFieldName	field to use for filtering StartDate and EndDate
System.DateTime	StartDate	used for filtering by date when UseDates set to true
System.DateTime	EndDate	used for filtering by date when UseDates set to true
System.String	QueryString	additional WHERE clause to use for filtering records

Returns

Type	Description
System.Data.DataTable	DataTable containing records that match filtering criteria

GetDatabaseData(Config.DBProviderTypes, String, String, String, Boolean, String, String, String[], Config.FieldDataTypes[], Boolean, String, DateTime, DateTime, String, String)

Returns a DataTable of values from the local or remote service by obtaining database values where the service is running.

Declaration

public DataTable GetDatabaseData(Config.DBProviderTypes DBProvider, string DBServer, string Database, string TableOrView, bool MSSQLWindowsAuthentication, string DBUser, string DBPassword, string[] FieldNames, Config.FieldDataTypes[] DataTypes, bool UseDates, string DateTimeFieldName, DateTime StartDate, DateTime EndDate, string QueryString, string NetworkNode)

Parameters

Type	Name	Description
Config.DBProviderTypes	DBProvider	database provider type to use
System.String	DBServer	database server to connect
System.String	Database	name of the database
System.String	TableOrView	name of the table
System.Boolean	MSSQLWindowsAuthentication	use Windows authentication for security
System.String	DBUser	database user - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String	DBPassword	database password - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String[]	FieldNames	list of columns to return from the database table
Config.FieldDataTypes[]	DataTypes	list of data types mapped to fields
System.Boolean	UseDates	use StartDate and EndDate for filtering when set to true
System.String	DateTimeFieldName	field to use for filtering StartDate and EndDate
System.DateTime	StartDate	used for filtering by date when UseDates set to true
System.DateTime	EndDate	used for filtering by date when UseDates set to true
System.String	QueryString	additional WHERE clause to use for filtering records
System.String	NetworkNode	the network node of the OAS service to connect - leave blank or null for localhost

Returns

Type	Description
System.Data.DataTable	DataTable containing records that match filtering criteria

GetDatabaseData(Config.DBProviderTypes, String, String, String, Boolean, String, String, String[], Config.FieldDataTypes[], Boolean, String, DateTime, DateTime, String, String, ref String)

Returns a DataTable of values from the local or remote service by obtaining database values where the service is running.

Declaration

public DataTable GetDatabaseData(Config.DBProviderTypes DBProvider, string DBServer, string Database, string TableOrView, bool MSSQLWindowsAuthentication, string DBUser, string DBPassword, string[] FieldNames, Config.FieldDataTypes[] DataTypes, bool UseDates, string DateTimeFieldName, DateTime StartDate, DateTime EndDate, string QueryString, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
Config.DBProviderTypes	DBProvider	database provider type to use
System.String	DBServer	database server to connect
System.String	Database	name of the database
System.String	TableOrView	name of the table
System.Boolean	MSSQLWindowsAuthentication	use Windows authentication for security
System.String	DBUser	database user - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String	DBPassword	database password - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String[]	FieldNames	list of columns to return from the database table
Config.FieldDataTypes[]	DataTypes	list of data types mapped to fields
System.Boolean	UseDates	use StartDate and EndDate for filtering when set to true
System.String	DateTimeFieldName	field to use for filtering StartDate and EndDate
System.DateTime	StartDate	used for filtering by date when UseDates set to true
System.DateTime	EndDate	used for filtering by date when UseDates set to true
System.String	QueryString	additional WHERE clause to use for filtering records
System.String	NetworkNode	the network node of the OAS service to connect - leave blank or null for localhost
System.String	ErrorString	Success when complete, or Error when not successful

Returns

Type	Description
System.Data.DataTable	DataTable containing records that match filtering criteria

GetDatabaseData(Config.DBProviderTypes, String, String, String, Boolean, String, String, String[], Config.FieldDataTypes[], Boolean, String, DateTime, DateTime, String, String, ref String, String)

Returns a DataTable of values from the local or remote service by obtaining database values where the service is running.

Declaration

public DataTable GetDatabaseData(Config.DBProviderTypes DBProvider, string DBServer, string Database, string TableOrView, bool MSSQLWindowsAuthentication, string DBUser, string DBPassword, string[] FieldNames, Config.FieldDataTypes[] DataTypes, bool UseDates, string DateTimeFieldName, DateTime StartDate, DateTime EndDate, string QueryString, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
Config.DBProviderTypes	DBProvider	database provider type to use
System.String	DBServer	database server to connect
System.String	Database	name of the database
System.String	TableOrView	name of the table
System.Boolean	MSSQLWindowsAuthentication	use Windows authentication for security
System.String	DBUser	database user - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String	DBPassword	database password - not applicable if using SQL Server and MSSQLWindowsAuthentication is set to true
System.String[]	FieldNames	list of columns to return from the database table
Config.FieldDataTypes[]	DataTypes	list of data types mapped to fields
System.Boolean	UseDates	use StartDate and EndDate for filtering when set to true
System.String	DateTimeFieldName	field to use for filtering StartDate and EndDate
System.DateTime	StartDate	used for filtering by date when UseDates set to true
System.DateTime	EndDate	used for filtering by date when UseDates set to true
System.String	QueryString	additional WHERE clause to use for filtering records
System.String	NetworkNode	the network node of the OAS service to connect - leave blank or null for localhost
System.String	ErrorString	Success when complete, or Error when not successful
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to pull data from

Returns

Type	Description
System.Data.DataTable	DataTable containing records that match filtering criteria

GetDataLogging_Parameter_Value(String, String)

Declaration

public object GetDataLogging_Parameter_Value(string Parameter, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group

Returns

Type	Description
System.Object

GetDataLogging_Parameter_Value(String, String, String)

Declaration

public object GetDataLogging_Parameter_Value(string Parameter, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetDataLogging_Parameter_Value(String, String, String, ref String)

Declaration

public object GetDataLogging_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetDataLogging_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetDataLogging_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetDataLogging_Parameter_Values(String)

Declaration

public object[] GetDataLogging_Parameter_Values(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Object[]

GetDataLogging_Parameter_Values(String, String)

Declaration

public object[] GetDataLogging_Parameter_Values(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetDataLogging_Parameter_Values(String, String, ref String)

Declaration

public object[] GetDataLogging_Parameter_Values(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetDataLogging_Parameter_Values(String, String, ref String, String)

Declaration

public object[] GetDataLogging_Parameter_Values(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetDataLoggingNames()

Declaration

public string[] GetDataLoggingNames()

Returns

Type	Description
System.String[]

GetDataLoggingNames(String)

Declaration

public string[] GetDataLoggingNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetDataLoggingNames(String, ref String)

Declaration

public string[] GetDataLoggingNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetDataLoggingNames(String, ref String, String)

Declaration

public string[] GetDataLoggingNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetDataLoggingParameterStrings()

Declaration

public string[] GetDataLoggingParameterStrings()

Returns

Type	Description
System.String[]

GetDataLoggingParameterStrings(String)

Declaration

public string[] GetDataLoggingParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetDataLoggingParameterStrings(String, String)

Declaration

public string[] GetDataLoggingParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetDriverInterface_Parameter_Value(String, String)

Declaration

public object GetDriverInterface_Parameter_Value(string Parameter, string Name)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Name

Returns

Type	Description
System.Object

GetDriverInterface_Parameter_Value(String, String, String)

Declaration

public object GetDriverInterface_Parameter_Value(string Parameter, string Name, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetDriverInterface_Parameter_Value(String, String, String, ref String)

Declaration

public object GetDriverInterface_Parameter_Value(string Parameter, string Name, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetDriverInterface_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetDriverInterface_Parameter_Value(string Parameter, string Name, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetDriverInterface_Parameter_Values(String)

Declaration

public object[] GetDriverInterface_Parameter_Values(string Name)

Parameters

Type	Name	Description
System.String	Name

Returns

Type	Description
System.Object[]

GetDriverInterface_Parameter_Values(String, String)

Declaration

public object[] GetDriverInterface_Parameter_Values(string Name, string NetworkNode)

Parameters

Type	Name	Description
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetDriverInterface_Parameter_Values(String, String, ref String)

Declaration

public object[] GetDriverInterface_Parameter_Values(string Name, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetDriverInterface_Parameter_Values(String, String, ref String, String)

Declaration

public object[] GetDriverInterface_Parameter_Values(string Name, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetDriverInterfaceNames()

Declaration

public string[] GetDriverInterfaceNames()

Returns

Type	Description
System.String[]

GetDriverInterfaceNames(String)

Declaration

public string[] GetDriverInterfaceNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetDriverInterfaceNames(String, ref String)

Declaration

public string[] GetDriverInterfaceNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetDriverInterfaceNames(String, ref String, String)

Declaration

public string[] GetDriverInterfaceNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetDriverInterfaceParameterStrings()

Declaration

public string[] GetDriverInterfaceParameterStrings()

Returns

Type	Description
System.String[]

GetDriverInterfaceParameterStrings(String)

Declaration

public string[] GetDriverInterfaceParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetDriverInterfaceParameterStrings(String, String)

Declaration

public string[] GetDriverInterfaceParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetFullyLicensed()

Gets the license status of an OAS Service

Declaration

public int GetFullyLicensed()

Returns

Type	Description
System.Int32	-1 if service is not reachable 0 if the service is not yet fully licensed, running in demo mode or disabled 1 if the service has been licensed

GetFullyLicensed(String)

Gets the license status of an OAS Service

Declaration

public int GetFullyLicensed(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32	-1 if service is not reachable 0 if the service is not yet fully licensed, running in demo mode or disabled 1 if the service has been licensed

GetFullyLicensed(String, String)

Gets the license status of an OAS Service

Declaration

public int GetFullyLicensed(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32	-1 if service is not reachable 0 if the service is not yet fully licensed, running in demo mode or disabled 1 if the service has been licensed

GetGroupNames()

Declaration

public string[] GetGroupNames()

Returns

Type	Description
System.String[]

GetGroupNames(String)

Declaration

public string[] GetGroupNames(string ReferenceGroup)

Parameters

Type	Name	Description
System.String	ReferenceGroup

Returns

Type	Description
System.String[]

GetGroupNames(String, String)

Declaration

public string[] GetGroupNames(string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetGroupNames(String, String, ref String)

Declaration

public string[] GetGroupNames(string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetGroupNames(String, String, ref String, String)

Declaration

public string[] GetGroupNames(string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetHistoryTagNames(String)

Declaration

public string[] GetHistoryTagNames(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.String[]

GetHistoryTagNames(String, String)

Declaration

public string[] GetHistoryTagNames(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetHistoryTagNames(String, String, ref String)

Declaration

public string[] GetHistoryTagNames(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetHistoryTagNames(String, String, ref String, String)

Declaration

public string[] GetHistoryTagNames(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetHistoryTagNamesFromTagName(String)

Declaration

public string[] GetHistoryTagNamesFromTagName(string TagName)

Parameters

Type	Name	Description
System.String	TagName

Returns

Type	Description
System.String[]

GetHistoryTagNamesFromTagName(String, String)

Declaration

public string[] GetHistoryTagNamesFromTagName(string TagName, string NetworkNode)

Parameters

Type	Name	Description
System.String	TagName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetHistoryTagNamesFromTagName(String, String, ref String)

Declaration

public string[] GetHistoryTagNamesFromTagName(string TagName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	TagName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetHistoryTagNamesFromTagName(String, String, ref String, String)

Declaration

public string[] GetHistoryTagNamesFromTagName(string TagName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	TagName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetLicenseString()

Returns a string of the OAS Service license

Declaration

public string GetLicenseString()

Returns

Type	Description
System.String	License string, or "OAS Service Not Reachable" if unable to connect

GetLicenseString(String)

Returns a string of the OAS Service license

Declaration

public string GetLicenseString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	License string, or "OAS Service Not Reachable" if unable to connect

GetLicenseString(String, String)

Returns a string of the OAS Service license

Declaration

public string GetLicenseString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	License string, or "OAS Service Not Reachable" if unable to connect

GetListOfAEOPCServers()

Declaration

public string[] GetListOfAEOPCServers()

Returns

Type	Description
System.String[]

GetListOfAEOPCServers(String)

Declaration

public string[] GetListOfAEOPCServers(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetListOfAEOPCServers(String, ref String)

Declaration

public string[] GetListOfAEOPCServers(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetListOfAEOPCServers(String, ref String, String)

Declaration

public string[] GetListOfAEOPCServers(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetListOfDirectories(String, Boolean)

Declaration

public string[] GetListOfDirectories(string DirectoryPath, bool ReturnFullPath)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the sub directories from. Set as blank to return the drives from the root. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.Boolean	ReturnFullPath	when set to true will return the full directory path for each directory returned. When set to false only the sub directory name will be returned.

Returns

Type	Description
System.String[]

GetListOfDirectories(String, Boolean, String)

Declaration

public string[] GetListOfDirectories(string DirectoryPath, bool ReturnFullPath, string NetworkNode)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the sub directories from. Set as blank to return the drives from the root. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.Boolean	ReturnFullPath	when set to true will return the full directory path for each directory returned. When set to false only the sub directory name will be returned.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetListOfDirectories(String, Boolean, String, ref String)

Declaration

public string[] GetListOfDirectories(string DirectoryPath, bool ReturnFullPath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the sub directories from. Set as blank to return the drives from the root. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.Boolean	ReturnFullPath	when set to true will return the full directory path for each directory returned. When set to false only the sub directory name will be returned.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetListOfDirectories(String, Boolean, String, ref String, String)

Declaration

public string[] GetListOfDirectories(string DirectoryPath, bool ReturnFullPath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the sub directories from. Set as blank to return the drives from the root. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.Boolean	ReturnFullPath	when set to true will return the full directory path for each directory returned. When set to false only the sub directory name will be returned.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetListOfFiles(String, String, Boolean)

Declaration

public string[] GetListOfFiles(string DirectoryPath, string FileExtension, bool ReturnFullPath)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the files from. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.String	FileExtension	a string containing the extension to filter files upon. Use * to return all files.
System.Boolean	ReturnFullPath	when set to true will return the full file path for each file name. When set to false only the file names without the full directory path will be returned.

Returns

Type	Description
System.String[]

GetListOfFiles(String, String, Boolean, String)

Declaration

public string[] GetListOfFiles(string DirectoryPath, string FileExtension, bool ReturnFullPath, string NetworkNode)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the files from. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.String	FileExtension	a string containing the extension to filter files upon. Use * to return all files.
System.Boolean	ReturnFullPath	when set to true will return the full file path for each file name. When set to false only the file names without the full directory path will be returned.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetListOfFiles(String, String, Boolean, String, ref String)

Declaration

public string[] GetListOfFiles(string DirectoryPath, string FileExtension, bool ReturnFullPath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the files from. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.String	FileExtension	a string containing the extension to filter files upon. Use * to return all files.
System.Boolean	ReturnFullPath	when set to true will return the full file path for each file name. When set to false only the file names without the full directory path will be returned.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetListOfFiles(String, String, Boolean, String, ref String, String)

Declaration

public string[] GetListOfFiles(string DirectoryPath, string FileExtension, bool ReturnFullPath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	DirectoryPath	a string containing the directory path to return the files from. The DirectoryPath should end with a directory seperator character for the operating system. \ for Windows / for Linux.
System.String	FileExtension	a string containing the extension to filter files upon. Use * to return all files.
System.Boolean	ReturnFullPath	when set to true will return the full file path for each file name. When set to false only the file names without the full directory path will be returned.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetListOfOPCServers()

Declaration

public string[] GetListOfOPCServers()

Returns

Type	Description
System.String[]

GetListOfOPCServers(String)

Declaration

public string[] GetListOfOPCServers(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetListOfOPCServers(String, ref String)

Declaration

public string[] GetListOfOPCServers(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetListOfOPCServers(String, ref String, String)

Declaration

public string[] GetListOfOPCServers(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetLiveDataCloudNodesConnected()

Declaration

public string[] GetLiveDataCloudNodesConnected()

Returns

Type	Description
System.String[]

GetLiveDataCloudNodesConnected(String)

Declaration

public string[] GetLiveDataCloudNodesConnected(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetLiveDataCloudNodesConnected(String, ref String)

Declaration

public string[] GetLiveDataCloudNodesConnected(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetMaintenanceExpiration()

Gets the maintenance expiration date within the service.
Please note that the actual maintenance expiration is retained by the company records of Open Automation Software and the value returned may be out of date.

Declaration

public string GetMaintenanceExpiration()

Returns

Type	Description
System.String	Expiration date

GetMaintenanceExpiration(String)

Declaration

public string GetMaintenanceExpiration(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Expiration date

GetMaintenanceExpiration(String, ref String)

Declaration

public string GetMaintenanceExpiration(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Expiration date

GetMaintenanceExpiration(String, ref String, String)

Declaration

public string GetMaintenanceExpiration(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Expiration date

GetNumberOfTagsAllowed()

Gets the number of tags allowed in the license.

Declaration

public int GetNumberOfTagsAllowed()

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of tags allowed

GetNumberOfTagsAllowed(String)

Gets the number of tags allowed in the license.

Declaration

public int GetNumberOfTagsAllowed(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of tags allowed

GetNumberOfTagsAllowed(String, ref String)

Gets the number of tags allowed in the license.

Declaration

public int GetNumberOfTagsAllowed(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of tags allowed

GetNumberOfTagsAllowed(String, ref String, String)

Gets the number of tags allowed in the license.

Declaration

public int GetNumberOfTagsAllowed(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of tags allowed

GetNumberOfTagsUsed()

Returns the number of tags, direct OPC items, and array elements in use

Declaration

public int GetNumberOfTagsUsed()

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of items in use

GetNumberOfTagsUsed(String)

Returns the number of tags, direct OPC items, and array elements in use

Declaration

public int GetNumberOfTagsUsed(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of items in use

GetNumberOfTagsUsed(String, ref String)

Returns the number of tags, direct OPC items, and array elements in use

Declaration

public int GetNumberOfTagsUsed(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of items in use

GetNumberOfTagsUsed(String, ref String, String)

Returns the number of tags, direct OPC items, and array elements in use

Declaration

public int GetNumberOfTagsUsed(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32	0 if the service is unreachable positive integer is total number of items in use

GetOEMCode()

Gets the current OEM Code

Declaration

public string GetOEMCode()

Returns

Type	Description
System.String	a string containing the OEM Code

GetOEMCode(String)

Gets the current OEM Code

Declaration

public string GetOEMCode(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	a string containing the OEM Code

GetOEMCode(String, ref String)

Gets the current OEM Code

Declaration

public string GetOEMCode(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	a string containing the OEM Code

GetOEMCode(String, ref String, String)

Gets the current OEM Code

Declaration

public string GetOEMCode(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	a string containing the OEM Code

GetOPCBranches(String, String)

Declaration

public string[] GetOPCBranches(string OPCServer, string ReferencePath)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath

Returns

Type	Description
System.String[]

GetOPCBranches(String, String, String)

Declaration

public string[] GetOPCBranches(string OPCServer, string ReferencePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetOPCBranches(String, String, String, ref String)

Declaration

public string[] GetOPCBranches(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetOPCBranches(String, String, String, ref String, String)

Declaration

public string[] GetOPCBranches(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetOPCBranchesWithDisplayNames(String, String)

Declaration

public string[] GetOPCBranchesWithDisplayNames(string OPCServer, string ReferencePath)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath

Returns

Type	Description
System.String[]

GetOPCBranchesWithDisplayNames(String, String, String)

Declaration

public string[] GetOPCBranchesWithDisplayNames(string OPCServer, string ReferencePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetOPCBranchesWithDisplayNames(String, String, String, ref String)

Declaration

public string[] GetOPCBranchesWithDisplayNames(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetOPCBranchesWithDisplayNames(String, String, String, ref String, String)

Declaration

public string[] GetOPCBranchesWithDisplayNames(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetOPCItemProperties(String, Boolean, Boolean, Boolean, Boolean, Boolean)

Declaration

public object[] GetOPCItemProperties(string OPCItem, bool ReturnDataType, bool ReturnScanRate, bool ReturnDescription, bool ReturnUnits, bool ReturnEnumeratedValue)

Parameters

Type	Name	Description
System.String	OPCItem
System.Boolean	ReturnDataType
System.Boolean	ReturnScanRate
System.Boolean	ReturnDescription
System.Boolean	ReturnUnits
System.Boolean	ReturnEnumeratedValue

Returns

Type	Description
System.Object[]

GetOPCItemProperties(String, Boolean, Boolean, Boolean, Boolean, Boolean, String)

Declaration

public object[] GetOPCItemProperties(string OPCItem, bool ReturnDataType, bool ReturnScanRate, bool ReturnDescription, bool ReturnUnits, bool ReturnEnumeratedValue, string NetworkNode)

Parameters

Type	Name	Description
System.String	OPCItem
System.Boolean	ReturnDataType
System.Boolean	ReturnScanRate
System.Boolean	ReturnDescription
System.Boolean	ReturnUnits
System.Boolean	ReturnEnumeratedValue
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetOPCItemProperties(String, Boolean, Boolean, Boolean, Boolean, Boolean, String, ref String)

Declaration

public object[] GetOPCItemProperties(string OPCItem, bool ReturnDataType, bool ReturnScanRate, bool ReturnDescription, bool ReturnUnits, bool ReturnEnumeratedValue, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OPCItem
System.Boolean	ReturnDataType
System.Boolean	ReturnScanRate
System.Boolean	ReturnDescription
System.Boolean	ReturnUnits
System.Boolean	ReturnEnumeratedValue
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetOPCItemProperties(String, Boolean, Boolean, Boolean, Boolean, Boolean, String, ref String, String)

Declaration

public object[] GetOPCItemProperties(string OPCItem, bool ReturnDataType, bool ReturnScanRate, bool ReturnDescription, bool ReturnUnits, bool ReturnEnumeratedValue, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OPCItem
System.Boolean	ReturnDataType
System.Boolean	ReturnScanRate
System.Boolean	ReturnDescription
System.Boolean	ReturnUnits
System.Boolean	ReturnEnumeratedValue
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetOPCItems(String, String)

Declaration

public string[] GetOPCItems(string OPCServer, string ReferencePath)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath

Returns

Type	Description
System.String[]

GetOPCItems(String, String, String)

Declaration

public string[] GetOPCItems(string OPCServer, string ReferencePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetOPCItems(String, String, String, ref String)

Declaration

public string[] GetOPCItems(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetOPCItems(String, String, String, ref String, String)

Declaration

public string[] GetOPCItems(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetOPCItemsAll(String, String)

Declaration

public string[] GetOPCItemsAll(string OPCServer, string ReferencePath)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath

Returns

Type	Description
System.String[]

GetOPCItemsAll(String, String, String)

Declaration

public string[] GetOPCItemsAll(string OPCServer, string ReferencePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetOPCItemsAll(String, String, String, ref String)

Declaration

public string[] GetOPCItemsAll(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetOPCItemsAll(String, String, String, ref String, String)

Declaration

public string[] GetOPCItemsAll(string OPCServer, string ReferencePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OPCServer
System.String	ReferencePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetOption(String)

Declaration

public object GetOption(string OptionName)

Parameters

Type	Name	Description
System.String	OptionName	Name of the option to return. The name can be found in the header of the CSV Export

Returns

Type	Description
System.Object

GetOption(String, String)

Declaration

public object GetOption(string OptionName, string NetworkNode)

Parameters

Type	Name	Description
System.String	OptionName	Name of the option to return. The name can be found in the header of the CSV Export
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetOption(String, String, ref String)

Declaration

public object GetOption(string OptionName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OptionName	Name of the option to return. The name can be found in the header of the CSV Export
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetOption(String, String, ref String, String)

Declaration

public object GetOption(string OptionName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OptionName	Name of the option to return. The name can be found in the header of the CSV Export
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetOptions(Boolean)

Declaration

public object[] GetOptions(bool ReturnValuesAsCSVStrings)

Parameters

Type	Name	Description
System.Boolean	ReturnValuesAsCSVStrings	When set to true 2 strings are returned for header column names and values. When false 2 arrays are returned, the first a string array with the option names, the second an object array containing the option values

Returns

Type	Description
System.Object[]

GetOptions(Boolean, String)

Declaration

public object[] GetOptions(bool ReturnValuesAsCSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.Boolean	ReturnValuesAsCSVStrings	When set to true 2 strings are returned for header column names and values. When false 2 arrays are returned, the first a string array with the option names, the second an object array containing the option values
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetOptions(Boolean, String, ref String)

Declaration

public object[] GetOptions(bool ReturnValuesAsCSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.Boolean	ReturnValuesAsCSVStrings	When set to true 2 strings are returned for header column names and values. When false 2 arrays are returned, the first a string array with the option names, the second an object array containing the option values
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetOptions(Boolean, String, ref String, String)

Declaration

public object[] GetOptions(bool ReturnValuesAsCSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.Boolean	ReturnValuesAsCSVStrings	When set to true 2 strings are returned for header column names and values. When false 2 arrays are returned, the first a string array with the option names, the second an object array containing the option values
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetParameter_Property_Strings()

Declaration

public string[] GetParameter_Property_Strings()

Returns

Type	Description
System.String[]

GetParameter_Property_Strings(String)

Declaration

public string[] GetParameter_Property_Strings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetParameter_Property_Strings(String, String)

Declaration

public string[] GetParameter_Property_Strings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetProductVersion()

Returns the installed product version from the OAS Engine.

Declaration

public string GetProductVersion()

Returns

Type	Description
System.String	Product version in the format of 00.00.0000 if successful. Returns Error - if unsuccesful.

GetProductVersion(String)

Returns the installed product version from the OAS Engine.

Declaration

public string GetProductVersion(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

Returns

Type	Description
System.String	Product version in the format of 00.00.0000 if successful. Returns Error - if unsuccesful.

GetProductVersion(String, String)

Returns the installed product version from the OAS Engine.

Declaration

public string GetProductVersion(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
System.String	RemoteSCADAHostingName	The name of the Live Data Cloud OAS Service to connect to.

Returns

Type	Description
System.String	Product version in the format of 00.00.0000 if successful. Returns Error - if unsuccesful.

GetRecipe_Parameter_Value(String, String)

Declaration

public object GetRecipe_Parameter_Value(string Parameter, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group

Returns

Type	Description
System.Object

GetRecipe_Parameter_Value(String, String, String)

Declaration

public object GetRecipe_Parameter_Value(string Parameter, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetRecipe_Parameter_Value(String, String, String, ref String)

Declaration

public object GetRecipe_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetRecipe_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetRecipe_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetRecipe_Parameter_Values(String)

Declaration

public object[] GetRecipe_Parameter_Values(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Object[]

GetRecipe_Parameter_Values(String, String)

Declaration

public object[] GetRecipe_Parameter_Values(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetRecipe_Parameter_Values(String, String, ref String)

Declaration

public object[] GetRecipe_Parameter_Values(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetRecipe_Parameter_Values(String, String, ref String, String)

Declaration

public object[] GetRecipe_Parameter_Values(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetRecipeNames()

Declaration

public string[] GetRecipeNames()

Returns

Type	Description
System.String[]

GetRecipeNames(String)

Declaration

public string[] GetRecipeNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetRecipeNames(String, ref String)

Declaration

public string[] GetRecipeNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetRecipeNames(String, ref String, String)

Declaration

public string[] GetRecipeNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetRecipeParameterStrings()

Declaration

public string[] GetRecipeParameterStrings()

Returns

Type	Description
System.String[]

GetRecipeParameterStrings(String)

Declaration

public string[] GetRecipeParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetRecipeParameterStrings(String, String)

Declaration

public string[] GetRecipeParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetReport_Parameter_Value(String, String)

Declaration

public object GetReport_Parameter_Value(string Parameter, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group

Returns

Type	Description
System.Object

GetReport_Parameter_Value(String, String, String)

Declaration

public object GetReport_Parameter_Value(string Parameter, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetReport_Parameter_Value(String, String, String, ref String)

Declaration

public object GetReport_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetReport_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetReport_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetReport_Parameter_Values(String)

Declaration

public object[] GetReport_Parameter_Values(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Object[]

GetReport_Parameter_Values(String, String)

Declaration

public object[] GetReport_Parameter_Values(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetReport_Parameter_Values(String, String, ref String)

Declaration

public object[] GetReport_Parameter_Values(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetReportNames()

Declaration

public string[] GetReportNames()

Returns

Type	Description
System.String[]

GetReportNames(String)

Declaration

public string[] GetReportNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetReportNames(String, ref String)

Declaration

public string[] GetReportNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetReportNames(String, ref String, String)

Declaration

public string[] GetReportNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetReportParameterStrings()

Declaration

public string[] GetReportParameterStrings()

Returns

Type	Description
System.String[]

GetReportParameterStrings(String)

Declaration

public string[] GetReportParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetReportParameterStrings(String, String)

Declaration

public string[] GetReportParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetSecurity_Parameter_Value(String, String)

Declaration

public object GetSecurity_Parameter_Value(string Parameter, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group

Returns

Type	Description
System.Object

GetSecurity_Parameter_Value(String, String, String)

Declaration

public object GetSecurity_Parameter_Value(string Parameter, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetSecurity_Parameter_Value(String, String, String, ref String)

Declaration

public object GetSecurity_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetSecurity_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetSecurity_Parameter_Value(string Parameter, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetSecurity_Parameter_Values(String)

Declaration

public object[] GetSecurity_Parameter_Values(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Object[]

GetSecurity_Parameter_Values(String, String)

Declaration

public object[] GetSecurity_Parameter_Values(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetSecurity_Parameter_Values(String, String, ref String)

Declaration

public object[] GetSecurity_Parameter_Values(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetSecurity_Parameter_Values(String, String, ref String, String)

Declaration

public object[] GetSecurity_Parameter_Values(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetSecurityGroupNames()

Declaration

public string[] GetSecurityGroupNames()

Returns

Type	Description
System.String[]

GetSecurityGroupNames(String)

Declaration

public string[] GetSecurityGroupNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetSecurityGroupNames(String, ref String)

Declaration

public string[] GetSecurityGroupNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetSecurityGroupNames(String, ref String, String)

Declaration

public string[] GetSecurityGroupNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetSecurityParameterStrings()

Declaration

public string[] GetSecurityParameterStrings()

Returns

Type	Description
System.String[]

GetSecurityParameterStrings(String)

Declaration

public string[] GetSecurityParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetSecurityParameterStrings(String, String)

Declaration

public string[] GetSecurityParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetSecurityUser_Parameter_Value(String, String)

Declaration

public object GetSecurityUser_Parameter_Value(string Parameter, string UserName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	UserName

Returns

Type	Description
System.Object

GetSecurityUser_Parameter_Value(String, String, String)

Declaration

public object GetSecurityUser_Parameter_Value(string Parameter, string UserName, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetSecurityUser_Parameter_Value(String, String, String, ref String)

Declaration

public object GetSecurityUser_Parameter_Value(string Parameter, string UserName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetSecurityUser_Parameter_Value(String, String, String, ref String, String)

Declaration

public object GetSecurityUser_Parameter_Value(string Parameter, string UserName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetSecurityUser_Parameter_Values(String)

Declaration

public object[] GetSecurityUser_Parameter_Values(string UserName)

Parameters

Type	Name	Description
System.String	UserName

Returns

Type	Description
System.Object[]

GetSecurityUser_Parameter_Values(String, String)

Declaration

public object[] GetSecurityUser_Parameter_Values(string UserName, string NetworkNode)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetSecurityUser_Parameter_Values(String, String, ref String)

Declaration

public object[] GetSecurityUser_Parameter_Values(string UserName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetSecurityUser_Parameter_Values(String, String, ref String, String)

Declaration

public object[] GetSecurityUser_Parameter_Values(string UserName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetSecurityUserNames()

Declaration

public string[] GetSecurityUserNames()

Returns

Type	Description
System.String[]

GetSecurityUserNames(String)

Declaration

public string[] GetSecurityUserNames(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetSecurityUserNames(String, ref String)

Declaration

public string[] GetSecurityUserNames(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetSecurityUserNames(String, ref String, String)

Declaration

public string[] GetSecurityUserNames(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetSecurityUserParameterStrings()

Declaration

public string[] GetSecurityUserParameterStrings()

Returns

Type	Description
System.String[]

GetSecurityUserParameterStrings(String)

Declaration

public string[] GetSecurityUserParameterStrings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetSecurityUserParameterStrings(String, String)

Declaration

public string[] GetSecurityUserParameterStrings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetServiceVersion()

Returns the installed service version from the OAS Engine.

Declaration

public string GetServiceVersion()

Returns

Type	Description
System.String	Product version in the format of 0.0.0.0 if successful. Returns Error - if unsuccesful.

GetServiceVersion(String)

Returns the installed service version from the OAS Engine.

Declaration

public string GetServiceVersion(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

Returns

Type	Description
System.String	Product version in the format of 0.0.0.0 if successful. Returns Error - if unsuccesful.

GetServiceVersion(String, String)

Returns the installed service version from the OAS Engine.

Declaration

public string GetServiceVersion(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
System.String	RemoteSCADAHostingName	The name of the Live Data Cloud OAS Service to connect to.

Returns

Type	Description
System.String	Product version in the format of 0.0.0.0 if successful. Returns Error - if unsuccesful.

GetSystemErrors(String, String, String, ref Boolean[])

Declaration

public string[] GetSystemErrors(string SystemType, string Group, string Category, ref bool[] CurrentlyInError)

Parameters

Type	Name	Description
System.String	SystemType
System.String	Group
System.String	Category
System.Boolean[]	CurrentlyInError

Returns

Type	Description
System.String[]

GetSystemErrors(String, String, String, ref Boolean[], String)

Declaration

public string[] GetSystemErrors(string SystemType, string Group, string Category, ref bool[] CurrentlyInError, string NetworkNode)

Parameters

Type	Name	Description
System.String	SystemType
System.String	Group
System.String	Category
System.Boolean[]	CurrentlyInError
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetSystemErrors(String, String, String, ref Boolean[], String, ref String)

Declaration

public string[] GetSystemErrors(string SystemType, string Group, string Category, ref bool[] CurrentlyInError, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	SystemType
System.String	Group
System.String	Category
System.Boolean[]	CurrentlyInError
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetSystemErrors(String, String, String, ref Boolean[], String, ref String, String)

Declaration

public string[] GetSystemErrors(string SystemType, string Group, string Category, ref bool[] CurrentlyInError, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	SystemType
System.String	Group
System.String	Category
System.Boolean[]	CurrentlyInError
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetSystemStatus()

Provides a list of system status messages

Declaration

public string[] GetSystemStatus()

Returns

Type	Description
System.String[]	array of strings containing system status information a 2-element array with Error in the first element indicates the service is unreachable

GetSystemStatus(String)

Provides a list of system status messages

Declaration

public string[] GetSystemStatus(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	array of strings containing system status information a 2-element array with Error in the first element indicates the service is unreachable

GetSystemStatus(String, ref String)

Provides a list of system status messages

Declaration

public string[] GetSystemStatus(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	array of strings containing system status information a 2-element array with Error in the first element indicates the service is unreachable

GetSystemStatus(String, ref String, String)

Provides a list of system status messages

Declaration

public string[] GetSystemStatus(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	array of strings containing system status information a 2-element array with Error in the first element indicates the service is unreachable

GetTag_Parameter_Names(String)

Declaration

public string[] GetTag_Parameter_Names(string TagName)

Parameters

Type	Name	Description
System.String	TagName

Returns

Type	Description
System.String[]

GetTag_Parameter_Names(String, String)

Declaration

public string[] GetTag_Parameter_Names(string TagName, string NetworkNode)

Parameters

Type	Name	Description
System.String	TagName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetTag_Parameter_Names(String, String, String)

Declaration

public string[] GetTag_Parameter_Names(string TagName, string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	TagName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetTag_Parameter_Strings()

Declaration

public string[] GetTag_Parameter_Strings()

Returns

Type	Description
System.String[]

GetTag_Parameter_Strings(String)

Declaration

public string[] GetTag_Parameter_Strings(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetTag_Parameter_Strings(String, String)

Declaration

public string[] GetTag_Parameter_Strings(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetTag_Parameter_Value(String, String, String)

Declaration

public object GetTag_Parameter_Value(string Parameter, string PropertyType, string TagName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.String	TagName

Returns

Type	Description
System.Object

GetTag_Parameter_Value(String, String, String, String)

Declaration

public object GetTag_Parameter_Value(string Parameter, string PropertyType, string TagName, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.String	TagName
System.String	ReferenceGroup

Returns

Type	Description
System.Object

GetTag_Parameter_Value(String, String, String, String, String)

Declaration

public object GetTag_Parameter_Value(string Parameter, string PropertyType, string TagName, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object

GetTag_Parameter_Value(String, String, String, String, String, ref String)

Declaration

public object GetTag_Parameter_Value(string Parameter, string PropertyType, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object

GetTag_Parameter_Value(String, String, String, String, String, ref String, String)

Declaration

public object GetTag_Parameter_Value(string Parameter, string PropertyType, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object

GetTag_Parameter_Values(String, String)

Declaration

public object[] GetTag_Parameter_Values(string Parameter, string TagName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	TagName

Returns

Type	Description
System.Object[]

GetTag_Parameter_Values(String, String, String)

Declaration

public object[] GetTag_Parameter_Values(string Parameter, string TagName, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	Parameter
System.String	TagName
System.String	ReferenceGroup

Returns

Type	Description
System.Object[]

GetTag_Parameter_Values(String, String, String, String)

Declaration

public object[] GetTag_Parameter_Values(string Parameter, string TagName, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetTag_Parameter_Values(String, String, String, String, ref String)

Declaration

public object[] GetTag_Parameter_Values(string Parameter, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetTag_Parameter_Values(String, String, String, String, ref String, String)

Declaration

public object[] GetTag_Parameter_Values(string Parameter, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetTagNames()

Declaration

public string[] GetTagNames()

Returns

Type	Description
System.String[]

GetTagNames(String)

Declaration

public string[] GetTagNames(string ReferenceGroup)

Parameters

Type	Name	Description
System.String	ReferenceGroup

Returns

Type	Description
System.String[]

GetTagNames(String, String)

Declaration

public string[] GetTagNames(string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetTagNames(String, String, ref String)

Declaration

public string[] GetTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetTagNames(String, String, ref String, String)

Declaration

public string[] GetTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetTagNamesFromTagID(String)

Useful for returning an array of strings containing the Tag Names that have the TagID provided set in the Value parameter

Declaration

public string[] GetTagNamesFromTagID(string TagID)

Parameters

Type	Name	Description
System.String	TagID	Tag ID to search

Returns

Type	Description
System.String[]	String array containing the Tag Names that match String array with 2 elements with Error in the first element and the message in the second element if service is not reachable

GetTagNamesFromTagID(String, String)

Useful for returning an array of strings containing the Tag Names that have the TagID provided set in the Value parameter

Declaration

public string[] GetTagNamesFromTagID(string TagID, string NetworkNode)

Parameters

Type	Name	Description
System.String	TagID	Tag ID to search
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	String array containing the Tag Names that match String array with 2 elements with Error in the first element and the message in the second element if service is not reachable

GetTagNamesFromTagID(String, String, ref String)

Useful for returning an array of strings containing the Tag Names that have the TagID provided set in the Value parameter

Declaration

public string[] GetTagNamesFromTagID(string TagID, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	TagID	Tag ID to search
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	String array containing the Tag Names that match String array with 2 elements with Error in the first element and the message in the second element if service is not reachable

GetTagNamesFromTagID(String, String, ref String, String)

Useful for returning an array of strings containing the Tag Names that have the TagID provided set in the Value parameter

Declaration

public string[] GetTagNamesFromTagID(string TagID, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	TagID	Tag ID to search
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	String array containing the Tag Names that match String array with 2 elements with Error in the first element and the message in the second element if service is not reachable

GetTagNamesFromTagIDs(String[])

Useful for returning an array of string arrays containing the Tag Names that have been provided in the TagIDs array.

Declaration

public object[] GetTagNamesFromTagIDs(string[] TagIDs)

Parameters

Type	Name	Description
System.String[]	TagIDs	Tag ID to search

Returns

Type	Description
System.Object[]	Array of String arrays containing the Tag Names that match

GetTagNamesFromTagIDs(String[], String)

Declaration

public object[] GetTagNamesFromTagIDs(string[] TagIDs, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	TagIDs
System.String	NetworkNode

Returns

Type	Description
System.Object[]

GetTagNamesFromTagIDs(String[], String, ref String)

Declaration

public object[] GetTagNamesFromTagIDs(string[] TagIDs, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	TagIDs
System.String	NetworkNode
System.String	ErrorString

Returns

Type	Description
System.Object[]

GetTagNamesFromTagIDs(String[], String, ref String, String)

Declaration

public object[] GetTagNamesFromTagIDs(string[] TagIDs, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	TagIDs
System.String	NetworkNode
System.String	ErrorString
System.String	RemoteSCADAHostingName

Returns

Type	Description
System.Object[]

GetTagProperties(String[], String[], String[], Boolean)

Gets an array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings

Declaration

public object[] GetTagProperties(string[] DesiredColumns, string[] TagNames, string[] GroupNames, bool ReturnValuesAsCSVStrings)

Parameters

Type	Name	Description
System.String[]	DesiredColumns	Array of strings containing the column names desired. The order returned will be in the same orders as the TagCSVHeaderString
System.String[]	TagNames	Array of tag names to return properties from. Leave empty to return all tags
System.String[]	GroupNames	Array of Tag Group Names to return all Tags within the groups specified. Leave empty to return all tags
System.Boolean	ReturnValuesAsCSVStrings	Set to true to return all records as CSV Strings, set to false to return all records as object arrays

Returns

Type	Description
System.Object[]	An array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings Empty array if service is not reachable

GetTagProperties(String[], String[], String[], Boolean, String)

Gets an array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings

Declaration

public object[] GetTagProperties(string[] DesiredColumns, string[] TagNames, string[] GroupNames, bool ReturnValuesAsCSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	DesiredColumns	Array of strings containing the column names desired. The order returned will be in the same orders as the TagCSVHeaderString
System.String[]	TagNames	Array of tag names to return properties from. Leave empty to return all tags
System.String[]	GroupNames	Array of Tag Group Names to return all Tags within the groups specified. Leave empty to return all tags
System.Boolean	ReturnValuesAsCSVStrings	Set to true to return all records as CSV Strings, set to false to return all records as object arrays
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]	An array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings Empty array if service is not reachable

GetTagProperties(String[], String[], String[], Boolean, String, ref String)

Gets an array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings

Declaration

public object[] GetTagProperties(string[] DesiredColumns, string[] TagNames, string[] GroupNames, bool ReturnValuesAsCSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	DesiredColumns	Array of strings containing the column names desired. The order returned will be in the same orders as the TagCSVHeaderString
System.String[]	TagNames	Array of tag names to return properties from. Leave empty to return all tags
System.String[]	GroupNames	Array of Tag Group Names to return all Tags within the groups specified. Leave empty to return all tags
System.Boolean	ReturnValuesAsCSVStrings	Set to true to return all records as CSV Strings, set to false to return all records as object arrays
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]	An array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings Empty array if service is not reachable

GetTagProperties(String[], String[], String[], Boolean, String, ref String, String)

Gets an array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings

Declaration

public object[] GetTagProperties(string[] DesiredColumns, string[] TagNames, string[] GroupNames, bool ReturnValuesAsCSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	DesiredColumns	Array of strings containing the column names desired. The order returned will be in the same orders as the TagCSVHeaderString
System.String[]	TagNames	Array of tag names to return properties from. Leave empty to return all tags
System.String[]	GroupNames	Array of Tag Group Names to return all Tags within the groups specified. Leave empty to return all tags
System.Boolean	ReturnValuesAsCSVStrings	Set to true to return all records as CSV Strings, set to false to return all records as object arrays
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]	An array of object arrays or arry of comma-separated string depending on ReturnValuesAsCSVStrings Empty array if service is not reachable

GetTagsAndParameters(String, String[])

Declaration

public object[] GetTagsAndParameters(string GroupName, string[] Parameters)

Parameters

Type	Name	Description
System.String	GroupName
System.String[]	Parameters

Returns

Type	Description
System.Object[]

GetTagsAndParameters(String, String[], String)

Declaration

public object[] GetTagsAndParameters(string GroupName, string[] Parameters, string NetworkNode)

Parameters

Type	Name	Description
System.String	GroupName
System.String[]	Parameters
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetTagsAndParameters(String, String[], String, ref String)

Declaration

public object[] GetTagsAndParameters(string GroupName, string[] Parameters, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	GroupName
System.String[]	Parameters
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetTagsAndParameters(String, String[], String, ref String, String)

Declaration

public object[] GetTagsAndParameters(string GroupName, string[] Parameters, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	GroupName
System.String[]	Parameters
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetTagsAndProperties(String, Boolean, Int32)

Declaration

public object[] GetTagsAndProperties(string ReferenceGroup, bool ReturnAllTags, int Version)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.Boolean	ReturnAllTags
System.Int32	Version

Returns

Type	Description
System.Object[]

GetTagsAndProperties(String, Boolean, Int32, String)

Declaration

public object[] GetTagsAndProperties(string ReferenceGroup, bool ReturnAllTags, int Version, string NetworkNode)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.Boolean	ReturnAllTags
System.Int32	Version
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetTagsAndProperties(String, Boolean, Int32, String, ref String)

Declaration

public object[] GetTagsAndProperties(string ReferenceGroup, bool ReturnAllTags, int Version, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.Boolean	ReturnAllTags
System.Int32	Version
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetTagsAndProperties(String, Boolean, Int32, String, ref String, String)

Declaration

public object[] GetTagsAndProperties(string ReferenceGroup, bool ReturnAllTags, int Version, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.Boolean	ReturnAllTags
System.Int32	Version
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetTagValuesByGroup(String)

Declaration

public object[] GetTagValuesByGroup(string GroupName)

Parameters

Type	Name	Description
System.String	GroupName

Returns

Type	Description
System.Object[]

GetTagValuesByGroup(String, String)

Declaration

public object[] GetTagValuesByGroup(string GroupName, string NetworkNode)

Parameters

Type	Name	Description
System.String	GroupName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

GetTagValuesByGroup(String, String, ref String)

Declaration

public object[] GetTagValuesByGroup(string GroupName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	GroupName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

GetTagValuesByGroup(String, String, ref String, String)

Declaration

public object[] GetTagValuesByGroup(string GroupName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	GroupName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

GetToken(String, String)

Declaration

public string GetToken(string UserName, string Password)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password

Returns

Type	Description
System.String

GetToken(String, String, String)

Declaration

public string GetToken(string UserName, string Password, string NetworkNode)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String

GetToken(String, String, String, ref String)

Declaration

public string GetToken(string UserName, string Password, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String

GetToken(String, String, String, ref String, String)

Declaration

public string GetToken(string UserName, string Password, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String

GetTrendPointGroupNames()

Declaration

public string[] GetTrendPointGroupNames()

Returns

Type	Description
System.String[]

GetTrendPointGroupNames(String)

Declaration

public string[] GetTrendPointGroupNames(string ReferenceGroup)

Parameters

Type	Name	Description
System.String	ReferenceGroup

Returns

Type	Description
System.String[]

GetTrendPointGroupNames(String, String)

Declaration

public string[] GetTrendPointGroupNames(string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetTrendPointGroupNames(String, String, ref String)

Declaration

public string[] GetTrendPointGroupNames(string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetTrendPointGroupNames(String, String, ref String, String)

Declaration

public string[] GetTrendPointGroupNames(string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetTrendPointParameterNames(String)

Declaration

public string[] GetTrendPointParameterNames(string TagName)

Parameters

Type	Name	Description
System.String	TagName

Returns

Type	Description
System.String[]

GetTrendPointParameterNames(String, String)

Declaration

public string[] GetTrendPointParameterNames(string TagName, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	TagName
System.String	ReferenceGroup

Returns

Type	Description
System.String[]

GetTrendPointParameterNames(String, String, String)

Declaration

public string[] GetTrendPointParameterNames(string TagName, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetTrendPointParameterNames(String, String, String, String)

Declaration

public string[] GetTrendPointParameterNames(string TagName, string ReferenceGroup, string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetTrendPointTagNames()

Declaration

public string[] GetTrendPointTagNames()

Returns

Type	Description
System.String[]

GetTrendPointTagNames(String)

Declaration

public string[] GetTrendPointTagNames(string ReferenceGroup)

Parameters

Type	Name	Description
System.String	ReferenceGroup

Returns

Type	Description
System.String[]

GetTrendPointTagNames(String, String)

Declaration

public string[] GetTrendPointTagNames(string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]

GetTrendPointTagNames(String, String, ref String)

Declaration

public string[] GetTrendPointTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]

GetTrendPointTagNames(String, String, ref String, String)

Declaration

public string[] GetTrendPointTagNames(string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]

GetVersion()

Gets the current numeric version of the OAS Service. Useful for an easy check if the OAS Service is started and reachable.

Declaration

public int GetVersion()

Returns

Type	Description
System.Int32	-1 if service is not reachable. A positive number of current version if successful.

GetVersion(String)

Gets the current numeric version of the OAS Service. Useful for an easy check if the OAS Service is started and reachable.

Declaration

public int GetVersion(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost.

Returns

Type	Description
System.Int32	-1 if service is not reachable. A positive number of current version if successful.

GetVersion(String, String)

Gets the current numeric version of the OAS Service. Useful for an easy check if the OAS Service is started and reachable.

Declaration

public int GetVersion(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost.
System.String	RemoteSCADAHostingName	The name of the Live Data Cloud OAS Service to connect to

Returns

Type	Description
System.Int32	-1 if service is not reachable. A positive number of current version if successful.

ImportABTags(String, String, Double, Config.LogixType, String, String, ref String, String)

Declaration

public void ImportABTags(string FilePath, string TagGroup, double PollRate, Config.LogixType RSLogixType, string DriverInterface, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	FilePath
System.String	TagGroup
System.Double	PollRate
Config.LogixType	RSLogixType
System.String	DriverInterface
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

InitialAlarmBufferTime(String, ref String, String)

Gets the date for the first time that the Alarm data buffering occured for the most recent buffering session

Declaration

public DateTime InitialAlarmBufferTime(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.DateTime	Initial data buffering DateTime

InitialBufferTime(String, ref String, String)

Gets the date for the first time that the data buffering occured for the most recent buffering session

Declaration

public DateTime InitialBufferTime(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.DateTime	Initial data buffering DateTime

InRuntime()

Returns the Runtime Status of an OAS Service

Declaration

public int InRuntime()

Returns

Type	Description
System.Int32	-1 : service is unreachable 0 : not in runtime 1 : in runtime

InRuntime(String)

Returns the Runtime Status of an OAS Service

Declaration

public int InRuntime(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32	-1 : service is unreachable 0 : not in runtime 1 : in runtime

InRuntime(String, String)

Returns the Runtime Status of an OAS Service

Declaration

public int InRuntime(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32	-1 : service is unreachable 0 : not in runtime 1 : in runtime

LastAlarmBufferTime(String, ref String, String)

Gets the date for the last time that Alarm data buffering occurred

Declaration

public DateTime LastAlarmBufferTime(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.DateTime	Last data buffering DateTime

LastBufferTime(String, ref String, String)

Gets the date for the last time that the data buffering occurred

Declaration

public DateTime LastBufferTime(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.DateTime	Last data buffering DateTime

LoadAEOPCServersConfiguration(String)

Declaration

public void LoadAEOPCServersConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadAEOPCServersConfiguration(String, String)

Declaration

public void LoadAEOPCServersConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadAEOPCServersConfiguration(String, String, ref String)

Declaration

public void LoadAEOPCServersConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadAEOPCServersConfiguration(String, String, ref String, String)

Declaration

public void LoadAEOPCServersConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadAlarmLoggingConfiguration(String)

Declaration

public void LoadAlarmLoggingConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadAlarmLoggingConfiguration(String, String)

Declaration

public void LoadAlarmLoggingConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadAlarmLoggingConfiguration(String, String, ref String)

Declaration

public void LoadAlarmLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadAlarmLoggingConfiguration(String, String, ref String, String)

Declaration

public void LoadAlarmLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadAlarmNotificationConfiguration(String)

Declaration

public void LoadAlarmNotificationConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadAlarmNotificationConfiguration(String, String)

Declaration

public void LoadAlarmNotificationConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadAlarmNotificationConfiguration(String, String, ref String)

Declaration

public void LoadAlarmNotificationConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadAlarmNotificationConfiguration(String, String, ref String, String)

Declaration

public void LoadAlarmNotificationConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadDataLoggingConfiguration(String)

Declaration

public void LoadDataLoggingConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadDataLoggingConfiguration(String, String)

Declaration

public void LoadDataLoggingConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadDataLoggingConfiguration(String, String, ref String)

Declaration

public void LoadDataLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadDataLoggingConfiguration(String, String, ref String, String)

Declaration

public void LoadDataLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadOptions()

Declaration

public void LoadOptions()

LoadOptions(String)

Declaration

public void LoadOptions(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadOptions(String, ref String)

Declaration

public void LoadOptions(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadOptions(String, ref String, String)

Declaration

public void LoadOptions(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadRecipeConfiguration(String)

Declaration

public void LoadRecipeConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadRecipeConfiguration(String, String)

Declaration

public void LoadRecipeConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadRecipeConfiguration(String, String, ref String)

Declaration

public void LoadRecipeConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadRecipeConfiguration(String, String, ref String, String)

Declaration

public void LoadRecipeConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadRemoteSCADAHostingConfiguration(String)

Declaration

public void LoadRemoteSCADAHostingConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadRemoteSCADAHostingConfiguration(String, String)

Declaration

public void LoadRemoteSCADAHostingConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadRemoteSCADAHostingConfiguration(String, String, ref String)

Declaration

public void LoadRemoteSCADAHostingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadRemoteSCADAHostingConfiguration(String, String, ref String, String)

Declaration

public void LoadRemoteSCADAHostingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadReportConfiguration(String)

Declaration

public void LoadReportConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadReportConfiguration(String, String)

Declaration

public void LoadReportConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadReportConfiguration(String, String, ref String)

Declaration

public void LoadReportConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadReportConfiguration(String, String, ref String, String)

Declaration

public void LoadReportConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadSecurityConfiguration(String)

Declaration

public void LoadSecurityConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadSecurityConfiguration(String, String)

Declaration

public void LoadSecurityConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadSecurityConfiguration(String, String, ref String)

Declaration

public void LoadSecurityConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadSecurityConfiguration(String, String, ref String, String)

Declaration

public void LoadSecurityConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadTagConfiguration(String)

Declaration

public void LoadTagConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadTagConfiguration(String, String)

Declaration

public void LoadTagConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadTagConfiguration(String, String, ref String)

Declaration

public void LoadTagConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadTagConfiguration(String, String, ref String, String)

Declaration

public void LoadTagConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadUDPBroadcastConfiguration(String)

Declaration

public void LoadUDPBroadcastConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadUDPBroadcastConfiguration(String, String)

Declaration

public void LoadUDPBroadcastConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadUDPBroadcastConfiguration(String, String, ref String)

Declaration

public void LoadUDPBroadcastConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadUDPBroadcastConfiguration(String, String, ref String, String)

Declaration

public void LoadUDPBroadcastConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LoadUDPReceiveConfiguration(String)

Declaration

public void LoadUDPReceiveConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

LoadUDPReceiveConfiguration(String, String)

Declaration

public void LoadUDPReceiveConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

LoadUDPReceiveConfiguration(String, String, ref String)

Declaration

public void LoadUDPReceiveConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

LoadUDPReceiveConfiguration(String, String, ref String, String)

Declaration

public void LoadUDPReceiveConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

LogIn(String, String)

The LogIn method sets the current user name and password for security access.

Declaration

public void LogIn(string UserName, string Password)

Parameters

Type	Name	Description
System.String	UserName	OAS credential username
System.String	Password	OAS credential password

LogInWithValidation(String, String)

Declaration

public bool LogInWithValidation(string UserName, string Password)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password

Returns

Type	Description
System.Boolean

LogInWithValidation(String, String, String)

Declaration

public bool LogInWithValidation(string UserName, string Password, string NetworkNode)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String	NetworkNode

Returns

Type	Description
System.Boolean

LogInWithValidation(String, String, String, String)

Declaration

public bool LogInWithValidation(string UserName, string Password, string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String	NetworkNode
System.String	RemoteSCADAHostingName

Returns

Type	Description
System.Boolean

LogInWithValidation(String, String, String, String, ref String)

Declaration

public bool LogInWithValidation(string UserName, string Password, string NetworkNode, string RemoteSCADAHostingName, ref string ErrorString)

Parameters

Type	Name	Description
System.String	UserName
System.String	Password
System.String	NetworkNode
System.String	RemoteSCADAHostingName
System.String	ErrorString

Returns

Type	Description
System.Boolean

LogOff()

Clears the current security user.

Declaration

public void LogOff()

OPCUABrowse(String, String, String, Boolean, Boolean, Boolean, Boolean, String, String, String, Boolean)

Declaration

public object[] OPCUABrowse(string ServerURL, string SecurityProfile, string NodeID, bool GetOnlyVariables, bool GetAllNodes, bool UseSecurity, bool UseUserSecurity, string UserName, string Password, string DomainNameOverride, bool AllowInvalidCertificate)

Parameters

Type	Name	Description
System.String	ServerURL
System.String	SecurityProfile
System.String	NodeID
System.Boolean	GetOnlyVariables
System.Boolean	GetAllNodes
System.Boolean	UseSecurity
System.Boolean	UseUserSecurity
System.String	UserName
System.String	Password
System.String	DomainNameOverride
System.Boolean	AllowInvalidCertificate

Returns

Type	Description
System.Object[]

OPCUABrowse(String, String, String, Boolean, Boolean, Boolean, Boolean, String, String, String, Boolean, String)

Declaration

public object[] OPCUABrowse(string ServerURL, string SecurityProfile, string NodeID, bool GetOnlyVariables, bool GetAllNodes, bool UseSecurity, bool UseUserSecurity, string UserName, string Password, string DomainNameOverride, bool AllowInvalidCertificate, string NetworkNode)

Parameters

Type	Name	Description
System.String	ServerURL
System.String	SecurityProfile
System.String	NodeID
System.Boolean	GetOnlyVariables
System.Boolean	GetAllNodes
System.Boolean	UseSecurity
System.Boolean	UseUserSecurity
System.String	UserName
System.String	Password
System.String	DomainNameOverride
System.Boolean	AllowInvalidCertificate
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Object[]

OPCUABrowse(String, String, String, Boolean, Boolean, Boolean, Boolean, String, String, String, Boolean, String, ref String)

Declaration

public object[] OPCUABrowse(string ServerURL, string SecurityProfile, string NodeID, bool GetOnlyVariables, bool GetAllNodes, bool UseSecurity, bool UseUserSecurity, string UserName, string Password, string DomainNameOverride, bool AllowInvalidCertificate, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ServerURL
System.String	SecurityProfile
System.String	NodeID
System.Boolean	GetOnlyVariables
System.Boolean	GetAllNodes
System.Boolean	UseSecurity
System.Boolean	UseUserSecurity
System.String	UserName
System.String	Password
System.String	DomainNameOverride
System.Boolean	AllowInvalidCertificate
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Object[]

OPCUABrowse(String, String, String, Boolean, Boolean, Boolean, Boolean, String, String, String, Boolean, String, ref String, String)

Declaration

public object[] OPCUABrowse(string ServerURL, string SecurityProfile, string NodeID, bool GetOnlyVariables, bool GetAllNodes, bool UseSecurity, bool UseUserSecurity, string UserName, string Password, string DomainNameOverride, bool AllowInvalidCertificate, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ServerURL
System.String	SecurityProfile
System.String	NodeID
System.Boolean	GetOnlyVariables
System.Boolean	GetAllNodes
System.Boolean	UseSecurity
System.Boolean	UseUserSecurity
System.String	UserName
System.String	Password
System.String	DomainNameOverride
System.Boolean	AllowInvalidCertificate
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Object[]

OptionsCSVImport(String[])

Declaration

public string OptionsCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	Array of 2 strings, the first the option names seperated by comma, the second the values to set seperated by a comma. Use CSV Export with Configure OAS application under Configure-Options to see all option names and CSV string format.

Returns

Type	Description
System.String

OptionsCSVImport(String[], String)

Declaration

public string OptionsCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	Array of 2 strings, the first the option names seperated by comma, the second the values to set seperated by a comma. Use CSV Export with Configure OAS application under Configure-Options to see all option names and CSV string format.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String

OptionsCSVImport(String[], String, ref String)

Declaration

public string OptionsCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	Array of 2 strings, the first the option names seperated by comma, the second the values to set seperated by a comma. Use CSV Export with Configure OAS application under Configure-Options to see all option names and CSV string format.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String

OptionsCSVImport(String[], String, ref String, String)

Declaration

public string OptionsCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	Array of 2 strings, the first the option names seperated by comma, the second the values to set seperated by a comma. Use CSV Export with Configure OAS application under Configure-Options to see all option names and CSV string format.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String

RecipeCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Recipe Group. This method is to be used in conjuction with RecipeCSVHeaderString.

Declaration

public string[] RecipeCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RecipeCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Recipe Group. This method is to be used in conjuction with RecipeCSVHeaderString.

Declaration

public string[] RecipeCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RecipeCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Recipe Group. This method is to be used in conjuction with RecipeCSVHeaderString.

Declaration

public string[] RecipeCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RecipeCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Recipe Group. This method is to be used in conjuction with RecipeCSVHeaderString.

Declaration

public string[] RecipeCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RecipeCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the RecipeCSVExport Function

Declaration

public string RecipeCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

RecipeCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the RecipeCSVExport Function

Declaration

public string RecipeCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

RecipeCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the RecipeCSVExport Function

Declaration

public string RecipeCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

RecipeCSVImport(String[])

Used to import comma-separated strings to the Recipe configuration

Declaration

public string RecipeCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RecipeCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Recipe Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RecipeCSVImport(String[], String)

Used to import comma-separated strings to the Recipe configuration

Declaration

public string RecipeCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RecipeCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Recipe Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RecipeCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Recipe configuration

Declaration

public string RecipeCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RecipeCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Recipe Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RecipeCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Recipe configuration

Declaration

public string RecipeCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RecipeCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Recipe Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RemoteSCADAHostingCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Remote SCADA Hosting Group (Live Data Cloud). This method is to be used in conjuction with RemoteSCADAHostingCSVHeaderString.

Declaration

public string[] RemoteSCADAHostingCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RemoteSCADAHostingCSVExport(String)

Declaration

public string[] RemoteSCADAHostingCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RemoteSCADAHostingCSVExport(String, ref String)

Declaration

public string[] RemoteSCADAHostingCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RemoteSCADAHostingCSVExport(String, ref String, String)

Declaration

public string[] RemoteSCADAHostingCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

RemoteSCADAHostingCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the RemoteSCADAHostingCSVExport Function

Declaration

public string RemoteSCADAHostingCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

RemoteSCADAHostingCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the RemoteSCADAHostingCSVExport Function

Declaration

public string RemoteSCADAHostingCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

RemoteSCADAHostingCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the RemoteSCADAHostingCSVExport Function

Declaration

public string RemoteSCADAHostingCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

RemoteSCADAHostingCSVImport(String[])

Used to import comma-separated strings to the Remote SCADA Hoting (Live Data Cloud) configuration

Declaration

public string RemoteSCADAHostingCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RemoteSCADAHostingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Remote SCADA Hosting Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RemoteSCADAHostingCSVImport(String[], String)

Used to import comma-separated strings to the Remote SCADA Hoting (Live Data Cloud) configuration

Declaration

public string RemoteSCADAHostingCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RemoteSCADAHostingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Remote SCADA Hosting Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RemoteSCADAHostingCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Remote SCADA Hoting (Live Data Cloud) configuration

Declaration

public string RemoteSCADAHostingCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RemoteSCADAHostingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Remote SCADA Hosting Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RemoteSCADAHostingCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Remote SCADA Hoting (Live Data Cloud) configuration

Declaration

public string RemoteSCADAHostingCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the RemoteSCADAHostingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Remote SCADA Hosting Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

RemoveAEOPCServer(String)

Declaration

public int RemoveAEOPCServer(string Server)

Parameters

Type	Name	Description
System.String	Server

Returns

Type	Description
System.Int32

RemoveAEOPCServer(String, String)

Declaration

public int RemoveAEOPCServer(string Server, string NetworkNode)

Parameters

Type	Name	Description
System.String	Server
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveAEOPCServer(String, String, ref String)

Declaration

public int RemoveAEOPCServer(string Server, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Server
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveAEOPCServer(String, String, ref String, String)

Declaration

public int RemoveAEOPCServer(string Server, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Server
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveAlarmLoggingGroup(String)

Declaration

public int RemoveAlarmLoggingGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

RemoveAlarmLoggingGroup(String, String)

Declaration

public int RemoveAlarmLoggingGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveAlarmLoggingGroup(String, String, ref String)

Declaration

public int RemoveAlarmLoggingGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveAlarmLoggingGroup(String, String, ref String, String)

Declaration

public int RemoveAlarmLoggingGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveAlarmNotificationGroup(String)

Declaration

public int RemoveAlarmNotificationGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

RemoveAlarmNotificationGroup(String, String)

Declaration

public int RemoveAlarmNotificationGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveAlarmNotificationGroup(String, String, ref String)

Declaration

public int RemoveAlarmNotificationGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveAlarmNotificationGroup(String, String, ref String, String)

Declaration

public int RemoveAlarmNotificationGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveDataLoggingGroup(String)

Declaration

public int RemoveDataLoggingGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

RemoveDataLoggingGroup(String, String)

Declaration

public int RemoveDataLoggingGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveDataLoggingGroup(String, String, ref String)

Declaration

public int RemoveDataLoggingGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveDataLoggingGroup(String, String, ref String, String)

Declaration

public int RemoveDataLoggingGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveDriverInterface(String)

Declaration

public int RemoveDriverInterface(string Name)

Parameters

Type	Name	Description
System.String	Name

Returns

Type	Description
System.Int32

RemoveDriverInterface(String, String)

Declaration

public int RemoveDriverInterface(string Name, string NetworkNode)

Parameters

Type	Name	Description
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveDriverInterface(String, String, ref String)

Declaration

public int RemoveDriverInterface(string Name, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveDriverInterface(String, String, ref String, String)

Declaration

public int RemoveDriverInterface(string Name, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveGroup(String)

Declaration

public int RemoveGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

RemoveGroup(String, String)

Declaration

public int RemoveGroup(string Group, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup

Returns

Type	Description
System.Int32

RemoveGroup(String, String, String)

Declaration

public int RemoveGroup(string Group, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveGroup(String, String, String, ref String)

Declaration

public int RemoveGroup(string Group, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveGroup(String, String, String, ref String, String)

Declaration

public int RemoveGroup(string Group, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveRecipeGroup(String)

Declaration

public int RemoveRecipeGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

RemoveRecipeGroup(String, String)

Declaration

public int RemoveRecipeGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveRecipeGroup(String, String, ref String)

Declaration

public int RemoveRecipeGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveRecipeGroup(String, String, ref String, String)

Declaration

public int RemoveRecipeGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveReportGroup(String)

Declaration

public int RemoveReportGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

RemoveReportGroup(String, String)

Declaration

public int RemoveReportGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveReportGroup(String, String, ref String)

Declaration

public int RemoveReportGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveReportGroup(String, String, ref String, String)

Declaration

public int RemoveReportGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveSecurityGroup(String)

Declaration

public int RemoveSecurityGroup(string Group)

Parameters

Type	Name	Description
System.String	Group

Returns

Type	Description
System.Int32

RemoveSecurityGroup(String, String)

Declaration

public int RemoveSecurityGroup(string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveSecurityGroup(String, String, ref String)

Declaration

public int RemoveSecurityGroup(string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveSecurityGroup(String, String, ref String, String)

Declaration

public int RemoveSecurityGroup(string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveSecurityUser(String)

Declaration

public int RemoveSecurityUser(string UserName)

Parameters

Type	Name	Description
System.String	UserName

Returns

Type	Description
System.Int32

RemoveSecurityUser(String, String)

Declaration

public int RemoveSecurityUser(string UserName, string NetworkNode)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveSecurityUser(String, String, ref String)

Declaration

public int RemoveSecurityUser(string UserName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveSecurityUser(String, String, ref String, String)

Declaration

public int RemoveSecurityUser(string UserName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveTag(String)

Declaration

public int RemoveTag(string Tag)

Parameters

Type	Name	Description
System.String	Tag

Returns

Type	Description
System.Int32

RemoveTag(String, String)

Declaration

public int RemoveTag(string Tag, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup

Returns

Type	Description
System.Int32

RemoveTag(String, String, String)

Declaration

public int RemoveTag(string Tag, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RemoveTag(String, String, String, ref String)

Declaration

public int RemoveTag(string Tag, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RemoveTag(String, String, String, ref String, String)

Declaration

public int RemoveTag(string Tag, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Tag
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

RemoveTags(String[])

Declaration

public int RemoveTags(string[] Tags)

Parameters

Type	Name	Description
System.String[]	Tags

Returns

Type	Description
System.Int32

RemoveTags(String[], String)

Declaration

public int RemoveTags(string[] Tags, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	Tags
System.String	NetworkNode

Returns

Type	Description
System.Int32

RemoveTags(String[], String, ref String)

Declaration

public int RemoveTags(string[] Tags, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	Tags
System.String	NetworkNode
System.String	ErrorString

Returns

Type	Description
System.Int32

RemoveTags(String[], String, ref String, String)

Declaration

public int RemoveTags(string[] Tags, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	Tags
System.String	NetworkNode
System.String	ErrorString
System.String	RemoteSCADAHostingName

Returns

Type	Description
System.Int32

RenameGroup(String, String)

Declaration

public int RenameGroup(string OldGroupName, string NewGroupName)

Parameters

Type	Name	Description
System.String	OldGroupName
System.String	NewGroupName

Returns

Type	Description
System.Int32

RenameGroup(String, String, String)

Declaration

public int RenameGroup(string OldGroupName, string NewGroupName, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	OldGroupName
System.String	NewGroupName
System.String	ReferenceGroup

Returns

Type	Description
System.Int32

RenameGroup(String, String, String, String)

Declaration

public int RenameGroup(string OldGroupName, string NewGroupName, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	OldGroupName
System.String	NewGroupName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

RenameGroup(String, String, String, String, ref String)

Declaration

public int RenameGroup(string OldGroupName, string NewGroupName, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OldGroupName
System.String	NewGroupName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

RenameGroup(String, String, String, String, ref String, String)

Declaration

public int RenameGroup(string OldGroupName, string NewGroupName, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OldGroupName
System.String	NewGroupName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

ReportCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Report Group. This method is to be used in conjuction with ReportCSVHeaderString.

Declaration

public string[] ReportCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

ReportCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Report Group. This method is to be used in conjuction with ReportCSVHeaderString.

Declaration

public string[] ReportCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

ReportCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Report Group. This method is to be used in conjuction with ReportCSVHeaderString.

Declaration

public string[] ReportCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

ReportCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Report Group. This method is to be used in conjuction with ReportCSVHeaderString.

Declaration

public string[] ReportCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

ReportCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the ReportCSVExport Function

Declaration

public string ReportCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

ReportCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the ReportCSVExport Function

Declaration

public string ReportCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

ReportCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the ReportCSVExport Function

Declaration

public string ReportCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

ReportCSVImport(String[])

Used to import comma-separated strings to the Report configuration

Declaration

public string ReportCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the ReportCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Report Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

ReportCSVImport(String[], String)

Used to import comma-separated strings to the Report configuration

Declaration

public string ReportCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the ReportCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Report Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

ReportCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Report configuration

Declaration

public string ReportCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the ReportCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Report Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

ReportCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Report configuration

Declaration

public string ReportCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the ReportCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Report Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

ResetTrendXSamples(String[])

Declaration

public void ResetTrendXSamples(string[] TagNames)

Parameters

Type	Name	Description
System.String[]	TagNames

ResetTrendXSamples(String[], String)

Declaration

public void ResetTrendXSamples(string[] TagNames, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	TagNames
System.String	NetworkNode	the network node to connect - leave null for localhost

ResetTrendXSamples(String[], String, ref String)

Declaration

public void ResetTrendXSamples(string[] TagNames, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	TagNames
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

ResetTrendXSamples(String[], String, ref String, String)

Declaration

public void ResetTrendXSamples(string[] TagNames, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	TagNames
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveAEOPCServersConfiguration(String)

Declaration

public void SaveAEOPCServersConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveAEOPCServersConfiguration(String, String)

Declaration

public void SaveAEOPCServersConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveAEOPCServersConfiguration(String, String, ref String)

Declaration

public void SaveAEOPCServersConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveAEOPCServersConfiguration(String, String, ref String, String)

Declaration

public void SaveAEOPCServersConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveAlarmLoggingConfiguration(String)

Declaration

public void SaveAlarmLoggingConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveAlarmLoggingConfiguration(String, String)

Declaration

public void SaveAlarmLoggingConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveAlarmLoggingConfiguration(String, String, ref String)

Declaration

public void SaveAlarmLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveAlarmLoggingConfiguration(String, String, ref String, String)

Declaration

public void SaveAlarmLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveAlarmNotificationConfiguration(String)

Declaration

public void SaveAlarmNotificationConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveAlarmNotificationConfiguration(String, String)

Declaration

public void SaveAlarmNotificationConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveAlarmNotificationConfiguration(String, String, ref String)

Declaration

public void SaveAlarmNotificationConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveAlarmNotificationConfiguration(String, String, ref String, String)

Declaration

public void SaveAlarmNotificationConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveDataLoggingConfiguration(String)

Declaration

public void SaveDataLoggingConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveDataLoggingConfiguration(String, String)

Declaration

public void SaveDataLoggingConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveDataLoggingConfiguration(String, String, ref String)

Declaration

public void SaveDataLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveDataLoggingConfiguration(String, String, ref String, String)

Declaration

public void SaveDataLoggingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveOptions()

Declaration

public void SaveOptions()

SaveOptions(String)

Declaration

public void SaveOptions(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveOptions(String, ref String)

Declaration

public void SaveOptions(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveOptions(String, ref String, String)

Declaration

public void SaveOptions(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveRecipeConfiguration(String)

Declaration

public void SaveRecipeConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveRecipeConfiguration(String, String)

Declaration

public void SaveRecipeConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveRecipeConfiguration(String, String, ref String)

Declaration

public void SaveRecipeConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveRecipeConfiguration(String, String, ref String, String)

Declaration

public void SaveRecipeConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveRemoteSCADAHostingConfiguration(String)

Declaration

public void SaveRemoteSCADAHostingConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveRemoteSCADAHostingConfiguration(String, String)

Declaration

public void SaveRemoteSCADAHostingConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveRemoteSCADAHostingConfiguration(String, String, ref String)

Declaration

public void SaveRemoteSCADAHostingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveRemoteSCADAHostingConfiguration(String, String, ref String, String)

Declaration

public void SaveRemoteSCADAHostingConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveReportConfiguration(String)

Declaration

public void SaveReportConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveReportConfiguration(String, String)

Declaration

public void SaveReportConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveReportConfiguration(String, String, ref String)

Declaration

public void SaveReportConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveReportConfiguration(String, String, ref String, String)

Declaration

public void SaveReportConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveSecurityConfiguration(String)

Declaration

public void SaveSecurityConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveSecurityConfiguration(String, String)

Declaration

public void SaveSecurityConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveSecurityConfiguration(String, String, ref String)

Declaration

public void SaveSecurityConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveSecurityConfiguration(String, String, ref String, String)

Declaration

public void SaveSecurityConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveTagConfiguration(String)

Declaration

public void SaveTagConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveTagConfiguration(String, String)

Declaration

public void SaveTagConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveTagConfiguration(String, String, ref String)

Declaration

public void SaveTagConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveTagConfiguration(String, String, ref String, String)

Declaration

public void SaveTagConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveUDPBroadcastConfiguration(String)

Declaration

public void SaveUDPBroadcastConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveUDPBroadcastConfiguration(String, String)

Declaration

public void SaveUDPBroadcastConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveUDPBroadcastConfiguration(String, String, ref String)

Declaration

public void SaveUDPBroadcastConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveUDPBroadcastConfiguration(String, String, ref String, String)

Declaration

public void SaveUDPBroadcastConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SaveUDPReceiveConfiguration(String)

Declaration

public void SaveUDPReceiveConfiguration(string ConfigurationFilePath)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath

SaveUDPReceiveConfiguration(String, String)

Declaration

public void SaveUDPReceiveConfiguration(string ConfigurationFilePath, string NetworkNode)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost

SaveUDPReceiveConfiguration(String, String, ref String)

Declaration

public void SaveUDPReceiveConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SaveUDPReceiveConfiguration(String, String, ref String, String)

Declaration

public void SaveUDPReceiveConfiguration(string ConfigurationFilePath, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ConfigurationFilePath
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SecurityCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Security Group. This method is to be used in conjuction with SecurityCSVHeaderString.

Declaration

public string[] SecurityCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Security Group. This method is to be used in conjuction with SecurityCSVHeaderString.

Declaration

public string[] SecurityCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Security Group. This method is to be used in conjuction with SecurityCSVHeaderString.

Declaration

public string[] SecurityCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Security Group. This method is to be used in conjuction with SecurityCSVHeaderString.

Declaration

public string[] SecurityCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the SecurityCSVExport Function

Declaration

public string SecurityCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

SecurityCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the SecurityCSVExport Function

Declaration

public string SecurityCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

SecurityCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the SecurityCSVExport Function

Declaration

public string SecurityCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

SecurityCSVImport(String[])

Used to import comma-separated strings to the Security configuration

Declaration

public string SecurityCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security Group Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SecurityCSVImport(String[], String)

Used to import comma-separated strings to the Security configuration

Declaration

public string SecurityCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SecurityCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Security configuration

Declaration

public string SecurityCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SecurityCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Security configuration

Declaration

public string SecurityCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SecurityUsersCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Security User. This method is to be used in conjuction with SecurityUsersCSVHeaderString.

Declaration

public string[] SecurityUsersCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityUsersCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Security User. This method is to be used in conjuction with SecurityUsersCSVHeaderString.

Declaration

public string[] SecurityUsersCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityUsersCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Security User. This method is to be used in conjuction with SecurityUsersCSVHeaderString.

Declaration

public string[] SecurityUsersCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityUsersCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Security User. This method is to be used in conjuction with SecurityUsersCSVHeaderString.

Declaration

public string[] SecurityUsersCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

SecurityUsersCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the SecurityUsersCSVExport Function

Declaration

public string SecurityUsersCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

SecurityUsersCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the SecurityUsersCSVExport Function

Declaration

public string SecurityUsersCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

SecurityUsersCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the SecurityUsersCSVExport Function

Declaration

public string SecurityUsersCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

SecurityUsersCSVImport(String[])

Used to import comma-separated strings to the Security User configuration

Declaration

public string SecurityUsersCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityUsersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security User Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SecurityUsersCSVImport(String[], String)

Used to import comma-separated strings to the Security User configuration

Declaration

public string SecurityUsersCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityUsersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security User Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SecurityUsersCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Security User configuration

Declaration

public string SecurityUsersCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityUsersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security User Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SecurityUsersCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Security User configuration

Declaration

public string SecurityUsersCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the SecurityUsersCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Security User Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

SetAEOPCServerParameter(String, String, Object)

Declaration

public int SetAEOPCServerParameter(string Server, string Parameter, object Value)

Parameters

Type	Name	Description
System.String	Server
System.String	Parameter
System.Object	Value

Returns

Type	Description
System.Int32

SetAEOPCServerParameter(String, String, Object, String)

Declaration

public int SetAEOPCServerParameter(string Server, string Parameter, object Value, string NetworkNode)

Parameters

Type	Name	Description
System.String	Server
System.String	Parameter
System.Object	Value
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetAEOPCServerParameter(String, String, Object, String, ref String)

Declaration

public int SetAEOPCServerParameter(string Server, string Parameter, object Value, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Server
System.String	Parameter
System.Object	Value
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetAEOPCServerParameter(String, String, Object, String, ref String, String)

Declaration

public int SetAEOPCServerParameter(string Server, string Parameter, object Value, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Server
System.String	Parameter
System.Object	Value
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Value(String, Object, String)

Declaration

public int SetAlarmLogging_Parameter_Value(string Parameter, object Value, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Value(String, Object, String, String)

Declaration

public int SetAlarmLogging_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetAlarmLogging_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetAlarmLogging_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Values(String[], Object[], String)

Declaration

public int SetAlarmLogging_Parameter_Values(string[] Parameters, object[] Values, string Group)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Values(String[], Object[], String, String)

Declaration

public int SetAlarmLogging_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Values(String[], Object[], String, String, ref String)

Declaration

public int SetAlarmLogging_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetAlarmLogging_Parameter_Values(String[], Object[], String, String, ref String, String)

Declaration

public int SetAlarmLogging_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Value(String, Object, String)

Declaration

public int SetAlarmNotification_Parameter_Value(string Parameter, object Value, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Value(String, Object, String, String)

Declaration

public int SetAlarmNotification_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetAlarmNotification_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetAlarmNotification_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Values(String[], Object[], String)

Declaration

public int SetAlarmNotification_Parameter_Values(string[] Parameters, object[] Values, string Group)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Values(String[], Object[], String, String)

Declaration

public int SetAlarmNotification_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Values(String[], Object[], String, String, ref String)

Declaration

public int SetAlarmNotification_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetAlarmNotification_Parameter_Values(String[], Object[], String, String, ref String, String)

Declaration

public int SetAlarmNotification_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetCustomObjectValue(String, Object)

Sets a value to a custom object in the service to be later retreived with GetCustomObjectValue

Declaration

public void SetCustomObjectValue(string ObjectName, object Value)

Parameters

Type	Name	Description
System.String	ObjectName	The object name
System.Object	Value	The custom value

SetCustomObjectValue(String, Object, String)

Sets a value to a custom object in the service to be later retreived with GetCustomObjectValue

Declaration

public void SetCustomObjectValue(string ObjectName, object Value, string NetworkNode)

Parameters

Type	Name	Description
System.String	ObjectName	The object name
System.Object	Value	The custom value
System.String	NetworkNode	the network node to connect - leave null for localhost

SetCustomObjectValue(String, Object, String, ref String)

Sets a value to a custom object in the service to be later retreived with GetCustomObjectValue

Declaration

public void SetCustomObjectValue(string ObjectName, object Value, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	ObjectName	The object name
System.Object	Value	The custom value
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SetCustomObjectValue(String, Object, String, ref String, String)

Sets a value to a custom object in the service to be later retreived with GetCustomObjectValue

Declaration

public void SetCustomObjectValue(string ObjectName, object Value, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	ObjectName	The object name
System.Object	Value	The custom value
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SetDataLogging_Parameter_Value(String, Object, String)

Declaration

public int SetDataLogging_Parameter_Value(string Parameter, object Value, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group

Returns

Type	Description
System.Int32

SetDataLogging_Parameter_Value(String, Object, String, String)

Declaration

public int SetDataLogging_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetDataLogging_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetDataLogging_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetDataLogging_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetDataLogging_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetDataLogging_Parameter_Values(String[], Object[], String)

Declaration

public int SetDataLogging_Parameter_Values(string[] Parameters, object[] Values, string Group)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group

Returns

Type	Description
System.Int32

SetDataLogging_Parameter_Values(String[], Object[], String, String)

Declaration

public int SetDataLogging_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetDataLogging_Parameter_Values(String[], Object[], String, String, ref String)

Declaration

public int SetDataLogging_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetDataLogging_Parameter_Values(String[], Object[], String, String, ref String, String)

Declaration

public int SetDataLogging_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetDriverInterface_Parameter_Value(String, Object, String)

Declaration

public int SetDriverInterface_Parameter_Value(string Parameter, object Value, string Name)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Name

Returns

Type	Description
System.Int32

SetDriverInterface_Parameter_Value(String, Object, String, String)

Declaration

public int SetDriverInterface_Parameter_Value(string Parameter, object Value, string Name, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetDriverInterface_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetDriverInterface_Parameter_Value(string Parameter, object Value, string Name, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetDriverInterface_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetDriverInterface_Parameter_Value(string Parameter, object Value, string Name, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Name
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetOEMCode(String)

Sets the current OEM Code

Declaration

public void SetOEMCode(string Value)

Parameters

Type	Name	Description
System.String	Value	a string containing the OEM Code

SetOEMCode(String, String)

Sets the current OEM Code

Declaration

public void SetOEMCode(string Value, string NetworkNode)

Parameters

Type	Name	Description
System.String	Value	a string containing the OEM Code
System.String	NetworkNode	the network node to connect - leave null for localhost

SetOEMCode(String, String, ref String)

Sets the current OEM Code

Declaration

public void SetOEMCode(string Value, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Value	a string containing the OEM Code
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

SetOEMCode(String, String, ref String, String)

Sets the current OEM Code

Declaration

public void SetOEMCode(string Value, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Value	a string containing the OEM Code
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

SetOption(String, Object)

Declaration

public string SetOption(string OptionName, object OptionValue)

Parameters

Type	Name	Description
System.String	OptionName
System.Object	OptionValue

Returns

Type	Description
System.String

SetOption(String, Object, String)

Declaration

public string SetOption(string OptionName, object OptionValue, string NetworkNode)

Parameters

Type	Name	Description
System.String	OptionName
System.Object	OptionValue
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String

SetOption(String, Object, String, ref String)

Declaration

public string SetOption(string OptionName, object OptionValue, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	OptionName
System.Object	OptionValue
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String

SetOption(String, Object, String, ref String, String)

Declaration

public string SetOption(string OptionName, object OptionValue, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	OptionName
System.Object	OptionValue
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String

SetOptions(String[], Object[])

Declaration

public string SetOptions(string[] OptionNames, object[] OptionValues)

Parameters

Type	Name	Description
System.String[]	OptionNames	Array of strings containing the option names.
System.Object[]	OptionValues	Array of objects containing the values to set.

Returns

Type	Description
System.String

SetOptions(String[], Object[], String)

Declaration

public string SetOptions(string[] OptionNames, object[] OptionValues, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	OptionNames	Array of strings containing the option names.
System.Object[]	OptionValues	Array of objects containing the values to set.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String

SetOptions(String[], Object[], String, ref String)

Declaration

public string SetOptions(string[] OptionNames, object[] OptionValues, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	OptionNames	Array of strings containing the option names.
System.Object[]	OptionValues	Array of objects containing the values to set.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String

SetOptions(String[], Object[], String, ref String, String)

Declaration

public string SetOptions(string[] OptionNames, object[] OptionValues, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	OptionNames	Array of strings containing the option names.
System.Object[]	OptionValues	Array of objects containing the values to set.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String

SetRecipe_Parameter_Value(String, Object, String)

Declaration

public int SetRecipe_Parameter_Value(string Parameter, object Value, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group

Returns

Type	Description
System.Int32

SetRecipe_Parameter_Value(String, Object, String, String)

Declaration

public int SetRecipe_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetRecipe_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetRecipe_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetRecipe_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetRecipe_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetRecipe_Parameter_Values(String[], Object[], String)

Declaration

public int SetRecipe_Parameter_Values(string[] Parameters, object[] Values, string Group)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group

Returns

Type	Description
System.Int32

SetRecipe_Parameter_Values(String[], Object[], String, String)

Declaration

public int SetRecipe_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetRecipe_Parameter_Values(String[], Object[], String, String, ref String)

Declaration

public int SetRecipe_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetRecipe_Parameter_Values(String[], Object[], String, String, ref String, String)

Declaration

public int SetRecipe_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetReport_Parameter_Value(String, Object, String)

Declaration

public int SetReport_Parameter_Value(string Parameter, object Value, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group

Returns

Type	Description
System.Int32

SetReport_Parameter_Value(String, Object, String, String)

Declaration

public int SetReport_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetReport_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetReport_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetReport_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetReport_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetReport_Parameter_Values(String[], Object[], String)

Declaration

public int SetReport_Parameter_Values(string[] Parameters, object[] Values, string Group)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group

Returns

Type	Description
System.Int32

SetReport_Parameter_Values(String[], Object[], String, String)

Declaration

public int SetReport_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetReport_Parameter_Values(String[], Object[], String, String, ref String)

Declaration

public int SetReport_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetReport_Parameter_Values(String[], Object[], String, String, ref String, String)

Declaration

public int SetReport_Parameter_Values(string[] Parameters, object[] Values, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	Parameters
System.Object[]	Values
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetSecurity_Parameter_Value(String, Object, String)

Declaration

public int SetSecurity_Parameter_Value(string Parameter, object Value, string Group)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group

Returns

Type	Description
System.Int32

SetSecurity_Parameter_Value(String, Object, String, String)

Declaration

public int SetSecurity_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetSecurity_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetSecurity_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetSecurity_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetSecurity_Parameter_Value(string Parameter, object Value, string Group, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	Group
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetSecurityUser_Parameter_Value(String, Object, String)

Declaration

public int SetSecurityUser_Parameter_Value(string Parameter, object Value, string UserName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	UserName

Returns

Type	Description
System.Int32

SetSecurityUser_Parameter_Value(String, Object, String, String)

Declaration

public int SetSecurityUser_Parameter_Value(string Parameter, object Value, string UserName, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetSecurityUser_Parameter_Value(String, Object, String, String, ref String)

Declaration

public int SetSecurityUser_Parameter_Value(string Parameter, object Value, string UserName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetSecurityUser_Parameter_Value(String, Object, String, String, ref String, String)

Declaration

public int SetSecurityUser_Parameter_Value(string Parameter, object Value, string UserName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.Object	Value
System.String	UserName
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetTag_Parameter_Value(String, String, Object, String)

Declaration

public int SetTag_Parameter_Value(string Parameter, string PropertyType, object Value, string TagName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.Object	Value
System.String	TagName

Returns

Type	Description
System.Int32

SetTag_Parameter_Value(String, String, Object, String, String)

Declaration

public int SetTag_Parameter_Value(string Parameter, string PropertyType, object Value, string TagName, string ReferenceGroup)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.Object	Value
System.String	TagName
System.String	ReferenceGroup

Returns

Type	Description
System.Int32

SetTag_Parameter_Value(String, String, Object, String, String, String)

Declaration

public int SetTag_Parameter_Value(string Parameter, string PropertyType, object Value, string TagName, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.Object	Value
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetTag_Parameter_Value(String, String, Object, String, String, String, ref String)

Declaration

public int SetTag_Parameter_Value(string Parameter, string PropertyType, object Value, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.Object	Value
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetTag_Parameter_Value(String, String, Object, String, String, String, ref String, String)

Declaration

public int SetTag_Parameter_Value(string Parameter, string PropertyType, object Value, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	Parameter
System.String	PropertyType
System.Object	Value
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetTag_Parameter_Values(String[], String[], Object[], String)

Declaration

public int SetTag_Parameter_Values(string[] Parameters, string[] PropertyTypes, object[] Values, string TagName)

Parameters

Type	Name	Description
System.String[]	Parameters
System.String[]	PropertyTypes
System.Object[]	Values
System.String	TagName

Returns

Type	Description
System.Int32

SetTag_Parameter_Values(String[], String[], Object[], String, String)

Declaration

public int SetTag_Parameter_Values(string[] Parameters, string[] PropertyTypes, object[] Values, string TagName, string ReferenceGroup)

Parameters

Type	Name	Description
System.String[]	Parameters
System.String[]	PropertyTypes
System.Object[]	Values
System.String	TagName
System.String	ReferenceGroup

Returns

Type	Description
System.Int32

SetTag_Parameter_Values(String[], String[], Object[], String, String, String)

Declaration

public int SetTag_Parameter_Values(string[] Parameters, string[] PropertyTypes, object[] Values, string TagName, string ReferenceGroup, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	Parameters
System.String[]	PropertyTypes
System.Object[]	Values
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Int32

SetTag_Parameter_Values(String[], String[], Object[], String, String, String, ref String)

Declaration

public int SetTag_Parameter_Values(string[] Parameters, string[] PropertyTypes, object[] Values, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	Parameters
System.String[]	PropertyTypes
System.Object[]	Values
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Int32

SetTag_Parameter_Values(String[], String[], Object[], String, String, String, ref String, String)

Declaration

public int SetTag_Parameter_Values(string[] Parameters, string[] PropertyTypes, object[] Values, string TagName, string ReferenceGroup, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	Parameters
System.String[]	PropertyTypes
System.Object[]	Values
System.String	TagName
System.String	ReferenceGroup
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Int32

SetTagProperties(Object[])

Used to set tag properties to mutliple tags in one call using native values for each property.

Declaration

public string SetTagProperties(object[] PropertyValues)

Parameters

Type	Name	Description
System.Object[]	PropertyValues	An array of object arrays. The first row array must be a header array with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.

Returns

Type	Description
System.String	Success or error message Error string if service is not reachable

SetTagProperties(Object[], String)

Used to set tag properties to mutliple tags in one call using native values for each property.

Declaration

public string SetTagProperties(object[] PropertyValues, string NetworkNode)

Parameters

Type	Name	Description
System.Object[]	PropertyValues	An array of object arrays. The first row array must be a header array with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Error string if service is not reachable

SetTagProperties(Object[], String, ref String)

Used to set tag properties to mutliple tags in one call using native values for each property.

Declaration

public string SetTagProperties(object[] PropertyValues, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.Object[]	PropertyValues	An array of object arrays. The first row array must be a header array with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Error string if service is not reachable

SetTagProperties(Object[], String, ref String, String)

Used to set tag properties to mutliple tags in one call using native values for each property.

Declaration

public string SetTagProperties(object[] PropertyValues, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.Object[]	PropertyValues	An array of object arrays. The first row array must be a header array with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Error string if service is not reachable

Started()

Returns a value indicating that the server Runtime has started

Declaration

public bool Started()

Returns

Type	Description
System.Boolean	True for fully started, False for in the process of starting or stopping, or stoppe

Started(String)

Returns a value indicating that the server Runtime has started

Declaration

public bool Started(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Boolean	True for fully started, False for in the process of starting or stopping, or stoppe

Started(String, ref String)

Returns a value indicating that the server Runtime has started

Declaration

public bool Started(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Boolean	True for fully started, False for in the process of starting or stopping, or stoppe

Started(String, ref String, String)

Returns a value indicating that the server Runtime has started

Declaration

public bool Started(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Boolean	True for fully started, False for in the process of starting or stopping, or stoppe

StartRuntime()

Starts the OAS Service Runtime Mode

Declaration

public void StartRuntime()

StartRuntime(String)

Starts the OAS Service Runtime Mode

Declaration

public void StartRuntime(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

StartRuntime(String, ref String)

Starts the OAS Service Runtime Mode

Declaration

public void StartRuntime(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

StartRuntime(String, ref String, String)

Starts the OAS Service Runtime Mode

Declaration

public void StartRuntime(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Stopped()

Returns a value indicating that the server Runtime has stopped

Declaration

public bool Stopped()

Returns

Type	Description
System.Boolean	True for fully stopped, False for in the process of starting or stopping, or started

Stopped(String)

Returns a value indicating that the server Runtime has stopped

Declaration

public bool Stopped(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.Boolean	True for fully stopped, False for in the process of starting or stopping, or started

Stopped(String, ref String)

Returns a value indicating that the server Runtime has stopped

Declaration

public bool Stopped(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.Boolean	True for fully stopped, False for in the process of starting or stopping, or started

Stopped(String, ref String, String)

Returns a value indicating that the server Runtime has stopped

Declaration

public bool Stopped(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.Boolean	True for fully stopped, False for in the process of starting or stopping, or started

StopRuntime()

Stops the OAS Service Runtime Mode

Declaration

public void StopRuntime()

StopRuntime(String)

Stops the OAS Service Runtime Mode

Declaration

public void StopRuntime(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

StopRuntime(String, ref String)

Stops the OAS Service Runtime Mode

Declaration

public void StopRuntime(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

StopRuntime(String, ref String, String)

Stops the OAS Service Runtime Mode

Declaration

public void StopRuntime(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

TagCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportByGroup(String)

Gets an array of comma-separated Strings of all Tags under a referenced group, each String representing all attributes of a Tag

Declaration

public string[] TagCSVExportByGroup(string GroupName)

Parameters

Type	Name	Description
System.String	GroupName	The reference path of the group to export from

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportByGroup(String, String)

Gets an array of comma-separated Strings of all Tags under a referenced group, each String representing all attributes of a Tag

Declaration

public string[] TagCSVExportByGroup(string GroupName, string NetworkNode)

Parameters

Type	Name	Description
System.String	GroupName	The reference path of the group to export from
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportByGroup(String, String, ref String)

Gets an array of comma-separated Strings of all Tags under a referenced group, each String representing all attributes of a Tag

Declaration

public string[] TagCSVExportByGroup(string GroupName, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	GroupName	The reference path of the group to export from
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportByGroup(String, String, ref String, String)

Gets an array of comma-separated Strings of all Tags under a referenced group, each String representing all attributes of a Tag

Declaration

public string[] TagCSVExportByGroup(string GroupName, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	GroupName	The reference path of the group to export from
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportWithDesiredColumns(String[])

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExportWithDesiredColumns(string[] DesiredColumns)

Parameters

Type	Name	Description
System.String[]	DesiredColumns	An array of strings containing the column names desired. The order returned will be in the same order as the TagCSVHeaderString

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportWithDesiredColumns(String[], String)

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExportWithDesiredColumns(string[] DesiredColumns, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	DesiredColumns
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportWithDesiredColumns(String[], String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExportWithDesiredColumns(string[] DesiredColumns, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	DesiredColumns	An array of strings containing the column names desired. The order returned will be in the same order as the TagCSVHeaderString
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVExportWithDesiredColumns(String[], String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a Tag. This method is to be used in conjuction with TagCSVHeaderString.

Declaration

public string[] TagCSVExportWithDesiredColumns(string[] DesiredColumns, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	DesiredColumns	An array of strings containing the column names desired. The order returned will be in the same order as the TagCSVHeaderString
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

TagCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the TagCSVExport Function

Declaration

public string TagCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

TagCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the TagCSVExport Function

Declaration

public string TagCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

TagCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the TagCSVExport Function

Declaration

public string TagCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

TagCSVImport(String[])

Used to import comma-separated strings to the Tag configuration

Declaration

public string TagCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

TagCSVImport(String[], String)

Used to import comma-separated strings to the Tag configuration

Declaration

public string TagCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

TagCSVImport(String[], String, ref String)

Used to import comma-separated strings to the Tag configuration

Declaration

public string TagCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

TagCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the Tag configuration

Declaration

public string TagCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPBroadcastCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Broadcast Group. This method is to be used in conjuction with UDPBroadcastCSVHeaderString.

Declaration

public string[] UDPBroadcastCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPBroadcastCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Broadcast Group. This method is to be used in conjuction with UDPBroadcastCSVHeaderString.

Declaration

public string[] UDPBroadcastCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPBroadcastCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Broadcast Group. This method is to be used in conjuction with UDPBroadcastCSVHeaderString.

Declaration

public string[] UDPBroadcastCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPBroadcastCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Broadcast Group. This method is to be used in conjuction with UDPBroadcastCSVHeaderString.

Declaration

public string[] UDPBroadcastCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPBroadcastCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the UDPBroadcastCSVExport Function

Declaration

public string UDPBroadcastCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

UDPBroadcastCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the UDPBroadcastCSVExport Function

Declaration

public string UDPBroadcastCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

UDPBroadcastCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the UDPBroadcastCSVExport Function

Declaration

public string UDPBroadcastCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

UDPBroadcastCSVImport(String[])

Used to import comma-separated strings to the UDP Broadcast configuration

Declaration

public string UDPBroadcastCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPBroadcastCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the IP Address and Port Number columns must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPBroadcastCSVImport(String[], String)

Used to import comma-separated strings to the UDP Broadcast configuration

Declaration

public string UDPBroadcastCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPBroadcastCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the IP Address and Port Number columns must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPBroadcastCSVImport(String[], String, ref String)

Used to import comma-separated strings to the UDP Broadcast configuration

Declaration

public string UDPBroadcastCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPBroadcastCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the IP Address and Port Number columns must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPBroadcastCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the UDP Broadcast configuration

Declaration

public string UDPBroadcastCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPBroadcastCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the IP Address and Port Number columns must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPReceiveCSVExport()

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Receive Group. This method is to be used in conjuction with UDPReceiveCSVHeaderString.

Declaration

public string[] UDPReceiveCSVExport()

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPReceiveCSVExport(String)

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Receive Group. This method is to be used in conjuction with UDPReceiveCSVHeaderString.

Declaration

public string[] UDPReceiveCSVExport(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPReceiveCSVExport(String, ref String)

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Receive Group. This method is to be used in conjuction with UDPReceiveCSVHeaderString.

Declaration

public string[] UDPReceiveCSVExport(string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPReceiveCSVExport(String, ref String, String)

Gets an array of comma-separated Strings, each String representing all attributes of a UDP Receive Group. This method is to be used in conjuction with UDPReceiveCSVHeaderString.

Declaration

public string[] UDPReceiveCSVExport(string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String[]	An array of comma-separated string Empty array if service is not reachable

UDPReceiveCSVHeaderString()

Gets a comma-separated list of property values representing the heading row to be used with the UDPReceiveCSVExport Function

Declaration

public string UDPReceiveCSVHeaderString()

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

UDPReceiveCSVHeaderString(String)

Gets a comma-separated list of property values representing the heading row to be used with the UDPReceiveCSVExport Function

Declaration

public string UDPReceiveCSVHeaderString(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

UDPReceiveCSVHeaderString(String, String)

Gets a comma-separated list of property values representing the heading row to be used with the UDPReceiveCSVExport Function

Declaration

public string UDPReceiveCSVHeaderString(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Comma-separated list of property values Empty string if service is not reachable

UDPReceiveCSVImport(String[])

Used to import comma-separated strings to the UDP Receive configuration

Declaration

public string UDPReceiveCSVImport(string[] CSVStrings)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPReceiveCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the UDP Receive Group Name column must be specified.

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPReceiveCSVImport(String[], String)

Used to import comma-separated strings to the UDP Receive configuration

Declaration

public string UDPReceiveCSVImport(string[] CSVStrings, string NetworkNode)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPReceiveCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the UDP Receive Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPReceiveCSVImport(String[], String, ref String)

Used to import comma-separated strings to the UDP Receive configuration

Declaration

public string UDPReceiveCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPReceiveCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the UDP Receive Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UDPReceiveCSVImport(String[], String, ref String, String)

Used to import comma-separated strings to the UDP Receive configuration

Declaration

public string UDPReceiveCSVImport(string[] CSVStrings, string NetworkNode, ref string ErrorString, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String[]	CSVStrings	An array of comma-separated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the UDPReceiveCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the UDP Receive Group Name column must be specified.
System.String	NetworkNode	the network node to connect - leave null for localhost
System.String	ErrorString	Success or message
System.String	RemoteSCADAHostingName	name of the Live Data Cloud node to use

Returns

Type	Description
System.String	Success or error message Empty string if service is not reachable

UpdateOASVersion(String)

Starts an automated update.

Declaration

public string UpdateOASVersion(string NetworkNode)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

Returns

Type	Description
System.String	Success if update begins or Error if parameter is invalid.

UpdateOASVersion(String, String)

Starts an automated update.

Declaration

public string UpdateOASVersion(string NetworkNode, string RemoteSCADAHostingName)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
System.String	RemoteSCADAHostingName	The name of the Live Data Cloud OAS Service to connect to.

Returns

Type	Description
System.String	Success if update begins or Error if parameter is invalid.

UpdateOASVersion(String, String, String, String, String, String)

Starts an automated update.

Declaration

public string UpdateOASVersion(string NetworkNode, string RemoteSCADAHostingName, string CustomServerFilePathOAS, string CustomServerFilePathOASUpdate, string FTPUser, string FTPPassword)

Parameters

Type	Name	Description
System.String	NetworkNode	The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
System.String	RemoteSCADAHostingName	The name of the Live Data Cloud OAS Service to connect to.
System.String	CustomServerFilePathOAS	Will allow you to use your own hosting server as an http or ftp file path to download a specific version of the oas platform. When left blank the OAS download server will be used with the latest version available from the OAS download server. Example: https://filedownloads.openautomationsoftware.com/windows/V15.00.0014/ for Windows and https://filedownloads.openautomationsoftware.com/linux/V15.00.0014/ for Linux.
System.String	CustomServerFilePathOASUpdate	Will allow you to use your own hosting server as an http or ftp file path to download a specific version of the update application. When left blank the OAS download server will be used with the latest version available from the OAS download server. Example: https://filedownloads.openautomationsoftware.com/windows-update/V15.00.0014/ for Windows and https://filedownloads.openautomationsoftware.com/linux-update/V15.00.0014/ for Linux.
System.String	FTPUser	The user for your own download server when using ftp.
System.String	FTPPassword	The password for your own download server when using ftp.

Returns

Type	Description
System.String	Success if update begins or Error if parameter is invalid.