File Watcher

Allows files or folders to be monitored for changes. When a file in the specified folder matching the specified mask is created, modified or renamed, the Node will fire.

This Node has been replaced by File Watch, FTP Watch, SFTP Watch and should not be used for new Workflows. These Nodes are only available in the 2023 Refresh.

Revision History

1.0.0.35 - Added support for explicit passive & active FTP, added support for custom timeout, some bug fixes
1.1.0.0 - Added support for SSH Authentication by providing certificate contents, changed property names for consistency.
1.1.0.2 - Updated the SFTP library which contains bug fixes.
1.1.0.6 - Provide a meaningful error when properties are missing
1.2.0.13 - Upgraded Libraries, Improved SFTP, FTP&FTPS Support, QoL fixes.
1.2.0.14 - Replaced IncludeSubDirectories property with FolderDepthLimit property. Allows for more granularity around result size.
1.2.0.15 - Fix to correctly surface inner exception in FTP Error cases.

Added override for FTP encryption mode in connection properties.

Properties

Connection

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

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

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

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

TrustedServerCertificateThumbprint
Type: String
The SHA-1 Fingerprint of the certificate of the FTPS server to connect to. Submitted as numbers and all uppercase letters, no colons. Note that leaving this field empty will trust any certificate presented by the server.

UsePassiveFTP
Type: Boolean
Some servers are configured to expect the PASV command when a connection is initialized. The Node then sends the PASV command instead of the PORT command when initiating a connection to the 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: Integer 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.
Note: This property does not apply when a Local/Network path is provided and the PollInterval is 0.

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.

Remarks

The File Watcher Trigger allows a set of files to be monitored for changes.

The prefix provided as part of Path determines the file type as follows:

  • [Drive]:\ local drive
  • \\ UNC path for network share
  • ftp:// FTP
  • sftp:// SFTP
  • ftps:// FTPS

As of Version 1.2.0.13, the File Watcher Node is no longer executable in Run From Cloud configuration and should instead be run from a DropPoint. Should the from cloud configuration be required, this can be arranged by submitting a support ticket.

Authentication

The Username and Password or ClientPrivateKeyFileContents provided in the Connection Property will be used to authorize FTP or SFTP sessions only. If you require specific credentials to gain access to a local file or UNC path, change the Windows Service account used by the DropPoint.

See Also

File Enumerator
File
File Compressor
FileManage
Flat File