Get Files Via FTP
Description
Use the step to get files using FTP (Files Transfer Protocol)
Configurations
| Field Name | Description |
|---|---|
| Step Name | Name of the step. This name must be unique in a single workflow. The field is mandatory. |
| Server name / IP address | Specify the name of the FTP server or IP address. The field is mandatory. |
| Server Port | Specify the TCP port number to use. Default port for FTP protocols: 21 The field is mandatory. |
| Username | Specify the username of your server account. The field is mandatory. |
| Password | Specify the password of your 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 Accept Value as variable/static is not selected, then the password field appears as a dropdown in which you can select a field from the previous steps. |
| Proxy Type | Specify the proxy types. Allowed values: HTTP or 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 Accept Value as variable/static is not selected, then 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 Tab - Remote | |
| Remote Directory | Specify the remote directory path of folder on the FTP server from which we get the files. Click Check Folder to validate whether the folder exists or not. Note: The Check Folder will not work if the Remote Directory value is set using the value from a field in the previous step. |
| Check Folder | Click Check Folder to connect to the remote server and validate whether the folder exists or not. |
| Wildcard (Regular Expression) | Specify the regular expression to get specific file(s) from remote directory. For example: .txt,.pdf,.xls,.xlsx Note: If no expression is defined, then all files will be deleted from remote directory. |
| Remove Files After Retrieval? | Specify Yes, to delete the remote file(s) after the file(s) is transferred. Allowed Values: Yes or No Default Value: No |
| Move Files After Retrieval? | Specify Yes to move the files after retrieval otherwise specify No. Allowed Values: Yes or No Default Value: No |
| Move to Folder | Specify the folder name to move file(s). |
| Check Folder | Click Check Folder to connect to the remote server and validate whether the folder exists or not. |
| Create Folder | Specify Yes to create the folder that will contain file(s) otherwise specify No. Allowed Values: Yes or No Default Value: No |
| Files Tab - Local | |
| Target Directory | Specify the target folder directory of local machine, which represents the destination directory where the downloaded file(s) will be stored. |
| Create Target Folder | Specify Yes to create destination folder if it does not exist. Allowed Values: Yes or No Default Value: No |
| Browse | Click Browse to select target folder directory of local machine to download the file(s). |
| Include Date In Filename | Specify Yes to add the system date to the filename otherwise specify No. Allowed Values: Yes or No Default Value: No |
| Include Time In Filename | Specify Yes to add the system time to the filename otherwise specify No. Allowed Values: Yes or No Default Value: No |
| Specify Date Time Format | Select Specify Date time format to set your own date or time format. |
| Date Time Format | Select date time format from list. |
| Add Date Before Extension | Specify Yes to add date to the filename before the extension otherwise specify No. Allowed Values: Yes or No Default Value: No |
| Overwrite Files | Specify Yes to overwrite the files, otherwise specify No. Default Value: No |
| If File Exists | Select an action from available list for file with an identical name already exists in the target directory. Available actions: - Skip - Give unique name to local file - Fail Note: Field is available only if Overwrite files is set to 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 | |
| Binary Mode? | Specify Yes or No. On Yes, the files will be transferred in binary mode otherwise specify No. Allowed Values: Yes or No Default Value: No |
| Timeout | Specify the timeout in milliseconds for FTP server connection. |
| Use Active FTP Connection | Specify Yes or No. If you specify Yes, you are connecting to the FTP server using active mode. Note: Set your firewall to accept connections to the port that your FTP client will open. The default is Passive mode. Allowed Values: Yes or No Default Value: No |
| Control Encoding | Select control character encoding that is valid for your server: - US-ASCII - ISO–8859-1 - UTF-8 - UTF-16BE - UTF-16LE - UTF-16 |
| Success Condition | |
| Success on | Sets the condition which defines the success of the step. |
| Limit Files | Sets the number of files associated with a condition of success to delete files. |