Get Files With Secure FTP
Description
Use the step to get files using SFTP (Secure Files Transfer Protocol)
Configurations
| Field Name | Description |
|---|---|
| General Tab | |
| Step Name | Name of the step. This name must be unique in a single workflow. |
| Server Name / IP Address | Specify the name of the SFTP server or the IP address. The field is mandatory. |
| Server Port | Specify the TCP port number to use. Default Port for SFTP protocol: 22 The field is mandatory. |
| Username | Specify the username of your SFTP server account. The field is mandatory. |
| Password | Specify the password of your SFTP server account. If the checkbox Accept Value as variable/static is selected, then the password field appears as a text box and accepts static or variable values. OR If the checkbox is not selected, the password field appears as a dropdown in which you can select a field from the previous steps. |
| Use Private Keyfile | Specify Yes to use private key file. Allowed Values: Yes or No Default Value: No |
| Private Key Filename | Specify the private key file location. Or click Browse to select the key file you want to upload. Note: - Supported file types: .pem and .ppk- The field is available if Use private key file is Yes. |
| Key passPhrase | Specify the passphrase of the key file if needed. Note: The field is available if Use private key file is Yes. |
| Proxy Type | Select the proxy type. Available values are: • HTTP • SOCKS5 |
| Proxy Host | Specify proxy server host name. |
| Proxy Port | Specify proxy server port number. |
| Proxy Username | Specify username of proxy server to sign on to server. |
| Proxy Password | Specify password of proxy server to sign on to server. If the checkbox Accept Value as variable/static is selected, then the password field appears as a text box and accepts static or variable values. OR If the checkbox is not selected, the password field appears as a dropdown in which you can select a field from the previous steps. |
| Test Connection | Click to check whether the connection is successfully established or not. |
| Files | |
| Source Files: | |
| Remote Directory | Specify the remote directory path of folder on the SFTP server from which we get the files. Click Test Folder to validate whether the folder exists or not. Note: Test Folder will not work if the Remote Directory value is set from a field in the previous step. |
| Wildcard (Regular Expression) | Specify a regular expression to get multiple files from specified remote directory. For example: *.txt, *.pdf, *.xls, *.xlsx Note: If no expression is defined, then all files will be uploaded from remote directory. |
| Group: Last Modified On (UTC DateTime) | Specify a date-time to select the file(s) that are last modified from mentioned date time. Allowed date-time format: yyyy-MM-dd hh:mm:ss aa specifies the AM/PM designation. |
| From | Specify From to select the last modified from mentioned date-time. |
| To | Specify To to select the last modified to mentioned date-time. |
| Remove Files After Retrieval? | Specify Yes to delete the remote file(s) after the file is transferred. If set to Yes, the files will not be retrieved again. Allowed Values: Yes or No Default Value: No |
| Files Tab – Target Files | |
| Target Directory | Specify the target folder directory of server which represents the destination directory where the downloaded file will be stored. OR Click Browse to select target folder directory of local machine to download the file(s). |
| Create Target Folder | Specify Yes to create destination folder if it does not exist. Allowed Values: Yes or No Default Value: No |
| Add Filenames To Result | Specify Yes to add name of file in the result stream. Allowed Values: Yes or No Default Value: No |
| Advanced Settings Tab | |
| Timeout | Specify the timeout in milliseconds for SFTP server connection. |
| Compression | Select to compress the file(s). Available options are: - None - zlib |