Contact your Customer Success Manager to request the CSV-over-SFTP option, as this is currently not offered as a self-serve admin action.
Connect your Customer Success Manager to the team/person configuring this on your end.
The Customer Success Manager securely provides the connection information and access credentials to our SFTP repository.
We support username/password as well as key-based authentication methods, so let us know which you prefer.
Create a daily automated job to export your employee details from your HRIS system into a single CSV file. Go deeper to learn more about the CSV file format.
This job uploads the file to our SFTP repository with the supplied credentials, while using the following naming convention:
uploads/hr_reports/people_report_2020-02-08.csv). The file path is case-sensitive and that the date format must be in the date format YYYY-MM-DD.
We pick up the file on daily basis and load the employee data into the platform.
CSV File Format
The file must include a header row with the following case-sensitive column names:
Only the Full Name and Email fields need to contain valid values. Other fields are optional and can be left empty (though this will limit certain features on the platform).
All values should be quoted using the double quotes (") character.
All columns must be separated using the comma (",") character.
Where necessary, data must be escaped using the backslash ("\") character.
All rows must be separated using the carriage-return followed by the line-feed characters ("\r\n").
The entire file should be encoded as UTF-8. If it's not, please let us know which file encoding you want to use, so that we can validate that we can support it (for example, ISO-8859-1).
You can grab the template here: https://2pl.us/people-integration-csv
PGP data decryption
You have the option to encrypt data using PGP in the CSV file for people integration. You must first enable the setting at Settings > Integrations > People > SFTP > Enable PGP decryption.
When you save this setting, the PGP Recipient and PGP Public Key values automatically populate. Add the public key to your local keyring and use it together with the recipient to encrypt files.
You can then encrypt the CSV data using a PGP client tool and. The rest of the workflow described above works the same way except that when we receive the files, we will first attempt to decrypt them.
You can disable PGP decryption at any time.