Overview
The Remote File Monitor task allows you to monitor for a file on a remote machine where an FTP server is running. The Remote File Monitor connects to the FTP server rather than the machine's file system to monitor for files. The Remote File Monitor can be used only within a workflow; you cannot run a Remote File Monitor task based on a trigger. To run a Remote File Monitor task, you need Universal Agent to communicate with the FTP server. The Agent can, but does not have to be, running on the same machine as the FTP server.
In the following example, the user wants to monitor for a file on a remote FTP Server that has an Agent running on it. In this case, the login credentials for the Agent machine and the FTP server machine are the same.
In the following example, the user wants to monitor for a file on a remote FTP Server that does not have an Agent running on it. In this case, the Remote File Monitor task definition provides an address and login credentials for the machine where the Agent is running as well as address and login credentials for the FTP server.
Built-In Variables
The following built-in variables can be used in a Remote File Monitor task to pass data where appropriate:
Creating a Remote File Monitor Task
Step 1 | From the Automation Center navigation pane, select Tasks > Remote File Monitor Tasks. The Remote File Monitor Tasks list displays a list of all currently defined Remote File Monitor tasks. |
---|---|
Step 2 | Enter/select Details for a new Remote 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 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).
Remote File Monitor Task Details
The following Remote File Monitor Task Details is for an existing Remote File Monitor task.
Depending on the values that you enter / select for these fields, and whether or not the Remote 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 Remote File Monitor Task Details.
Remote File Monitor Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Remote 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. |
Remote 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. |
Wait until Satisfied | Unable to render {include} The included page could not be found. |
Poll Interval (Seconds) | If Wait until Satisfied is enabled: Frequency, in seconds, in which the Remote File Monitor will check to see if the file exists or is missing. |
Maximum Polls | If Wait until Satisfied is enabled: Maximum number of times that the Remote File Monitor will check to see if the file exists or is missing. |
Stable (Seconds) | If Wait until Satisfied is enabled: Period of time, in seconds, during which the file has not changed. |
Server Type | Unable to render {include} The included page could not be found. Note The Remote File Monitor Task Exclude Protocols Universal Controller system property permits the exclusion of one or more, but not all, protocols (server types) from being selected.) |
Additional FTP Commands | Unable to render {include} The included page could not be found. |
Transfer Mode | Unable to render {include} The included page could not be found. |
Verify Host Name | If Server Type = FTPS or FTPES; Indication of whether to verify the DNS name or IP address of the FTP server's certificate against the host system. |
Authenticate Peer | If Server Type = FTPES; Indication of whether to use a CA certificate configured in the agent to authenticate the FTP server's certificate. |
Remote Server | Name or IP address of the remote server. This machine may or may not be the same as the Universal Agent machine. |
FTP Credentials | Unable to render {include} The included page could not be found. |
FTP Credentials Variable | Unable to render {include} The included page could not be found. |
Remote Filename | Path and file name on the remote server. Note If the task instance unexpectedly ends in Start Failure, review the Remote Filename for any leading or trailing whitespace (such as CRLF and CR), or any other unintended characters (such as extra slashes). |
Use Regular Expression | Enables the use of a regular expression in the Remote Filename field. |
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. |
Job Card (z/OS only) | 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 specifications for 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:
|
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. |
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 a Remote File Monitor Task Instance
When a Remote 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 Remote File Monitor Task Details for that task
- Activity Monitor
- Task Instances list
Remote File Monitor Task Instance Details
The following Remote File Monitor Task Instance Details contains information on the execution of the task shown in the Remote File Monitor Task Details.
Remote File Monitor Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in Remote 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. |
Remote 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. |
Wait until Satisfied | Unable to render {include} The included page could not be found. |
Poll Interval (Seconds) | If Wait until Satisfied is enabled: Frequency, in seconds, in which the Remote File Monitor will check to see if the file exists or is missing. |
Maximum Polls | If Wait until Satisfied is enabled: Maximum number of times that the Remote File Monitor will check to see if the file exists or is missing. |
Stable (Seconds) | If Wait until Satisfied is enabled: Period of time, in seconds, during which the file has not changed.
12345 in the example above).The default file list format varies across different FTP client/server implementations, but most support additional commands that can force the output to the required format. The Additional FTP Commands field is provided to insert those statements into the FTP script that the file monitor task executes. |
Server Type | Unable to render {include} The included page could not be found. Note The Remote File Monitor Task Exclude Protocols Universal Controller system property permits the exclusion of one or more, but not all, protocols (server types) from being selected.) |
Additional FTP Commands | Unable to render {include} The included page could not be found. |
Transfer Mode | Unable to render {include} The included page could not be found. |
Verify Host Name | If Server Type = FTPS or FTPES; Indication of whether to verify the DNS name or IP address of the FTP server's certificate against the host system. |
Transfer Mode | Unable to render {include} The included page could not be found. |
Remote Server | Name or IP address of the remote server. This machine may or may not be the same as the Universal Agent machine. |
FTP Credentials | Unable to render {include} The included page could not be found. |
FTP Credentials Variable | Unable to render {include} The included page could not be found. |
Remote Filename | Path and file name on the remote server. Note If the task instance unexpectedly ends in Start Failure, review the Remote Filename for any leading or trailing whitespace (such as CRLF and CR), or any other unintended characters (such as extra slashes). |
Use Regular Expression | Enables the use of a regular expression in the Remote Filename field. |
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. |
Job Card (z/OS only) | 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. |
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. |
Output | Unable to render {include} The included page could not be found. |
Notes | Unable to render {include} The included page could not be found. |
Running a Remote File Monitor Task
You can run a Remote File Monitor task:
- Manually, by clicking the Launch Task or Launch Task with Variables button in the Remote File Monitor Tasks list or Remote File Monitor Task Details Action menu.
- As part of a Workflow.
- Specify triggers that run the task automatically based on times or events.
Monitoring Task Execution
You can monitor all system activity from the Activity Monitor and can view activity history from the History list.
Built-In Variables
The built-in variables outlined below can be used in a Remote File Monitor task to pass data where appropriate: