Skip to content

Commit 8ce885a

Browse files
Release v2.1.0 (#11)
* Updated config * Updated Readme * Removed unnecessary file * No longer set permissions in account lifecycle * Initial release of script to grant permission * Initial release of script to revoke permission * Initial release of script to list permissions * Removed versioning (is in Git commit history now) * changed dependent properties to AD instead of AAD * Added UsId to update fields when option is toggled * Corrected createUser to createAccount * Corrected $c.updateConnector * Added remark for concurrent actions * Formatted * Corrected function Get-ErrorMessage * Corrected user to account * Only log update when fields are selected to update * Fix: removed permissions Permissions need to be further tested before we add this to the connector * Fix readme typo's --------- Co-authored-by: rhouthuijzen <r.houthuijzen@tools4ever.com>
1 parent 61d60a7 commit 8ce885a

8 files changed

Lines changed: 1457 additions & 1712 deletions

File tree

README.md

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# HelloID-Conn-Prov-Target-AFAS-Profit-Users
2-
| :information_source: Information |
3-
|:---------------------------|
4-
| 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. |
2+
Repository for HelloID Provisioning Target Connector to AFAS Users
3+
4+
<a href="https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users/network/members"><img src="https://img.shields.io/github/forks/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users" alt="Forks Badge"/></a>
5+
<a href="https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users/pulls"><img src="https://img.shields.io/github/issues-pr/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users" alt="Pull Requests Badge"/></a>
6+
<a href="https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users/issues"><img src="https://img.shields.io/github/issues/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users" alt="Issues Badge"/></a>
7+
<a href="https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users?color=2b9348"></a>
8+
9+
| :information_source: Information |
10+
| -------------------------------- |
11+
| 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. |
512

613
<p align="center">
714
<img src="https://www.tools4ever.nl/connector-logos/afas-logo.png">
815
</p>
916

10-
## Versioning
11-
| Version | Description | Date |
12-
| - | - | - |
13-
| 2.0.0 | Release of v2 connector including performance and logging upgrades | 2022/08/30 |
14-
| 1.0.0 | Initial release | 2020/07/24 |
15-
1617
<!-- TABLE OF CONTENTS -->
1718
## Table of Contents
1819
- [HelloID-Conn-Prov-Target-AFAS-Profit-Users](#helloid-conn-prov-target-afas-profit-users)
19-
- [Versioning](#versioning)
2020
- [Table of Contents](#table-of-contents)
2121
- [Introduction](#introduction)
2222
- [Getting Started](#getting-started)
@@ -36,13 +36,13 @@ The interface to communicate with Profit is through a set of GetConnectors, whic
3636
For this connector we have created a default set, which can be imported directly into the AFAS Profit environment.
3737
The HelloID connector consists of the template scripts shown in the following table.
3838

39-
| Action | Action(s) Performed | Comment |
40-
| ------------------------------- | --------------------- | --------- |
41-
| create.ps1 | Update AFAS user | Update EmAd and UPN |
42-
| enable.ps1 | Enable AFAS user | Enable InSite, disable OutSite |
43-
| update.ps1 | Update AFAS user | Update EmAd and UPN |
44-
| disable.ps1 | Disable AFAS user | Disable InSite, enable OutSite |
45-
| delete.ps1 | Update AFAS user | Clear the unique fields, since the values have to be unique over all AFAS environments |
39+
| Action | Action(s) Performed | Comment |
40+
| ---------------------------------- | -------------------------------------------------- | ------- |
41+
| create.ps1 | Create or Update AFAS user | Optionally you can update the UserID to match the mapped convention. **Note that this is not advised as this can break certain links in AFAS. Use with care!**. Users are only created or updated when this is configured, **make sure to check your configuration options to prevent unwanted actions**. |
42+
| enable.ps1 | Unblock and optionally update AFAS user | Optionally, you can provide additional properties to update, e.g. **"EmAd", "Upn"**. The **default example sets these with the AD values**. This action is perfomed with **entry code "6"**. For more information on the entry codes, see the [AFAS documenation](https://help.afas.nl/help/en/SE/App_Conect_UpdDsc_KnUser.htm). |
43+
| update.ps1 | Update AFAS user | Update with the specified properties, e.g. **"EmAd", "Upn"**, etc. The **default example sets these with the AD values**. This action is perfomed with **entry code "1"**. For more information on the entry codes, see the [AFAS documenation](https://help.afas.nl/help/en/SE/App_Conect_UpdDsc_KnUser.htm) |
44+
| disable.ps1 | Block and optionally update AFAS user | Optionally, you can provide additional properties to update, e.g. **"EmAd", "Upn"**. The **default example clears these values**, as the values have to be unique over all AFAS environments. This action is perfomed with **entry code "2"**. For more information on the entry codes, see the [AFAS documenation](https://help.afas.nl/help/en/SE/App_Conect_UpdDsc_KnUser.htm). |
45+
| delete.ps1 | Block, remove from all groups and update AFAS user | Optionally, you can provide additional properties to update, e.g. **"EmAd", "Upn"**. The **default example clears these values**, as the values have to be unique over all AFAS environments. This action is perfomed with **entry code "0"**. For more information on the entry codes, see the [AFAS documenation](https://help.afas.nl/help/en/SE/App_Conect_UpdDsc_KnUser.htm). |
4646

4747
<!-- GETTING STARTED -->
4848
## Getting Started
@@ -62,14 +62,16 @@ Please see the following pages from the AFAS Knowledge Base for more information
6262

6363
The following settings are required to connect to the API.
6464

65-
| Setting | Description | Mandatory |
66-
| --------------------- | --------------------------------------------- | ----------- |
67-
| BaseUrl | The URL to the AFAS environment REST services | Yes |
68-
| ApiKey | The AppConnector token to connect to AFAS | Yes |
69-
| Relation number | The relation number of the AFAS environment | Yes |
70-
| Update User when correlating and mapped data differs from data in AFAS | When toggled, the mapped properties will be updated in the create action (not just correlate). | No |
71-
| Update User ID if it doesn't match mapped naming convention | When toggled, the userId is updated to match the mapped convention. Note that this is not advised as this can break certain links in AFAS. Use with care! | No |
72-
| Toggle debug logging | When toggled, extra logging is shown. Note that this is only meant for debugging, please switch this off when in production. | No |
65+
| Setting | Description | Mandatory |
66+
| --------------------------- | ----------- | --------- |
67+
| Base Uri | The URL to the AFAS environment REST services | Yes |
68+
| Token in XML format | The AppConnector token to connect to AFAS | Yes |
69+
| Get Connector | The GetConnector in AFAS to query the user with | Yes |
70+
| Update Connector | The UpdateConnector in AFAS to update the user with | Yes |
71+
| Create account when not found | When toggled, if the user account is not found, a new the AFAS user account will be created in the create action (only in the create action). | No |
72+
| Update on correlate | When toggled, if the mapped data differs from data in AFAS, the AFAS user will be updated in the create action (not just correlated). | No |
73+
| Update User ID | When toggled, the User ID will be updated if it doesn't match mapped naming convention. **Note that this is not advised as this can break certain links in AFAS. Use with care!** | No |
74+
| Toggle debug logging | When toggled, extra logging is shown. Note that this is only meant for debugging, please switch this off when in production. | No |
7375

7476
### Prerequisites
7577

@@ -91,10 +93,10 @@ When the connector is defined as target system, only the following GetConnector
9193
The data collection retrieved by the set of GetConnector's is sufficient for HelloID to provision persons.
9294
The data collection can be changed by the customer itself to meet their requirements.
9395

94-
| Connector | Field | Default filter |
95-
| ----------------------------------------------------- | ------------------- | ------------------------- |
96-
| __Tools4ever - HelloID - T4E_HelloID_Users_v2__ | contract start date | <[Vandaag + 3 maanden] |
97-
| | contract end date | >[Vandaag - 3 maanden];[] |
96+
| Connector | Field | Default filter |
97+
| ----------------------------------------------- | ------------------- | ------------------------- |
98+
| __Tools4ever - HelloID - T4E_HelloID_Users_v2__ | contract start date | <[Vandaag + 3 maanden] |
99+
| | contract end date | >[Vandaag - 3 maanden];[] |
98100

99101
### UpdateConnector
100102
In addition to use to the above get-connector, the connector also uses the following build-in Profit update-connectors:
@@ -107,4 +109,4 @@ In addition to use to the above get-connector, the connector also uses the follo
107109
> _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_
108110
109111
## HelloID docs
110-
The official HelloID documentation can be found at: https://docs.helloid.com/
112+
The official HelloID documentation can be found at: https://docs.helloid.com/

configuration.json

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,33 +22,53 @@
2222
}
2323
},
2424
{
25-
"key": "RelationNumber",
25+
"key": "GetConnector",
2626
"type": "input",
27-
"defaultValue": "",
27+
"defaultValue": "T4E_HelloID_Users_v2",
28+
"templateOptions": {
29+
"label": "GetConnector",
30+
"placeholder": "T4E_HelloID_Users_v2",
31+
"required": true
32+
}
33+
},
34+
{
35+
"key": "UpdateConnector",
36+
"type": "input",
37+
"defaultValue": "KnUser",
2838
"templateOptions": {
29-
"label": "Relation number",
30-
"placeholder": "12345",
39+
"label": "UpdateConnector",
40+
"placeholder": "KnUser",
3141
"required": true
3242
}
3343
},
3444
{
35-
"key": "updateUserOnCorrelate",
45+
"key": "createAccount",
46+
"type": "checkbox",
47+
"defaultValue": false,
48+
"templateOptions": {
49+
"label": "Create account when not found",
50+
"required": false,
51+
"description": "When toggled, if the user account is not found, a new AFAS user account will be created in the create action (only in the create action)."
52+
}
53+
},
54+
{
55+
"key": "updateOnCorrelate",
3656
"type": "checkbox",
3757
"defaultValue": false,
3858
"templateOptions": {
39-
"label": "Update User when correlating and mapped data differs from data in AFAS",
59+
"label": "Update on correlate",
4060
"required": false,
41-
"description": "This will update AFAS users in the create action (not just correlate)."
61+
"description": "When toggled, if the mapped data differs from data in AFAS, the AFAS user will be updated in the create action (not just correlated)."
4262
}
4363
},
4464
{
4565
"key": "updateUserId",
4666
"type": "checkbox",
4767
"defaultValue": false,
4868
"templateOptions": {
49-
"label": "Update User ID if it doesn't match mapped naming convention",
69+
"label": "Update User ID",
5070
"required": false,
51-
"description": "Use with care! This can break certain links in AFAS. Please consult AFAS first."
71+
"description": "When toggled, the User ID will be updated if it doesn't match mapped naming convention. Use with care! This can break certain links in AFAS. Please consult AFAS first."
5272
}
5373
},
5474
{
@@ -61,4 +81,4 @@
6181
"required": false
6282
}
6383
}
64-
]
84+
]

0 commit comments

Comments
 (0)