SFTP Text Reader Documentation

Version: 3.0.0 

Retrieved: 2025-10-09 15:16:19

SFTP Text Reader

The module reads text file content from an SFTP server into a property and passes it to the next module(s).

Settings

Credential

This module contains an option to select credentials to use in the module. All credentials supported by the module are presented in a drop-down.

Input

Any message.

Output

The same as the input, but the output will also have the contents of the text file added at Target Property and also the 'crosser' object added.

Example - Read Text File from SFTP server

# Settings:
Host="localhost"
Port=22
Remote Directory="upload"
Filename="example.txt"
Target Property="data"

# Incoming message:
{
    "SomeKey": "SomeValue"
}

# Outgoing message:
{
    "SomeKey": "SomeValue",
    "data": "This is the contents of example.txt\n"
}

Example - Fetch Remote Directory and Filename from incoming message

# Settings:
Host="localhost"
Port=22
Remote Directory=
Filename=
Target Property="data"


# Incoming message:

{
  "crosser": {
    "success": true
  },
  "sftptextreader": {
    "filename": "my_csv.csv",
    "remotedirectory": "folder_1\sub_1"
  }
}

# Outgoing message:

{
  "crosser": {
    "success": true
  },
  "data": "temp;pressure 123;456 789,012",
  "sftptextreader": {
    "filename": "my_csv.csv",
    "remotedirectory": "folder_1\sub_1"
  }
}