Deel can also connect to Lucca using the dedicated integration that leverages the SFTP protocol. This article explains how to prepare Lucca to send data to Deel and how to connect to it using the integration.
In this article
Before you begin
To configure the Lucca integration, make sure to have:
- A user with an admin role on Lucca
- A user with an admin role on Deel
Prepare Lucca
Step 1. Create an FTP on Lucca
To set up an FTP on Lucca, follow the instructions from the Lucca Help Center.
Make sure to store the credentials and FTP server information, as they are needed to complete the setup.
Step 2. Configure the employee data export
After creating the FTP, the employee data must be configured to be exported.
1. Create the employee data export
The first part of configuring the employee data consists in creating an export.
To create an export:
1. Log in to your Lucca instance as an admin and go to Solutions > Core HR.
2. Go to Export, then click Create an export setup.
3. On the Create an export configuration dialog:
a. Select the relevant establishment.
b. Name the export so that you can recognize that it’s related to employee data. For example, Employee data.
c. Enter Deel as the name of the synchronized software.
d. Click Save.
2. Configure the employee data export settings
After the export is generated, users are taken to the export’s Configuration settings. Here’s how to configure them:
1. In the Generation of the export section, set the generation mode to Automatic.
2. Set the frequency and the hours at which the report must be generated, then click Save changes.
3. In the Shipping policy section, set the file to be sent by FTP.
4. Select the FTP where you want to send the file, then click Save changes.
3. Configure the employee data file template
After configuring the export settings, a file template must be created.
To create a file template:
1. From the export page, go to the File templates tab, and click Add a file.
2. On the Create a file template dialog, set the file template as follows, then click Next.
| Setting | Option |
|---|---|
| File name | data_{{config.name}}_{{export.date}}_{{export.hour}}_{{export.period}} |
| Format | CSV |
| Encoding | UTF-8 without BOM |
3. In the File settings section, configure the following additional settings, then click Save.
| Setting | Option |
|---|---|
| Field separator | Semicolon |
| Content of the export | All employees |
4. Edit the employee data file structure
After configuring the template file settings, the file structure must be edited.
To edit the file structure:
1. In the File templates tab, click Editing the file structure, then click Validate.
2. Enter the following values, pairing header values with body values:
| Header | Body |
|---|---|
employeeNumber |
Login details and authentication - Payroll number |
addressLine1 |
User - Postal address |
zip |
Custom data - Zip code |
firstName |
Personal Information - First Name |
lastName |
Personal Information - Last Name |
country |
Custom data - Pays de résidence |
city |
Custom data - City |
jobTitle |
Job title - Job title |
jobEffectiveDate |
Job title - Effective date |
workEmail |
Professional contact details - Business email |
startDate |
Contract - Contract start date |
fte |
1 |
employmentType |
Full Time |
employmentEffectiveDate |
Contract - Contract start date |
payGroupId |
Legal unit code |
Step 3. Configure the establishment data export
After configuring the employee data to be exported, it’s time to configure the establishment data to be exported.
1. Create the establishment export
The first part of configuring the establishment data consists in creating an export, similarly to the employee data one.
To create an export:
1. Log in to your Lucca instance as an admin and go to Solutions > Core HR.
2. Go to Export, then click Create an export setup.
3. On the Create an export configuration dialog:
a. Select the relevant establishment.
b. Name the export so that you can recognize that it’s related to employee data. For example, Establishment data.
c. Enter Deel as the name of the synchronized software.
d. Click Save.
2. Configure the establishment export settings
After the export is generated, users are taken to the export’s Configuration settings. Here’s how to configure them:
1. In the Generation of the export section, set the generation mode to Automatic.
2. Set the frequency and the hours at which the report must be generated, then click Save changes.
3. In the Shipping policy section, set the file to be sent by FTP.
4. Select the FTP where you want to send the file, then click Save changes.
3. Configure the establishment file template
After configuring the export settings, a file template must be created.
To create a file template:
1. From the export page, go to the File templates tab, and click Add a file.
2. On the Create a file template dialog, set the file template as follows, then click Next.
| Setting | Option |
|---|---|
| File name | establishment_{{config.name}}_{{export.date}}_{{export.hour}}_{{export.period}} |
| Format | CSV |
| Encoding | UTF-8 without BOM |
3. In the File settings section, configure the following additional settings, then click Save.
| Setting | Option |
|---|---|
| Field separator | Semicolon |
| Content of the export | All employees |
4. Edit the establishment data file structure
After configuring the template file settings, the file structure must be edited.
To edit the file structure:
1. In the File templates, click Editing the file structure, then click Validate.
2. Enter the following values, pairing header values with body values:
| Header | Body |
|---|---|
| companyId | Contract - Establishment code |
| companyName | Establishment - Establishment name |
Step 4. Configure the compensation data export
After configuring the establishment data to be exported, it’s time to configure the compensation data to be exported.
1. Create a compensation export
The first part of configuring the compensation data consists in creating an export.
To create an export:
1. Log in to your Lucca instance as an admin and go to Solutions > Pagga Compensation.
2. Go to Exports, then click New configuration.
3. On the Add an export configuration dialog:
a. Name the export so that you can recognize that it’s related to employee data. For example, Compensation data.
b. Choose Generic format as the format.
c. Click Save.
2. Configure the compensation export scope
After the export is created, users are taken to the export’s Configuration settings. Here’s how to configure them:
1. From the export settings, go to the Scope of export tab.
2. Set the scope as follows:
a. Select the relevant establishments to be exported.
b. In the Population to be included in the export section, select Employee(s) without an assigned occupation category.
c. In the Selection of the variable pay natures to be exported, leave all options unselected.
d. In the Selection of the fixed pay natures to be exported (only in turn-around file), select the following options:
- Salaire de base
- Basic salary
- Salario fijo
- Salario base
3. In the Options section, unselect all the available options.
4. Click Save the configuration.
3. Configure the compensation export format
After the scope is configured, the export format must be configured.
To configure the export format:
1. From the export settings, go to the Data and export format tab.
2. Set the export format as follows, then click Save the configuration.
| Setting | Option |
|---|---|
| Selection and position of the fields to display in the export | - Col. 1: Employee (employee number)- Col. 2: Establishment (code)
|
| Name and extension of the file | compensation_$[configName]_$[exportDate]_$[exportPeriod] |
| Output file type | CSV file |
| Date format | yyyy/MM/dd |
| Decimal separator | Semicolon |
| Using quotation marks ("") to force the text forma in the generated file | true |
| Character encoding | ANSI |
4. Configure compensation automated exports
After the export format is configured, the automated exports must be configured.
To configure the automated exports:
1. From the export settings, go to the Automated exports tab.
2. Set automated exports as Enabled.
3. Set the FTP export as Enabled, then click Configure.
4. On the Configure the FTP server dialog:
a. Set the Selection of file types to Turn-around file only.
b. In Endpoint choice, select the FTP server where to send the export**.**
5. Click Save.
After configuring the automated exports, all the settings in Lucca are configured and it’s time to set up the integration on Deel.
Set up the integration
This section explains how to set up the Lucca integration on Deel.
Step 1. Connect to Lucca
To connect to Lucca:
1. Go to the Hub > Apps and search for Lucca in the App Store.
2. On the integration page, click Connect Lucca.
3. Enter the information of the Lucca FTP server, then click Connect & go to settings.
Step 2. Enable the sync
Once the integration is connected, the sync can be enabled.
To enable the sync:
1. In the Plugins and settings section, locate the People data sync plugin and click Enable.
2. On the Configuration step:
a. Select Pull as the integration type.
b. Map the entities by selecting the relevant one.
c. Click Continue.
3. On the Sync entities step, configure the sync schedule, then click Continue.
4. On the Data/field mapping step, confirm that the field mapping is correct, then click Continue.
5. On the Notification settings step, add notification recipients, then click Continue.
6. On the Review & confirm step, review your settings, then click Continue.
7. (Optional) Repeat the configuration for each entity by clicking on the enabled plugin and then Add entity.
Step 3. Syncing data from Lucca
The data will sync automatically at the time you configured while setting up the integration, but you can always do a manual sync by clicking the Sync Lucca button in the integration.
Once the integration syncs, contracts are automatically created for the synced users.