Skip to content

FTP integration

James Williamson edited this page Jul 12, 2018 · 2 revisions

What is the FTP integration?

The Importer is an Http Api that can be called from anywhere (as long as you are authenticated). However, we recognise that often clients and companies will provide there Feed on an FTP site. For this reason, we have created an integration that calls pull via FTP.

FTP options and features

  • FTP configuration eg Host, Port
  • Login and password
  • Login and SSH
  • Directory configuration
  • Reporting/feedback files (Re-active mode needed/Require write access)
  • Files moved to the processing directory to indicate progress (Re-active mode needed/Require write access)
  • Setting a schedule via Crontab

Configuration and settings

Property Name Required Type Description
host True string Location of the FTP site
username True string The FTP login to use
port True int Used to determine if an object should be updated
schedule_cron True string Uses the crontab format to set up a schedule for polling
password False string If using Username/password login

Configuration examples in github

Why its important for the Login to be allowed to rename files?

A huge advantage of having a login that can rename files and create directories is being able to provide feedback via the FTP site. If enabled, files can be moved to show progress, reports dropped, and generally have a more efficient application.

Clone this wiki locally