FTP / SFTP

Configuring FTP/SFTP as a Source

Perform the following steps to configure FTP/SFTP as the Source in your Pipeline:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE in the Pipeline List View.

3. In the Select Source Type page, select FTP/SFTP.

4. In the Configure your FTP/SFTP Source page, specify the following:

   

   • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

   • Type: The network protocol for ingesting files. For example, FTP (File Transfer Protocol).

   • Host: The IP address or the DNS for your network protocol location.

   • Port: The port on which your network protocol server is listening for connections. Default value: 21.

   • User: The user ID for logging in to the network protocol server.

   • Password: The password of the user logging in to the network protocol server.

     Note: This field is optional if you selected Type as SFTP above. However, you must add the public key displayed on the UI to the .ssh/authorized\_keys file on your SFTP server.

   • Path Prefix: The prefix of the path for the directory that contains your data. By default, the files are listed from the root of the directory.

   • File Format: The format of the data file in the Source. Hevo supports the CSV, JSON, TSV, and XML file formats to ingest data.

     Note: You can select only one file format at a time. If your Source data is in a different format, you can export the data to either of the supported formats and then ingest the files.

     Based on the format you select, you must specify some additional settings:

     • Field Delimiter: The character on which the fields in each line are separated. For example, \t or ,.

       This field is visible only for CSV data.

     • Treat first row as column headers: If enabled, Hevo identifies the first row in your CSV file and uses it as a column header rather than an Event.

       If disabled, and if your Source data file does not contain column headers, Hevo automatically creates them during ingestion. Default setting: Enabled. Refer to section, Example.

       This field is visible only for CSV data.

     • Create Events from child nodes: If enabled, Hevo loads each node present under the root node in the XML file as a separate Event.

       If disabled, Hevo combines and loads all nodes present in the XML file as a single Event.

       This field is visible only for XML data.

   • Include compressed files: If enabled, Hevo also ingests the compressed files of the selected file format from the folders. Hevo supports the tar.gz and zip compression types only.

     If disabled, Hevo does not ingest any compressed file present in the selected folders.

     This field is visible for all supported data formats.

   • Create Event Types from folders: If enabled, Hevo ingests each subfolder as a separate Event Type.

     Note: Files lying at the prefix path (and not in a subdirectory) are ignored.

     If disabled, Hevo merges subfolders into their parent folders and ingests them as one Event Type.

     This field is visible for all supported data formats.

   • Connect Through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your network protocol host to Hevo. This provides an additional level of security to your database by not exposing your network protocol setup to the public. Read Connecting Through SSH.

     If this option is disabled, you must whitelist Hevo’s IP addresses to allow Hevo to connect to your network protocol host.

   • Convert date/time format fields to timestamp: If enabled, Hevo converts the date/time format within the files of selected folders to a timestamp. For example, the date/time format 07/11/2022, 12:39:23 converts into timestamp 1667804963.

     If disabled, Hevo ingests the datetime fields in the original format.

     This field is visible for all supported data formats.

5. Click TEST & CONTINUE.

6. Proceed to configuring the data ingestion and setting up the Destination.