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 an 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 an SFTP server (Sysarb-hosted or your own)

  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


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 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 — Start the integration setup in Sysarb

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.


Step 3 — Choose who should host the server

You will be taken to the Authentication screen. First, choose who should host the SFTP server:



Sysarb-hosted

  • Sysarb provides and manages the SFTP server

  • The standard option for most setups

  • ⚠️ Your firewall must allow outbound SFTP connections — confirm with your IT team

Self-hosted

  • The SFTP server runs in your environment, managed by your IT team

  • Suitable if internal IT or security policies require self-hosting

  • ⚠️ Setup requires IT involvement on your side


Step 3a - If you chose Sysarb-hosted: Upload method and credentials

Choose how you want to upload data to the SFTP server:


SFTP delivery (recommended)

  • The file is pushed to the SFTP server daily

  • Suitable for recurring, automated transfers

Manual upload in Sysarb

  • Upload the file directly in Sysarb when an update is needed

  • Suitable for ad hoc or low-frequency supplementary updates

Under SFTP configurations, select your File extension (.csv or JSON).

Your credentials are generated automatically:

Field

Value

URL

sftp.sysarb.app — copy using the copy button

Port

2022 — copy using the copy button

Username

Auto-generated (GUID format) — copy using the copy button

Password

Auto-generated — shown once only, copy using the copy button

⚠️ Copy and save your password before clicking Continue. The password will be hidden after leaving this page and cannot be recovered — only regenerated.

Share the connection details with your HRIS administrator or IT team. Click Continue.


Step 3b - If you chose Self-hosted: Enter your connection details

Under SFTP configurations, fill in the following fields manually:

Field

Value

File extension

Select .csv or JSON

URL

Your SFTP server address

Port

Your SFTP server port

Username

Your SFTP username

Password

Your SFTP password

Click Authenticate. If successful, click Continue.



If authentication fails, double-check the credentials and ensure your network allows outbound connections from Sysarb to your SFTP server.


To regenerate credentials later (Sysarb-hosted only)

To regenerate credentials, navigate back to the integration configuration in Sysarb.

⚠️ Regenerating credentials immediately invalidates the old ones. Any active SFTP delivery using the old credentials will fail until your HRIS or IT team updates their configuration.


Step 4 — Profile

On the Profile screen you can:

  • Optionally give this integration a Title — used to differentiate integrations from the same partner or to structure your integrations

  • Enable Decrypt uploaded files if your HRIS delivers encrypted files

⚠️ Disabling "Decrypt uploaded files" will erase the current keys and block access to any existing files.

Click Continue.


Step 5 — 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 (SFTP-server) shows fields — select matching field using the dropdown

  • The right column (Sysarb) shows the Sysarb fields to map to

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

  • 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 6 — Validation

Once you have completed field matching and clicked Add integration,

  • Review the imported data in Sysarb and confirm it matches your expectations — employee records, field values, org structure. You might want to edit


Step 7 — 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 hosting choice

Customer

Sysarb support or customer success

Credential generation (Sysarb-hosted)

Sysarb (automatic)

Sysarb support or customer success

Credential management (self-hosted)

Customer / HRIS vendor

HRIS vendor

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 if unresolved

Credentials not working (Sysarb-hosted)

Regenerate credentials — notify HRIS/IT team to update

Encryption mismatch

Contact Sysarb support or customer success


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?