V2

File

Perform file operations on the local file system.

Revision History

0.0.0.1 - Initial release.
0.0.0.3 - Project restructure.
0.0.0.5 - SupportedCluster update.
0.0.0.10 - Node name correction.
0.0.0.20 - Added Listen method.

Setup Notes

You can add this Node to a Workflow without authentication or external setup.

Methods

Read

Parameter Type Notes
Path String The path of the file to read.
Parameter Type Notes
Content Stream Stream content of file to read.

Write

Parameter Type Notes
Path String The path of the file to write.
Content Stream Stream content of file to write.
OverwriteExisting Boolean When enabled, existing files will be replaced during upload. Defaults to true.

Copy

Parameter Type Notes
Path String TThe path of the file to copy.
Destination String The destination folder to copy the file into.
OverwriteExisting Boolean When enabled, an existing file at the destination will be replaced. Defaults to true.

Move

Parameter Type Notes
Path String TThe path of the file to move.
Destination String The destination folder to move the file into.
OverwriteExisting Boolean When enabled, an existing file at the destination will be replaced. Defaults to true.

Delete

Parameter Type Notes
Path String The path of the file to read.

Info

Parameter Type Notes
Path String The path of the file to read.
Parameter Type Notes
Metadata Object The metadata for the specified file/folder.

Listen

  • If Path is to a file, eg: C:\Folder\invoices.txt, Mask will be ignored. Any changes to the file indicated in Path will trigger an event. Deleting the file will not trigger an event, but replacing or editing the file will.
  • If Path is to a folder, eg C:\Folder, Mask can be used to watch for changes to multiple files eg: *.csv or *.*. If there are multiple changes, each change will trigger an event and the workflow will for each change.
Parameter Type Notes
Path String Folder or file path to listen for changes. EG: C:/path/to/file.txt C:/Folder/Listen
Mask String Only files matching this mask in the specified folder will be watched. EG: *.txt *.* data.csv
PollInterval Integer Time in seconds the system waits between checking for changes. Set to 0 to use event-based monitoring.
FolderDepthLimit Integer Specifies the sub-directory depth to evaluate. Defaults to 0, which means only the supplied directory level is evaluated.
FindMatchesOnStart Boolean If true, matching files are emitted immediately when the node starts.
Parameter Type Notes
Files Array List of files that were changed.