Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Notifications
Login / Register
Community
Community
Notifications
close
  • Forums
  • Knowledge Center
  • Events & Webinars
  • Ideas
  • Blogs
Help
Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Login / Register
Sustainability
Sustainability

Join our "Ask Me About" community webinar on May 20th at 9 AM CET and 5 PM CET to explore cybersecurity and monitoring for Data Center and edge IT. Learn about market trends, cutting-edge technologies, and best practices from industry experts.
Register and secure your Critical IT infrastructure

List of object with API

EcoStruxure Geo SCADA Expert Forum

Schneider Electric support forum about installation, configuration, integration and troubleshooting of EcoStruxure Geo SCADA Expert (ClearSCADA, ViewX, WebX).

cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
  • Home
  • Schneider Electric Community
  • Remote Operations
  • EcoStruxure Geo SCADA Expert Forum
  • List of object with API
Options
  • Subscribe to RSS Feed
  • Mark Topic as New
  • Mark Topic as Read
  • Float this Topic for Current User
  • Bookmark
  • Subscribe
  • Mute
  • Printer Friendly Page
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.
You have entered an invalid email address. Please re-enter the email address.
This co-worker has already been invited to the Exchange portal. Please invite another co-worker.
Please enter email address
Send Invite Cancel
Invitation Sent
Your invitation was sent.Thanks for sharing Exchange with your co-worker.
Send New Invite Close
Top Experts
User Count
sbeadle
Kirk sbeadle Kirk
307
AndrewScott
Admiral AndrewScott
96
BevanWeiss
Spock BevanWeiss
90
AdamWoodlandToo
Lt. Commander AdamWoodlandToo
36
View All

Invite a Colleague

Found this content useful? Share it with a Colleague!

Invite a Colleague Invite
Solved Go to Solution
Back to EcoStruxure Geo SCADA Expert Forum
Solved
IvanDeMarco97
Lieutenant JG IvanDeMarco97 Lieutenant JG
Lieutenant JG

Posted: ‎2023-05-10 05:30 AM

0 Likes
11
1883
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-10 05:30 AM

List of object with API

Hi everyone,
I'm making a tool that interfaces with GeoSCADA through the API.
Is there a method that returns me the list of all object types existing in GeoSCADA? (Ex. CMimic, CGroup, CDNP3AnalogIn, etc.)
Is there a method that returns all the properties of one or of these objects? (Ex. FullScale, Units, etc.)

 

Thank you!

Labels
  • Labels:
  • SCADA
  • Scripting
Reply

Link copied. Please paste this link to share this article on your social media post.

  • All forum topics
  • Previous Topic
  • Next Topic

Accepted Solutions
AndrewScott
Admiral AndrewScott
Admiral

Posted: ‎2023-05-10 06:31 AM

0 Likes
0
1877
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-10 06:31 AM

You've not said which API you're using but you can do this in the .NET client API. The IDatabaseMetadata.ListClasses() method will return all the classes (aka types) if you specify an empty string for the base class name parameter.

var classes = conn.Server.ListClasses("");

This method returns an array of ClassMetadata objects, which has a property called Properties which is a collection of the class's properties.


Andrew Scott, R&D Principal Technologist, AVEVA

See Answer In Context

Reply

Link copied. Please paste this link to share this article on your social media post.

Replies 11
AndrewScott
Admiral AndrewScott
Admiral

Posted: ‎2023-05-10 06:31 AM

0 Likes
0
1878
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-10 06:31 AM

You've not said which API you're using but you can do this in the .NET client API. The IDatabaseMetadata.ListClasses() method will return all the classes (aka types) if you specify an empty string for the base class name parameter.

var classes = conn.Server.ListClasses("");

This method returns an array of ClassMetadata objects, which has a property called Properties which is a collection of the class's properties.


Andrew Scott, R&D Principal Technologist, AVEVA
Reply

Link copied. Please paste this link to share this article on your social media post.

sbeadle
Kirk sbeadle Kirk
Kirk

Posted: ‎2023-05-10 06:43 AM

