This article is for clients and explains how they can setup their Lucca SFTP connector app on Deel.
A Secure File Transfer Protocol (SFTP) connector App helps clients automate the process of importing and exporting files to and from the Deel system.
With the help of Inbound connector, clients can create an SFTP connection, place a file in their SFTP location which will be imported to a database in the Deel system from where our internal teams such as PRM's can view the file and take necessary actions.
On the other hand, with the outbound connector, clients can create a SFTP connection and will be able to export files to their SFTP server.
Before you begin
To successfully follow the steps below and setup this integration, follow this article to setup an SFTP connection on Lucca.
One must be an Org Admin, IT Developer Admin, or Integrations Admin-People to set up this integration.
Configuring Lucca Files
In Lucca, there are two solutions files to configure which can be found under talent:
- Core HR: Employee details
- Pagga Compensation: Compensation details
Core HR
✅ Step 1 - Inside the Core HR solution, select export from the list of sidebar options.
✅ Step 2 - On the exports page, either use the Create an export setup button to create a new one or browse through the list of existing exports to use one.
✅ Step 3 - Use the configure button to go within configuration settings and set Generation mode to Automatic. Next, choose a time, e.g., 00:00 before setting Shipping policy to Send files by FTP. Finally, select the declared FTP, e.g., SFTP Server - root and save changes.
Next, create a File template:
✅ Step 1 - Click on Create a file template to start the process.
✅ Step 2 - Set the file name to: data_{{config.name}}_{{export.date}}_{{export.hour}}_{{export.period}} and choose CSV as the format.
✅ Step 3 - Next, set encoding to UTF-8 without BOM, set Semicolon as the field separator and select All employees for Integrate into the export file.
Pagga Compensation
✅ Step 1 - To set up export, navigate to Exports and click New configuration.
✅ Step 2 - Enter a configuration name, e.g. Compensation export.
✅ Step 3 - Choose Generic format as the format and save.
For the Scope of Export:
- Select all establishments and include all occupation categories and employees without an assigned category.
- Skip variable pay natures and select applicable compensation rate fields, e.g., "Basic Salary," "Salaire de base," "Salario fijo," "Salario base." before unchecking options.
For Data and Export Format:
- Set the name to: compensation_$[configName]_$[exportDate]_$[exportPeriod].
For Automated Exports:
- Enable automated exports.
- Enable FTP export.
- Select the turnaround file.
- Choose the endpoint, e.g., "SFTP Server - root."
Setting Up Lucca SFTP connector app
✅ Step 1 - Connect to SFTP
From the Deel home page, select the Hub icon and Apps tab. Search for SFTP integration and begin the connection to automate data imports.
✅ Step 2 - On the SFTP Page, under connection settings tab a list of SFTP integrations will be displayed. Select Lucca HR - Global payroll - inbound by clicking on the connect button.
Provide the following details in their corresponding input fields - host, username, password, file directory and notification recipient.
Once done, use the connect button to proceed to the plugins page.
Plugin
These will remain locked until after the connection is complete and successful.
To enable the Employee data sync plugin:
✅ Step 1 - Use the enable button to initiate the process
✅ Step 2 - Under Configuration, select the Lucca HR entity as well as the Deel entity, payroll group and group.
✅ Step 3 - Continue to sync scheduling, data/ item mapping and notification settings before completing the process.