HelloID-Conn-Prov-Source-OrtecWS

ℹ️ 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.

Table of contents

• HelloID-Conn-Prov-Source-OrtecWS
  • Table of contents
  • Introduction
    • Endpoints
  • Getting started
    • Connection settings
    • Remarks
      • Logic in-depth
  • Getting help
  • HelloID docs

Introduction

HelloID-Conn-Prov-Source-OrtecWS is a source connector. The purpose of this connector is to import employees and their shifts.

Endpoints

Currently the following endpoints are being used..

Endpoint	Purpose
/CAIS/ApplicationIntegration/{servername}/SOAP12	Retrieving Employees and Shifts

Getting started

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
ApiKey	The ApiKey to connect to the API	Yes
BaseUrl	The URL to the API	Yes
HistoricalDays	- The number of days in the past from which the shifts will be imported. - Will be converted to a [DateTime] object containing the current date minus the number of days specified.	Yes
FutureDays	- The number of days in the future from which the shifts will be imported. - Will be converted to a [DateTime] object containing the current date plus the number of days specified.	Yes

Remarks

• The connector makes use of an xml soap request to retrieve the data that is necessary for the connector.

• The window for querying is -2 days and +7 days. If a call falls outside this window, the API constrains it to fit within the window. You can change these value's with HistoricalDays and FutureDays in the configuration.

• It is possible for a employee to come back twice with a get call. this happens when a user is assigned to multiple employements (Dienstverband) (The same user exists multiple times in the source system with only a different empCon). The connector handles this by creating one person with all the empCon (employements / dienstverband) in a comma separated string.

Getting help

Note

For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages

Note

_If you need help, feel free to ask questions on our forum

HelloID docs

The official HelloID documentation can be found at: https://docs.helloid.com/