.NET API to query ClearSCADA View

[Kan]

Hello! I need to replicate some logic in ClearSCADA code in .NET. The scada code selects values from a View and does some processing.

Does anyone know what API calls can query the View and get its data? Thanks a lot.

[sbeadle · Accepted solution]

What do you mean by a View - a SQL query?

An SQL query can be made on the .Net API using the Advanced connection type.

// Non-working code as an example:
                var node = new ClearScada.Client.ServerNode(ClearScada.Client.ConnectionType.Standard, "127.0.0.1", 5481);

                AdvConnection = node.Connect("mytest", false); // New type argument
                using (var spassword = new System.Security.SecureString())
                {
                    foreach (var c in password)
                    {
                        spassword.AppendChar(c);
                    }

                    AdvConnection.LogOn(user, spassword);
                }
// Fix indenting!
			Int32 result = 0;
                        String sql = "select id from cgroup"
			// Find the database reference of the thing
			ClearScada.Client.Advanced.IQuery serverQuery = AdvConnection.PrepareQuery(sql, new ClearScada.Client.Advanced.QueryParseParameters());
			ClearScada.Client.Advanced.QueryResult queryResult = serverQuery.ExecuteSync(new ClearScada.Client.Advanced.QueryExecuteParameters());

			if (queryResult.Status == ClearScada.Client.Advanced.QueryStatus.Succeeded || queryResult.Status == ClearScada.Client.Advanced.QueryStatus.NoDataFound)
			{
				if (queryResult.Rows.Count > 0)
				{
					// Found
					IEnumerator<ClearScada.Client.Advanced.QueryRow> e = queryResult.Rows.GetEnumerator();
					while (e.MoveNext())
					{
						result = (Int32)e.Current.Data[0];
					}
				}
			}
			serverQuery.Dispose();

[Kan]

Hi sbeadle,

Thanks heaps for answering my question.

I tried your solution and it works! The view in my question refers to the Historic Views defined in Historic Configuration.

Thank you again and have a nice day!

Kan

[BevanWeiss]

Hey Steve,

That's quite some old style enumerator iteration there

while (e.MoveNext())
					{
						result = (Int32)e.Current.Data[0];
					}

You're not a fan of the 'foreach'?

There's really so much more power in the .NET stuff around this, like doing processing in parallel..

[AdamWoodlandToo]

For anyone stumbling upon this in 2025, below is the same code (mostly!) as Steve's for Geo SCADA 2023 and PowerShell 5.1 (removed a load of exception handling to simplify things a little)

Write-Host "Starting"$(Get-Date) -ForegroundColor Cyan

Add-Type -path "C:\Program Files (x86)\Schneider Electric\ClearSCADA\ClearScada.Client.dll"

$serveraddress = "127.0.0.1"

$port = "5481"

$username = "some_user"

$password = ConvertTo-SecureString "some_password" -AsPlainText -Force

Write-Host "Connecting to Geo SCADA at" $serveraddress":"$port -ForegroundColor Cyan

$node = New-Object ClearScada.Client.ServerNode($serveraddress, $port)

$clearscada = New-Object ClearScada.Client.Simple.Connection("SqlTest")

$clearscada.Connect($node)

Write-Host "Connected. Logging in as" $username "... " -NoNewline

$clearscada.LogOn($username, $password) # In this code I don't actually use this, but its a snippet of something

Write-Host "Success" -ForegroundColor Green

$advclearscada = $clearscada.Server # Creates the advanced connection

$advclearscada.LogOn($username, $password)

$sql = "SELECT Id, FullName FROM CDBObject"

$parseparams = New-Object ClearScada.Client.Advanced.QueryParseParameters

$serverQuery = $advclearscada.PrepareQuery($sql, $parseparams)

$executeparams = New-Object ClearScada.Client.Advanced.QueryExecuteParameters

$queryResult = $serverQuery.ExecuteSync($executeparams)

if ($queryResult.Status -eq "Succeeded") # Not worked out how to do the enumeration in PowerShell for this so hard-coded!

{

    foreach($row in $queryResult.Rows)

    {

        Write-Host $row.data[0] "/" $row.data[1]

    }

}

$serverQuery.Dispose()

$serverQuery = $null

$advclearscada.LogOff()

$advclearscada = $null

$clearscada.LogOff()

$clearscada.Disconnect()

$clearscada = $null

Write-Host "Ended"$(Get-Date) -ForegroundColor Cyan