The HR file keeps the people in portierX in step with your HR system. The HR system places a file in a folder portierX provides, and portierX imports it each morning. Only the Organisation Admin sets it up and runs it, under Integrations, with the HR file tile.
Also called: HR interface, HR feed, SFTP import, daily staff file.
You hold the Organisation Admin role.
Your HR IT builds the export to portierX's interface specification. Download it under People with Download interface specification. The file's columns and values are on Spreadsheet and file formats.
Settle with HR IT whether each file lists everyone or only the people who changed. Whether Mirror is possible depends on it.
Open Integrations, the Available tab and the HR file tile in the HR Systems category, then the Connect tab.
Under Source name, enter a name. It shows on the source's page and in the Sync Log.
Under What each file lists, choose whether each file lists everyone, Everyone the HR system holds (a full file), or only who changed, Only the people who changed (a partial file).
Turn on Mirror if people missing from the file are to be ended. It works only with full files.
Turn on Start paused if nothing is to be imported until you resume it.
Under Name of the HR person ID, enter what your organisation calls the staff number, for example KID. The field is optional.
Click Activate.
The source opens with the Summary and Sync Log tabs. Under Folder is the drop folder portierX assigned to the source. Copy folder path copies it for your HR IT.
Each morning at 07:00 in your organisation's time zone, portierX looks in the folder. With no time zone set, UTC applies. Every file waiting there is imported, oldest first, and each is applied before portierX reads the next. The file is then deleted from the folder. Every run is listed in the Sync Log.
A source's first file waits for your review, as does a file whose columns changed or whose staff numbers are mostly unknown to the source. Nothing changes until you apply it. How to review a waiting run is on Review, apply or undo an HR file run.
Checked shows the daily time, and Last checked when portierX last looked and what it found.
Mirror compares full files with the people who came from this source. A person missing from a file for the first time is flagged. Missing from the next full file too, they are ended: they get the end of the day the file is dated as their leaving date. An earlier leaving date stands. A person who appears in a file again loses the flag.
On the source's page, click Pause imports and confirm in the Pause imports? dialog.
To resume, click Resume imports and confirm in the Resume imports? dialog.
While imports are paused, the morning check skips the folder, and the people from this source stay as they are. After resuming, the next morning check imports every file in the folder, oldest first.
The Daily limit on the Summary tab caps how many people a source can make leave, or move to another org unit, in a day. You enter two numbers, People and Percent. The higher one applies: 10 people or 5 percent of everyone, when nobody sets it. The card shows how many people that is today.
Each person counts once a day when their leaving date is set, moved or cleared, their org unit is moved or cleared, or Mirror ends them. People a run adds do not count. What goes over the limit waits as a held change for an Organisation Admin, and the rest of the run applies. Held changes are on Review, apply or undo an HR file run.
Each run writes the people by the source's rules. Which fields the HR file decides, and which it leaves alone, is on Where people records come from.
Every finished run is listed in the Sync Log, with its counts and the people who joined, left or moved.
Every change to the daily limit is written to the audit log, with the numbers before and after.
An organisation has one HR file source.
Only the Organisation Admin adds the source, pauses it, resumes it and changes the daily limit. An Access Manager sees the source's page and the daily limit without changing them.
A file is at most 4 MB.
A file dated before the last file applied is not read.
If a file lacks a column the saved mapping needs, the run fails and names the column.
A leaver with no leaving date leaves on the date of the file, not the day portierX reads it.
Mirror is only for full files. A file that lists only who changed ends nobody.
The daily limit applies to the whole organisation, from the next run. A people spreadsheet someone imports by hand does not count toward it.
