Page tree
Skip to end of metadata
Go to start of metadata

Overview 

The DBSyncs FTP (File Transfer Protocol) connector implements a file transport channel that allows the DBSync to exchange files with an FTP server. This FTP connector can be used to:

  1. download the file from an FTP server
  2. upload files to an FTP server,
  3. read one or more files, and
  4. write to a file or more files.

What is FTP

File Transfer Protocol or FTP is a network protocol used to transfer computer files between a client and a server.

It has an extension, named FTPS, which allows for the encryption of the sessions. It uses a different port (see table below).

Prerequisites

In order to establish a connection to an external File Transfer Protocol server, the user needs the following:

  1. Have a valid license to DBSync FTP connector, username and password to connect to DBSync iPaaS platform.
  2. An FTP user with sufficient permission to read/write to the required directories.

Data Transfer

The DBSync FTP connector allows you to transfer data from and to an FTP server.

In order to transfer data from an FTP server to another source, you need to define a Trigger that describes where the data resides.

In order to transfer to an FTP server, you need to define one or more Rules that describe where to store the data

Notes:

  1. When the FTP Connector is used to transfer a file, the data is transfered in-memory to the ftp server, and nothing is registered on Cloudworkflow.
  2. It is possible to connect to several FTP servers. However, each connection requires a separate conector.


Connector Configuration

The following table describes the parameters needed to define an FTP connector:


Property

Description

Required

Default Values

HostName

The HostName of the FTP server, by default we provide file protocol as FTP and in case if the user wishes to change to
anything else the below is the format which need be used.

DBSync supports only below given protocols.

ftp://hostname \\

sftp://hostname
ftps://hostname

yes

FTP, SFTP, FTPS

Port

The port number of the FTP server . By default for plain file protocol the port number should be 21 and for secured protocol it is 22

yes

FTP:21
SFTP:22
FTPS:990/21

UserName

The username of the FTP server

Yes


Password

The password of the FTP server

Yes


Folder

The folder path from where the files should be read or written. If slash is given at the start of the path then connector picks 
it as a root folder of ftps protocol
Note : There shouldn't to be no slashes at the start or end of the folder path

Yes


Columns

The columns are the header in the file which should be comma separated

Optional


DelimiterDelimiter indicating separation of data. For example a comma.

Enable


Remote serverEnables the use of a remote server

Use SSHEnables the use of SSH, also known as Secure Socket Shell, is a network protocol that provides administrators with a secure way to access a remote computer.


Trigger Configuration

The following table describes the Trigger properties of an FTP connector that need to be defined when sending data from the FTP server to another source.

Property

Description

Required

Default Value

Store

This property enables the data to be stored in-memory during file Transfers. There are two possible values i.e. Session 
and InMemory.

InMemory means that the transferred values are held in the cache. Session means that the stored values are held in the session


yes

session

Directory

DBSync FTP connector enables you to dynamically select the inbound file directory via Trigger property Section

optional


File Has HeaderIndicates that the file has a header.optional
Post ProcessingEnables the execution of Shell commands after completing the data transfer process.optional
Regular ExpressionEnables to select all similar files on the server location for processing. Example: ^([a-zA-Z]:\\)?[^\x00-\x1F"<>\|:\*\?/]+\.[a-zA-Z]{3,4}$ matches a valid Windows file name.optional



The Query Builder is a tool that allows you to define a specific SQL query. In this manner you can create queries that are tailored to your needs.


Rule Configuration

The following table describes the Rule properties that need to be defined when sending data to an FTP server.

Property

Description

Required

Default Values

Mode

FTP has a two different ways to establish a data connection between FTP server and its client. The two modes are referred to as 
PASV(passive) and PORT mode.

yes

passive

File Type

The property is the file type and there are two types i.e. First one is binary and the other one is ASCII

yes

ASCII

File Name

File name signifies the target file name which is set for two purposes 

  1.  If a new file to be created on the target FTP server then user need to fill in the text area as @ Filename @ and can specify the file name of his choice 
  2.  If data has to be appended to the existing file then leave this field blank

optional


Batch Size

The batch size is the speed with which files are inserted into target system. By default the DBSync will pass this as 200

optional


Directory

Directory to store the file on to the Target FTP server

optional


Write HeaderBoolean value indicating if the header should be written or not.optionalFalse


Uses of the FTP Connector

  • Automated file backups by decreasing the manual intervention from any CRM, Accounting system to a remote FTP server.
  • Post processing of files from one directory to another directory within a file system.
  • An example of usage of the FTP connector can be found in the following article:

Frequently Asked Questions

Q: Does FTP connector support Bi-directional data flow?

A: Yes, and you also have the control to make it uni-directional if you chose.

Q: How frequently one can sync the data if reading from or writing to any FTP server?

A: The sync can be performed every five-minute interval of time.

Q: Is this connector available with both on-demand and on-premise versions?

A: Yes, the FTP connector can be used both on-demand and on-premise versions of DBSync Cloud Workflow.



  • No labels