RoboFlowHelp.1.17

!!! warning "Legacy Documentation" This page contains documentation for the original RoboFlow application. Some features described here may not exist in the new Damtoolkit WAP interface.

Hotfolder (Process newly dropped files in hot folder)

The Hotfolder workflow checks a folder (directory) and its subfolder(s) in every time-loop. Every file (unless filtered out) is then processed one by one.

For each file the "Action script for files" is executed.

If an e-mail-address is specified, the "mail" text is evaluated and bundled per e-mail. When all records are processed that mail(s) is sent.

Afterwards the file (called hot) from the hotfolder is deleted (unless a special parameter is added).

Files with file-size 0 or file-size changing (being written) or read-only are not processed.

Parameters

Hotfolder

The path to the folder to watch

 type in the path or click on the button to select a folder

HotFileFilter

The files with a file-extension specified here, will not be processed (not case sensitive).

  • every file-extension starts with a point (.)

  • to invert the FileFilter: start it with ! In this case only files ending with that extension will be processed.

File File-Filter Process Description
test.Tif yes
test.Tif .xmp.xml.txt yes files not ending with .xmp or .xml or .txt are processed
test.Tif .xmp.xml.txt.tif no files ending with .xmp or .xml or .txt .tif are NOT processed
test.Tif !.tif.jpg yes only files ending with .tif or .jpg are processed
Test .xmp.. no files ending with .xmp or without file-extension are NOT processed
test.jpg [regex]tes.* no files starting with "tes" are NOT processed
test.jpg ![regex]tes.* yes only files starting with "tes" are processed

For more information see Regular Expressions Tutorial.

FolderFilter

Specify the folder names separated by "#" to exclude these folders from being processed (not case sensitive); subfolders of excluded folders are NOT processed.

e.g. layout#layouts so all folders called layout or layouts are not processed

to invert the FolderFilter: start it with "!"

--

Folder (root=...) Folder-filter Process Process files Process subfolders Process files in subfolders Description
... yes yes yes yes no folder-filter so everthing is processed
... #subfolder# yes yes yes if not "subfolder" yes if not in "subfolder" all subfolders are processed except "subfolder"
... subfolder yes yes yes if not "subfolder" yes if not in "subfolder" all subfolders are processed except "subfolder"
.../subfolder subfolder no no no no not processed (folder name equals "subfolder")
.../folder subfolder yes yes yes if not "subfolder" yes if not in "subfolder" all subfolder are processed except "subfolder"
.../folder/subfolder subfolder no no no no not processed (folder name equals "subfolder")
.../folder/subfolder subfolder#another no no no no not processed (folder name equals "subfolder")
.../folder sub* yes yes yes if not "sub*" yes if not in "sub*" all subfolders are processed except if name starts with "sub"
.../folder/subfolder sub* no no no no not processed (folder starts with "sub")
.../folder/subfolder *sub yes yes yes if not "*sub" yes if not in "*sub" all subfolders are processed except if name ends with "sub"
.../folder/subfolder *bfolder no no no no not processed (folder name ends with "bfolder")
.../folder/subfolder *subfolder no no no no not processed (folder name ends with "subfolder")
.../folder [regex]sub.* yes yes yes if not "[regex]sub.*" yes if not in "[regex]sub.*" all subfolders are processed except if name starts with "sub"
.../folder/subfolder [regex]sub.* no no no no not processed (folder starts with "sub")
.../folder/subfolder [regex].*sub.* yes yes yes yes if not in "[regex]*.sub.*" all subfolders are processed except if name contains "sub"
.../folder/subfolder [regex].*sub yes yes yes if not [regex]*.sub yes if not in "[regex]*.sub" all subfolders are processed except if name ends with "sub"
... !#subfolder# yes no no only if called "subfolder" only files of a subfolder called "subfolder" are processed
... !subfolder#another yes no no only if called "subfolder" only files of a subfolder called "subfolder" or "aonther" are processed
.../folder !subfolder no no no no, only inside "subfolder" only files in subfolder called "subfolder"
.../folder/subfolder !subfolder no no no no, only inside "subfolder" only files in subfolder called "subfolder"
.../subfolder !subfolder yes yes yes only if called "subfolder" only files in subfolder called "subfolder"
.../subfolder/folder !subfolder no no no no, only inside "subfolder" only files in subfolder called "subfolder"
.../folder !sub* no no no no, only inside "sub*" only files in subfolder starts with "sub"
.../folder/subfolder !sub* no no no no, only inside "sub*" only files in subfolder starts with "sub"
.../subfolder !sub* yes yes yes only if starts with "sub" only files in subfolder starts with "sub"
.../subfolder/folder !sub* no no no no, only inside "sub*" only files in subfolder starts with "sub"
.../folder !*bfolder no no no no, only inside "*bfolder" only files in subfolder end with "bfolder"
.../folder/subfolder !*bfolder no no no no, only inside "*bfolder" only files in subfolder end with "bfolder"
.../subfolder !*bfolder yes yes yes only if ends with "bfolder" only files in subfolder end with "bfolder"
.../subfolder/folder !*bfolder no no no no, only inside "*bfolder" only files in subfolder end with "bfolder"
.../folder ![regex]sub.* no no no no, only inside "sub*" only files in subfolder starts with "sub"
.../folder/subfolder ![regex]sub.* no no no no, only inside "sub*" only files in subfolder starts with "sub"
.../subfolder ![regex]sub.* yes yes yes only if starts with "sub" only files in subfolder starts with "sub"
.../subfolder/folder ![regex]sub.* no no no no, only inside "sub*" only files in subfolder starts with "sub"

WaitForFolderStable

if set this workflow will, before processing a subfolder, first check if its files are stable by counting them and waiting the specified number of seconds and count them again. It will repeat this process per subfolder as long as the result of the count is not the same.

Use this to group some files in a (sub-)folder and only start processing them when the folder is stable. (complete)

EmailNotify

E-mail-address of person to notify for every new file being processed (multiple e-mail-addresses separated by ;)

E-mail-Message-Configuration

Parameter file for the e-mail mail-subject, mail-body and mail message per record.

For each record the mail message is parsed, stored and bundled per e-mail-address.

When all files are processed the e-mail(s) are inserted into the mail-body and are sent.

Per e-mail address only 1 mail is sent; referred to as bundled mail

To attach a file to the mail, add the following to the body or mail message:

Additional parameters that can be added:

hotfolder-delete-fileboolean

NOTE: By default this workflow deletes the hot-folder after processing it. Unless you add this parameter with value false. In this case after processing the file, it will not be deleted.