set_folder

Member of namespace

Syntax

bool set_folder (string folderpath)

Parameters

folderpath

Type: string

Path to folder containing files to be ingested.

Parameters

folderpath

A string value specifying the path an input folder. Multiple input folders can be separated by vertical bar symbols (|). The scan() action ingests selected file types from these folders, and optionally subfolders, into batches for processing. Each ingested batch will contain files from a single folder.

Smart parameters are supported.

Returns

Level

Details

This action configures the folder from where the "Scan" action will look for files to ingest into the batch. Call this action before calling the Scan action.

The example uses a smart parameter to set the input directory. This smart parameter references the variable vscanimagedir which is specified in the application file (*.app) and appends the additional folder "\input 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.

Example:

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

set_folder(“c:\shared\group1|c:\shared\group2|d:\shared\group3”)
scan()