Administering the LogRemover Application

[General]

Section label. This section controls how often the application processes all rules, how many files the application will process before delaying, and how long the application will delay after each batch of files has been processed. It should not be edited.

NA

PostRuleProcessingDelay

Indicates how long, in minutes, the delay that will be encountered from the time the current round of rule processing is complete and next round begins.

1 - 1440 minutes

FileBatchSize

Indicates how many files will be processed before a configurable delay is introduced.

1 - 60

FileBatchDelay

Indicates how long, in seconds, to delay before another FileBatchSize file is processed.

1 - 60 seconds

[ActiveRules]

Section label. This section lists which Rules Section(s) will be processed by LogRemover. It should not be edited.

NA

Rule

A listing of all the rules sections that will processed by LogRemover.

This can be any name you choose.

[Rule]

Section label. This section allows the administrator to configure which file(s) are moved or deleted, whether we should check the file or set of files on a daily or hourly basis, and how long to skip the files before moving or deleting them. It also allows the administrator to specify where files for a given rule should be moved.

Must match a Rule listed under [ActiveRules].

FileList

Informs the application which file(s) to process for this rule.

If the application cannot expand any environment variable, the rule will be ignored (on the given iteration) and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof file:
"[Rule <Current Rule Name>] Could not expand Environment Vars."

If wildcard characters cannot be expanded, the rule will be ignored and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof file: "[Rule <Current Rule Name>] Could not expand FileList."

If FileList starts with any character other than / or $, then FileList will be prepended with $PARMLIB/ and then processed as if $PARMLIB/FileList were in the ini file. $PARMLIB/FileList is not written to the ini file in these cases. It is only prepended and later expanded in memory.

Valid file name(s) must start with either a backslash (/) or a dollar sign ($) or an alphabetic character. A "." or ".." are not allowed as the first character.

FileList may have wildcard characters or environmental variables embedded within them.

LogRetentionPeriod

Indicates how long in LogRetentionUnits time intervals the file should be ignored. After the file is older than LogRetentionPeriod/LogRetentionUnit (e.g., 5 Day), the file is either deleted or moved based on Action.

If LogRetentionPeriod is set to a negative value, the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof file: "[Rule <Current Rule Name>] LogRetentionPeriod is invalid. Set LogRetentionPeriod to either zero (skip rule) or a positive value (process in n LogRetentionUnits)."

0 - 32000

0 = rule is skipped

LogRetentionUnits

Indicates whether the LogRetentionPeriod is based on an hourly or daily basis.

If this field is set to any other value, the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof file:
"[Rule <Current Rule Name>] LogRetentionUnits is invalid.

day, Day—Sets retention based on days

hour, Hour—Sets retention based on hours

Action

Indicates whether to delete or move the file to <MovePath>/<Current Filename>.old.

If this field is set to any other value, the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof logfile: "[Rule <Current Rule Name>] Action is invalid.

move, Move—Moves the current file.

delete, Delete—Deletes the current file.

MovePath

When Action is set to move, indicates location of directory.

If the application cannot expand any environment variable, the rule will be ignored (on the given iteration) and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof file:
"[Rule <Current Rule Name>] Could not expand Environment Vars."

Wildcard characters may not be included in the MovePath. If they are included, the files will not to be processed and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof file: "Could NOT Move <Current Filename> No such file or directory."

If MovePath starts with any character other than "." or "/", then MovePath will be prepended with $PARMLIB/ and then processed as if $PARMLIB/MovePath were in the ini file. $PARMLIB/MovePath is not written to the .ini file in these cases. It is only prepended and later expanded in memory.

A filepath, starting with either a slash (/), an alphabetic character, or a single period (with nothing following the period), which tells the application where to move the file on Actions of Move.

MovePath may have environmental variables embedded within them.

If MovePath is set to a period only, the current file is moved to current file.old.