set_problem_folder

Member of namespace

Syntax

bool set_problem_folder (string folderpath)

Parameters

Type: string

Path to folder which contains any files that cannot be ingested.

Parameters

folderpath

A string value specifying the path of the folder where files that cannot be ingested are placed.

Smart parameters are supported.

Returns

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. Any files already ingested into the batch remain in the batch. The file which cannot be ingested may be left in a locked state. Manual intervention is then required.

The folderpath can be specified as a relative path to the scan directory. For example, if the scan directory is configured as "C:\Datacap\MyApp\Input" and if the problem folder is configured as "Problem" then the problem directory name resolves as C:\Datacap\MyApp\Problem. Using a relative path for the folder can be useful when scan is configured to ingest from multiple root directories.

Example:

set_folder("@APPPATH(vscanimagedir)+@STRING(\input folder)")
set_problem_folder(@APPPATH(vscanimagedir)+@STRING(\problem folder))
scan()

The variable vscanimagedir which is specified in the application file (*.app) and appends the additional folder "\problem folder" to the path. Because the root scan directory is read from the application file, it makes it easy to change the source directory using the application manager to update the root directory as necessary, without having to update the rules in the application.