set_max_docs

Specifies maximum number of pages in each batch. If Metadata files are used, this is the maximum number of metadata files to import.

Member of namespace

mvscan

Syntax

bool set_max_docs (int nDocs)

Parameters

nDocs: Type: int; Number of documents in a batch. Default 100.

Parameters

nDocs : An integer value which specifies the maximum number of input files to place into a batch.

If Metadata files are used, set_metadata_types() is called instead of set_types(), this specifies the maximum number of metadata files to ingest. All files referenced in each metadata file are included in the batch, there is no limit on the number of pages in the batch in this case. The default value is 100.

Returns

Always True.

Level

Batch level.

Details

This action configures the maximum number of files to be ingested into a batch. If the number of available files is less than this number, the Scan action waits for more files based on the time configured with the action set_wait_time. For this action to take effect, it must be called before the Scan action.

Example:

set_tree_mode(false)
set_max_docs("1")
scan()