scan

Polls the folder that is specified by the set_folder action and scans the images into a batch folder.

Member of namespace

mvscan

Syntax

bool scan ()

Parameters

None.

Returns

False, if the operation fails, and pauses before the return. Otherwise, True.

Action returns when timeout is reached, or the requested number of files is ingested.

Level

Batch level Open event only.

Details

Scans the source folder for files with the extensions that you want, then ingests them into a batch. Call one time for each batch. All options must be set before this action is called. If no files are present for ingestion, the batch is set to pending status, and the action returns immediately. The files in each batch folder are ingested by the order of the date the file was last modified.

Each input file generates one or more "pages" in the batch with the following page variables set:

TYPE : Always set to "Other".
IMAGEFILE : The file name within the batch, for example TM000002.tif.

Example:

set_folder("@APPPATH(vscanimagedir)+@STRING(\mvscan folder)"))
set_types("jpg,pdf,tif")
set_max_docs("2")
scan()