Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tools4everbv/helloid-conn-prov-target-ubw
Unit4 Business World - Target
https://github.com/tools4everbv/helloid-conn-prov-target-ubw
erp provisioning target
Last synced: 2 days ago
JSON representation
Unit4 Business World - Target
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-conn-prov-target-ubw
- Owner: Tools4everBV
- Created: 2021-11-30T17:11:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T10:55:51.000Z (12 months ago)
- Last Synced: 2024-11-10T22:35:28.654Z (2 months ago)
- Topics: erp, provisioning, target
- Language: PowerShell
- Homepage:
- Size: 177 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HelloID-Conn-Prov-Target-UBW
| :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. |
| :warning: Warning |
|:---------------------------|
| Note that this connector is not yet implemented nor tested on a HelloID environment. Contact our support for further assistance |
## Table of contents
- [Introduction](#Introduction)
- [Getting started](#Getting-started)
+ [Connection settings](#Connection-settings)
+ [Prerequisites](#Prerequisites)
+ [Remarks](#Remarks)
- [Setup the connector](@Setup-The-Connector)
- [Getting help](#Getting-help)
- [HelloID Docs](#HelloID-docs)
## Introduction
_HelloID-Conn-Prov-Target-UBW_ is a _target_ connector. Unit4 Business World provides a set of REST API's that allow you to programmatically interact with it's data. The HelloID connector uses the API endpoints listed in the table below.
> Unit4 Business World is a on-premises application.
| Endpoint | Description |
| ------------ | ----------- |
| /Users | This endpoint is used to create,update,delete users. |
| /Employees | This endpoint is used to verify if a user has a linked employee account |
## Getting started
### Connection settings
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
| ------------ | ----------- | ----------- |
| UserName | The UserName to connect to the Business World API | Yes |
| Password | - | Yes |
| BaseUrl | The URL to the API | Yes |
### Remarks
#### Static value's and order
Both the __create__ and __update__ files contain the account mapping. The property's are ordered because UBW doesn't accept the object if the value's if the order is different.
The account mapping also contains a few property's which are static value's. These property's are:
General:
- alertMedia
- defaultLogonCompany
- languageCode
- printer
userStatus
- status
roleAndCompany:
- companyId
- roleId
Make sure to verify the value of the property's listed above with the customer.
#### User accounts
This connector only creates user accounts. During creation we validate the exsistence of the employee account and user account.
Both objects contain a property called _[personId]_.
The flow is as follows:
- Lookup the employee by _[personId]_. We assume the _[personId]_ is the _[ExternalId]_ for a HelloID person.
- If no employee account is found, we cannot continue and the process will exit.
- If an employee account has been found:
- Retrieve all user accounts. (User accounts do have the property _[personId]_ but we cannot get it directly).
- Verify if there is a user account that matches with the _[personId]_ in the account mapping.
- When a user account has been found:
- Correlate the account
- When a user account aannot be found:
- Create the user account and connect the user account with the employee account.
#### Update
At this point the update.ps1 only updates the description as an example. Most (if not all) property's within Unit4 Business World are static value's.
The user object itself does not contain any user information apart from the _[userId]_ and _[userName]_
## Setup the connector
> _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_
## Getting help
> _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/