Agent File Monitor Task Properties

Task Properties: Agent File Monitor Task

Property

UI Field Name

Description

Specifications

Required

byPercentage

By Percentage

If fmtype = Changed (3); Amount that the file size has changed, expressed as a percentage of the original file size. For example, enter 10 to monitor for a change in file size of 10 percent (larger or smaller).

BigDecimal.

N

byScale

By Scale

If fmtype = Changed (3); Used in conjunction with bySize, specifies a change in file size that you want to monitor for. For example, to monitor for a change in file size of 10MB, enter 10 in bySize and enter 1024000 in byScale.

Integer; Valid values:

  • 1 = Bytes
  • 1024 = KB
  • 1024000 = MB

N

bySize

By Size

If fmtype = Changed (3); Used in conjunction with byScale, specifies an actual change in file size. For example, to monitor for a change in file size of 10MB, enter 10 in bySize and enter 1024000 in byScale.

BigDecimal.

N

fileName

Monitor File(s)

Location and name of a specific file or file pattern (for example, ACT001*) being monitored.

Variables and Wildcards are supported.

Y

fileOwner

File Owner

If fmtype = Create (1), Delete (2), Changed (3), or Exist (4); 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.

N

fmtype

Monitor Type

Type of file event being monitored for.

Valid values:

  • As String = Created, As Value = 1
  • As String = Deleted, As Value = 2
  • As String = Changed, As Value = 3
  • As String = Exist, As Value = 4
  • As String = Missing, As Value = 5

Default is Created (1).

N

maxFiles

Maximum Files

If fmtype = Create (1), Delete (2), or Changed (3); For searches that use wildcards, limits the number of files to be searched.

Integer

N

minFileScale

Minimum File Scale

If fmtype = Create (1); Scale for the minimum file size.

Valid values:

  • As String = Bytes, As Value = 0
  • As String = KB, As Value = 1
  • As String = MB, As Value = 2

Default is KB (1).

N

minFileSize

Minimum File Size

If fmtype = Create (1); Minimum file size.


N

recursive

Recursive

Specification for whether or not the Agent File Monitor searches the specified directory and all sub-directories.

Boolean; Valid values: true/false. Default is false.

N

scanForward

Scan Forward

If fmtype = Changed (3); Specification that once the Agent File Monitor has been satisfied, it should continue from where it left off. If it is scanning within a file, it should resume from the point in the file that it last scanned. If it is monitoring for files, it should resume monitoring for the next file. If you are scanning a file that is being overwritten each time and you want to start from the beginning each time, do not use scanForward.

Boolean; Valid values: true/false. Default is false.

N

scanText

Scan Text

If fmtype = Create (1), Changed (3), or Exist (4); String that the Agent File Monitor will search for in the file or files. Specifying a string means that only files containing the string constitute a match.


N

stableSeconds

Stable (seconds)

If fmtype = Create (1) or Changed (3); Period of time, in seconds, during which the file has not changed (Agent File Monitor checks the modification timestamp and the file size).

Integer.

N

toScale

To Scale

If fmtype = Changed (3); Used in conjunction with toSize, specifies an actual file size that you want to monitor for. For example, to monitor for a file size of 5KB, enter 5 in toSize and enter 1024 in toScale.

Integer; Valid values:

  • 1 = Bytes
  • 1024 = KB
  • 1024000 = MB

Default is 1024.

N

toSize

To Size

If fmtype = Changed (3); Used in conjunction with toScale, specifies an actual file size that you want to monitor for. For example, to monitor for a file size of 5KB, enter 5 in toSize and enter 1024 in toScale.

BigDecimal; Default is 1024.

N

triggerOnExist

Trigger on Existence

If fmtype = Create (1); task is triggered if the file being monitored for creation already exists.

Boolean; Valid values: true/false. Default is false.

N

useRegex

Use Regular Expression

Enables the use of a regular expression in fileName.

Boolean; Valid values: true/false. Default is false.

N