---
title: "Onboard employee data"
id: "onboard-employee-data"
project: "EHR User Guide"
url: "https://help.cloud5.com.au/articles/ehr-user-guide/onboard-employee-data"
updated: 2026-10-19T00:52:56Z
---

# Onboard employee data

## Onboarding web service process

The web service uses a SOAP ![](/resources/Storage/ehr-user-guide/icons/leave%20-%20info%20icon.png)protocol and accepts an XML ![](/resources/Storage/ehr-user-guide/icons/leave%20-%20info%20icon.png) string containing the employee details. All data in the web service is validated.
SOAP (Simple Object Access Protocol) is a messaging protocol that allows programs that run on disparate operating systems to communicate using http and xml. It was developed as an intermediate language so applications built on various programming languages could talk easily to each other and avoid the extreme development effort.Extensible Markup Language (XML) is used for storing and transferring data on the web and in other applications. It’s a versatile tool for encoding and organising data in a way that both humans and machines can comprehend.

The onboarding process comprises:

* data setup of the xml file
* initiation to temporarily load the data
* validation and load of the actual data into EmpowerHR

[+] [Show onboarding options](javascript:void%280%29)
 [-] [Hide onboarding options](javascript:void%280%29)
 The following sets of new employee data are available for the onboarding process:

* personal data
* tax and declaration data
* position and pay (remuneration) data
* payment instructions
* long service leave (accruing in days or hours)
* regular transactions
* super fund data
* normal leave allocation
* additional data
* regular allowances

See:

* [high-level XML representation](/articles/ehr-user-guide/high-level-xml-representation) for an example of each high-level data category
* [onboarding XML structure (file)](/articles/ehr-user-guide/onboarding-xml-structure-file) for the complete structure on which the (detailed) data tables are based

### Temporarily load the data

EmpowerHR validates the complete set of data for a new employee before accepting the data load. In some cases, when one set of data is rejected, related sets of data are also rejected.

If, according to transaction rules and field error severity levels the data is acceptable, you can load the validated data while requiring manual validation of pay details before the employee is available to pay functions. In other words, flag the pay details as incomplete so they require manual completion or verification. The [installation option](/articles/ehr-user-guide/installation-options) called **onboarding; manual check of pay required? (obop)** is designed for this purpose. If you set this option to:

* **y** (yes), then EmpowerHR requires a manual check before the new employee is set up for pay
* **n** (no), then no check is required and the new employee is immediately set up for pay

## Re-employments

You can re-employ previously terminated employees by doing the following:

* Set the [installation option](/articles/ehr-user-guide/installation-options) called **allow re-employment via onboarding (orem)** to **y** (yes).
* Update the [installation setting](/articles/ehr-user-guide/installation-settings) called **define reemploy move, oper code (obre)**, where at:

* **Character Variable**, you enter****the movement reason code your organisation uses for re-employments
* **Text Variable**, you enter the operator code capable of loading any employee and their employment details

### How does the orem installation option work?

When an employee is onboarded and the reemployment flag is set to **y** (yes), EmpowerHR checks the **orem** installation setting to determine if re-employments are permitted.

Here's what happens according to how **orem** is set...

| **orem** installation option = **y** (yes) | EmpowerHR checks the employee code (if provided), TFN ![](/resources/Storage/ehr-user-guide/icons/leave%20-%20info%20icon.png), name, and date of birth to see if the individual exists in the system and has a termination status (for example, **t%** or **g%**).<br>TFN = Tax File Number<br>If the system finds the employee's record, before onboarding, EmpowerHR cleans up existing data including any currently held information for super fund, payment instructions, and additional data.<br><br>The data supplied for onboarding is used for the re-employment. All supplied fields override existing data, even when the supplied data is blank. The exception is any fields governed by transaction rules. |
| --- | --- |
| **orem**installation option = **n** (no) | An error occurs for the re-employed individual and they have to be onboarded as a new employee with a new employee number |

### How does the obre installation setting work?

The transaction rules for the movement code defined in the installation setting, **obre**, direct which fields default from the position and which are updated from the data supplied for onboarding.

| ![Information](/resources/Storage/ehr-user-guide/ehr-user-guide/Info.png) | Once you've set these up, see **[Onboard employee data](/articles/ehr-user-guide/onboard-employee-data/a/h3_958474700 "Jump to the section on uploading re-employments")** under **Onboard new employees via web service** for what happens when you upload a re-employment. |
| --- | --- |

## Onboard new employees via web service

