Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tools4everbv/helloid-conn-prov-target-esis_employee

Esis - Target - Employees
https://github.com/tools4everbv/helloid-conn-prov-target-esis_employee

edu provisioning sis target

Last synced: 26 days ago
JSON representation

Esis - Target - Employees

Awesome Lists containing this project

README 

        
# HelloID-Conn-Prov-Target-esis

| :information_source: 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



- [Introduction](#Introduction)

- [Getting started](#Getting-started)

  + [Connection settings](#Connection-settings)

  + [Prerequisites](#Prerequisites)

  + [Remarks](#Remarks)

- [Setup the connector](@Setup-The-Connector)

- [Correlation](#Correlation)

- [Getting help](#Getting-help)

- [HelloID Docs](#HelloID-docs)



## Introduction



_HelloID-Conn-Prov-Target-Esis-employee_ is a _target_ connector. Esis-employee provides a set of REST API's that allow you to programmatically interact with it's data. The connector manages Account Management And links the SSO Identifier. Authorization and group Management is out of scope. Although it's possible to activate a person to multiple departments.

## Getting started



### Connection settings



The following settings are required to connect to the API.z



| Setting           | Description                                               | Mandatory   |

| ------------      | -----------                                               | ----------- |

| BaseURL           | The url to send the API requests to                       | Yes         |

| BaseUrlToken      | The url to send te request for a token                    | Yes         |

| ClientId          | The id needed to get the token                            | Yes         |

| ClientSecret      | The secret needed to get the token                        | Yes         |

| XVendorCode       | The code needed to for the headers of the api request     | Yes         |

| XVerificatieCode  | The code needed to for the headers of the api request     | Yes         |

| CompanyNumber     | The company number needed in the uri of the api request   | Yes         |



### Prerequisites

- A Brin6 code is required to use the connector. Preferable in a Custom property or a code from HR.

- A mapping available between HR function Title and Esis Role (Leraar, Director, etc..)



### Remarks

- The webservice does not support verifying if the SSO identifier is linked or not therefore it is not updated in the update script

- The webservice does not support looking up a single person. The script can be a bit slower because it needs to loop through every person

- The webservice is event based, because of this there is some retry logic in the script you change how often it retries and how long it has to wait before retrying again with the variables $MaxRetrycount and $RetryWaitDuration.

- Username is the unique value from a employee, this value is used in the requests to the webservice. This value can be changed when updating a user.

- The disable and enable scripts are not used. And the activation of the department is managed with dynamic Permissions. This is because it's possible to activate persons in multiple departments. The activation is automatically calculated based on unique brin6 in contracts in scope.

- Activation on a department also requires a Function Role. The mapping for the function roles can be configured in the grant script. (See below)

- Correlation cannot be performed on a EmployeeNr, we must correlate on login name or mail: See [Correlation](#Correlation)



## Setup the connector



> _How to setup the connector in HelloID._ Are special settings required. Like the _primary manager_ settings for a source connector.



#### Correlation

 - In ESIS, there are employees and user accounts, with a 1 on 1 relation. Both objects do not have a property like an Employee Number. So correlation must be performed on, for example loginname or email address.

 - By default, we correlate the users account on **LoginName** and the Employee Object on **basispoortEmailadres** against the **GebruikersNaam** from the account object.

  Please verify during implementation if this match the business needs. You can change this, in the code itself:

 ```PowerShell

  # Correlation properties Employee Object

  # Only needed if your implementation contains Employees without User accounts.

  $responseEmployee = $users.gebruikersLijst.medewerkers.where({ $_.basispoortEmailadres -eq $account.GebruikersNaam })



  # Correlation properties User Account Object

  $responseUser = $users.gebruikersLijst.gebruikers.where({ $_.gebruikersnaam -eq $account.GebruikersNaam })



  ```



#### Script Settings

* Besides the configuration tab, you can also configure script variables. To decide which property from a HelloID contract holds the Brin6 department code. And you can configure the primary contract calculation for each Brin6 Department (Only used in Permission scripts). Please note that some "same" configuration takes place in multiple scripts. Shown as below:



#### Create / Update and Delete.ps1



```PowerShell

#Brin6

$departmentBrin6 = $p.PrimaryContract.Department.ExternalId

```



#### Grant.ps1



  ```PowerShell

# Role| Function Mapping

$defaultFunction = 'Leraar'



$mappingHashTableFunctions = @{  # $functionContractProperty  value from

    MEDSBI  = 'Director'

    MEDSBI2 = 'Director'

    MEDSBI3 = 'Support'

}



#Script Configuration

$brin6ContractProperty = { $_.Department.ExternalId }

$functionContractProperty = { $_.Title.ExternalId }



# Primary Contract Calculation foreach employment

$firstProperty = @{ Expression = { $_.Details.Fte } ; Descending = $true }

$secondProperty = @{ Expression = { $_.Details.HoursPerWeek }; Descending = $false }



# Priority Calculation Order (High priority -> Low priority)

$splatSortObject = @{

    Property = @(

        $firstProperty,

        $secondProperty)

}

  ```



## Getting help



> _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/hc/en-us/articles/360012558020-Configure-a-custom-PowerShell-target-system) pages_



> _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_



## HelloID docs



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