SFTP Files Move Documentation

Version: 2.1.0

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

SFTP Files Moves

Will move 0-n files on a SFTP server based on a path and pattern.

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

• If the File Pattern is not set the module requires the File Pattern Property to be included on the incoming message.
• If the Target Folder is not set the module requires the Target Folder Property to be included on the incoming message.

Output

The same as input

Example 1

Usage with File Pattern set in the module and wildcard in file name. Will move all .txt files in the folder named myFolder to the folder newLocation.

Settings

File Pattern = './myFolder/*.txt'
Target Folder = './newLocation/'

Input

{
  example:{
    data:{
      temp: 342,
      rpm: 4500
    }
  }
}

Output

{
  example:{
    data:{
      temp: 342,
      rpm: 4500
    }
  },
  crosser : {
    success: true
  }
}

Example 2

Usage with File Pattern set in the module, wildcard in the filename and adding a string to the original file name. Will move all .txt files in the folder named myFolder to the folder newLocation with the new file name myPrefix_{FileName}.

Settings

File Pattern = './myFolder/*.txt'
Rename Pattern = 'myPrefix_{FileName}'
Target Folder = './newLocation/'

Input

{
  example:{
    data:{
      temp: 342,
      rpm: 4500
    }
  }
}

Output

{
  example:{
    data:{
      temp: 342,
      rpm: 4500
    }
  },
  crosser : {
    success: true
  }
}

Example 3

Usage with File Pattern set in the module, wildcard in the filename and accessing property from incoming message. Will move all .txt files in the folder named myFolder to the folder newLocation with the new file name MyNewPrefix_{FileName}.

Settings

File Pattern = './myFolder/*.txt'
Rename Pattern = '{example.filename}_{FileName}'
Target Folder = './newLocation/'

Input

{
  example:{
    filename: 'MyNewPrefix',
    data:{
      temp: 342,
      rpm: 4500
    }
  }
}

Output

{
  example:{
    filename: 'MyNewPrefix',
    data:{
      temp: 342,
      rpm: 4500
    }
  },
  crosser : {
    success: true
  }
}