Live File Processor Agent File – Archive

<< Click to Display Table of Contents >>

Navigation:  Live > Agents > File Agents > File Processor > Settings > File >

Live File Processor Agent File – Archive

 

Setting

Type

Description

archiveFileMinimumSize

Int64

Archive a file if its size is greater than or equal to this number of bytes.

 

Default Value: 0 (always archive the file, if an archiveFilePath is specified).

archiveFileName

Composite String

Rename the file (when moving it to the archiveFilePath).

 

If this setting is not defined or empty, the file is not renamed (but it can still be moved).

archiveFilePath

Composite String

Move the file to this path, after it is processed.

 

The path can be one of the following types:

 

Path Type

Example

Local/rooted

C:\EarthSoft\Live\HOBO

Relative

..\Archive

UNC

\\servername\path

 

Relative paths are relative to the folderWatcherPath.

 

Example 1: ..\Archive

with a folderWatcherPath of 'C:\A\B\C',

where .. is used to go up one directory,

moves the file to 'C:\A\B\Archive\'.

 

Example 2: Archive

with a folderWatcherPath of 'C:\A\B\C',

moves the file to 'C:\A\B\C\Archive\'.

 

Note: For remote folderWatcherPaths, if the archiveFilePath is relative then the files are archived to the remote site (relative to the folderWatcherPath), not to the server on which the agent is running. If the archiveFilePath is local/rooted (e.g., C:\EarthSoft\Live\HOBO) then the files are archived to the server on which the agent is running.

 

If this setting is empty or not defined, then the file is not moved.

 

If the archive folder does not exist, then the file is not moved.

 

If the destination file already exists, it is deleted first.

deleteFileMinimumSize

Int64

Delete the file from the folder if its size is greater than or equal to this value.

 

For example, set this value to 0 to always delete the file, or set it to 1000 to delete the file when its size is greater than or equal to 1000 bytes.

 

Default Value: Int64.MaxValue (9223372036854775807) bytes