This lesson is part of the Enterprise Administration Module course. You can browse the rest of the lessons below.


Autoplay Off


The EAM adds status information and statistics to the Gateway and the Designer. Learn about the Tags, binding functions, and scripting functions that are available to use in the clients.

Video recorded using: Ignition 7.9


(open in window)

[00:00] - [Music] The enterprise administration module provides a lot of information inside the designer as well. Things that will allow you to fetch agent information, or see history of tasks. And we are going to talk about those now. If you look in the tag browser in your designer, then you can see under the system folder, there is a gateway section which has an EAM folder in there. In addition to that we have a gateway network folder. If you expand out the EAM you can see that we have information about each of our Agents. In this case we just have the one, but if we expand these guys out, you can see here that I have information specifically about Agent one including which group it's in, what the name of it is, if it is approved, connected, running, what the licenses is, what the server ID is, all that information. Anything you could possibly want to know about the Agent. In addition to that we have this Metrics folder, Which tells us a lot of interesting information about all of the parts of that Agent. I don't have anything active running right now, but if I did then we would have a non zero value for the for the active connections and queries in the database. We'd be logging information and any errors to our console. We'd have any information about any sessions that are open and we have CPU and memory usage available to us. In addition to that under the gateway folder, you can see that we have also the agent information and specifically is it available on the gateway network, and when was the last communication time. In addition to the to the system tags, the EAM provides binding functions that allows us to learn a little bit more about what's going on. So I am going to open up my window here, and take a look at this power table that I've got. Now in the power table, I can go down to my data properties and click on the binding icon, and you can see because it's a data set property type, I have access to these function's bindings. If you go up to the dropdown at the top, then you can see that there is an enterprise administration section, and we can chose to do the Agent Status or Agent History. If we choose Agent Status, we can filter out based on a name, and bind either to a tag or to something else on the screen. We can bind based on a group, or we can choose specific connection. Now I am just going to leave all these blank, which means give me information about all of my agents and hit OK. And then you can see that we have our Agents here. We have the Agents Name, Node Role if its got one, what group I'm in, when my last communication was. Whether I mix up a connected all that information. In addition to that, if we go back here and instead of choosing Agent Status we choose agent history, you can see we have specific start and end dates, and then the same agent name and group name, And we have this Event Level as well. And we can say we want all of them or none. We can do normal warnings or errors. And if I hit OK here at the bottom, and you can see here all the different Agents items that happened. The agent role, the event time, the catecore, whether the task, the agent itself, a metric, any of that stuff. Now what the Event type was and all that information. The enterprise administration module also provides a couple of scripting functions for you. So I am going to go to my button here, And over to my script editor. And if you go to the system dot list then you can see we have a new EAM section. And you can see here we have the query agent status and query agent history and these are the same functions that we just saw in that binding. But then there is one other one here. This get Groups that is going to get the names the defined organizational groups. So what that means is it's going to give you the list of all the organizational groups that Agents are apart of. Why this is useful is in both he Agent History and Agent Status, you can filter out the results based on which group you want. So you can potentially loop through, and get one group at a time.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.


Share this video