File Watcher job parameters

The following table describes the General parameters for a File Watcher job.

NOTE: You cannot run a File Watcher job on a remote host.

For more information about the Control-M File Watcher, see ctmfw File Watcher utility.

Parameter

Description

Run as

Identifies the user name with the authorization to execute the job. This parameter is used by the Control-M security mechanism.

Path

Defines the path of the file to be detected. The file name can include wildcard character * to represent any number of characters (including no characters) or ? to represent any one character.

Mode

Determines whether to detect creation or deletion of a file as follows:

  • Create: Detects creation of a file. File size is ignored if the filename parameter contains wildcards (unless the monitor file size when wildcard is used parameter is set to Y).
  • Delete: Detects deletion of a file. When the ctmfw utility is run in this mode, it first checks for files that match the specified name. After a specified file is detected, the ctmfw utility checks at the specified interval for deletion of that file.

Minimum size

Minimum file size in bytes, KB, MB or GB . This parameter is ignored if the Path parameter contains wildcards (unless the Wildcard support parameter is set to Yes) or if the mode parameter is set to DELETE.

Search interval

Interval between successive attempts to detect the existence/deletion of a file (in seconds).

File size interval

Interval between attempts to monitor the size of a file after it is detected (in seconds). This parameter is ignored when using wildcards in PATH (unless the monitor file size when wildcard is used parameter is set to Y) or when using DELETE mode.

Iterations

Number of attempts to monitor file size where the size remains static and greater than or equal to Minimum Size (indicating successful creation of the file). This parameter is ignored when using wildcards in PATH or when using DELETE mode.

Wildcard support

Indicates whether the file size should be monitored if the filename contains wildcards. This parameter is ignored if the Path does not contain a wildcard.

Time limit

Maximum time (in minutes) to run the process without detecting the file at its minimum size (CREATE) or detecting its deletion (DELETE). If the file is not detected/deleted in this specified time frame, the process terminates with an error return code.

Start

Indicates an absolute time at which the utility starts monitoring the file or from the dropdown list, select Start immediately.

Stop

Indicates an absolute time at which the file is no longer watched, or from the dropdown list, select No Stop time.

Maximal age

Indicates the maximum amount of time that can pass since the file you want to watch was last modified, or from the dropdown list, select No Maximal age.

NOTE: If you selected No Maximal age, files older than 10 years cannot be detected by the utility. If you want to detect files older than 10 years, you must define the number of years, such as 11y.

Minimal age

Indicates the minimum amount of time that must have passed since the file you want to watch was last modified, or from the dropdown list select No Minimal age.

Parent Topic

Job types