Overview

The Agent File Monitor task allows you to monitor a specific remote machine for the creation, deletion, change, existence, or non-existence of one or more files at a specific location. In order to run an Agent File Monitor task, you need Universal Agent for Windows, Linux/Unix, or z/OS running on the machine where you are monitoring for the file.

Processing Flow for Agent File Monitors

Agent File Monitor tasks are meant to be launched either by using a Agent File Monitor trigger or by being included within a Workflow. However, there are no technical restrictions on how an Agent File Monitor task can be launched. The processing may differ depending on which of the following methods was used to launch it:

Launched by a Workflow
Launched by an Agent File Monitor trigger
Launched manually or by another trigger type

The processing on an Agent File Monitor task for each launching method is described below.

Note

Any changes made to an Agent File Monitor task are not recognized by its respective Triggers until those Triggers are disabled and re-enabled.

Launching an Agent File Monitor Task Within a Workflow

The Agent File Monitor task can be launched within a Workflow.

In this scenario, the task launches when the upstream workflow conditions are satisfied. Workflow processing then pauses until the conditions in the Agent File Monitor task are satisfied. If the Agent File Monitor is watching for the creation, change, or deletion of a file, the task goes to SUCCESS when the event occurs. If the Agent File Monitor is watching for the existence or non-existence of a file, the task immediately goes to SUCCESS or FAILURE. Subsequent processing depends on the conditions built into the Workflow.

The following diagram illustrates the processing for this scenario.

Launching an Agent File Monitor Task Using an Agent File Monitor Trigger

A common use for the Agent File Monitor task is to launch it using an Agent File Monitor trigger, which specifies one or more tasks that are launched when a condition(s) is satisfied.

In this scenario, the Agent File Monitor task launches when its associated Agent File Monitor trigger is enabled.

Note

You should use an Agent File Monitor trigger to launch only Agent File Monitor tasks that specify a single Agent, not an Agent Cluster. An Agent File Monitor trigger can launch only a single task, not multiple tasks, which would be the case if an Agent Cluster was specified.

This method is best geared toward watching for the creation, deletion, or change in files. When the conditions in the Agent File Monitor task are satisfied, the Agent File Monitor task goes to SUCCESS and the tasks listed in the associated trigger are launched. The Agent File Monitor task continues running until its conditions are satisfied or until the user disables the trigger.

If you use this method to check for the existence or non-existence of a file, as soon as the task is launched it goes to SUCCESS or FINISHED status. If it goes to SUCCESS, the tasks specified in the trigger are launched. A FINISHED status indicates that it found a file that should not be there or did not find a file that should be there. Both of these cases constitute a "failure" of the conditions and therefore the tasks in the trigger are not launched.

When the Agent File Monitor task goes to FINISHED or SUCCESS, the associated Agent File (Monitor) trigger is automatically disabled.

Note

Using an Agent File Monitor trigger to trigger an Agent File Monitor task that is monitoring for the creation of one or more files (Monitor Type = Exists) will disable the trigger. You should instead specify (Monitor Type = Create) and check Trigger on Existence.

When you launch an Agent File Monitor task from an Agent File Monitor trigger, you cannot manually cancel or force finish the task. You can only stop the task by disabling the trigger. If you manually disable the trigger while the task is still running, the task goes to FINISHED status.

The diagram below illustrates the processing flow for this scenario.

Launching an Agent File Monitor Task Manually or Via Other Trigger

If you manually launch an Agent File Monitor task or launch it using a non-Agent File Monitor trigger, such as a Time trigger, the task continues running until its specified conditions are met, at which time the task goes to SUCCESS. No other processing occurs unless you have configured notifications with the task or set up some other task(s) to launch based on the status of this task.

If the conditions are not met, the task runs perpetually or until a user issues a Cancel or Force Finish command against it.

Built-In Variables

The following built-in variables can be used in an Agent File Monitor task to pass data where appropriate:

Creating an Agent File Monitor Task

Step 1	From the Automation Center navigation pane, select Tasks > Agent File Monitor Tasks. The Agent File Monitor Tasks list displays a list of all currently defined Agent File Monitor tasks. Below the list, Agent File Monitor Task Details for a new Agent File Monitor task displays.
Step 2	Enter/select Details for a new Agent File Monitor task, using the field descriptions below as a guide. Required fields display an asterisk ( * ) after the field name. Default values for fields, if available, display automatically. To display more of the Details fields on the screen, you can either: Use the scroll bar. Temporarily hide the list above the Details. Click the New button above the list to display a pop-up version of the Details.
Step 3	Click a Save button. The task is added to the database, and all buttons and tabs in the Task Details are enabled.

Note

To open an existing record on the list, either:

Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Agent File Monitor Task Details

The following Agent File Monitor Task Details is for an existing Agent File Monitor task.

Depending on the values that you enter / select for these fields, and whether or not the Agent File Monitor task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the Agent File Monitor Task Details.

Agent File Monitor Task Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Agent File Monitor Task Details.

Field Name	Description
General	This section contains general information about the task.
Name	Unable to render {include} The included page could not be found.
Version	Unable to render {include} The included page could not be found.
Description	Unable to render {include} The included page could not be found.
Member of Business Services	Unable to render {include} The included page could not be found.
Resolve Name Immediately	Unable to render {include} The included page could not be found.
Time Zone Preference	Unable to render {include} The included page could not be found.
Hold on Start	Unable to render {include} The included page could not be found.
Hold Reason	Unable to render {include} The included page could not be found.
Virtual Resource Priority	Unable to render {include} The included page could not be found.
Hold Resources on Failure	Unable to render {include} The included page could not be found.
Agent Details	This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.
Cluster	Unable to render {include} The included page could not be found.
Agent	Unable to render {include} The included page could not be found.
Agent Variable	Unable to render {include} The included page could not be found.
Agent Cluster	Unable to render {include} The included page could not be found.
Agent Cluster Variable	Unable to render {include} The included page could not be found.
Broadcast	Unable to render {include} The included page could not be found.
Cluster Broadcast	Unable to render {include} The included page could not be found.
Cluster Broadcast Variable	Unable to render {include} The included page could not be found.
Credentials	Unable to render {include} The included page could not be found.
Credentials Variable	Unable to render {include} The included page could not be found.
Agent File Monitor Details	This section contains assorted detailed information about the task.
Monitor Type	Unable to render {include} The included page could not be found.
Trigger on Existence	Unable to render {include} The included page could not be found.
Monitor File(s)	Unable to render {include} The included page could not be found.
Use Regular Expression	Unable to render {include} The included page could not be found.
Recursive	Unable to render {include} The included page could not be found.
Maximum Files	Unable to render {include} The included page could not be found.
File Owner	Unable to render {include} The included page could not be found.
Stable (seconds)	Unable to render {include} The included page could not be found.
By Percentage (+/-)	Unable to render {include} The included page could not be found.
By Size (+/-)	Unable to render {include} The included page could not be found.
By Scale	Unable to render {include} The included page could not be found.
To Size	Unable to render {include} The included page could not be found.
To Scale	Unable to render {include} The included page could not be found.
Minimum File Size	Unable to render {include} The included page could not be found.
Minimum File Scale	Unable to render {include} The included page could not be found.
Scan Text	Unable to render {include} The included page could not be found.
Scan Forward	Unable to render {include} The included page could not be found.
Wait / Delay Options	This section contains specifications for waiting to start and/or delaying on start the task.
Wait To Start	Unable to render {include} The included page could not be found.
Wait Time	Unable to render {include} The included page could not be found.
Wait Day Constraint	Unable to render {include} The included page could not be found.
Wait Duration	Unable to render {include} The included page could not be found.
Wait Duration In Seconds	Unable to render {include} The included page could not be found.
Delay On Start	Unable to render {include} The included page could not be found.
Delay Duration	Unable to render {include} The included page could not be found.
Delay Duration In Seconds	Unable to render {include} The included page could not be found.
Workflow Only	Unable to render {include} The included page could not be found.
Time Options	This section contains time-related statistics for task instances of the task.
Late Start	Unable to render {include} The included page could not be found.
Late Start Type	Unable to render {include} The included page could not be found.
Late Start Time	Unable to render {include} The included page could not be found.
Late Start Day Constraint	Unable to render {include} The included page could not be found.
Late Start Nth Amount	Unable to render {include} The included page could not be found.
Late Start Duration	Unable to render {include} The included page could not be found.
Late Finish	Unable to render {include} The included page could not be found.
Late Finish Type	Unable to render {include} The included page could not be found.
Late Finish Offset Type	Unable to render {include} The included page could not be found.
Late Finish Percentage Offset ( + )	Unable to render {include} The included page could not be found.
Late Finish Duration Offset ( + )	Unable to render {include} The included page could not be found.
Late Finish Duration Offset Unit	Unable to render {include} The included page could not be found.
Late Finish Time	Unable to render {include} The included page could not be found.
Late Finish Day Constraint	Unable to render {include} The included page could not be found.
Late Finish Nth Amount	Unable to render {include} The included page could not be found.
Late Finish Duration	Unable to render {include} The included page could not be found.
Early Finish	Unable to render {include} The included page could not be found.
Early Finish Type	Unable to render {include} The included page could not be found.
Early Finish Offset Type	Unable to render {include} The included page could not be found.
Early Finish Percentage Offset ( - )	Unable to render {include} The included page could not be found.
Early Finish Duration Offset ( - )	Unable to render {include} The included page could not be found.
Early Finish Duration Offset Unit	Unable to render {include} The included page could not be found.
Early Finish Time	Unable to render {include} The included page could not be found.
Early Finish Day Constraint	Unable to render {include} The included page could not be found.
Early Finish Nth Amount	Unable to render {include} The included page could not be found.
Early Finish Duration	Unable to render {include} The included page could not be found.
User Estimated Duration	Unable to render {include} The included page could not be found.
Critical Path Options	This section contains Critical Path-related specifications for the task.
CP Duration	Unable to render {include} The included page could not be found.
CP Duration (Resolved)	Unable to render {include} The included page could not be found.
CP Duration Unit	Unable to render {include} The included page could not be found.
Workflow Execution Options	This section contains Execution Restriction specifications for the task if it is within a Workflow.
Execution Restriction	Unable to render {include} The included page could not be found.
Restriction Period	Unable to render {include} The included page could not be found.
Before Date	Unable to render {include} The included page could not be found.
Before Time	Unable to render {include} The included page could not be found.
After Date	Unable to render {include} The included page could not be found.
After Time	Unable to render {include} The included page could not be found.
Date List	Unable to render {include} The included page could not be found.
Statistics	This section contains time-related statistics for task instances of the task.
First Execution	Unable to render {include} The included page could not be found.
Last Execution	Unable to render {include} The included page could not be found.
Last Instance Duration	Unable to render {include} The included page could not be found.
Lowest Instance Time	Unable to render {include} The included page could not be found.
Average Instance Time	Unable to render {include} The included page could not be found.
Highest Instance Time	Unable to render {include} The included page could not be found.
Number of Instances	Unable to render {include} The included page could not be found.
Metadata	This section contains Metadata information about this record.
UUID	Universally Unique Identifier of this record.
Updated By	Name of the user that last updated this record.
Updated	Date and time that this record was last updated.
Created By	Name of the user that created this record.
Created	Date and time that this record was created.
Buttons	This section identifies the buttons displayed above and below the Task Details that let you perform various actions.
Save	Saves a new task record in the Controller database.
Save & New	Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
Save & View	Saves a new record in the Controller database and continues to display that record.
New	Displays empty (except for default values) Details for creating a new task.
Update	Unable to render {include} The included page could not be found.
Launch Task	Unable to render {include} The included page could not be found.
View Parents	Unable to render {include} The included page could not be found.
Copy	Creates a copy of this task, which you are prompted to rename.
Delete	Unable to render {include} The included page could not be found. Note You cannot delete a task if it is either: Specified in an enabled Trigger. The only task specified in a disabled Trigger.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this task.
Tabs	This section identifies the tabs across the top of the Task Details that provide access to additional information about the task.
Variables	Unable to render {include} The included page could not be found.
Actions	Unable to render {include} The included page could not be found.
Virtual Resources	Unable to render {include} The included page could not be found.
Mutually Exclusive	Unable to render {include} The included page could not be found.
Instances	Lists all instances of the task.
Agent File Monitor Triggers	Unable to render {include} The included page could not be found.
Triggers	Unable to render {include} The included page could not be found.
Notes	Unable to render {include} The included page could not be found.
Versions	Unable to render {include} The included page could not be found.