0 Likes
1
1873
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-10 06:43 AM

More detail - you can walk the class definitions:

var dbobject = connection.GetObject(fullname);
var cd = dbobject.ClassDefinition;
var bc = cd.BaseClass;
var dc = cd.DerivedClasses;

// Properties are separated into types for Config and Data (also Dynamic)

var cp = cd.ConfigurationProperties;

var dp = cd.DataProperties;

// You may need to walk into the aggregates too
var af = dbobject.Aggregates;

 

Reply

Link copied. Please paste this link to share this article on your social media post.

IvanDeMarco97
Lieutenant JG IvanDeMarco97 Lieutenant JG
Lieutenant JG

Posted: ‎2023-05-10 07:21 AM

0 Likes
0
1870
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-10 07:21 AM

I write this code in VB.NET:

SCXSystem = "Main"

SCXUser = "root"

SCXPassword = "MyPassword"

Svr.Connect(SCXSystem, SCXUser, SCXPassword)

 

After that, I don't understand what I have to write to have a list of objects...

Reply

Link copied. Please paste this link to share this article on your social media post.

AndrewScott
Admiral AndrewScott
Admiral

Posted: ‎2023-05-10 08:45 AM

0 Likes
0
1858
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-10 08:45 AM

Your VB.NET code is using the legacy COM automation API whereas Steve and myself are using the .NET client API and C#, see "EcoStruxure Geo SCADA \ Client API Guide" in the Windows start menu for the documentation.

 

Your original question asked for a list of object types (not a list of objects), which is what I described in my answer. Steve's answer assumed you had already created an object of a particular type and wanted to list the properties of that object.

 

I don't think the COM automation API contains any methods for listing the types of objects or getting a list of their properties.


Andrew Scott, R&D Principal Technologist, AVEVA
Reply

Link copied. Please paste this link to share this article on your social media post.

IvanDeMarco97
Lieutenant JG IvanDeMarco97 Lieutenant JG
Lieutenant JG

Posted: ‎2023-05-11 01:01 AM

0 Likes
0
1842
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-11 01:01 AM

Ah ok perfect.

is there a method to get the list of servers configured with client api?
The equivalent of:
Dim Systems As ScxV6DbClient.ScxV6Systems
Systems = Svr.Systems

Reply

Link copied. Please paste this link to share this article on your social media post.

sbeadle
Kirk sbeadle Kirk
Kirk

Posted: ‎2023-05-11 01:20 AM

0 Likes
1
1840
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-11 01:20 AM

Here's some sample code which reads systems.xml set up in Configure Connections.

It gets the address of the servers in a system from the system name. You could change it or add a function to return all systems.

 

		private static Dictionary<String, Int16> ReadServerDetails( string server)
		{
			Dictionary<String, Int16> result = new Dictionary<string, short>();
			// Any errors cause abort and no servers to be found
			try
			{
				// Open Systems.XML
				XmlDocument SystemsXML = new XmlDocument();
				SystemsXML.Load("C:\\ProgramData\\Schneider Electric\\ClearSCADA\\Systems.xml");
				XmlNodeList Systems = SystemsXML.SelectNodes("Systems/System");
				foreach (XmlNode System in Systems)
				{
					var SystemName = System.Attributes.GetNamedItem("name").Value;
					if (SystemName.ToLower() == server.ToLower())
					{
						XmlNodeList Servers = System.SelectNodes("Server");
						foreach (XmlNode Server in Servers)
						{
							var ServerName = Server.Attributes.GetNamedItem("name").Value;
							short ServerPort;
							if (short.TryParse(Server.Attributes.GetNamedItem("port").Value, out ServerPort))
							{
								// Identical server names but different ports will not be supported
								// i.e. if you are using 127.0.0.1 and two different ports, then change one for "localhost"
								result.Add(ServerName, ServerPort);
							}
						}
						break;
					}
				}
			}
			catch (Exception e)
			{
				Console.WriteLine("Error reading SYSTEMS.XML: " + e.Message);
			}
			return result;
		}

 

 

