Put Files with SecureFTP
Description
Put Files with Secure FTP uploads one or more local files to a remote directory using the SFTP protocol. Use this process entry when your process needs to securely deliver files with SSH-based authentication — for example, uploading encrypted reports to a partner's SFTP server or transferring data files to a cloud-hosted system. It supports private key authentication, automated remote folder creation, and post-upload actions like moving source files.
Configurations
| Field Name | Description |
|---|---|
| Process Entry name | Specify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name. |
| Server settings: | |
| SFTP server name / IP | The name of the SFTP server or the IP address |
| Port | The TCP port to use. This is usually 22 |
| User name | The user name to log into the SFTP server |
| Password | The password to log into the SFTP server |
| Use private keyfile | Indicates whether or not a private keyfile is to be used. |
| Private key filename | If "Use private keyfile" is checked then this field is enabled. The file can be browsed to using the browse button to the right of the field. The Private Key should be in the PEM file format. For PuTTY-based Private Keys, use PuTTYgen to convert the file into "OpenSSH" format. |
| Key passphrase | If "Use private keyfile" is checked then this field is enabled. If a passphrase is required then enter it here. |
| Use old algorithm for SSH Communication | Select the checkbox to enforce the internal library to use older or weaker algorithms for SSH communication. Important: Choosing the checkbox is required when the client or source machine with updated SSH environment is trying to communicate with a target machine which has older SSH environment. If not selected, then user will get "Algorithm negotiation failed" error. Recommendation: We recommend using modern and secure algorithms wherever possible. Using old algorithms for SSH communication can be a security risk. |
| Proxy type | The proxy type (SOCKS5, HTTP) of the specified proxy server. |
| Proxy host | Proxy server host name |
| Proxy port | Proxy server port number |
| Proxy username | Proxy server account user name |
| Proxy password | Proxy server account password |
| Compression | The compression to use in the file transfer. Current options are "none" and "zlib". |
| Files Tab | |
| Source (local) files: | |
| Copy previous results to args | If files to send are dynamically generated by another workflow or if you want to identify files to send, check this option.Process Studio will select files list from previous result rows (not result files, see next option) and send theses files. If the file cannot be found, Process Studio will ignore it. (It takes the first field of the result row as a string field.) |
| Copy previous result files to args | If files to send are dynamically generated by another workflow or process entry or if you want to identify files to sent, please check this option. Process Studio will select files from previous files result entry and send theses files. If the file cannot be found,Process Studio will ignore it. |
| Local Directory | The directory on the machine on which Process Studio runs from which you want to ftp the files from |
| Wildcard (regular expression) | Specify a regular expression here if you want to select multiple files. |
| Success when no file | Check this option if the process entry has to success when there is no files to process otherwise the process will fail. |
| After SFTP put | Specify the target directory on the local machine where files will be moved after they are successfully uploaded. Or Click Folder.. to browse the target directory on the local machine. - Dynamic values: Use environment variables to define the destination folder dynamically. - Automatic folder creation: If the Create destination folder is enabled, the specified folder will be created on the local machine if it does not exist. Note: When the After FTP Put is set to Move file to, the fields Destination folder and Create destination folder are available and mandatory. |
| Destination folder | Specify the target directory on the local machine where files will be moved after they are successfully uploaded. Or Click Folder.. to browse the target directory on the local machine. - Dynamic values: Use environment variables to define the destination folder dynamically. - Automatic folder creation: If the Create destination folder is enabled, the specified folder will be created on the local machine if it does not exist. Note: When the After FTP Put is set to Move file to, the fields Destination folder and Create destination folder are available and mandatory. |
| Create destination folder | Enabled if "After SFTP Put" is set to "Move file to". If the "Destination folder" does not exists check this option to create it. |
| Add filename to result | Enabled if "After SFTP Put" is seet to "Do nothing". If checked the name of the file is added to the result stream. |
| Target (remote) files: | |
| Remote Directory | Specify the target directory on the remote SFTP server where files will be uploaded. Specify the full path to the directory on the remote server. - Automatic folder creation: If the Create folder is checked, the specified directory will be created automatically on the remote server if it does not exist. - Dynamic interaction: Use environment variables to dynamically set the directory path. Note: On blank or missing field values, the server's default home directory for the specified user will be used. |
| Test folder | Click Test folder to test the connection to the specified SFTP server and verify the existence and accessibility of the Remote Directory. If the connection fails or the directory is invalid, an error message will be displayed, indicating the issue for example, authentication failure, directory not found, and so on. |
| Create folder | Check this option if the destination folder does not exist and should be created. |