Although Cleary supports many HRIS platforms through direct integrations, If there is not an HRIS platform that can connect with Cleary directly we can set up an integration with SFTP. It’s automation for ingesting CSV files sent over via SFTP.

A CSV file is generated on the Customer’s side, sent to Cleary’s File repository (S3) via SFTP, and then Cleary can consume the file by reading from the S3 repository.

* Although not recommended we can also integrate with your own SFTP server, refer to Customer's SFTP Integration

How to configure

Step 1 - Set up your HRIS to export a CSV report

Make sure it contains as many fields as you are able to share with us so we can have better targeting capabilities.

Fields: employee_id,birthday,last_name,first_name,start_date,end_date,city,country,region,active,worker_type,manager_employee_id,title,office_location,manager,email_type,email,phone_mobile_type,phone_mobile,personal_email_type,personal_email,hris_external_group_ids,department
Example File → Click Download Zip on the right.
Filename format: COMPANYNAME-yyyy-mm-dd-hh-mm-ss.csv
Feel free to send a file with all the company’s employees or just a dozen of them. Cleary will process only the ones sent and leave the others unchanged.

Step 2 - Have a Public SSH Key ready to install on our SFTP server

* if you already have one, you can skip to Step 3

Follow the steps below to generate a SSH key pair, you’ll send us the Public one, and the private one you’ll use to connect to our servers.

On macOS and other Unix operating systems, run the following command to generate an RSA key-pair: ssh-keygen -P '' -f transfer-key

Windows users can do the equivalent operation using PuTTYgen.

Make sure you send us the format in this little box where it says ‘Public key for pasting into OpenSSH…’ copy that to paste it on our installation card, next steps

Step 3 - Set up your Cleary application with your public key

Head over to https://your_company.gocleary.com/admin/app_integrations
Expand the ‘People’ section and you’ll be able to see the card on the screenshot above ‘CSV Upload Automation via Cleary SFTP’
Check the Enable field for installing a new key
Paste the Public key in the text field and click on “Install Public SSH Key”
Make sure you also configure the other fields according to your preference

Step 4 - Connect to SFTP for testing

Feel free to use whatever tool you like for SFTP connection, just make sure it supports Private Key authentication method
Here’s an example of how to do it with a tool called FileZilla

Step 5 - Start sending your CSV files to the SFTP repository

This can be done however you want - we will automatically import any files placed into the SFTP server at 18:00, 21:00, and 00:00 (UTC).

We recommend setting up an automatic process to upload the latest version of the CSV export to Cleary at least once a day.