File Finder Documentation

Version: 4.0.0

Retrieved: 2025-10-09 15:15:51

File Finder

The module will find files in local storage and pass the path to each file found in an array of strings. The search is triggered by incoming messages.

This module is designed to be located in the middle of a flow.

Settings

Name	Requirements	Purpose	Default
Source Path	Not Null, Length 0-128	The path on disk to search in. If empty the application folder will be used	""
File Pattern	Not Null, Length 2-32	The pattern to use to find files. For example *.txt to find all .txt files	.
Include subfolders	Boolean	If true, the search will include all subfolders of the SourcePath	true
Max Number of Files	Integer (0 = no limit)	Maximum number of files to return	0
Target Property	Not Null, Length 1-64	The property to write the result into	data

Input

There are no specific requirements on the input. The result from the module will extend the incoming messages.

Output

The output from the File Finder is always the same as the input including the result of the files found written to the Target Property.

Examples

Using Source Path and File Pattern directly from settings

# Settings

Source Path: MyFolder
File Pattern: *.*
Include subfolders: false
Max Number of Files: 0
Target Property: data.files

# Input

{
  "data": {
  }
}

# Output

{
  "data": {
    "path": "MyFolder",
    "files": [
      "/path/to/MyFolder/file1.txt",
      "/path/to/MyFolder/file2.txt"
    ]
  }
}

Using Source Path and File Pattern from incoming message

# Settings

Source Path: {data.path}
File Pattern: {data.pattern}
Include subfolders: false
Max Number of Files: 0
Target Property: data.files

# Input

{
  "data": {
    "path": "MyFolder"
    "pattern": "*.txt"
  }
}

# Output

{
  "data": {
    "path": "MyFolder",
    "pattern": "*.txt",
    "files": [
      "/path/to/MyFolder/file1.txt",
      "/path/to/MyFolder/file2.txt"
    ]
  }
}

Search Documentation

Data Sources

Files