set_problem_folder

Sets the folder into which the files that cannot be ingested are placed.

Member of namespace

mvscan

Syntax

bool set_problem_folder (string folderpath)

Parameters

folderpath
The folder to which the scan action moves files that it could not ingest. Specify a full or relative folder path. If you specify a relative path, the path is relative to the root input folder. For information about the root input folder, see set_folder.

The location of the problem folder is affected by the mv_retain_folder action. For more information, see mv_retain_folder.

Returns

Always True.

Level

Batch level.

Details

This action must be called before scan(). If this action is not called, and scan is unable to ingest a file, the batch is aborted. Files that are already ingested into the batch remain in the batch. The file that cannot be ingested might be in a locked state. Manual intervention is required.
Example:
set_folder("@APPPATH(vscanimagedir)+@STRING(\input folder)")
set_problem_folder(@APPPATH(vscanimagedir)+@STRING(\problem folder))
scan()