Background information
This article describes the file format required to sync users automatically via an FTP server.
General principles
You can automate synchronisation of users from third-party software to Lucca to guarantee regular information updates. To do this, you can sync your user files via FTP (File Transfer Protocol).
The file sent to Lucca’s FTP server must be a flat file in CSV format (semi-colon separator).
Lucca lets you define the default values (Co-workers > Configuration > Default values) by legal entity or department.
These values are assigned to each new arrival by default if you do not enter any values in the file.
The file can be placed either on an FTP server provided by Lucca or the client’s server. Syncing takes place once a day at an hour specified during set-up.
Your import files must always include the user’s identifier, which can be either:
- in the first column, the login
- in the first and second column, the ‘Legal entity’ + ‘employee number’ pair
Mandatory fields
If default values are configured, the mandatory fields can be left blank or the columns for these fields can be left out of the file.
|
Code for the data |
Description |
Default value |
Possible values |
|
login |
The employee’s identifier |
Yes |
|
|
firstName |
First name |
No |
|
|
lastName |
Last name |
No |
|
|
|
Professional email |
No |
|
|
legalEntity |
Legal entity |
Yes |
|
|
dtContractStart |
Contract start date |
No |
DD/MM/YYYY |
|
employee number |
Employee number |
No |
|
|
dtBirth |
Date of birth |
No |
DD/MM/YYYY |
|
department |
Department/Division |
Yes |
List of departments created or imported (general settings under cogwheel > Departments) |
|
manager |
The staff member who approves the employee’s leave |
No |
Possible formats: manager’s login or manager’s first and last names |
|
role |
Primary role |
Yes |
List of roles configured under general settings > Roles |
|
culture |
Lucca’s display language |
Yes |
fr-FR; de-DE; en-US; en-GB; es-ES; nl-BE; it-IT |
|
dtContractEnd |
Contract end date |
No |
DD/MM/YYYY |
Mandatory and optional fields for the Timmi Absences module (Leave & absences management)
|
Code for the data |
Description |
Default value |
Possible values |
|
roles or role |
Timmi Absences role |
Yes |
List of secondary roles or primary role in Timmi Absences |
|
profile_ Timmi Absences |
Acquisition profile |
Yes |
List of profiles created in regulations |
|
calendar |
Public holiday calendar applicable to the employee |
Yes |
List of calenders (configure > calendars) |
|
SPC |
Socio-professional category (depends on your settings) |
Yes |
List of SPCs (Configure > Socio-professional categories) |
|
manager2 (optional) |
Second leave approver |
No |
List of employees created in Lucca (format: login or first and last names) |
|
userWorkCycles |
Work cycles (cycles configured) |
No |
List of work cycles (general settings: cogwheel) |
|
userWorkCycles.start |
Work cycle start date |
No |
DD/MM/YYYY |
|
userWorkCycles.end (optional) |
Work cycle end date |
No |
DD/MM/YYYY If blank, no end date |
|
dtSeniority (optional) |
Seniority date if different from the contract start date |
No |
DD/MM/YYYY |
Mandatory and optional fields for the Timmi Timesheet module (Time and activity management)
|
Code for the data |
Description |
Default value |
Possible values |
|
roles or role |
Employee’s role for the Timmi Timesheet module |
No if secondary role |
List of secondary roles or primary role in Timmi Timesheet |
|
userWorkCycles |
Work cycles |
No |
List of work cycles (general settings: cogwheel) |
|
userWorkCycles.start |
Work cycle start date |
No |
DD/MM/YYYY |
|
userWorkCycles.end (optional) |
Work cycle end date |
No |
DD/MM/YYYY If blank, no end date |
Mandatory and optional fields for the Cleemy Expenses module (Expense report management)
|
Code for the data |
Description |
Default value |
Possible values |
|
roles or role |
Employee’s role for the Cleemy Expenses module |
No if secondary role |
List of secondary roles or primary role in Cleemy Expenses |
|
IBAN |
mandatory (if payment via Cleemy Expenses) |
No |
|
|
BIC |
mandatory (if payment via Cleemy Expenses) |
No |
|
|
profile_ Cleemy Expenses (mandatory) |
Reimbursement profile |
Yes |
Profiles created in Settings > Expense policy |
|
personalAccount (fill in if required by accounting) |
Employee’s personal account (subsidiary credit account) |
No |
|
|
frenchCarTaxHorsePower (optional) |
Tax horsepower of the employee’s car |
No |
Format: Number (i.e. for 6 HP, enter 6) |
|
frenchMotorcyclesTaxHorsePower (optional) |
Tax horsepower of the employee’s motorcycle |
No |
Format: Number (i.e. for 6 HP, enter 6) |
|
axisValues(x) (optional) x is the ID for the analytical axes indicated in analytical axis management |
Value of an analytical section under the employee’s analytical axis x. |
No |
List of analytical sections |
Mandatory and optional fields for the Pagga Payslip module (Dematerialisation of payslips)
|
Code |
Description |
Default value |
Possible values |
|
roles or role |
Employee’s role for the payslip dematerialisation module |
No if secondary role |
List of secondary roles or primary role in Pagga Payslip |
|
personalEmail (optional) |
Personal email to log in to the CPA |
No |
|
|
insuranceNumber (mandatory) |
Insurance number or code (in the same format as on the payslips) |
No |
Mandatory field for Poplee - HR file
|
Code |
Description |
Default value |
Possible values |
|
roles or role |
Employee’s role for the Poplee module |
No if secondary role |
List of secondary roles or primary role in Poplee |
The HR file is made up of two types of data:
- the Core data (data from the above tables), which are uneditable data
- and Extended data, which are data that you can add and configure; for more information, you can visit the Different Types of Data in the HR File help page
You can import these data using the same template as the user import; the file must include the Login in the first column.
Each piece of data in your base is given a unique code. You can find this code in the Users import module by clicking on ‘questions about the file format”.
The code for the data is the Name; if you want to import the Direct Line data, in the column header, enter “DirectLine”.