LESSON

EAM in the Designer

Description

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 8.3

Transcript

(open in window)

[00:00] In this lesson, we'll learn how to use the designer with the unique features available in the enterprise administration module. Looking at my screen, I've created this agent monitor window designed to view agent information and execute task. This power table here is set up to view the results of query functions depending on which button I click, so we could view the current status of our agents confirming if they are connected or running or the history of all agent events in the database. We can take a look at the functions by opening up the scripting panel for the components. In this case, we see the function for query agent history and its return dataset is assigned to the table's data. The script for our other button looks exactly the same except it uses the query agent status function. To use either of the functions in your own scripts, you can simply type out system dot eam dot and the editor will present all of the available EAM functions and you can just choose which ones you need from this list. Below this video, I've included a link to the user manual page for EAM in the designer, and you can find more information on these functions, including their return values and any special parameters.

[01:10] Now, you are not limited to just scripting functions when it comes to viewing an agent's status or history. You can instead use a function binding. For example, I can open up the binding menu on the power tables data and I'll select the functions option. And in this dropdown under EAM, we'll find the query agent status and history. Each of them have additional input fields allowing us to do things like specifying an agent or group and setting a date to view information by, but effectively these will show us the same information returned from those scripts. Now I mentioned we are able to run tasks from this window, and that's done using this button down here. If we take a look at its script, it runs the system do eam dot run task function, which executes a pre-configured task. I'll close out of this and I can run either the collect backup or restart agent task depending on what's selected in the dropdown. But for this to work, they already need to be available in the controller's agents task page. We'll navigate there and we can see they are in fact here, and the task name matches the input I have in the designer.

[02:08] So we could go back and execute a restart agent task, and if we look at the agent, we'll see it go down and come back online again. Just a quick note here is that if you plan on executing task like this in vision, then you do need to enable the project permission. The last function we have available is system dot eam dot get groups, which will return a list of all agent groups set on the controller. I'm going to open up a script console and run this function that prints the results from the returned list. In the output, we see the default group that all agents belong to initially and this new group I created. Outside of functions we are also able to view agent information with system tags. I'll close out of the console here and set my tag provider to system. Expanding this gateway folder reveals that we do have a folder for EAM with sections for each of our agents. These will hold tags that include things like the group, the agent is in, the name, if it is approved, connected or running and even the version. To wrap up this lesson, I'd like to talk about being able to send tags from the designer utilizing EAM. From the controller, you can right click on the tag and I'll do it on this example controller tag and then highlight the EAM option, which reveals the send tags to servers feature.

[03:19] Clicking on this opens up a panel where we can specify the location to copy any of our selected tags. So I can choose the provider and which agent gateways to send to. There is a collision policy for handling duplicate tags, and by default, if this controller tag already existed on my agent, it would get overwritten. After selecting the location, we can click on okay and confirm that we want to send the tag over. Once this is done, we can go to the agent's designer and a copy of that controller tag is now available. Since it is unlikely that you have identical PLC devices connected to multiple ignition gateways, this will only be useful for development slash production server pairs or for memory tags. Something to keep in mind is that remote tag editing through an EAM system is not allowed by default and is prevented by the security zone setup on our agent gateway.

[04:05] To get around this, we'll need to add a new zone for our controller users to be able to send tags. So we'll go back to the agent gateway and I'll need to log in since we did restart this with the restart agent task. From the homepage, we'll navigate to the platform tab and the zones page. Now, I already created a zone that allows me to do remote tag editing, and if you want to create one, you'll click on this create security zone button. You would then give it a name of your choice and then what's important is this identifier section here. You can pass in a remote identifier for your controller, whether that be the IP host name or gateway name, and this allows it to be accepted in the security zone. After this, you would click on the create security zone button at the bottom, but I'll just close this page since I already have the zone. Once the new zone is created and shows up on this page, you would then click on this more options button and choose to manage the zone's policies. We'll scroll down to the tag access section and what we need to change is this default provider access level.

[05:02] Setting this to a mode of read/write/edit will allow us to send over the tags with EAM.

You are editing this transcript.

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