Remote File Monitor Task

Remote File Monitor Task

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.
 
To the right of the list, Remote File Monitor Task Details for a new Remote File Monitor task displays.
 

Step 2

Enter/select Details for a new Remote 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 

     button above the list to display a pop-up version of the Details.

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).

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

Field Name

Description

General

This section contains general information about the task.

Name

Version

Description

Member of Business Services

Resolve Name Immediately

Time Zone Preference

Hold on Start

Hold Reason

Virtual Resource Priority

Hold Resources on Failure

Mutually Exclusive With Self

Simulate 

Agent Details

This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.

Cluster

Agent

Agent Variable

Agent Cluster

Agent Cluster Variable

Broadcast

Cluster Broadcast

Cluster Broadcast Variable

Credentials

Credentials Variable

Remote File Monitor Details

This section contains assorted detailed information about the task.

Monitor Type

Wait until Satisfied

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.
 
For a Remote File Monitor task, a file's stability depends on its size. If the file size displayed in the FTP/SFTP output does not change during the specified number of seconds, the file is considered stable. In order for the task to reliably monitor the file's stability, the task must display a file's size in a well-known location. This means that the file list returned in the output must be in Unix long-listing format, as follows:
 

 
The task will only find the size if it is in the 5th column (for example, 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

 

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

Transfer Mode

Verify Host Name

Authenticate Peer

Remote Server

Name or IP address of the remote server. This machine may or may not be the same as the Universal Agent machine.
 
You also can specify a non-standard FTP, SFTP, FTPS, or FTPES port: port number separated from the host name with a colon: "some.server.com:2222".

FTP Credentials

FTP Credentials Variable

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

Minimum File Scale

Job  Card (z/OS only)

Result Processing Details 

 

Automatic Output Retrieval 

Specifies whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record.

  • None
    Do not attach any output to the task instance record.

  • Standard Output
    Attach all standard output.

  • Standard Error
    Attach standard error output.

  • Standard Output/Error
    Attach all standard output and standard error output.

 

Wait for Output

If  Automatic Output Retrieval = Standard Output, Standard Error, or Standard Output/Error, and Failure Only is not enabled (checked); Specification that the task should wait for the requested output before completing.

Failure Only

If  Automatic Output Retrieval  = Standard Output, Standard Error, or Standard Output/Error, and Wait For Output is not enabled (checked); Indication for whether output should be retrieved on task failure only.

Start Line

If  Automatic Output Retrieval  = Standard Output, Standard Error, or Standard Output/Error; Instructs the Controller to retrieve data beginning at the line indicated.

  • If a Start Line value is not specified, the default is 1.

  • If the Start Line value is -1, data will be retrieved starting at the end of the file.

Number of Lines

If  Automatic Output Retrieval  = Standard Output, Standard Error, or Standard Output/Error; Allows you to limit the retrieved data to the number of lines specified. If a Number of Lines value is not specified, the default is the value of the Retrieve Output Default Number Of Lines Universal Controller system property.

Scan Text

If  Automatic Output Retrieval  = Standard Output, Standard Error, or Standard Output/Error; Regex pattern that the Controller will search for a match for in STDOUT/STDERR. The Controller will include the Number of Lines above and below the first line matched.
 
if the Regex pattern is not found, the following message is returned: OPSWISE WARNING - Scan text string not found.

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Wait To Start

Wait Time

Wait Day Constraint

Wait Duration

Wait Duration In Seconds

Delay On Start

Delay Duration

Delay Duration In Seconds

Workflow Only

Time Options

This section contains time-related specifications for the task.

Late Start

Late Start Type

Late Start Time

Late Start Day Constraint

Late Start Nth Amount

Late Start Duration

Late Finish

Late Finish Type

Late Finish Offset Type

Late Finish Percentage Offset ( + )

Late Finish Duration Offset ( + )

Late Finish Duration Offset Unit

Late Finish Time

Late Finish Day Constraint

Late Finish Nth Amount

Late Finish Duration

Early Finish

Early Finish Type

Early Finish Offset Type

Early Finish Percentage Offset ( - )

Early Finish Duration Offset ( - )

Early Finish Duration Offset Unit

Early Finish Time

Early Finish Day Constraint

Early Finish Nth Amount

Early Finish Duration

User Estimated Duration

Critical Path Options

This section contains Critical Path-related specifications for the task.

CP Duration

CP Duration (Resolved)

CP Duration Unit

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Execution Restriction

Restriction Period

Before Date

Before Time

After Date

After Time

Date List

Statistics

This section contains time-related statistics for task instances of the task.

First Execution