Agent File Monitor Task
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. |
---|---|
Step 2 |
Enter/select Details for a new Agent File Monitor task, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
Step 3 |
Click the 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 |
User-defined name of this task (Maximum = 255 alphanumeric characters); variables supported. It is the responsibility of the user to develop a workable naming scheme for tasks. |
||||||||||
Version |
System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning. |
||||||||||
Description |
Description of this record. Maximum length is 255 characters. |
||||||||||
Member of Business Services |
User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
||||||||||
Resolve Name Immediately |
If enabled, the Instance Name of the task instance will be resolved immediately at trigger/launch time. |
||||||||||
Time Zone Preference |
User-defined; Allows you to specify the time zone that will be applied to the task. Options:
|
||||||||||
Hold on Start |
If enabled, when the task is launched it appears in the Activity Monitor with a status of Held. The task runs when the user releases it. |
||||||||||
Hold Reason |
Information about why the task will be put on hold when it starts. |
||||||||||
Virtual Resource Priority |
Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task. Options: 1 (high) - 100 (low). Default is 10. |
||||||||||
Hold Resources on Failure |
If enabled, the task instance will continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped. |
||||||||||
Mutually Exclusive With Self |
If enabled, the task will not be allowed to run concurrently with itself. Task will not start until the instance that is running finishes. An instance will transition to Exclusive Wait status if it cannot start due to another instance already running. |
||||||||||
Simulate | Specifies if the instance should execute under simulation mode. |
||||||||||
Agent Details |
This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
||||||||||
Cluster |
Indication that selecting an Agent Cluster is required and selecting Broadcast, which lets you select a Cluster Broadcast, is optional. If Cluster is selected, selecting an Agent is not required unless Agent Variable is selected. |
||||||||||
Agent |
Name of the Agent resource that identifies the machine where the operation will run. If you do not specify an Agent, you must specify an Agent Cluster or Cluster Broadcast. |
||||||||||
Agent Variable |
Indication of whether the Agent field is a reference field for selecting a specific Agent (unchecked) or a text field for specifying the Agent as a variable (checked). Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent reference to using an Agent variable, you must change the Agent Variable field to Yes and specify the Agent variable in the Agent Unresolved field. Conversely, to change from using an Agent variable to using an Agent reference, you must change the Agent Variable field to No and specify the Agent reference in the Agent field. |
||||||||||
Agent Cluster |
If Cluster is selected and Broadcast is not selected; Group of Agents, one of which the Controller will choose to run this task (compare with Cluster Broadcast). You can specify an agent cluster in addition to or in place of a specific Agent. If you specify an Agent and an agent cluster, the Controller first tries to run the task on the specific agent. If the Agent is not available, the Controller reverts to the agent cluster. See Agent Clusters for more information. |
||||||||||
Agent Cluster Variable |
Indication of whether the Agent Cluster field is a reference field for selecting a specific Agent Cluster (unchecked) or a text field for specifying the Agent Cluster as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent Cluster reference to using an Agent Cluster variable, you must change the Agent Cluster Variable field to Yes and specify the Agent Cluster variable in the Agent Cluster Unresolved field. Conversely, to change from using an Agent Cluster variable to using an Agent Cluster reference, you must change the Agent Cluster Variable field to No and specify the Agent Cluster reference in the Agent Cluster field. |
||||||||||
Broadcast |
Displays only if Cluster is selected; Indication that selecting a Cluster Broadcast is required. Selecting Broadcast hides the Agent and Agent Cluster fields; you cannot select values for them. |
||||||||||
Cluster Broadcast |
Group of Agents, all of which will run this task (compare with Agent Cluster). If Broadcast is selected for a task, you must select a Cluster Broadcast instead of a specific Agent and/or agent cluster. Each instance of the task running on its own Agent becomes a separate task instance record in the database and displays separately on the Activity Monitor. |
||||||||||
Cluster Broadcast Variable |
Indication of whether the Cluster Broadcast field is a reference field for selecting a specific Cluster Broadcast (unchecked) or a text field for specifying the Cluster Broadcast as a variable (checked). Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Cluster Broadcast reference to using a Cluster Broadcast variable, you must change the Cluster Broadcast Variable field to Yes and specify the Cluster Broadcast variable in the Cluster Broadcast Unresolved field. Conversely, to change from using a Cluster Broadcast variable to using a Cluster Broadcast reference, you must change the Cluster Broadcast Variable field to No and specify the Cluster Broadcast reference in the Cluster Broadcast field. |
||||||||||
Credentials |
Credentials under which an Agent runs this task. These Credentials override any Credentials provided in the Agent Details for any Agent running this task. If the user does not have a login shell, add a - character in front of the runtime credentials name. The Controller will provide a shell for that user and strip the - character from the name. Required if the Agent Credentials Required Universal Controller system property is true. When required, if the Credential is specified as a variable, and the variable resolves to blank, a Start Failure will occur. |
||||||||||
Credentials Variable |
Indication of whether the Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Credential as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Credentials reference to using a Credentials variable, you must change the Credentials Variable field to Yes and specify the Credentials variable in the Credentials Unresolved field. Conversely, to change from using a Credentials variable to using a Credentials reference, you must change the Credentials Variable field to No and specify the Credentials reference in the Credentials field. |
||||||||||
Agent File Monitor Details |
This section contains assorted detailed information about the task. |
||||||||||
Monitor Type |
Type of file event being monitored for. Options:
Note For UNIX and Windows, Agent File Monitor polls the directory listing every 5 seconds to compare the listings and decide whether there were any file system changes that match the monitor criteria. |
||||||||||
Trigger on Existence |
If Monitor Type = Create; Task is triggered if the file being monitored for creation already exists. Note This field is valid only for Linux/Unix and Windows Agents. |
||||||||||
Trigger on Create | If Monitor Type = Change; Task is triggered if the file being monitored is being created. Note This field is valid only for z/OS Agents. |
||||||||||
Monitor File(s) |
Location and name of a specific file or file pattern (for example, ACT001*) being monitored. Variables supported. Wildcards supported. Note z/OS files must be valid names based on the Data Set Naming Rules. No extra quoting is necessary. Note Agent File Monitors with Monitor Type = Exists or Missing do not work with GDG datasets. Whether the generation is coded explicitly (for example: DATA.SET.NAME.G0001V00) or relatively (for example: DATA.SET.NAME(0)), the Agent File Monitor will always end with 'Dataset Not Found'. |
||||||||||
Use Regular Expression |
Enables the use of a regular expression in the Monitor File(s) field. |
||||||||||
Recursive |
If enabled, the monitor searches the specified directory and all subdirectories. |
||||||||||
Maximum Files |
If Monitor Type = Create, Delete, or Change; For searches that use wildcards, limits the number of files to be searched. |
||||||||||
File Owner |
If Monitor Type = Create, Delete, Change, or Exists; User name / group name of the owner of the file on the operating system; that is, the user name / group name returned by the operating system in the file ownership information. LDAP groups are supported. Specifying a file owner limits the search to files with that owner. |
||||||||||
Stable (seconds) |
If Monitor Type = Change or Create; Period of time, in seconds, that a file's timestamp and size may not change to be considered as stable. Not applicable for z/OS. |
||||||||||
By Percentage (+/-) |
If Monitor Type = Change; Number that specifies the growth of a file as a percentage. A negative number specifies a reduction in size as a percentage. Not applicable for z/OS. |
||||||||||
By Size (+/-) |
If Monitor Type = Change; Used in conjunction with the By Scale field, specifies an actual change in file size. For example, to monitor for a change in file size of 10 MB, enter 10 in this field and select MB in the By Scale field. Enter a negative number to specify a reduction in size. Not applicable for z/OS. |
||||||||||
By Scale |
If Monitor Type = Change; Used in conjunction with the By Size field, specifies Bytes, KB (kilobytes), or MB (megabytes). Not applicable for z/OS. |
||||||||||
To Size |
If Monitor Type = Change; Used in conjunction with the To Scale field, specifies an actual file size that you want to monitor for. For example, to monitor for a file size of 5KB, enter 5 in this field and select KB in the To scale field. Not applicable for z/OS. |
||||||||||
To Scale |
If Monitor Type = Change; Used in conjunction with the To Size field, specifies an actual file size that you want to monitor for. Not applicable for z/OS. |
||||||||||
Minimum File Size |
If Monitor Type = Create; Minimum file size required for the file being created. Not applicable for z/OS. |
||||||||||
Minimum File Scale |
If Monitor Type = Create; Scale for the Minimum File Size. Not applicable for z/OS. Options:
|
||||||||||
Scan Text |
If Monitor Type = Change or Exists, or if Monitor Type = Create and a value for Stable (seconds) is specified; Specifying a string means that only files containing the string constitute a match. The string will be processed as a regular expression. Not applicable for z/OS. |
||||||||||
Scan Forward |
If Monitor Type = Change; Specifies that once the File Monitor has been satisfied, it should continue from where it left off.
Not applicable for z/OS. |
||||||||||
Wait / Delay Options |
This section contains specifications for waiting to start and/or delaying on start the task. |
||||||||||
Wait To Start |
Amount of time to wait before starting a task from the time that it was launched.
|
||||||||||
Wait Time |
If Wait To Start = Time or Relative Time; Time of day (in 24-hour time) to wait until before starting the task. |
||||||||||
Wait Day Constraint |
If Wait To Start = Time or Relative Time; Specification for whether or not to advance the wait time to another day. Valid values:
Default is – None --. |
||||||||||
Wait Duration |
If Wait To Start = Duration; Number of days, hours, minutes, and seconds to wait before starting the task. |
||||||||||
Wait Duration In Seconds |
If Wait To Start = Seconds; Number of seconds to wait before starting the task. |
||||||||||
Delay On Start |
Amount of time to delay the start of a task, after it has been launched, from the time that it is eligible to start; that is, all dependencies have been met. For example: it is not being held, it is not waiting on any predecessors, or there is no wait time specified.
|
||||||||||
Delay Duration |
If Delay On Start = Duration; Number of days, hours, minutes, and seconds to delay after starting the task. |
||||||||||
Delay Duration In Seconds |
If Delay On Start = Seconds; Number of seconds to delay after starting the task. |
||||||||||
Workflow Only |
Specification for whether or not to apply the Wait To Start and Delay On Start specifications only if the task is in a Workflow.
|
||||||||||
Time Options |
This section contains time-related statistics for task instances of the task. |
||||||||||
Late Start |
If enabled, and if the task instance starts after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late start (see Late Start Type). To determine whether a task instance started late, open the task instance and locate the Started Late field; the field is checked if the instance started after the specified time. The Started Late field displays in the task instance Details only if the user specified a Late Start in the task Details. |
||||||||||
Late Start Type |
Required if Late Start is enabled. Options:
|
||||||||||
Late Start Time |
If Late Start Type = Time; Time after which the task start time is considered late. Use HH:MM, 24-hour time. |
||||||||||
Late Start Day Constraint |
If Late Start Type = Time; Specification for whether or not to advance the late start time to another day.
Default is – None --. |
||||||||||
Late Start Nth Amount |
If Late Start Day Constraint = Nth Day; Number of days to advance. |
||||||||||
Late Start Duration |
If Late Start Type = Duration; Duration (amount of relative time) after which the task is considered to have started late. For a task within a workflow, the duration is the period between the time the workflow starts and the time the task itself starts. For example, a task might have a Late Start Duration of 60 minutes. If the workflow starts at 9:00 a.m. but the task itself does not start until 10:30, the task has started late. For a task that is not within a workflow, Late Start Duration has meaning only if the task has been held upon starting. For example, if a task has a Late Start Duration of 60 minutes and the Hold on Start field is enabled, if the task is not released from hold within the amount of time specified in the Late Start Duration field, the task has started late. |
||||||||||
Late Finish |
If enabled, and if the task instance finishes after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late finish (see Late Finish Type). To determine whether a task instance finished late, open the task instance and locate the Finished Late field; the field is checked if the instance finished after the specified time or lasted longer than expected. This field only appears on the task instance if the user specified a Late Finish in the task definition. |
||||||||||
Late Finish Type |
Required if Late Finish is enabled. Options:
|
||||||||||
Late Finish Offset Type |
|
||||||||||
Late Finish Percentage Offset ( + ) |
Required if Late Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
Late Finish Duration Offset ( + ) |
Required if Late Finish Offset Type = Duration; Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
Late Finish Duration Offset Unit |
|
||||||||||
Late Finish Time |
If Late Finish Type = Time; Time after which the task finish time is considered late. Use HH:MM, 24-hour time. |
||||||||||
Late Finish Day Constraint |
If Late Finish Type = Time; Specification for whether or not to advance the late finish time to another day.
Default is – None --. |
||||||||||
Late Finish Nth Amount |
If Late Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
Late Finish Duration |
If Late Finish Type = Duration; Longest amount of time this task instance should take to run. |
||||||||||
Early Finish |
If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. You can specify a time or duration to determine an early finish (see Early Finish Type). To determine whether a task instance finished early, open the task instance and locate the Finished Early field; the field is checked if the instance finished before the specified time or did not last as long as expected. This field only appears on the task instance if the user added Early Finish specifications to the task definition. |
||||||||||
Early Finish Type |
Required if Early Finish is enabled. Options:
|
||||||||||
Early Finish Offset Type |
|
||||||||||
Early Finish Percentage Offset ( - ) |
Required if Early Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
Early Finish Duration Offset ( - ) |
Required if Early Finish Offset Type = Duration; Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
Early Finish Duration Offset Unit |
|
||||||||||
Early Finish Time |
If Early Finish Type = Time; Time before which the task finish time is considered early. That is, enter a time at which the task should still be running. Use HH:MM, 24-hour time. |
||||||||||
Early Finish Day Constraint |
If Early Finish Type = Time; Specification for whether or not to advance the early finish time to another day.
Default is – None --. |
||||||||||
Early Finish Nth Amount |
If Early Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
Early Finish Duration |
If Early Finish Type = Duration; Shortest amount of time this task instance should take to run. |
||||||||||
User Estimated Duration |
Required if Early Finish Type or Late Finish Type = Average Duration; Estimated amount of time it should normally take to run this task. The Controller uses this information to calculate the User Estimated End Time on a task instance record. User Estimated Duration is used when the Average Duration is not available; for example, on the first launch of a task. |
||||||||||
Critical Path Options |
This section contains Critical Path-related specifications for the task. |
||||||||||
CP Duration |
Optional; Allows you to override the estimated Critical Path Duration of the task when running in a Workflow; used in conjunction with the CP Duration Unit field. In most cases, this field should be left blank, which implies that the Controller will estimate the Critical Path Duration based on historical executions. Valid values are any integer equal to or greater than 0. Variables and Functions are supported. |
||||||||||
CP Duration (Resolved) |
Displays the current resolved value of the CP Duration field, which may contain variables or functions that will be displayed as unresolved until the task instance starts. The CP Duration (Resolved) field can continue to change value until the task instance starts, at which time CP Duration will display as resolved and CP Duration (Resolved) will no longer be visible unless there was an issue resolving the variables and/or functions contained within CP Duration. If the Controller is unable to resolve CP Duration or it resolves to an invalid value, CP Duration will be ignored and the Controller will estimate the Critical Path Duration based on historical executions. |
||||||||||
CP Duration Unit |
Type of CP Duration; used in conjunction with the CP Duration field. For example, for a CP Duration of two minutes, specify 2 in the CP Duration field and select Minutes in this field. Options:
Default is Minutes. |
||||||||||
Workflow Execution Options |
This section contains Execution Restriction specifications for the task if it is within a Workflow. |
||||||||||
Execution Restriction |
Specification for whether or not there is a restriction for this task to be run, skipped, or held. Options are:
If Execution Restriction on a task is Run or Skip, then when it is part of a Workflow that is being launched, the Restriction Period is evaluated. The task instance will be skipped if Execution Restriction is Skip and the date is within the Restriction Period or Execution Restriction is Run and the date is not within the Restriction Period. Execution Restriction can be set to Skip with a Restriction Period of - None -, meaning the restriction is always active and the task will be skipped when it is part of a Workflow. |
||||||||||
Restriction Period |
If Execution Restriction = Run, Skip, or Hold; Period of time when the task is restricted. Options are:
|
||||||||||
Before Date |
If Restriction Period = Before or Span; Date before which the restriction is valid. |
||||||||||
Before Time |
If Restriction Period = Before or Span; Time on the selected date before which the restriction is valid. |
||||||||||
After Date |
If Restriction Period = After or Span; Date after which the restriction is valid. |
||||||||||
After Time |
If Restriction Period = After or Span; Time on the selected date after which the restriction is valid. |
||||||||||
Date List |
If Restriction Period = On; Date(s) on which the restriction is valid. |
||||||||||
Statistics |
This section contains time-related statistics for task instances of the task. |
||||||||||
First Execution |
System-supplied; End Time of the first instance of this task to complete. |
||||||||||
Last Execution |
System-supplied; End Time of the last instance of this task to complete. |
||||||||||
Last Instance Duration |
System-supplied; Amount of time the task took to run the last time it ran. |
||||||||||
Lowest Instance Time |
System-supplied; Lowest amount of time this task has taken to run. |
||||||||||
Average Instance Time |
System-supplied; Average amount of time this task takes to run. |
||||||||||
Highest Instance Time |
System-supplied; Highest amount of time this task has taken to run. |
||||||||||
Number of Instances |
System-supplied; Number of instances in the database for this task. |
||||||||||
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 |
Saves updates to the record. |
||||||||||
Launch Task |
|
||||||||||
View Parents |
Displays a list of any parent Workflow tasks for this task. |
||||||||||
Copy |
Creates a copy of this task, which you are prompted to rename. |
||||||||||
Delete |
Deletes the current record. Note You cannot delete a task if it is either:
|
||||||||||
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 |
|
||||||||||
Actions |
Allows you to specify actions that the Controller will take automatically based on events that occur during the execution of this task. Events are:
Actions are:
|
||||||||||
Virtual Resources |
|
||||||||||
Mutually Exclusive |
|
||||||||||
Instances |
Lists all instances of the task. |
||||||||||
Agent File Monitor Triggers |
Lists all Agent File Monitor triggers that reference this task in the Agent File Monitor field of the trigger Details; that is, a list of all Agent File Monitor triggers that execute this task. For instructions on creating triggers, see /wiki/spaces/UC71x/pages/5179564. |
||||||||||
Triggers |
List of all triggers that reference this task in the Task(s) field of the trigger Details; that is, a list of all triggers that have been defined to launch this task. Also allows you to add new triggers. If you add a new trigger from this location, the Controller automatically constructs a default trigger name as follows: <current task name>#TRIGGER#. You can change the default name if desired. For instructions on creating triggers, see Triggers. |
||||||||||
Notes |
|
||||||||||
Versions |
|
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 |
System-supplied; Sequentially assigned number, maintained per task, representing the creation order of the instance. |
Description |
Description of this record. Maximum length is 255 characters. |
Member of Business Services |
User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
Task |
Name of the task that was run to create this task instance. Click the icon to display Task Details for the task. |
Source Version |
Version of the task that was run to create this task instance. |
Launch Source |
System-supplied; Source from which this task was launched. Options:
|
Source Instance |
System-supplied; UUID of the source instance.
|
Invoked by |
System-supplied; how the task instance was launched. Options:
|
Execution User |
System-supplied; If the task was launched manually; ID of the user who launched it. |
Calendar |
Calendar associated with the task instance. |
Time Zone Preference |
User-defined; Allows you to specify the time zone that will be applied to the task. Options:
|
Virtual Resource Priority |
Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task. Options: 1 (high) - 100 (low). Default is 10. |
Hold Resources on Failure |
If enabled, the task instance will continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped. |
Mutually Exclusive With Self |
If enabled, the task will not be allowed to run concurrently with itself. Task will not start until the instance that is running finishes. An instance will transition to Exclusive Wait status if it cannot start due to another instance already running. |
Simulate | Specifies if the instance should execute under simulation mode. |
Status |
This section contains information about the current status of the task instance. |
Status |
|
Exit Code |
System-supplied; the exit code captured by the Agent when executing the task (for example, a command or script). |
Status Description |
System-supplied; additional information, if any, about the status of the task instance. |
Operational Memo |
User-defined operational memo. |
Evaluation Time |
If time zone of user is different than time zone of task instance; Time at which Execution Restrictions and Run Criteria were evaluated based upon the requested time zone. (Time zone of task instance displays in parentheses.) |
Critical |
Indicates that this task is in the Critical Path of a workflow. |
Critical Endpoint |
Indicates that this task was defined as a Critical Endpoint of a Critical Path in a workflow. |
Wait Until Time |
Amount of time calculated to wait before the task was started, based on Wait To Start and Delay On Start times. |
Queued Time |
System-supplied; Date and time the task was queued for processing. |
Trigger Time |
System-supplied; Date and time the task instance was triggered. |
Launch Time |
System-supplied; Date and time the task instance was launched. |
Start Time |
System-supplied; Date and time the task instance started. |
End Time |
System-supplied; Date and time the task instance completed. |
Duration |
System-supplied; amount of time the task instance took to run. |
Agent Details |
This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
Cluster |
Indication that selecting an Agent Cluster is required and selecting Broadcast, which lets you select a Cluster Broadcast, is optional. If Cluster is selected, selecting an Agent is not required unless Agent Variable is selected. |
Agent |
Name of the Agent resource that identifies the machine where the operation will run. If you do not specify an Agent, you must specify an Agent Cluster or Cluster Broadcast. |
Agent Variable |
Indication of whether the Agent field is a reference field for selecting a specific Agent (unchecked) or a text field for specifying the Agent as a variable (checked). Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent reference to using an Agent variable, you must change the Agent Variable field to Yes and specify the Agent variable in the Agent Unresolved field. Conversely, to change from using an Agent variable to using an Agent reference, you must change the Agent Variable field to No and specify the Agent reference in the Agent field. |
Agent Cluster |
If Cluster is selected and Broadcast is not selected; Group of Agents, one of which the Controller will choose to run this task (compare with Cluster Broadcast). You can specify an agent cluster in addition to or in place of a specific Agent. If you specify an Agent and an agent cluster, the Controller first tries to run the task on the specific agent. If the Agent is not available, the Controller reverts to the agent cluster. See Agent Clusters for more information. |
Agent Cluster Variable |
Indication of whether the Agent Cluster field is a reference field for selecting a specific Agent Cluster (unchecked) or a text field for specifying the Agent Cluster as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent Cluster reference to using an Agent Cluster variable, you must change the Agent Cluster Variable field to Yes and specify the Agent Cluster variable in the Agent Cluster Unresolved field. Conversely, to change from using an Agent Cluster variable to using an Agent Cluster reference, you must change the Agent Cluster Variable field to No and specify the Agent Cluster reference in the Agent Cluster field. |
Credentials |
Credentials under which an Agent runs this task. These Credentials override any Credentials provided in the Agent Details for any Agent running this task. If the user does not have a login shell, add a - character in front of the runtime credentials name. The Controller will provide a shell for that user and strip the - character from the name. Required if the Agent Credentials Required Universal Controller system property is true. When required, if the Credential is specified as a variable, and the variable resolves to blank, a Start Failure will occur. |
Credentials Variable |
Indication of whether the Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Credential as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Credentials reference to using a Credentials variable, you must change the Credentials Variable field to Yes and specify the Credentials variable in the Credentials Unresolved field. Conversely, to change from using a Credentials variable to using a Credentials reference, you must change the Credentials Variable field to No and specify the Credentials reference in the Credentials field. |
Agent File Monitor Details |
This section contains assorted detailed information about the task instance. |
Monitor Type |
Type of file event being monitored for. Options:
Note For UNIX and Windows, Agent File Monitor polls the directory listing every 5 seconds to compare the listings and decide whether there were any file system changes that match the monitor criteria. |
Trigger on Create | If Monitor Type = Change; Task is triggered if the file being monitored is being created. Note This field is valid only for z/OS Agents. |
Trigger on Existence |
If Monitor Type = Create; Task is triggered if the file being monitored for creation already exists. Note This field is valid only for Linux/Unix and Windows Agents. |
Monitor File(s) |
Location and name of a specific file or file pattern (for example, ACT001*) being monitored. Variables supported. Wildcards supported. Note z/OS files must be valid names based on the Data Set Naming Rules. No extra quoting is necessary. Note Agent File Monitors with Monitor Type = Exists or Missing do not work with GDG datasets. Whether the generation is coded explicitly (for example: DATA.SET.NAME.G0001V00) or relatively (for example: DATA.SET.NAME(0)), the Agent File Monitor will always end with 'Dataset Not Found'. |
Use Regular Expression |
Enables the use of a regular expression in the Monitor File(s) field. |
Recursive |
If enabled, the monitor searches the specified directory and all subdirectories. |
Maximum Files |
If Monitor Type = Create, Delete, or Change; For searches that use wildcards, limits the number of files to be searched. |
File Owner |
If Monitor Type = Create, Delete, Change, or Exists; User name / group name of the owner of the file on the operating system; that is, the user name / group name returned by the operating system in the file ownership information. LDAP groups are supported. Specifying a file owner limits the search to files with that owner. |
Stable (seconds) |
If Monitor Type = Change or Create; Period of time, in seconds, that a file's timestamp and size may not change to be considered as stable. Not applicable for z/OS. |
By Percentage (+/-) |
If Monitor Type = Change; Number that specifies the growth of a file as a percentage. A negative number specifies a reduction in size as a percentage. Not applicable for z/OS. |
By Size (+/-) |
If Monitor Type = Change; Used in conjunction with the By Scale field, specifies an actual change in file size. For example, to monitor for a change in file size of 10 MB, enter 10 in this field and select MB in the By Scale field. Enter a negative number to specify a reduction in size. Not applicable for z/OS. |
By Scale |
If Monitor Type = Change; Used in conjunction with the By Size field, specifies Bytes, KB (kilobytes), or MB (megabytes). Not applicable for z/OS. |
To Size |
If Monitor Type = Change; Used in conjunction with the To Scale field, specifies an actual file size that you want to monitor for. For example, to monitor for a file size of 5KB, enter 5 in this field and select KB in the To scale field. Not applicable for z/OS. |
To Scale |
If Monitor Type = Change; Used in conjunction with the To Size field, specifies an actual file size that you want to monitor for. Not applicable for z/OS. |
Minimum File Size |
If Monitor Type = Create; Minimum file size required for the file being created. Not applicable for z/OS. |
Minimum File Scale |
If Monitor Type = Create; Scale for the Minimum File Size. Not applicable for z/OS. Options:
|
Scan Text |
Unable to render {include} The included page could not be found.
|
Scan Forward |
If Monitor Type = Change; Specifies that once the File Monitor has been satisfied, it should continue from where it left off.
|