FTP Client
uniflow.plugin.ftpclient •
Category: Network Protocol •
Version: v1.0.31
FTP Client Plugin Reference Manual
1. Overview
Plugin Name: FTP Client
Type: Network Protocol
Identifier: uniflow.plugin.ftpclient
Description
Connects to remote FTP/SFTP servers. Lists files in configured remote folders with per-folder polling, uploads and downloads files via a deduplicated retry queue, and stores operation results in Internal Storage.
2. Configuration Parameters
The following configuration fields are available in the User Interface for this plugin:
| Configuration Setting | Description |
|---|---|
| Friendly Name | Specifies the friendly name. |
| Description / Notes | Specifies the description / notes. |
| Host / IP Address | Specifies the host / ip address. |
| Protocol | Specifies the protocol. |
| Port | Numeric value specifying the port. |
| Username | Specifies the username. |
| Auth Mode | Specifies the auth mode. |
| Private Key Path | Specifies the private key path. |
| Max Transfer Retries | Specifies the max transfer retries. |
| Connect Timeout (ms) | Numeric value specifying the connect timeout (ms). |
| Reconnect Interval (ms) | Numeric value specifying the reconnect interval (ms). |
| Passive Mode | Specifies the passive mode. |
| Use TLS (FTPS) | Toggle to enable or disable use tls (ftps). |
3. Exposed Routes & Data Types
The following routes are available in the Uniflow catalog for this plugin:
| Display Name | Route ID | Kind | Category | Access | Data Type |
|---|---|---|---|---|---|
| displayName | folder.Id | Value | Storage | Read | Json |
| Configured Remote Folders | ftp:remote_folders | Value | Virtual | Read | Json |
| Internal Storage Points | ftp:storage_tags | Value | Virtual | Read | Json |
| Upload File | ftp:upload | Value | Storage | Write | Json |
| Download File | ftp:download | Value | Storage | Write | Json |
Route Parameters: Upload File
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Download File
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
4. Usage Examples
Scenario A: Reading/Monitoring Data
To monitor data from FTP Client, add the corresponding Input Node in the Rule Editor and select the desired property from the catalog. Link its output to any logical comparison or directly to an Action Node.
Scenario B: Triggering Actions
If the plugin supports writable properties or actions, use an Action Node in the Rule Editor. Configure the Target property to point to the FTP Client action, and supply any required parameters mapping from your rule's logic.