Subscribing is a smart move!
You can subscribe to this board after you log in or create your free account.
Invite a Co-worker
Send a co-worker an invite to the portal.Just enter their email address and we'll connect them to register. After joining, they will belong to the same company.
Send Invite Cancel
Link copied. Please paste this link to share this article on your social media post.
📖 Home
In many applications there is a need to interface ClearSCADA to external programs. Geo SCADA supports a range of application program interfaces (APIs) that can be accessed from various programming languages including C#, VB, C/C++ and Python. These include:
- .Net Client API
- Automation Interface
- ODBC
- XML/SOAP
- OPC
.Net Client API (Preferred)
Increasingly external programs are written using Microsoft's managed code environment. A .Net API is available for many advanced functions. (However the existing COM based API is also available to use from a managed code environment.)
The .Net API is used to connect to the server to perform monitoring, control or configuration of the Geo SCADA database. You can use any .Net Framework compatible languages, such as VB.Net or C#. You can also use Python via the library 'Pythonnet'.
.Net Client API Documentation:
If you look in the Start Menu folder for Geo SCADA, you will notice a "Client API Guide" shortcut.
This link will take you to the documentation for the automation interface. You should start in the ClearScada.Client.Simple Namespace.
The important classes to use are "Connection" and "DBObject". Note that you will need to reference the database schema. You should browse your own database for schema specifics such as your driver and metadata field settings - find it at the web services port of Geo SCADA, e.g. http://localhost/schema
For a simple example where C# code sets and reads a point value, go to: https://github.com/GeoSCADA/Utilities-and-Examples/tree/main/SetInternalPoint
For a similar example using Python and the Windows Pythonnet library, go to: https://github.com/GeoSCADA/Utilities-and-Examples/blob/main/PythonSamples/Geo%20SCADA%20Samples.py
Automation Interface (COM)
There are two COM interfaces.
Server Automation
Server Automation is a programming interface intended to allow external programs to interface to Geo SCADA. You can use the interface from a number of different programming languages to:
- Programmatically create new objects, modify existing objects, or even delete objects in a Geo SCADA database. This might be used to create a custom import tool, or create content in the Geo SCADA database based on a set of rules.
- Programmatically query the objects in a Geo SCADA database. This might be useful in creating custom reports or an export tool.
Server Automation uses the Common Object Model (COM) to export ActiveX Objects to external scripting or programming languages.
Documentation:
Documentation for this interface is in the class definitions - viewable from Visual Studio's object browser.
See examples linked below.
Client Automation
Client (ViewX) Automation enables programs to interact with ViewX and its documents. For example, mimics can be opened and edited.
Note: Client side automation is disabled by default for new installations of Geo SCADA 2022 (85) onward for improved security. It can be enabled from the "System Configuration \ ViewX" page in the Server Configuration tool.
Documentation:
Documentation for this interface is in the class definitions - viewable from Visual Studio's object browser.
See examples linked below.
Web Interfaces
Geo SCADA also presents information through SOAP and XML via the Web Interface, with some additional information as REST queries. Services using the EWS (EcoStruxure Web Services) and OPC-XML-DA protocols are available too. This is used by the Geo SCADA Web Client to communicate to the Geo SCADA Server. These interfaces are also open for use by third party applications.
Documentation:
These interfaces are not documented and may not be stable between Geo SCADA releases.
Home
More Links:
Introductions to the Server and Client Automation Interfaces
Log File Generation with the .Net API
Using the Server Automation Interface from Perl
Using the Server Automation Interface with C(sharp)
Changing Alarm Limits via the Server Automation Interface
Enable Historic Logging on a Point with the Server Automation Interface
Reading or Writing Object Properties in the Server Automation Interface
Resolving Server Automation Interface Connection Failures
Typical Server Automation Interface Errors
Using Server Automation Interface to Add or Modify Security
Using ViewX Client Automation Interface to an Edit ST Program
Author
Create your free account or log in to subscribe to the board - and gain access to more than 10,000+ support articles along with insights from experts and peers.