Configure SFTP in theEMPLOYEEapp

Table of contents

1. Introduction
2. SFTP configuration
3. SFTP settings
4. Sync employees
5. After sync

1. Introduction

Account admins can securely integrate internal systems with theEMPLOYEEapp using Secure File Transfer Protocol (SFTP) to automate employee data syncs, such as new hires, profile updates, and deactivations, from their HRIS or internal database.

SFTP ensures encrypted, efficient, and reliable data transfer. It improves data accuracy, streamlines administrative workflows, and reduces manual effort. It is beneficial for large organizations that manage multiple app profiles or frequently update employee records.

2. SFTP configuration

Contact our support team to enable SFTP configuration for your organization.

After SFTP is enabled, the SFTP credentials (host URL, port, username, and password) are auto-generated. Configure these credentials in your preferred SFTP server (for example, FileZilla, Cyberduck, Transmit, or WinSCP).

To configure SFTP in theEMPLOYEEapp:

Navigate to Settings > SFTP Configuration.

1. In the “SFTP Configuration” section, select Enable SFTP, allowing employees to sync to the theEMPLOYEEapp server.
2. Click Save.

  3.   Click Download Sample on the right to preview an example Excel file with employee details.

  4.   Log in to your SFTP server.

  5.   Copy the auto-generated credentials from theEMPLOYEEapp and paste them into the respective fields in your SFTP server.

After entering the credentials, the connection to theEMPLOYEEapp is established, completing the integration between theEMPLOYEEapp and the SFTP server.

3. SFTP settings

After configuring the connection, set up the sync settings to map fields in the sync file. Perform the following actions as required:

1. Select Skip Headers to skip the header row when processing sync files.

The system uses the default column sequence:

1. 1. Registration code
   2. Email
   3. First name
   4. Last name
   5. Mobile number
   6. Groups
   7. App profile name
   8. Status

  2.   Select Block Non-Sync Users to block users who are not included in the sync file.

  3.   Select Delete Groups Without Members to remove any groups that do not have members after the sync.

  4.   From the “File Extension” drop-down, select the file format: CSV, XLS, or XLSX.

Based on your selection, the corresponding file path is generated.

By default, the registration code is used as the unique identifier.

  5.   Click Save after applying your settings.

4. Sync employees

After the integration is set up, you can begin syncing employees.

1. Download the template from theEMPLOYEEapp.
2. Open the downloaded template, enter the employee details, and save the file.

  3.   Log in to your SFTP server and upload the file.

The system runs a CRON job every 24 hours at 12:30 AM UTC to auto-sync any new or updated employee details.

5. After sync

After every sync:

• Logged-in admins receive email notifications.
• The “SFTP Configuration” page displays the sync status (in progress, completed, or failed) and the recent sync date and time.

To view sync details:

Navigate to Settings > SFTP Configuration.

1. Scroll down to view the sync status and timestamp.