set_wait_time

Specifies interval to wait for additional files to ingest, before finishing a batch which has not reached the specified maximum size or time limits.

Important: This action can be used to group incoming files when ingesting from a single input folder. It is not effective in tree mode or for metadata XML. When ingesting from multiple folders or in tree mode, use set_min_age instead to wait for a group of files to appear in the input folders. See set_min_age for the special case set_wait_time(0) in tree mode.

Member of namespace

mvscan

Syntax

bool set_wait_time (int nSecs)

Parameters

nSecs: Type: integer; Time to wait for files to complete a batch.

Parameters

nSecs

The maximum number of seconds to wait for files to complete a batch.

If you do not call this action, the default wait interval is 2 seconds.

Returns

Always True.

Level

Batch level.

Details

The maximum time to wait for input files to arrive to meet the total quantity specify by the set_max_docs action. If at least one file was ingested, no more files are available, and the batch has not reached capacity, the scan action will wait for additional files to be placed into the directory configured by the set_folder action. Ingestion of files into the batch will stop when the wait limit is reached or when the maximum number of files per batch has been reached. If no files are available during the scan() action, and this time is reached, the scan action returns and the batch status remains pending.

Example:

set_wait_time("60")
scan()