To onboard new employees via web service, generate the XML file and then use your organisation's preferred method to send your request.

To learn about the fields for onboarding, see:

* [personal data onboarding fields](/articles/ehr-user-guide/personal-data-onboarding-fields)
* [tax and declaration data onboarding fields](/articles/ehr-user-guide/tax-and-declaration-data-onboarding-fields)
* [position and pay data onboarding fields](/articles/ehr-user-guide/position-and-pay-data-onboarding-fields)
* [payment instructions data onboarding fields](/articles/ehr-user-guide/payment-instructions-data-onboarding-fields)
* [long service leave data onboarding fields](/articles/ehr-user-guide/long-service-leave-data-onboarding-fields)
* [normal leave data onboarding fields](/articles/ehr-user-guide/normal-leave-data-onboarding-fields)
* [regular transactions data onboarding fields](/articles/ehr-user-guide/regular-transactions-data-onboarding-fields)
* [super fund data onboarding fields](/articles/ehr-user-guide/super-fund-data-onboarding-fields)
* [employee additional data onboarding fields](/articles/ehr-user-guide/employee-additional-data-onboarding-fields)

When the data is onboarded and no errors found, the employee details are successfully loaded.

EmpowerHR displays in the **Bulk Take-On/Onboard Error Fix** screen, the details of any employees with errors in their onboarded data. From there you can correct the data, after which the employee onboards successfully. See [fix onboarding errors](/articles/ehr-user-guide/fix-onboarding-errors) for more information.

### How EmpowerHR matches re-employment records
 When you upload a re-employment record via the onboarding web service with the re-employ flag set to **y**, EmpowerHR tries to match it to an existing terminated employee. It checks four fields: Tax File Number (TFN), Date of Birth, Surname, and Given Name.
 
 What happens next depends on whether EmpowerHR finds a match and which fields don't match.

| Non-generic TFN | | TFN | DOB | Surname | Given name | What happens |<br>| --- | --- | --- | --- | --- |<br>| Match | Match | Match | Match | Re-employed straight away. View in Current Employee Information. |<br>| Match | Match | Match | Mismatch | Re-employed using the new given name. No action needed. |<br>| Match | Match | Mismatch | Match | Goes to Error/Fix screen with original emp code. A surname mismatch message appears. You can accept or change it, then save. |<br>| Match | Mismatch | Match | Match | Goes to Error/Fix screen with original emp code. A DOB mismatch message appears. Correct it and save. |<br>| Match | Match | Mismatch | Mismatch | Goes to Error/Fix screen with original emp code. A surname mismatch message appears on save. |<br>| Mismatch | Match | Match | Match | Goes to Error/Fix screen with blank emp code. Use the lookup or enter the original code manually. |<br>| Mismatch | Mismatch | Mismatch | Mismatch | Goes to Error/Fix screen with blank emp code. Use the lookup to find the employee, or enter a new code to onboard as a new starter. | |
| --- | --- |
| Generic TFN (e.g. 111111111) | When a generic TFN is used, the matching works differently because the TFN isn't unique to one person. EmpowerHR relies more on DOB and surname to narrow down the match.<br> <br><br>| DOB | Surname | Given name | What happens |<br>| --- | --- | --- | --- |<br>| Match | Match | Match | Re-employed using original emp code. View in Current Employee Information. |<br>| Match | Match | Mismatch | If a single match is found, the employee is re-employed. If there are multiple matches, the record goes to the Error/Fix screen with blank emp code so you can select from the lookup. |<br>| Match | Mismatch | Match | Goes to Error/Fix screen with blank emp code. A surname mismatch message appears on save. You can accept or change it. |<br>| Mismatch | Match | Match | Goes to Error/Fix screen with blank emp code. A DOB mismatch message appears. Correct it and save. |<br>| Match | Mismatch | Mismatch | Goes to Error/Fix screen. A surname mismatch message appears on save. |<br>| Mismatch | Mismatch | Mismatch | Goes to Error/Fix screen with blank emp code. Use the lookup to find the right employee, or enter a new code to onboard as a new starter. | |
| --- | --- |

#### Multiple re-employment records with mismatches
Only one record with a blank employee code can exist on the Error/Fix screen at a time. Fix the first record before uploading the next.

The web service displays this message: "The employee could not be found using the supplied details causing duplicate records in the Error/Fix screen. Please fix the first re-employ before loading another."

| Next topic<br> <br>[Overtime code fields](/articles/ehr-user-guide/overtime-code-fields) |
| --- |

© 2023 Fusion5. All rights reserved.