| Step Details | |
| Introduced in Version | --- |
| Modified in Version | 8.12.0 |
| Location | Integration > FTP |
The Download/ Download by SFTP step allows users to download a file across a network from an FTP (File Transfer Protocol) /SFTP (Secure File Transfer Protocol) server. The step requires proper authentication via username and password to connect to the specified server type, regardless if an FTP server allows anonymous connections.
Note: All Certificates and related information for FTP/SFTP steps are stored within the Flow Step and are not stored independently in the database or the server.
Properties
FTP/SFTP
| Property | Description | Data Type | ||||
|---|---|---|---|---|---|---|
| Get Configuration From Data | Allows the user to set the configuration as input fields | --- | ||||
| Server | ||||||
| Host | Host name of the FTP server | --- | ||||
| Port | Port of the FTP server | --- | ||||
| SSL | Enables user to select an SSL Security Type | --- | ||||
| SSL Security Type | Choose the security type as Explicit, Unsecure, Implicit, or Secure. | --- | ||||
| Authentication | ||||||
| Use Certificate for Auth | Enables users to use a Certificate and Certificate Password for authentication for FTP. Users can use the following types of certificates - X.509, PFX/PKCS#12, and PEM. | --- | ||||
| Username | Username for the FTP account | --- | ||||
| Password | Password for the FTP account | --- | ||||
| Proxy | ||||||
| Type | Allows the user to select the Proxy type | --- | ||||
| Advanced | ||||||
| Enable Compression | Enables compression of the file being uploaded | --- | ||||
Advanced (SFTP step)
| Property | Description | Data Type | |
|---|---|---|---|
| Show Advanced Options | |||
| Enable Compression | Enables compression of the file being uploaded | --- | |
| SSH Key Exchange Algorithm | Enables the SSH to use a specified algorithm type | --- | |
| Business Metrics | Adds and configures business metrics to be captured in this folder. Business Metrics are quantifiable values that measure the success and efficiency of a given business process. Different process goals call for different metrics to measure their success. | --- | |
Inputs
| Property | Description | Data Type |
|---|---|---|
| Output File Name | The desired file name of the downloaded file | String |
| Remote File Path | The FTP/SFTP directory path of the FTP/SFTP host | String |
Step Changes
| DT Title | Description | Version | Date |
|---|---|---|---|
| [DT-037229] SSL Security Type drop-down does not display | Added a new "SSL Security Type" setting for the FTP steps. | 8.11 | April 2023 |
Related Information
Video:
SFTP and FTP in Decisions
Video:
SFTP and FTP in Decisions
Forum Posts:
FTP File Download Update Upload Flow
Download SFTP File - Remote File Path
Access SFTP Folder Using SSH Keys