Skip to main content

SFTP Integration Setup Guide

SFTP, integration, HR system, HRIS, file export, field matching, data sync, CSV, scheduled export, activation, setup

Written by Nina Wettergren

Overview

This guide walks through the steps required to set up an SFTP-based data integration between your HR system (HRIS) and Sysarb. Once active, your HRIS will automatically deliver an employee data file to Sysarb's SFTP server on a schedule, which Sysarb then picks up and imports into your domain.

How it works

  1. Your HRIS (or IT team) generates a structured export of employee data on a schedule

  2. The file is delivered to Sysarb's SFTP server

  3. Sysarb picks up the file and imports the data into your domain


Before you begin

This guide is intended for customers who have already completed the integration assessment and confirmed that SFTP is the right integration path for their setup. If you are still exploring your options, please refer to our integration assessment guidance before proceeding.

Important — if you have existing data in Sysarb: If employee data has already been imported manually, make sure that the unique employee IDs in your HRIS match those already in Sysarb. A mismatch will result in duplicate employee records.


Prerequisites

Before setup can begin, confirm the following:

  • You have admin access to your HRIS, or IT support available to configure a scheduled export

  • Your organisation can connect to an external SFTP server — check with IT if unsure

  • You have worked through the Sysarb salary file template to understand which fields are available in your HRIS and how they map to Sysarb's required fields

  • A Sysarb integration request has been submitted and assessed — contact [email protected] to get started.


Step 1 — Prepare the export file in your HRIS

Work with your HRIS administrator or vendor to configure a scheduled data export with the following specifications:

  • File format: CSV (.csv) or JSON, UTF-8 encoding

  • Delivery: SFTP push to Sysarb's server (details in Step 2)

  • Schedule: As agreed during assessment (e.g. nightly at 02:00)

Key requirements for the file:

  • One row per employment. If an employee has multiple active employments, include one row per employment and ensure each row includes the appropriate unique ID to link them to the same person

  • The unique employee ID must remain consistent across all future exports. If an employee's ID changes between exports, Sysarb will treat them as a new employee, resulting in duplicates. In addition to creating a duplicate record, this will have a negative impact on historical pay equity analyses and employment record connections, as well as conversations (applicable to Pay Management clients)

  • Column headers are recommended to match the field names in your HRIS export — this makes the field matching step (Step 4) significantly easier

  • Date format: YYYY-MM-DD

  • Empty fields should be left blank, not filled with placeholder values (e.g. "N/A")

  • Full population file required: Each delivery must include all active employees — not just changes or new hires. Sysarb replaces the previous import with each new file. If only changed or new records are sent, existing employees not included in the file will be treated as inactive or removed

If your HRIS does not support direct SFTP delivery, your IT team may need to set up a script or middleware to handle the file transfer.


Step 2 — Connect to Sysarb's SFTP server

In the Sysarb interface, navigate to Import Data via the side menu and select Integrations as your import method. From the list of available integrations, select SFTP-server.

You will be taken to the Authentication screen. Enter the following connection details:

File extension

.csv

URL

sftp.sysarb.app

Port

2022

Username

Provided by Sysarb*

Password

Provided by Sysarb*

* To receive your Username and Password, contact Sysarb support at [email protected] before starting setup.

Click Authenticate. If the connection is successful, you will see a confirmation message. Click Continue to proceed.

If authentication fails, double-check the credentials provided by Sysarb and ensure your network allows outbound connections to sftp.sysarb.app on port 2022.

Note: It is also possible to use a customer-hosted SFTP server instead, where Sysarb fetches the file rather than receiving it. If this is relevant for your setup, contact Sysarb support at [email protected].


Step 3 — Profile

On the Profile screen, you can optionally give this integration a title — useful if you have or expect to have multiple integrations set up (e.g. to tell them apart by source system or data type). This can be edited later.

Click Continue.


Step 4 — Match fields

On the Match fields screen, you map the columns from your SFTP export file to the corresponding fields in Sysarb.

  • The left column shows the fields detected from your file

  • The right column shows the Sysarb fields to map them to

  • A warning icon (⚠️) indicates a required field that has not yet been mapped

  • A green checkmark indicates a successfully mapped field

  • Clicking on a Sysarb field shows a Data preview on the right, including a description of what the field expects and a preview of the value from your file

Note: The data preview requires the cache layer to be loaded. If you see a "Try again later" message, use the menu and select Refresh data. At initial setup there may be a short processing delay — this is expected. Try again after a few minutes.

Work through the list and select the matching field from your export for each Sysarb field. If you need guidance on required vs. recommended fields, refer to your customer success contact or Sysarb support.

Once all available fields are matched, click Add integration.

Note: Once the integration is active, you can return to the field mapping at any time by navigating to Import Data, locating your integration, clicking the menu, and selecting Matched fields.


Step 5 — Test run

Once you have completed field matching and clicked Add integration, contact Sysarb support at [email protected] to validate the integration from a technical perspective.

Your part in the test:

  • Review the imported data in Sysarb and confirm it matches your expectations — employee records, field values, org structure

  • Flag any discrepancies in field mapping or data quality to your Sysarb contact

Any issues identified are resolved before the integration is marked as live.


Step 6 — Go-live

Once testing is signed off:

  • The scheduled export runs automatically going forward

  • Any changes to the file format or field mapping must be communicated to Sysarb in advance


Responsibilities

Area

Responsible party

Support contact

SFTP credentials and endpoint

Sysarb

Sysarb support or customer success

Export configuration in HRIS

Customer / HRIS vendor

HRIS vendor

Scheduled file delivery to SFTP

Customer / HRIS

HRIS vendor

File format specification

Sysarb

Sysarb support or customer success

Field matching in Sysarb UI

Customer

Sysarb support or customer success

Technical testing

Sysarb

Sysarb support or customer success

Business validation

Customer

Sysarb support or customer success

Ongoing export monitoring

Customer / HRIS

HRIS vendor


Troubleshooting

Issue

Who to contact

File not delivered / missing

Customer / HRIS administrator

Import failed in Sysarb

Sysarb support or customer success

Incorrect or unexpected data

Customer (check source data) — Sysarb support or customer success if mapping issue

SFTP connection error

Customer IT team, then Sysarb support or customer success if unresolved


Not sure which path is right for you?


Support

Reach Sysarb at [email protected] or directly in the interface. If you are in an active implementation, your customer success contact is also available to help.

Did this answer your question?