File

Local file systems store files and folders on the machine where a process is running. They are commonly used for temporary staging, file-based integrations, and watching folders for new or changed files.

The File Node works with the local file system on a Local Runtime. You use it to read, write, copy, move, delete, inspect, and listen for local files and folders inside a Workflow.

Revision History

0.0.0.22 - Corrected Listener rename tracking so reused file names are detected.
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.
0.0.0.23 - Updated the Node icon.

Setup Notes

This Node runs against the local file system of the Local Runtime where the Workflow executes.

Make sure the Local Runtime service account has the required access to the paths that the Workflow will read, write, move, delete, or watch.

Methods

The File Node exposes local file operations plus a listener trigger for file and folder changes.

Read

Reads a local file and returns its content as a stream.

Parameter	Type	Description
Path	String	Path of the file to read.

Return	Type	Description
Content	Stream	Stream containing the file content.

Write

Writes content to a local file and can replace an existing file when requested.

Parameter	Type	Description
Path	String	Path of the file to write.
Content	Stream	Content stream to write to the file.
OverwriteExisting	Boolean	When true, an existing file is replaced.

Return	Type	Description
None	None	This method does not emit output values.

Copy

Copies a local file to another location on the same file system and can replace an existing destination file.

Parameter	Type	Description
Path	String	Path of the file to copy.
Destination	String	Destination folder where the file should be copied.
OverwriteExisting	Boolean	When true, an existing file at the destination is replaced.

Return	Type	Description
None	None	This method does not emit output values.

Move

Moves a local file to another location on the same file system and can replace an existing destination file.

Parameter	Type	Description
Path	String	Path of the file to move.
Destination	String	Destination folder where the file should be moved.
OverwriteExisting	Boolean	When true, an existing file at the destination is replaced.

Return	Type	Description
None	None	This method does not emit output values.

Delete

Deletes a local file.

Parameter	Type	Description
Path	String	Path of the file to delete.

Return	Type	Description
None	None	This method does not emit output values.

Info

Retrieves metadata for a local file or folder.

Parameter	Type	Description
Path	String	Path of the file or folder to inspect.

Return	Type	Description
Metadata	Object	Metadata object containing ObjectType, ObjectPermission, SizeInBytes, CreationTime, LastWriteTime, and FullPath.

Listen

Watches a local file or folder and fires when a matching file is created, modified, or renamed.

Parameter	Type	Description
Path	String	Folder or file path to watch for changes.
Mask	String	File mask used when watching a folder, such as *.txt or *.*.
PollInterval	Integer	Time in seconds between checks when polling is used. Set 0 to use event-based monitoring.
FolderDepthLimit	Integer	Subdirectory depth to evaluate. 0 means only the supplied directory level is watched.
FindMatchesOnStart	Boolean	When true, matching files are emitted immediately when the Node starts.

Return	Type	Description
Files	Array	Array of file-change events. Each item includes ChangedFilePath.

Usage Notes

Use exact local paths that are valid on the machine running the Local Runtime.

For folder listeners, use Mask and FolderDepthLimit to keep the watch scope predictable and to avoid reacting to unrelated files.