---
title: "What you need to set up (onboard web services)"
id: "what-you-need-to-set-up-onboard-web-services"
project: "EHR User Guide"
url: "https://help.cloud5.com.au/articles/ehr-user-guide/what-you-need-to-set-up-onboard-web-services"
updated: 2026-10-19T00:52:56Z
---

# What you need to set up \(onboard web services\)

Before you can onboard employees via a web service, you need to perform some setup tasks.

## Switch on the onboarding web service

By default, the onboarding web service is switched off. Use the following instructions to switch it on. Your organisation, or your organisation's third party application suppliers, will know about creating web service clients in order to use this service.

To switch on the onboarding web service:

1. Uncomment the onboarding web service end point entry in the **&lt;SelfService&gt;/WEB-INF/sun-jaxws.xml** file.
2. By default, the onboarding entry is commented out.

![](/resources/Storage/ehr-user-guide/what-you-need-to-set-up-onboard-web-services/001%20config%20onboard%20web%20serv.png)

1. Remove the comment instructions surrounding the onboarding entry.

![](/resources/Storage/ehr-user-guide/what-you-need-to-set-up-onboard-web-services/002%20config%20onboard%20web%20serv.png)

1. Uncomment the onboarding web service servlet mapping entry in the **&lt;SelfService&gt;/WEB-INF/web.xml** file.
2. By default, the onboarding entry is commented out.

![](/resources/Storage/ehr-user-guide/what-you-need-to-set-up-onboard-web-services/003%20config%20onboard%20web%20serv.png)

1. Remove the comment instructions surrounding the onboarding entry.

![](/resources/Storage/ehr-user-guide/what-you-need-to-set-up-onboard-web-services/004%20config%20onboard%20web%20serv.png)

1. Uncomment the onboarding web service tokens entry and define the username and password tokens in the **&lt;SelfService&gt;/WEB-INF/Mawson/conf/config.xml** file.
2. By default, the onboarding entry is commented out.

![](/resources/Storage/ehr-user-guide/what-you-need-to-set-up-onboard-web-services/005%20config%20onboard%20web%20serv.png)

1. Remove the comment instructions surrounding the onboarding entry and set the username and password tokens.

| ![Information](/resources/Storage/ehr-user-guide/ehr-user-guide/Info.png) | The password token must be encrypted using the Encode Service Password.bat executable. |
| --- | --- |

![](/resources/Storage/ehr-user-guide/what-you-need-to-set-up-onboard-web-services/006%20config%20onboard%20web%20serv.png)

1. After making your changes, restart the Java servlet container (for example, Tomcat).

## Schema and WSDL files

The schema ![](/resources/Storage/ehr-user-guide/icons/leave%20-%20info%20icon.png)is described in the document:
The schema describes the static structure of the complex data types being exchanged. It describes the types, their fields, any restriction on those fields (like max length), and so on.

It's a description of data types and static properties of the service - it's about data.

* **OnboardingServiceSchema1.xml**

The WSDL ![](/resources/Storage/ehr-user-guide/icons/leave%20-%20info%20icon.png)is described in the document:
WSDL (Web Services Description Language) is a XML document that describes a web service. It shows which operations are available and how data should be structured to send to those operations.

It's a description of the behaviour of the service - it's functionality.

* **OnboardingServiceWSDL.xml**

## Check transaction rules and data validation ![](/resources/Storage/ehr-user-guide/ehr-user-guide/icons/desktop%20icon.png)

Aligning transaction rules and validation with your organisation's requirements is a vital part of ensuring data loads successfully. The transaction rules that apply to the onboarding process depend on the movement type you use.

As your business changes, we recommend you regularly review and maintain the rules attached to the movement code. You can check the rules at:

* **Administration** &gt; **Screen Management** &gt; **Transaction Rules** &gt; **Rules by Frame/Function**

## Set installation setting (movement code) ![](/resources/Storage/ehr-user-guide/ehr-user-guide/icons/desktop%20icon.png)

The movement code is defined in the [installation setting](/articles/ehr-user-guide/installation-settings) called **define ns (new starter) movement code, operator code (obns)**, where:

* **Character Variable** contains the movement reason code your organisation uses
* **Text Variable** contains the operator code capable of loading any new employee and their employment details

| ![Information](/resources/Storage/ehr-user-guide/ehr-user-guide/Info.png) | The operator must have a privacy level to load the data for any employee and access to functions normally used to enter new employee data in the EmpowerHR desktop. |
| --- | --- |

## Set installation option (no pay details) ![](/resources/Storage/ehr-user-guide/ehr-user-guide/icons/desktop%20icon.png)

If you want to onboard employee position data *without* the pay details, set the [installation option](/articles/ehr-user-guide/installation-options) called on **board employee position data only, without pay data (opos)** to **y** (yes).

| Next topic<br><br>[Overtime code fields](/articles/ehr-user-guide/overtime-code-fields) |
| --- |

© 2023 Fusion5. All rights reserved.