Skip to main content

SFTP integration

This integration uses an SFTP connection to exchange employee data via a CSV file

Rosa avatar
Written by Rosa
Updated yesterday


Via this integration a user can be onboarded, deactivated or updated.
​

CSV File format requirements (defaults)

  • Comma separated values

    • ; or other characters are not accepted

  • YYYY-MM-DD date format

  • Dots (.) for decimal character (123456.71123)

The file must be named using the following naming convention: alleo_employees_XXXXX.csv

  • Where XXXXX can be a customer-specific or sequential identifier


Access and security

  • (S)FTP authentication method: username & password

    • Please make sure you create a dedicated user that has limited access

    • Please share this information with Alleo in a secure way, together with the following:

      • Protocol (FTP or SFTP)

      • Hostname or IP address

      • Port

      • Directory where the files are located

      • Any additional information such as the connect mode (passive, active etc)

  • If needed, please whitelist the following IP address to allow the connection: 99.80.106.85


File pickup operations

  • The CSV file is picked up twice per day:

    • 2:45 AM UTC

    • 20:00 PM UTC

  • If an offboarding date is set based on the provided file, employees are deactivated at 23:00 PM UTC on the provided date.


CSV accepted fields

If the below field naming convention is not supported by the exporting platform, Alleo can set up mapping of the fields. To set this up, please provide an overview of the Alleo field names and mapping to the provided CSV field names.

Alleo field

Mandatory / Optional

Description

Email

Mandatory

The email field serves as the unique identifier and must be unique per file

Changes in email address need to communicated to admin-support@alleo.nl

This field is also mandatory when updating an employee

First name

Mandatory

Also mandatory when updating an employee

Last name

Mandatory

Also mandatory when updating an employee

Prefix

Optional

-

Onboarding date

Optional

Required format: YYYY-MM-DD

  • Must be today or a future date. If left empty, the employee will be onboarded as of today.
    ​

  • If the onboarding date is in the future, the account will be active, but the employee can only log in from the onboarding date.

  • Once an employee is onboarded, the date cannot be changed via the Manager Portal.

  • If you need to adjust the onboarding date to a future date after the integration sync, please contact admin-support@alleo.nl.

Offboarding date

Optional

Required format: YYYY-MM-DD

  • Must be set to a future date. We ask setting it at least 30 days in advance.

  • Once set, the offboarding date cannot be removed via the Manager Portal.

  • The date can only be changed to a future date if the employee's account is still active.

  • If the employee's account has already been deactivated and reactivation is needed, please contact admin-support@alleo.nl.

Birthday

Optional

Required format: YYYY-MM-DD

Work anniversary

Optional

Required format: YYYY-MM-DD

Language

Optional

Sets the language in Alleo for the employee, options are:

"en" - English

"nl" - Dutch

"de" - German

If this field is not provided, the default language for the Company is used.

Company group

Optional

Make sure the value matches an existing company group already set up in Alleo

Custom fields

Optional

Custom fields can be added by following this naming convention: "custom_field_name" - for example: "custom_employee_id"

In the reporting, "alleo_" is added to each custom field uploaded - for example:

"alleo_custom_employee_id"



πŸ’‘ Need more help? Get in touch!

πŸ’¬ Live chat support - Click the icon or Help in the Manager Portal
βœ‰οΈ admin-support@alleo.nl

Did this answer your question?