FTP

Overview

You can create an SFTP Destination Connector to write CSV files (by default) or JSONL files to an SFTP folder using an SSH Private Key or your SFTP password.
Note: We only support SFTP Destination Connector and not FTP.
Supported file formats: CSV and JSONL

Prerequisites

Required information:
  • SFTP Host
  • Port Number
  • Username
  • Password
  • Directory

Creating a SFTP Destination Connector

Step 1: Click New Connector.
Step 2: Under the System prompt, click SFTP.
Step 3: Provide a Connector Name.
Step 4: Select Destination Connector.
Step 5: Select the SFTP protocol used by the server.
Step 6: Provide the SFTP host.
Step 7: Provide the port number.
Step 8: Provide your SFTP username.
Step 9: Provide the directory path for the SFTP folder you want to connect to. (Note: the path is case sensitive)

Authentication

You have the option to authenticate with an SSH Private key or with a Username and Password.
SSH Private Key
Step 1: If you choose to authenticate with an SSH Private Key, provide the SSH private key with the BEGIN prefix and END suffix, as shown below.
Step 2: Some private keys have a password as well. If you have one, provide the password in the in the SSH Private Key Password field. If you do not have one, you can leave this field blank.
Password
If you select this option, provide your SFTP password.

Building the Schema for the Destination Connector

Use the schema designer to build the output schema for this Destination Connector.
Parameter
Description
Field Name
Provide a field name for the output fields. These names will be used as the column headers or field names in the output file you are writing to.
Type
Define the type of each field. The field types will be used to enforce rules when you send data to this Connector.
Nullable
Check this box if the field is nullable. If the field is not nullable, you will be required to provide values for this field when sending data to this Connector.
Delete
Deletes the field.
Add Field
Adds another field to the schema.
Step 1: Click Add Field for each additional field required in the schema Step 2: Select Create Schema once you have built the schema.
The schema cannot be changed after saving the Destination Connector, so please confirm it is accurate before proceeding.

Advanced Options

Output File Format
By default, this Destination Connector writes CSV files, and each Osmos Pipeline run produces a new file. If preferred, you can choose to change the output to a JSONL file instead of a CSV file.
​
Copy link
On this page
Overview
Prerequisites
Creating a SFTP Destination Connector
Authentication
Building the Schema for the Destination Connector
Advanced Options