A property in FileSieve automation is a value that can be changed to influence the way FileSieve automation functions.
Setting a property requires a specific syntax:
- /set:property=value
The set
command specifies that a property is being set.
The property
is the actual property that's being set.
The value
is the value the property should be set to. The value can be optionally enclosed in "quotes",
unless there are any spaces in that value then quotes must be used.
- FileSieve.exe /set:AutoFileDepthLimit=5
The available properties are detailed below.
- AutoFileDepthLimit <value>on failure: automation continues
Changes the number of AutoFile recursions allowed. An AutoFile calling another AutoFile counts as one recursion. Doing too many recursions may cause an error; typically this value is in the hundreds but it depends on what is happening within the FileSieve automation environment.
The default value is 10
.
- CopyBufferSize <value>on failure: automation continues
The size, in bytes, of the file copy buffer when the copy mode is set to Copy. This is the amount of data that is read from the file(s) being copied in one go before it is written to the destination.
The default value is 1048576
(1MB).
- DirectoryWatcherBufferSize <value>on failure: automation continues
The larger the buffer, the more events the Directory Watcher can store. Use a multiple of 4KB; range is 4KB to 64KB. Specified in bytes.
The default value is 8192
(8KB).
- ProcessingPriority <value>on failure: automation continues
The thread priority of the processing thread. Higher means it'll use more CPU time.
The default value is BelowNormal
.
- SourceItemRootDriveCheck <value>on failure: automation continues
Determines if FileSieve should perform a check to see if a Source Item is the root of a drive and disallow it (highly recommended!).
The default value is True
.
- PerformGarbageCollectionAfterProcessing <value>on failure: automation continues
Forces the garbage collector to perform a full collection across all generations to reduce after-processing memory usage.
The default value is True
.
- DeleteEmptySourceItemSubFoldersWhenProcessingComplete <value>on failure: automation continues
If True
and Delete Empty Sub-Folders for a Source Item is enabled, the empty sub-folders will be deleted at the end instead of during processing.
The default value is True
.
- LogStatistics <value>on failure: automation continues
If True
, system information (such as available memory) is logged to the Log before and after processing.
The default value is True
.
- BeepIfWindowInactive <value>on failure: automation continues
If True
, an audible notification will sound to indicate that processing has completed.
The default value is True
.