FTP – Setup

Introduction

This guide explains how to install and authenticate the FTP Connector for use in Cyclr. The connector can be used to connect to FTP, FTPS, and SFTP servers that support username and password authentication.

FTP servers are commonly used to exchange files between systems, often in the form of CSV or XML documents. They provide a central location where data can be uploaded, stored, and retrieved — for example, daily reports, sales exports, or data feeds generated by other systems.

Setup

The FTP Connector enables you to connect Cyclr to an FTP, FTPS, or SFTP server using username and password credentials.

FTP Connector Installation

When installing an FTP Connector, the following values are used:

ParameterDescription
Host URIThe full address of your FTP, FTPS, or SFTP server, including the protocol (e.g. ftp://example.com).
PortThe port number used by your server.
UsernameThe username of the FTP/SFTP account to authenticate as.
PasswordThe password for the FTP/SFTP account.
Server Time ZoneThe time zone of the FTP server using TZ database format (e.g. Europe/London).
If not set correctly the List Updated Files method will not function as expected.
Encryption Mode (optional)Select None, Explicit, or Implicit to match your server configuration.
Encrypted Data Channel (optional)Set to True for FTP Servers that use Data Channel Encryption. Otherwise, set as False.
TSL Session Reuse (optional)Set True for FTP Servers sharing TLS session on command and data channels. Otherwise, set as False.

Additional Information

Supported Protocols

The Cyclr FTP Connector supports multiple protocols:

  • FTP (File Transfer Protocol)
  • FTPS (FTP Secure): FTP enhanced with TLS encryption for secure transfer.
  • SFTP (SSH File Transfer Protocol): operates over SSH, encrypted by default.

Cyclr’s FTP Connector is compatible with all three when using username and password authentication.

If your system requires SFTP with private key authentication, use the SFTP Private Key Connector instead.

Encryption methods

The FTP Connector supports three encryption methods:

  • None: plain FTP, unencrypted.
  • Implicit: encryption begins immediately on connection (usually port 990).
  • Explicit: encryption begins unencrypted (port 21) and upgrades to TLS (Transport Layer Security).

For Private Key encryption, you should use the SFTP Private Key Connector.

Defining File Structures

When working with delimited (CSV) or XML files, you must define their structure before mapping data to other systems.

  1. Open the Connector’s settings page.
  2. Copy the Delimited Text Files or XML Files method category to create a custom version.
  3. Rename the copied category (e.g. Invoice CSV Files).
  4. Select Generate Fields and paste a sample of your file data (e.g. header row and one line of CSV).
  5. Cyclr will automatically create matching fields for mapping in subsequent steps.

This allows you to work with multiple file formats or structures without reinstalling the Connector.

Typical Use Case

You can create a cycle that retrieves daily CSV files from an FTP server, filters them based on naming conventions, and sends the data into another system. For example:

  1. List Updated Files checks for new files since the last run.
  2. A Decision step filters files (e.g. only import_ files).
  3. Download Delimited Text File retrieves and parses the CSV.
  4. Another Connector (e.g. Salesforce) uses that data to create or update records.

This approach can be adapted to work with several systems, including reporting databases, analytics systems, or ERPs.