Warning
WARNING: The TrackAbout MetaWiki has been deprecated and is no longer being updated.

Please visit our new TrackAbout Knowledge Base at https://supportkb.trackabout.com for the most-up-to-date documentation on TrackAbout and TrackAbout Mobile.

Difference between revisions of "FTP with Filezilla"

From TrackAbout MetaWiki
Jump to navigation Jump to search
(Document that FTPS is only supported in Production)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Need==
+
==What is FTP?==
Some files created by a TrackAbout process (or by Support team member) will be exported and stored on TrackAbout's FTP server. TrackAbout Support will first create the needed directories on the FTP server and then create a secure login for a client to receive such files, which typically contain data used for integration, data exports, or pdf files.
+
FTP stands for File Transfer Protocol. FTP is used to download or upload files to a remote server.
  
==FTP Basics and FileZilla==
+
Using FTP requires that you have an FTP program (or "client") on your computer.
In order to easily manage transfer via FTP, TrackAbout recommends using a recognized FTP client such as FileZilla. FileZilla is free open-source software distributed under the terms of the GNU General Public License free of charge. Basically this means that everyone, including corporate entities, can use FileZilla, including but not limited to private, educational and commercial use.
 
  
===Downloading Filezilla===
+
==Why might I need FTP?==
[https://filezilla-project.org/download.php?type=server Download from this link] and run the installer.
+
At various times, TrackAbout may create files that you need to access, like data exports. Or, you may need to upload data to TrackAbout for processing such as customer lists, orders or invoices. FTP is one way we can exchange these files.
===Basics===
+
 
An FTP client like FileZilla allows you to download files stored on TrackAbout's FTP server onto your local computer or network drive. The FileZilla interface is divided into three main components.
+
==The FileZilla FTP Client==
 +
FileZilla is popular, free, open-source FTP client.
 +
 
 +
FileZilla is distributed under the terms of the GNU General Public License. This means that everyone, including corporate entities, can use FileZilla for private, educational, and commercial purposes.
 +
 
 +
Please check your company policy regarding third party or open source software before installing FileZilla.
 +
 
 +
==Getting FileZilla==
 +
[https://filezilla-project.org/download.php?type=client Download the FileZilla client from this link] and run the installer.
 +
 
 +
==Basics==
 
[[File:FileZilla Interface.png|thumbnail|FileZilla interface - main areas highlighted]]
 
[[File:FileZilla Interface.png|thumbnail|FileZilla interface - main areas highlighted]]
*quickconnect bar (highlighted red in screenshot)
+
The FileZilla interface is divided into three main components.
*local site (highlighted green in screenshot)
+
*Quick Connect bar (highlighted red in screenshot)
*remote site (highlighted blue in screenshot)
+
*Local site (highlighted green in screenshot) - This is a folder on your computer.
===Quickconnect bar===
+
*Remote site (highlighted blue in screenshot) - This is a folder on our server.
These fields allow you to easily enter the needed credentials to connect to TrackAbout's FTP server.
 
*Host - Enter: '''files.trackabout.com'''
 
*Username - enter your client-specific username provided by TA support (this will be different than your TrackAbout website login)
 
*Password - enter the password provided by TA support (this will be different than your TrackAbout website login)
 
*Port - can be left blank--not required for TA FTP
 
Once the values are entered click the 'Quickconnect' button and you will be authenticated and connected to the TrackAbout FTP server. You will be given the option to save the credentials in the quickconnect history dropdown for future use.
 
  
===Local site===
+
===Site Manager===
 +
We recommend using the FileZilla Site Manager (File - Site Manager) to save connection settings for an FTP server. The Site Manager allows you to store entries and configure more parameters than Quick Connect allows.
 +
 
 +
Access the Site Manager from the Menu > File > Site Manager, or click on the top left icon.
 +
 
 +
Create a new site for TrackAbout using the parameters (Site picture below):
 +
[[File:FileZilla_host.png|thumbnail|Site Manager - Typical settings for TrackAbout FTPS server|link=Special:FilePath/FileZilla_host.png]]
 +
 
 +
[https://wiki.filezilla-project.org/Site_Manager For more information on FileZilla Site manager consult this page].
 +
 
 +
====Choosing a Protocol - FTPS vs SFTP====
 +
TrackAbout supports two different encrypted, secure file transfer protocols: FTPS and SFTP.
 +
 
 +
If you don't know the difference, use FTPS. FTPS is FTP over Transport-Layer Security (TLS). This encrypts vanilla FTP, which is what most people are used to using.
 +
 
 +
SFTP is a variant of Secure Shell (SSH) and Secure Copy Protocol (SCP). SFTP is more appropriate when you're automating file transfers using the Linux/Unix scp client program.
 +
 
 +
'''FTPS is only supported in Production environment, not Test.'''
 +
 
 +
Due to the antiquated port forwarding requirements for FTPS, TrackAbout only offers FTPS (FTP over TLS) for the production environment accessible at ftp.trackabout.com.
 +
 
 +
If you wish to test out file transfer processes in the Test environment, you must use SFTP (SSH/SCP) instead.
 +
====FTPS Connection Settings====
 +
*Host: enter: '''ftp.trackabout.com''' (Production)
 +
*Port: Leave empty
 +
*Protocol: '''FTP - File Transfer protocol'''
 +
*Encryption: '''Require implicit FTP over TLS'''
 +
*Login type: Normal'''
 +
*Username: Enter your client-specific username provided by TA support (this will be different than your TrackAbout website login).
 +
*Password: Enter the password provided by TA support (this will be different than your TrackAbout website login).
 +
 
 +
====SFTP Connection Settings====
 +
*Host: enter: '''ftp.trackabout.com'''
 +
*Port: '''2224'''
 +
*Protocol: '''SFTP /SSH'''
 +
*Login type: Normal'''
 +
*Username: Enter your client-specific username provided by TA support (this will be different than your TrackAbout website login).
 +
*Password: Enter the password provided by TA support (this will be different than your TrackAbout website login).
 +
 
 +
===Local Site===
 
This section will be populated as soon as you open FileZilla. It will allow you to navigate within your available folders on your PC or network (top section), and then display available files/folders within the selected folder (bottom section). If you want to download files from TrackAbout FTP to a specific folder, navigate to that folder within the 'Local site' (left side of the FileZilla pane).
 
This section will be populated as soon as you open FileZilla. It will allow you to navigate within your available folders on your PC or network (top section), and then display available files/folders within the selected folder (bottom section). If you want to download files from TrackAbout FTP to a specific folder, navigate to that folder within the 'Local site' (left side of the FileZilla pane).
===Remote site===
+
 
This section will be populated only after you connect to TrackAbout's (or another) FTP server. It will similarly allow you to navigate within available folders on the FTP server (top section), and then display available files/folders within the selected folder (bottom section). To download a file from the FTP server you can drag-and-drop from the remote site to your local machine, or double-click the file on the remote site. You can also place files on the FTP server by dragging from left to right or double-clicking a file on your local site.
+
===Remote Site===
 +
This section will be populated only after you connect to TrackAbout's (or another) FTP server. It will similarly allow you to navigate within available folders on the FTP server (top section), and then display available files/folders within the selected folder (bottom section). To download a file from the FTP server you can drag-and-drop from the remote site to your local machine or double-click the file on the remote site. You can also place files on the FTP server by dragging from left to right or double-clicking a file on your local site.
  
 
==More Information==
 
==More Information==

Latest revision as of 18:18, 18 July 2023

What is FTP?

FTP stands for File Transfer Protocol. FTP is used to download or upload files to a remote server.

Using FTP requires that you have an FTP program (or "client") on your computer.

Why might I need FTP?

At various times, TrackAbout may create files that you need to access, like data exports. Or, you may need to upload data to TrackAbout for processing such as customer lists, orders or invoices. FTP is one way we can exchange these files.

The FileZilla FTP Client

FileZilla is popular, free, open-source FTP client.

FileZilla is distributed under the terms of the GNU General Public License. This means that everyone, including corporate entities, can use FileZilla for private, educational, and commercial purposes.

Please check your company policy regarding third party or open source software before installing FileZilla.

Getting FileZilla

Download the FileZilla client from this link and run the installer.

Basics

FileZilla interface - main areas highlighted

The FileZilla interface is divided into three main components.

  • Quick Connect bar (highlighted red in screenshot)
  • Local site (highlighted green in screenshot) - This is a folder on your computer.
  • Remote site (highlighted blue in screenshot) - This is a folder on our server.

Site Manager

We recommend using the FileZilla Site Manager (File - Site Manager) to save connection settings for an FTP server. The Site Manager allows you to store entries and configure more parameters than Quick Connect allows.

Access the Site Manager from the Menu > File > Site Manager, or click on the top left icon.

Create a new site for TrackAbout using the parameters (Site picture below):

File:FileZilla host.png
Site Manager - Typical settings for TrackAbout FTPS server

For more information on FileZilla Site manager consult this page.

Choosing a Protocol - FTPS vs SFTP

TrackAbout supports two different encrypted, secure file transfer protocols: FTPS and SFTP.

If you don't know the difference, use FTPS. FTPS is FTP over Transport-Layer Security (TLS). This encrypts vanilla FTP, which is what most people are used to using.

SFTP is a variant of Secure Shell (SSH) and Secure Copy Protocol (SCP). SFTP is more appropriate when you're automating file transfers using the Linux/Unix scp client program.

FTPS is only supported in Production environment, not Test.

Due to the antiquated port forwarding requirements for FTPS, TrackAbout only offers FTPS (FTP over TLS) for the production environment accessible at ftp.trackabout.com.

If you wish to test out file transfer processes in the Test environment, you must use SFTP (SSH/SCP) instead.

FTPS Connection Settings

  • Host: enter: ftp.trackabout.com (Production)
  • Port: Leave empty
  • Protocol: FTP - File Transfer protocol
  • Encryption: Require implicit FTP over TLS
  • Login type: Normal
  • Username: Enter your client-specific username provided by TA support (this will be different than your TrackAbout website login).
  • Password: Enter the password provided by TA support (this will be different than your TrackAbout website login).

SFTP Connection Settings

  • Host: enter: ftp.trackabout.com
  • Port: 2224
  • Protocol: SFTP /SSH
  • Login type: Normal
  • Username: Enter your client-specific username provided by TA support (this will be different than your TrackAbout website login).
  • Password: Enter the password provided by TA support (this will be different than your TrackAbout website login).

Local Site

This section will be populated as soon as you open FileZilla. It will allow you to navigate within your available folders on your PC or network (top section), and then display available files/folders within the selected folder (bottom section). If you want to download files from TrackAbout FTP to a specific folder, navigate to that folder within the 'Local site' (left side of the FileZilla pane).

Remote Site

This section will be populated only after you connect to TrackAbout's (or another) FTP server. It will similarly allow you to navigate within available folders on the FTP server (top section), and then display available files/folders within the selected folder (bottom section). To download a file from the FTP server you can drag-and-drop from the remote site to your local machine or double-click the file on the remote site. You can also place files on the FTP server by dragging from left to right or double-clicking a file on your local site.

More Information

FileZilla maintains their own Wiki documentation (in multiple languages) as the client evolves. For more in-depth and updated information on FileZilla, please visit their help section: