Magidoc

HotFolder
Object

A hotfolder is a processing pattern to support file-based workflows. Files are dropped into a known folder and are then processed by a device or a software component, being moved to output folders upon completion.

Fields

#

id

ID !
Non-null

The ID of the HotFolder

name

String !
Non-null

A human readable name for the HotFolder

mode

HotFolderMode !
Non-null

The mode of this folder

active

Boolean !
Non-null

Whether the folder is actively being monitored

path

String !
Non-null

The path of the folder to monitor, this should be a fully qualified path.

module

String

The script to be run to process a file, required for WATCHED folders, ignored for DROP_ONLY

processingFolder

String

The folder to move files into for processing

completedFolder

String

The folder to move files into after processing

errorFolder

String

The folder to move files into after an error

controllerId

ID !
Non-null

The ID of the controller that is monitoring this hotfolder

controller

Controller !
Non-null

The controller that is monitoring this hotfolder

createdAt

DateTimeISO !
Non-null

When the hotfolder was added to the system

updatedAt

DateTimeISO !
Non-null

When the hotfolder was last updated

Usages

#

References

#