Viewing an Agent File Monitor Task Instance

When an Agent File Monitor task is launched, the Controller creates a task instance record of that task.

A task instance contains detailed information about a single execution of that task.

You can access a task instance from:

Instances tab on the Agent File Monitor Task Details for that task
Activity Monitor
Task Instances list

Agent File Monitor Task Instance Details

The following Agent File Monitor Task Instance Details contains information on the execution of the task shown in the Agent File Monitor Task Details.

Agent File Monitor Task Instance Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in Agent File Monitor Task Instance Details.

Field Name	Description
General	This section contains general information about the task instance.
Instance Name	Name of this task instance.
Instance Number	Unable to render {include} The included page could not be found.
Description	Unable to render {include} The included page could not be found.
Member of Business Services	Unable to render {include} The included page could not be found.
Task	Unable to render {include} The included page could not be found.
Source Version	Unable to render {include} The included page could not be found.
Launch Source	Unable to render {include} The included page could not be found.
Source Instance	Unable to render {include} The included page could not be found.
Invoked by	Unable to render {include} The included page could not be found.
Execution User	Unable to render {include} The included page could not be found.
Calendar	Unable to render {include} The included page could not be found.
Time Zone Preference	Unable to render {include} The included page could not be found.
Virtual Resource Priority	Unable to render {include} The included page could not be found.
Hold Resources on Failure	Unable to render {include} The included page could not be found.
Status	This section contains information about the current status of the task instance.
Status	Unable to render {include} The included page could not be found.
Exit Code	Unable to render {include} The included page could not be found.
Status Description	Unable to render {include} The included page could not be found.
Operational Memo	Unable to render {include} The included page could not be found.
Evaluation Time	Unable to render {include} The included page could not be found.
Critical	Unable to render {include} The included page could not be found.
Wait Until Time	Unable to render {include} The included page could not be found.
Queued Time	Unable to render {include} The included page could not be found.
Trigger Time	Unable to render {include} The included page could not be found.
Launch Time	Unable to render {include} The included page could not be found.
Start Time	Unable to render {include} The included page could not be found.
End Time	Unable to render {include} The included page could not be found.
Duration	Unable to render {include} The included page could not be found.
Agent Details	This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.
Cluster	Unable to render {include} The included page could not be found.
Agent	Unable to render {include} The included page could not be found.
Agent Variable	Unable to render {include} The included page could not be found.
Agent Cluster	Unable to render {include} The included page could not be found.
Agent Cluster Variable	Unable to render {include} The included page could not be found.
Credentials	Unable to render {include} The included page could not be found.
Credentials Variable	Unable to render {include} The included page could not be found.
Agent File Monitor Details	This section contains assorted detailed information about the task instance.
Monitor Type	Unable to render {include} The included page could not be found.
Trigger on Existence	Unable to render {include} The included page could not be found.
Monitor File(s)	Unable to render {include} The included page could not be found.
Use Regular Expression	Unable to render {include} The included page could not be found.
Recursive	Unable to render {include} The included page could not be found.
Maximum Files	Unable to render {include} The included page could not be found.
File Owner	Unable to render {include} The included page could not be found.
Stable (seconds)	Unable to render {include} The included page could not be found.
By Percentage (+/-)	Unable to render {include} The included page could not be found.
By Size (+/-)	Unable to render {include} The included page could not be found.
By Scale	Unable to render {include} The included page could not be found.
To Size	Unable to render {include} The included page could not be found.
To Scale	Unable to render {include} The included page could not be found.
Minimum File Size	Unable to render {include} The included page could not be found.
Minimum File Scale	Unable to render {include} The included page could not be found.
Scan Text	Unable to render {include} The included page could not be found.
Scan Forward	Unable to render {include} The included page could not be found.
Wait / Delay Options	This section contains specifications for waiting to start and/or delaying on start the task.
Wait To Start	Unable to render {include} The included page could not be found.
Wait Time	Unable to render {include} The included page could not be found.
Wait Day Constraint	Unable to render {include} The included page could not be found.
Wait Duration	Unable to render {include} The included page could not be found.
Wait Duration In Seconds	Unable to render {include} The included page could not be found.
Delay On Start	Unable to render {include} The included page could not be found.
Delay Duration	Unable to render {include} The included page could not be found.
Delay Duration In Seconds	Unable to render {include} The included page could not be found.
Time Options	This section contains time-related specifications for the task instance.
Late Start	Unable to render {include} The included page could not be found.
Started Late	Unable to render {include} The included page could not be found.
Late Start Type	Unable to render {include} The included page could not be found.
Late Start Time	Unable to render {include} The included page could not be found.
Late Start Day Constraint	Unable to render {include} The included page could not be found.
Late Start Nth Amount	Unable to render {include} The included page could not be found.
Late Start Duration	Unable to render {include} The included page could not be found.
Computed Late Start Time	Unable to render {include} The included page could not be found.
Late Finish	Unable to render {include} The included page could not be found.
Finished Late	Unable to render {include} The included page could not be found.
Late Finish Type	Unable to render {include} The included page could not be found.
Late Finish Offset Type	Unable to render {include} The included page could not be found.
Late Finish Percentage Offset ( + )	Unable to render {include} The included page could not be found.
Late Finish Duration Offset ( + )	Unable to render {include} The included page could not be found.
Late Finish Duration Offset Unit	Unable to render {include} The included page could not be found.
Late Finish Time	Unable to render {include} The included page could not be found.
Late Finish Day Constraint	Unable to render {include} The included page could not be found.
Late Finish Nth Amount	Unable to render {include} The included page could not be found.
Late Finish Duration	Unable to render {include} The included page could not be found.
Computed Late Finish Time	Unable to render {include} The included page could not be found.
Early Finish	Unable to render {include} The included page could not be found.
Finished Early	Unable to render {include} The included page could not be found.
Early Finish Type	Unable to render {include} The included page could not be found.
Early Finish Offset Type	Unable to render {include} The included page could not be found.
Early Finish Percentage Offset ( - )	Unable to render {include} The included page could not be found.
Early Finish Duration Offset ( - )	Unable to render {include} The included page could not be found.
Early Finish Duration Offset Unit	Unable to render {include} The included page could not be found.
Early Finish Time	Unable to render {include} The included page could not be found.
Early Finish Day Constraint	Unable to render {include} The included page could not be found.
Early Finish Nth Amount	Unable to render {include} The included page could not be found.
Early Finish Duration	Unable to render {include} The included page could not be found.
Projected Late	Unable to render {include} The included page could not be found.
Critical Path Options	This section contains Critical Path-related specifications for the task.
CP Duration	Unable to render {include} The included page could not be found.
CP Duration (Resolved)	Unable to render {include} The included page could not be found.
CP Duration Unit	Unable to render {include} The included page could not be found.
Workflow Execution Options	This section contains Execution Restriction specifications for the task if it is within a Workflow.
Execution Restriction	Unable to render {include} The included page could not be found.
Restriction Period	Unable to render {include} The included page could not be found.
Before Date	Unable to render {include} The included page could not be found.
Before Time	Unable to render {include} The included page could not be found.
After Date	Unable to render {include} The included page could not be found.
After Time	Unable to render {include} The included page could not be found.
Date List	Unable to render {include} The included page could not be found.
Statistics	This section contains time-related statistics for the task instance.
User Estimated End Time	Unable to render {include} The included page could not be found.
Lowest Estimated End Time	Unable to render {include} The included page could not be found.
Average Estimated End Time	Unable to render {include} The included page could not be found.
Highest Estimated End Time	Unable to render {include} The included page could not be found.
Projected End Time	System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration.
Metadata	This section contains Metadata information about this record.
UUID	Universally Unique Identifier of this record.
Updated By	Name of the user that last updated this record.
Updated	Date and time that this record was last updated.
Created By	Name of the user that created this record.
Created	Date and time that this record was created.
Status History	History of all statuses that the task instance has gone through.
Buttons	This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions.
Update	Unable to render {include} The included page could not be found.
Force Finish	Unable to render {include} The included page could not be found.
Hold	Unable to render {include} The included page could not be found.
Skip	Unable to render {include} The included page could not be found.
Re-run	Unable to render {include} The included page could not be found.
View Parent	Unable to render {include} The included page could not be found.
Retrieve Output	Unable to render {include} The included page could not be found.
Delete	Unable to render {include} The included page could not be found.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this task instance.
Tabs	This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance.
Virtual Resources	Unable to render {include} The included page could not be found.
Exclusive Requests	Unable to render {include} The included page could not be found.
Notes	Unable to render {include} The included page could not be found.

Monitoring Task Execution

You can monitor all system activity from the Activity Monitor and can view activity history from the History list.