| This is a private repository due to the complexity of the connector and requirements such as Tools4ever's generated certificate |
| ℹ️ Information |
|---|
| This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements. |
HelloID-Conn-Prov-Source-NedapOns-Rooster is a source connector. It utilizes a set of REST API's that allow you to programmatically interact with Roster information in NedapONS It collects the Employees from nedap, including their shiftassignments and/or their planned visits
The HelloID connector uses the API endpoints listed in the table below.
| Endpoint | Description |
|---|---|
| ./t/employees/x-stream-connect/data | The list of employees |
| ./t/moves/shift_assignments/starting_between | The list of shift assigments |
| ./t/employees/{employee_id}/planned_visits | The list of planned visits for an employee |
| ./t/teams/x-stream-connect/data | The list of teams, to lookup the team name |
The following settings are required to connect to the API.
| Setting | Description |
|---|---|
| Environment URL API | https://api-staging.ons.io |
| Certificate (.PFX) Path | Full path to Certificate Nedap-cert.pfx |
| Certificate Password | Password of the certificate |
| Start Day | The number of days in the past to start collecting data. Assignments or visits with an earlier startdate will not be collected |
| Total number of days collected | Assignments or vistits with a startdate later than this number of days after the "start day", will not be collected |
| CollectShiftAssignments | Collect the Shift Assignments (toggle) |
| CollectPlannedVisits | Collect the planned visits (toggle) |
Each shift assignment of an employee results in a contract where the field "T4eType" has the value "NedapShiftAssignment". Each planned visit of an employee results in a contract where the field "T4eType" has the value "NedapPlannedVisit"
ShiftsAssignments for each employee are collected, for startdates as specified in de configuration. Planned visits are also collected for the period containing Yesterday, today and tomorrow.
Warning: Collecting planned visits can take a considerable time, as there is one call per user required, which may exceed allowed HelloID limits for larger numbers of emloyees.
Warning: Collecting Shift assignments may take a considerable time if the "total number of days collected" is large, as it requires a separate Api call for each hour in the period. Default setting is therefore 3 days.
For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages
If you need help, feel free to ask questions on our forum
The official HelloID documentation can be found at: https://docs.helloid.com/