ctmfw rules file global parameters

The following table lists the ctmfw rules file global parameters:

Parameter

Description

CYCLIC_INTERVAL

Indicates the interval between multiple operations of detecting the file (in minutes). This interval must be greater than the value for WAIT_TIME. If the cyclic_interval is 0, only one attempt to detect the file will be performed. Default: 0

FROM_TIME

Starting time for detecting all the files (default FROM_TIME). Used with WAIT_TIME to identify the time frame for detecting and monitoring the files. This parameter is expressed in 24-hour, hhmm format. Default: 0000 or Now

INTERVAL

Sleep interval (in seconds) between successive scans for all the files. This parameter replaces individual sleep_int and mon_int parameters for each file. Default: 10

MAX_AGE

Indicates the maximum amount of time that can pass since the file you want to watch was last modified.

  • If MAX_AGE = 0, any change to the file timestamp means that the condition is met.
  • IF MAX_AGE = 10 Min and if the amount of time of the watched file that has passed is less than 10 minutes, then the condition is met.

This parameter is ignored if the mode parameter is set to DELETE.
Default: 0

MIN_AGE

Indicates the minimum amount of time that must have passed since the file you want to watch was last modified. For example, 2y3d5h means that 2years, 3 days, and 5 hours must pass before the file will be watched.

This parameter is ignored if the mode parameter is set to DELETE. Default: 0

MIN_SIZE

Minimum file size in bytes. This parameter is ignored if the FILE parameter contains wildcards (unless the monitor file size when wildcard is used parameter is set to Y) or if the mode parameter is set to DELETE. Default: 0 (any size detected).

MON_SIZE_
WILDCARD

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

Valid values:

  • N – do not monitor file size (Default)
  • Y – monitor the file size

If this parameter is set to Y and more than one file matches the specified mask, the ctmfw utility randomly selects one matching file, monitors its file size, and ignores all other matching files.

STOP_TIME

Indicates an absolute time at which the file is no longer watched. For example, 200702061400, means that at 2 PM on February 6th, 2007 the FileWatcher utility will stop watching the file.

You can also use the HHMM format, which uses the current date, plus the HHMM entered. Default: 0 (meaning, no stop time)

NOTE: STOP_TIME can only be used as a global parameter.

WAIT_TIME

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, as described in ctmfw- return codes table below.. Default: 0 (no time limit).

Parent Topic

ctmfw File Watcher utility