Skip to main content
SFTP integration
Updated yesterday

⚠️ If you’re already using Javelo and have users in the app, please read Preparing Javelo for External User Source Integration before proceeding.


How to configure the synchronization between SFTP and Javelo?

It is very simple to set up the synchronization between your SFTP server and Javelo.

Let’s start! 🚀

1- Set up the integration in your SFTP server

  1. Create an SFTP user in order for Javelo to have access to your SFTP server. Note the SFTP user’s name and password, as you will need those for the next step.

  2. Create a folder where you’ll make the file available (this folder should only contain the user import file).

2- Add the user import file in the folder for synchronization

There should only be one file in the server, as updates replace the previous file with the new one.

  • The file should be a xlsx file

  • You can name the file however you’d like

  • Find more information about the file content on our User import file page.

3 - Enter your SFTP server information in Javelo

⚠️ You need to have the company manager’s right to access the page.

1. Go to “Settings" (⚙️ icon) in the upper right corner of your Javelo account.

2. Select “Integrations” from the navigation menu under the Company section.

3. Click on "Connect" in SFTP integration panel.

4. Fill out the form to configure SFTP client with the following settings:

  • Host: URL (aka Hostname) of the SFTP server. Example of the required format: test.javelo_europe.com

  • Port: by default the value will be set to 22. If you use another port, please change the default value.

  • Username: the name of the sftp user corresponding to Javelo configured to have access to your SFTP server in step 1.

  • Password: the password of the sftp user to allow Javelo to access your SFTP server (configured in step 1).⚠️ Please note that we use password (not key based) authentification.

  • Directory: the directory from where Javelo will download the .xlsx file for parsing and user synchronization.

  • Delete file(s) after synchronization: by default after the synchronization is completed Javelo will delete the processed file from the server. If you do not want this behaviour, just uncheck this box. ⚠️Please note that if this box is checked, Javelo will need to have write access to the directory mentioned above.

5. Click "Apply" and the integration should be configured now.

  • A first sync will happen right away

  • Next syncs will be triggered on a daily basis in the early morning.


Important notes

⚠️ Synchronization of users is based on the use of a file in XLSX format.

⚠️The synchronization is launched for the first time after you have completed the configuration and clicked on Apply. Afterwards, the synchronization runs every morning.

⚠️ If your SFTP server is protected by an IP whitelist, you’ll need to allow the IP referenced by this domain name nat-gw.javelo.io.


How to deactivate the synchronization?

If you need to interrupt the synchronization, you can come back to the Integrations tab and click on “Disconnect” at the bottom of the SFTP panel:

Then check the box "OK, I understand" and click "Confirm" to delete the integration :


Setup Example

This is an example, values have to be replaced with values from your own SFTP server:

Field

Example

Host

Port

22

Username

javelo_username

Password

****************

Directory path

/user-folder/javelo/

Did this answer your question?