Administering an FTP server

Before you get started

SFTP/FTPS management is centralized in a single module and available from Lucca administration ⚙. This help page describes the various features of this module, and outlines what to look for if you wish to modify certain parameters.

If you need help, view our SFTP/FTPS server FAQ here.

SFTP/FTPS: what is it?

SFTP/FTPS (file transfer protocol) is a protocol used to transfer files between two systems. In Lucca, SFTP/FTPS is set up to automate file transfer between Lucca and external software (e.g. exporting absences to payroll), or between external software and Lucca (e.g. automatic import of users into Lucca from payroll).

Important vocabulary

When setting up an SFTP/FTPS, several notions are important to fully understand what is being configured:
  • Connection type: SFTP, FTPS FTPES. These are the different protocols managed by Lucca. SFTP or FTPS are preferred, but this depends on your ecosystem.
  • Account: an SFTP/FTPS account corresponds to an access to a server. It consists of a name, login, password, host and the types of connections authorized. One or more accounts can be created for each instance.
  • Remote folder (or path): a remote folder corresponds to a folder on the server. This is where the files will be stored. An account is comprised of one or more remote folders. A remote folder corresponds to a name (for easy retrieval in Lucca), and a "path".
  • The path is the address of the remote folder on the server. It takes the format of /folder1/folder2/folder3, for example. If this remote folder is selected, then the file will be dropped into folder3 (which is located in folder2, which is located in folder1) on the SFTP/FTPS server.

Setting up an SFTP/FTPS

Creating an account

To set up a new SFTP/FTPS account on your instance, go to the SFTP/FTPS management module (⚙ - Other settings SFTP/FTPS).

chrome_FVNQQlIl5h.png

In this module, click on "Create an account". A window opens and you need to enter the details of the account you are creating. First, you need to select the host server from the following choices:

  • Lucca: server hosted by Lucca without any special configuration
  • E-paye: server hosted by Lucca with e-paye-specific settings (when rolling out e-paye clients)
  • MPRH: server hosted by Lucca with MPRH specific settings (in cases of MPRH client rollout)
  • Client server: server hosted by you. Then, you will have to fill in the server information.

SFTP/FTPS server hosted by Lucca 

You need to name this account, so it can be easily identified in the list of accounts available on your instance.

chrome_BLMVocBnIi.png

Once this step has been validated, the login and password will be displayed. You must make a note of them to conduct your tests.

Server not hosted by Lucca

You need to name this account, so it can be easily identified in the list of accounts available on your instance. Next, enter the host name and connection type.

chrome_ZHC7tnknxz.png

Once this step has been validated, you need to enter your login and password (or RSA key, depending on your connection type and authentication method).

chrome_GEDR4GPRGf.png

Adding remote folders

Once an account has been created, you can add remote folders to this account. These will be the folders where the various files to be integrated will be uploaded, either in Lucca or from Lucca. Click on the three dots next to the account, then on "Edit remote folders".

A window will open, allowing you to create the various remote folders required for integrations. You need to enter the name of the remote folder (to find it easily in the list later), and the path.

Update an existing SFTP/FTPS server

You can update the account name, login and password for a server hosted by Lucca, as well as the host and connection type for a server hosted by you.

To do this, click on the three small dots next to the account name, then "Edit account". On the window that appears, you will see 2 "edit" buttons to perform your update.

Please note that editing this information may disrupt the integrations already established with the SFTP/FTPS server.

chrome_Un9GCfLsgK.png

Page content

Was this article helpful?
2 out of 2 found this helpful