SFTP Put
Description
SFTP Put is a step in the Experimental Plugin for Process Studio Workflows. This step corresponds to the Put files with SFTP process entry. SFTP Put step can be used to transfer one or more source files from a directory on the machine on which Process Studio runs to a remote target directory using the Secure FTP protocol.
Configurations
No. | Field Name | Description |
---|---|---|
1 | Step name | Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow. |
Server settings: | ||
2 | Server | Specify the name of the SFTP server or the IP address. |
3 | Port | Specify the TCP port to use. This is usually 22. |
4 | Username | Specify the user name to log into the SFTP server. |
5 | Password | Specify the password to log into the SFTP server. |
6 | Use keyfile | Enable this Checkbox to indicate whether or not a private keyfile is to be used. |
7 | Keyfile | If "Use keyfile" above 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. |
8 | Key password | If "Use keyfile" above is checked then this field is enabled. If a passphrase is required then enter it here. |
9 | Proxy type | Specify the proxy type (SOCKS5, HTTP) of the specified proxy server. |
10 | Proxy host | Specify the host name or the IP address of the proxy server. |
11 | Proxy port | Specify the port of the proxy server to connect to. |
12 | Proxy username | Specify the username to log into the proxy server as. |
13 | Proxy password | Specify the password associated with "Proxy username". |
14 | Button: Test Connection | Click this button to test SFTP connection. |
15 | Compression | Specify the compression to use in the file transfer. Current options are "none" and "zlib". |
Files tab | ||
Source(local) files: | ||
1 | Input is a stream | Enable this checkbox to indicate that input filename is coming from the workflow stream. |
2 | Source filename field | Choose a field in the stream containing the filename. |
3 | Add filename to result | Enable checkbox to add filename to result. |
4 | After SFTP Put | Specify the action to take after the file is transferred. Actions are "Do nothing","Delete file" and "Move file to". |
5 | Destination folder | Destination folder is enabled if "After SFTP Put" is set to "Move file to". The destination on the source file for the move is specified here. Use to browse button to browse to destination folder. |
6 | Create destination folder | Enabled if "After SFTP Put" is set to "Move file to". If the "Destination folder" does not exist check this option to create it. |
Target (remote) folder: | ||
7 | Remote directory | Specify the remote directory on the SFTP server to which we need to put the files. |
8 | Create folder | Check this option if the destination folder does not exist and should be created. |
9 | Remote filename | Provide a remote filename. |