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


Autoplay Off


Agent tasks can be created and stored on the Controller Gateway to be run on-demand or by a Crontab schedule.

Video recorded using: Ignition 8.1


(open in window)

[00:00] Agent gateway tasks are enormously useful for applying an action to many agent gateways at once. To perform tasks on an agent, we need to be within the controller gateway webpage. Once here, you would go to the config tab and scroll all the way down to the agent task section of enterprise administration. This page holds all tasks that have been created. I currently do not have any tasks, so to make one, ill click on the create new gateway task selection. We have a list of unique tasks we could perform on an agent. Those include collecting project and gateway backups and restoring or sending those backups, handling agent licenses and modules, and sending over project resources. I'll choose a collect backup task here and click next to go over how to schedule the task. On the task scheduling screen, we can give the task a name and apply an execution method from one of five types.

[01:05] We can execute immediately, which will run the task as soon as this wizard is complete. Execute on demand provides the user the ability to immediately execute at any time without the need for a schedule. The once scheduled option runs the task once at the date and time you specify. Once delayed runs the task after the delayed duration. Finally, we can execute on a specified schedule, which provides us more in depth configuration. This method creates a schedule using cron tab, which is an expression that looks at a schedule, in order of minutes, hours, days, months, and days of the week. For example, the once per hour pre-configured selection in the common settings here starts at minute zero and runs every hour for every day, month, and weekday. With the every or all selection being specified by these asterisk. we can see it's been applied to hours, days, months, and days of the week.

[02:05] If you are unsure about how this scheduling is working, there is also this expression descriptor below, which provides a simple explanation of the cron tab expression. This menu also allows you to create your own expression with a custom method. So I'll set my custom schedule to run the task once on the first and 15th of every month. So to create this expression, I'll say at minute zero of hour zero or midnight. Using this number zero and for the first and 15th day, using one comma 15, and for every month and weekday using an asterisk. With my schedule defined, I'll continue through the wizard by clicking next. Now we can decide which agents or agent groups you can run the task on. If you had more groups or agents defined, this is where you would run the task on multiple agents. I'll select my only agent here and click next. Since we could run the collect backup task on multiple agents, we do have a nice setting here.

[03:06] This max concurrent backups, which can limit the number of concurrent requests. Specifying a value greater than zero provides the limit. This page would have relevant settings for the newly created task, so this page might have other settings if you chose a different task previously. Since I'm only running one task, I'll leave this as zero and click next. Finally, we are presented with the task summary that displays the name of the task, the task type, the schedule method, the target agents, and the limit on max concurrent backups. I'll click on finish here to enable the task on my agent. Now that the task is created, we could edit the task with the edit button. This would bring us back to the same configuration wizard we were just in. This more button here allows you to delete or run the task or even view its details, which would be the same information from the task summary we saw before. Since this task is scheduled in the future, it will show up in this running and scheduled task tab.

[04:05] In addition to the task, we also see this progress bar that would continue while the task is running, and we could also pause the task to prevent any further execution. The final tab here, task history, will display the results of our task, after it has been run. We can see I have a couple of failures and success messages for task I've run earlier. Task information can also be viewed within our status tab, so I'll click on status, then EAM task. Here we can see our currently running and scheduled task, as well as recent task history. All of this information as well as those tools previously mentioned, help us better maintain how tasks are run on connected agents.

You are editing this transcript.

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