FTP / SFTP
On This Page
You can load data from files in an FTP location into your Destination database or data warehouse using Hevo Pipelines.
Configuring FTP/SFTP as a Source
To configure FTP/SFTP as a Source in Hevo:
-
Click PIPELINES in the Asset Palette.
-
Click + CREATE in the Pipeline List View.
-
In the Select Source Type page, select FTP/SFTP.
-
In the Configure your FTP/SFTP Source page, specify the following:
-
Pipeline Name - A unique name for the Pipeline.
-
Type - Select FTP or SFTP.
-
Host - The IP address or the DNS for your FTP location.
-
Port - The port at which Hevo can connect with your FTP/SFTP Server. The default port is 21.
-
User - The user ID for logging in to the FTP/SFTP server.
-
Password - The password of the user logging in to the FTP/SFTP server. The password is optional for SFTP type connections. However, in that case, you will have to add our public key displayed on the UI to the
.ssh/authorized\_keys
file on your SFTP Server. -
Path Prefix - The path Prefix for the data directory. By default, the files are listed from the root of the directory.
-
File Format - Choose a file format. Hevo currently supports CSV, TSV, JSON, and XML formats. Contact Hevo Support if your Source data is in a different format.
Based on the format you select, you must specify some additional settings:
-
CSV:
-
Specify the Field Delimiter. This is the character on which fields in each line are separated. For example, `\t`, or `,`).
-
Disable the Treat First Row As Column Headers option if the Source data file does not contain column headers. Hevo automatically creates the headers during ingestion. Default setting: Enabled. See Example below.
-
-
TSV:
- Disable the Treat First Row As Column Headers option if the Source data file does not contain column headers. Hevo automatically creates the headers during ingestion. Default setting: Enabled.
-
XML: Enable the Create Events from child nodes option to load each node under the root node in the XML file as a separate Event.
-
-
Create Event Types from folders - Enable this option if the prefix path has subdirectories containing files in different formats. Hevo reads each subdirectory as a separate Event Type.
Note: Files lying at the prefix path (and not in a subdirectory) are ignored.
-
Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your FTP host to Hevo. Read Connecting Through SSH.
If this option is disabled, you must whitelist Hevo’s IP addresses to allow Hevo to connect to your FTP host.
-
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Data replication
Default Pipeline Frequency | Minimum Pipeline Frequency | Maximum Pipeline Frequency |
---|---|---|
5 Mins | 5 Mins | 3 Hrs |
See Also
Revision History
Refer to the following table for the list of key updates made to this page:
Date | Release | Description of Change |
---|---|---|
Apr-11-2022 | 1.86 | Updated section, Configuring FTP/SFTP as a Source to reflect support for TSV file format. |
Mar-21-2022 | 1.85 | Removed section, Limitations as Hevo now supports UTF-16 encoding format for CSV files. |
Oct-25-2021 | NA | Added the section, Data Replication. |
Jun-28-2021 | 1.66 | Updated the page overview with information about __hevo_source_modified_at being uploaded as a metadata field from Release 1.66 onwards. |
Feb-22-2021 | NA | Added the limitation about Hevo not supporting UTF-16 encoding format for CSV data. |