SFTP Watch

Fires when a file is created, modified or renamed in a monitored folder on an SFTP server.

This Node is only available in the 2023 Refresh.

Revision History

2.0.0.0 - Initial Release
2.0.0.1 - Fixed exception: Poll interval too long
2.0.0.2 - Updated SSH.NET Nuget Package to version 2024.0.0 (fixes HMAC server errors)

Properties

Connection

Type: Connection Input
Provides a Connection and optionally a DropPoint to service the request.

Host
Type: String
Identifies the network location or address where the server is located.

Port
Type: Int32
Defines the specific communication channel through which data is transmitted.
Typically set to port 22 for standard SFTP connections.

Username
Type: String
The username used to authenticate access to the SFTP server.

Password
Type: String
The password used to authenticate access to SFTP server.

ClientPrivateKeyFileContents
Type: Multiline Text Data
The SSH Certificate contents used to authenticate to the SFTP server.

Path

Type: String Input
The path to the folder or file which should be watched for changes.

Mask

Type: String Input
Only files matching the mask in the specified folder will be watched, the others will be ignored.
To watch changes in all files, set the Mask property to an empty string. To watch a specific file, set the Mask property to the file name. For example, to watch for changes in the file MyDoc.txt, set the Mask property to MyDoc.txt. You can also watch for changes in a certain type of file. For example, to watch for changes in any text files, set the Mask property to *.txt. Use of multiple masks such as *.txt|*.doc is not supported.

PollInterval

Type: Int32 Static
The duration in seconds which the system will wait between checking for changes to the specified file/folder.

FolderDepthLimit

Type: Int32 Input
Specifies to what extent sub-directories should be evaluated. If no input is supplied, defaults to 0, meaning that sub-directory contents is not evaluated. The directory path supplied to the node acts as level 0, and a sub-directory inside the supplied path would be considered level 1.

FindMatchesOnStart

Type: Boolean Static
If True, the node will immediately return all files which match the criteria provided when the node is executed. If not, only changes made after the node is executed cause a change event to be recognized.

ChangedFilePath

Type: String Output
Provides the path to a file which has changed, been created or been renamed.