set_tree_mode

Determines whether subdirectories are included in the scan for files to ingest.

Member of namespace

mvscan

Syntax

bool set_tree_mode (bool bTreeFlag)

Parameters

bTreeFlag: Type: bool

Parameters

bTreeFlag : A Boolean value that enables or disables ingesting files from sub-folders within the top-level scan folder.

True: Search for files in subfolders to any depth under the scan folder. Folder names beginning with underscore (_) are ignored. This is the default if the action is not called.

False: Ingest files that are located in the scan folder only. Ignore subfolders.

Details

When "tree mode" is enabled, which is the default, the scan action ingests files from an sub directories that are present in the configured ingestion folder. Each batch contains files from only one folder regardless of the tree mode setting. If there are multiple folders, scan operates on only one file at a time. Files from multiple folders are never be ingested into the same batch. When tree mode is enabled, the scan action firsts ingest files from the root folder directory. When all of those files have been ingested, it will then ingest from the sub folders, one at a time. Tree mode is true by default.

For this action to take effect, it must be called before the Scan action.

Example:

set_types("tif")
set_tree_mode(True)
scan()