Reply

Link copied. Please paste this link to share this article on your social media post.

AndrewScott
Admiral AndrewScott
Admiral

Posted: ‎2023-05-11 01:46 AM

In response to sbeadle
0 Likes
0
1836
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2023-05-11 01:46 AM

You can also use the ServerSystemCollection class to parse the "Systems.xml" file for you, using a 

System.Xml. XmlReader.

Andrew Scott, R&D Principal Technologist, AVEVA
Reply

Link copied. Please paste this link to share this article on your social media post.

IvanDeMarco97
Lieutenant JG IvanDeMarco97 Lieutenant JG
Lieutenant JG

Posted: ‎2024-02-20 04:45 AM

In response to sbeadle
0 Likes
0
1265
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2024-02-20 04:45 AM

Hi Steve,

I start from class "CDNP3BinaryOut" and if I use "configurationProperties" I see InService, FullScale, ZeroScale, ecc.

How can I start from "CDNP3BinaryOut" and get to the "CDNP3BinaryControl" class?

 

Thanks!

Reply

Link copied. Please paste this link to share this article on your social media post.

AndrewScott
Admiral AndrewScott
Admiral

Posted: ‎2024-02-23 01:36 AM

0 Likes
1
1237
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2024-02-23 01:36 AM

The "CDNP3BinaryOut" class has an aggregate called "Control" of type "CDNP3BinaryControl". You can see this in the database schema:

 

image.png

 

So if you have a DNP3 binary output object you need to get the "Control" property of the object to get the associated control aggregate.


Andrew Scott, R&D Principal Technologist, AVEVA
Reply

Link copied. Please paste this link to share this article on your social media post.

IvanDeMarco97
Lieutenant JG IvanDeMarco97 Lieutenant JG
Lieutenant JG

Posted: ‎2024-03-15 10:36 AM

In response to AndrewScott
0 Likes
0
1137
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2024-03-15 10:36 AM

Hi Andrew,
it works! Just one last question...
How do I see the enable status of "Control"? I see all the properties relating to the control but I don't know which of these is the enable.

Reply

Link copied. Please paste this link to share this article on your social media post.

AndrewScott
Admiral AndrewScott
Admiral

Posted: ‎2024-03-18 04:59 AM

0 Likes
0
1129
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2024-03-18 04:59 AM

Are you referring to whether the control aggregate is enabled (i.e. whether the point can be controlled by Geo SCADA) or the operational state of the control (i.e. whether users are currently allowed to issue controls)?

See Specify Whether an Output Point is Controlled by Geo SCADA Expert 

See Disable Controls and Enable Controls pick actions

 

For the former the "Control" property itself indicates if the control aggregate is enabled or disabled.

For the later the "Control.ControlDisabled" Boolean property indicates whether controls are enabled (false) or disabled (true).


Andrew Scott, R&D Principal Technologist, AVEVA
Reply

Link copied. Please paste this link to share this article on your social media post.

Preview Exit Preview

never-displayed

You must be signed in to add attachments

never-displayed

 
To The Top!

Forums

  • APC UPS Data Center Backup Solutions
  • EcoStruxure IT
  • EcoStruxure Geo SCADA Expert
  • Metering & Power Quality
  • Schneider Electric Wiser

Knowledge Center

Events & webinars

Ideas

Blogs

Get Started

  • Ask the Community
  • Community Guidelines
  • Community User Guide
  • How-To & Best Practice
  • Experts Leaderboard
  • Contact Support
Brand-Logo
Subscribing is a smart move!
You can subscribe to this board after you log in or create your free account.
Forum-Icon

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.

Register today for FREE

Register Now

Already have an account? Login

Terms & Conditions Privacy Notice Change your Cookie Settings © 2025 Schneider Electric

This is a heading

With achievable small steps, users progress and continually feel satisfaction in task accomplishment.

Usetiful Onboarding Checklist remembers the progress of every user, allowing them to take bite-sized journeys and continue where they left.

of