Get Files Via FTPS
Description
Use step to get files using FTPS (Files Transfer Protocol Secure)
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 FTPS server or the IP address to connect. The field is mandatory. |
| Server Port | Specify the TCP port number to use. Default Port for FTPS protocol: - Explicit Encryption: 21 - Implicit Encryption: 990 The field is mandatory. |
| Username | Specify the username of your FTPS server account log in. The field is mandatory. |
| Password | Specify the password of your FTPS server account log in. 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 proxy server account username to access server. |
| Proxy Password | Specify proxy server account password to access 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. |
| Connection Type | Select the connection type for encryption. Available options are: - TLS/SSL Implicit encryption - TLS/SSL Explicit encryption |
| 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 FTPS server from which we get the files. |
| Check Folder | Click Check Folder to validate whether the folder exists or not. |
| 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. |
| Remove Files After Retrieval | Specify Yes to delete the remote file(s) after the file is transferred. Allowed Values: Yes or No Default Value: No |
| Move Files After Retrieval | Specify Yes to move the remote file(s) after the file is retrieved. 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 validate whether the folder exists or not. |
| Create Folder | Specify Yes to create the folder that will contain files. Allowed Values: Yes or No Default Value: No |
| Files Tab – Local | |
| Target Directory | Specify the target folder directory on the local machine, which represents the destination directory where the downloaded file(s) will be stored. The field is mandatory. |
| 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 No. |
| Add Filenames To Result | Specify Yes to add name of file to the result stream. Allowed Values: Yes or No Default Value: No |
| Additional Settings Tab – Advanced | |
| 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 FTPS 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 |
| Success Condition | |
| Success On | Sets the condition which defines the success of the step. Select condition from list, available options are: - All works fine - At least x files - No. of errors less than |
| Limit Files | Sets the number of files associated with a condition of success to delete files. Note: Field is enabled if Success On is At least x files or No. of errors less than. |