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
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 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.
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 key classes to use are "Connection" and "DBObject". Note that you will need to reference the database schema, there is an online version At This Link, although you should browse your own database for schema specifics such as your driver and metadata field settings.
The API for Geo SCADA 2020 is also available online at this link: .Net Client API for 2020
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.
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.
Page: Calling Methods Using the Automation Interface
Page: Changing Alarm Limits via Automation Interface
Page: Enable Historic Logging on a Point
Page: Reading or Writing Object Properties in the Automation Interface
Page: Resolving Automation Interface Connection Failures
Page: Typical Automation Interface Errors
Page: Using Automation Interface to Add or Modify Security
Page: Using Automation Interface to Edit ST Program
Page: Using the Automation Interface from Perl
Page: Using the Automation Interface with C(sharp)