Feature fieldmapping updates and cleanup (#20)

* Update fieldMapping.json

* Removed pw as it is no longer required

* Removed notes about default value to false, as this is expected

* Updated mandatory descriptions

* Updated logo and corrected table of contents

* Moved requirements and remarks to top

* improved description of insite and profit

* Updated readme with remarks about insite and profit windows

Author: rschouten97

README.md

@@ -5,26 +5,56 @@
 > 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.
 
 <p align="center">
-  <img src="https://www.tools4ever.nl/wp-content/uploads/2024/08/Logo.png>
+  <img src="https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-AFAS-Profit-Users/blob/main/Logo.png?raw=true" alt="AFAS Logo">
 </p>
 
-## Table of contents
+## Table of Contents
 
 - [HelloID-Conn-Prov-Target-AFAS-Profit-Users](#helloid-conn-prov-target-afas-profit-users)
-  - [Table of contents](#table-of-contents)
+  - [Table of Contents](#table-of-contents)
+    - [Requirements](#requirements)
+    - [Remarks](#remarks)
   - [Introduction](#introduction)
   - [Getting started](#getting-started)
     - [Provisioning PowerShell V2 connector](#provisioning-powershell-v2-connector)
       - [Correlation configuration](#correlation-configuration)
       - [Field mapping](#field-mapping)
     - [Connection settings](#connection-settings)
-    - [Prerequisites](#prerequisites)
-    - [Remarks](#remarks)
       - [Scope](#scope)
   - [Setup the connector](#setup-the-connector)
   - [Getting help](#getting-help)
   - [HelloID docs](#helloid-docs)
 
+### Requirements
+
+- [ ] HelloID Provisioning agent (cloud or on-prem).
+- [ ] Loaded and available AFAS GetConnectors.
+- [ ] In addition to use to the above get-connector, the connector also uses the following build-in Profit update-connectors:
+*	KnUser
+- [ ] AFAS App Connector with access to the GetConnectors and associated views.
+  - [ ] Token for this AppConnector
+
+> [!TIP]
+> For this connector we have created a default set [Tools4ever - HelloID - T4E_HelloID_Users_v2.gcn], which can be imported directly into the AFAS Profit environment.
+
+> [!NOTE]
+> When the connector is defined as target system, only the following GetConnector is used by HelloID:
+> * 	Tools4ever - HelloID - T4E_HelloID_Users_v2
+
+### Remarks
+
+> [!IMPORTANT]
+> In view of GDPR, the persons private data, such as private email address and birthdate are not in the data collection by default. When needed for the implementation (e.g. set emailaddress with private email address on delete), these properties will have to be added.
+
+> [!IMPORTANT]
+> We never delete users in AFAS, we only clear the unique fields and block the users.
+
+> [!IMPORTANT]
+> **InSite** is a required field when creating a user. If this field is not mapped, the default value is `true`. Enabling InSite will automatically enable Pocket.
+
+> [!IMPORTANT]
+> **Profit Windows** is a required field when creating a user. If this field is not mapped, the default value is `true`. Enabling Profit Windows will automatically enable both InSite and Pocket.
+
 ## Introduction
 
 _HelloID-Conn-Prov-Target-AFAS-Profit-Users_ is a _target_ connector. _AFAS-Profit-Users_ provides a interface to communicate with Profit through a set of GetConnectors, which is component that allows the creation of custom views on the Profit data. GetConnectors are based on a pre-defined 'data collection', which is an existing view based on the data inside the Profit database. 
@@ -102,30 +132,6 @@ The following settings are required to connect to the API.
 | 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!** |           |
 | Toggle debug logging          | When toggled, extra logging is shown. Note that this is only meant for debugging, please switch this off when in production.                                                      |           |
 
-### Prerequisites
-
-- [ ] HelloID Provisioning agent (cloud or on-prem).
-- [ ] Loaded and available AFAS GetConnectors.
-- [ ] In addition to use to the above get-connector, the connector also uses the following build-in Profit update-connectors:
-*	KnUser
-- [ ] AFAS App Connector with access to the GetConnectors and associated views.
-  - [ ] Token for this AppConnector
-
-> [!TIP]
-> For this connector we have created a default set [Tools4ever - HelloID - T4E_HelloID_Users_v2.gcn], which can be imported directly into the AFAS Profit environment.
-
-> [!NOTE]
-> When the connector is defined as target system, only the following GetConnector is used by HelloID:
-> * 	Tools4ever - HelloID - T4E_HelloID_Users_v2
-
-### Remarks
-
-> [!IMPORTANT]
-> In view of GDPR, the persons private data, such as private email address and birthdate are not in the data collection by default. When needed for the implementation (e.g. set emailaddress with private email address on delete), these properties will have to be added.
-
-> [!IMPORTANT]
-> We never delete users in AFAS, we only clear the unique fields and block the users.
-
 #### Scope
 The data collection retrieved by the set of GetConnector's is sufficient for HelloID to provision persons.
 The data collection can be changed by the customer itself to meet their requirements.
@@ -135,8 +141,6 @@ The data collection can be changed by the customer itself to meet their requirem
 | __Tools4ever - HelloID - T4E_HelloID_Users_v2__ | contract start date | <[Vandaag + 3 maanden]    |
 |                                                 | contract end date   | >[Vandaag - 3 maanden];[] |
 
-
-
 ## Setup the connector
 
 > [!TIP]

fieldMapping.json

@@ -3,7 +3,7 @@
   "MappingFields": [
     {
       "Name": "Acon",
-      "Description": "Connector",
+      "Description": "[Required when creating user] Connector.",
       "Type": "Text",
       "MappingActions": [
         {
@@ -19,7 +19,7 @@
     },
     {
       "Name": "Abac",
-      "Description": "Reservekopieen via commandline",
+      "Description": "[Required when creating user] Reservekopieen via commandline Connector.",
       "Type": "Text",
       "MappingActions": [
         {
@@ -35,7 +35,7 @@
     },
     {
       "Name": "Acom",
-      "Description": "Commandline",
+      "Description": "[Required when creating user] Commandline.",
       "Type": "Text",
       "MappingActions": [
         {
@@ -100,7 +100,7 @@
     },
     {
       "Name": "Gebruiker",
-      "Description": "[Mandatory] This is the account refference. For export account data",
+      "Description": "[Required] This is the account refference. For export account data",
       "Type": "Text",
       "MappingActions": [
         {
@@ -117,7 +117,7 @@
     },
     {
       "Name": "Medewerker",
-      "Description": "[Mandatory] For Correlation",
+      "Description": "[Required] For Correlation",
       "Type": "Text",
       "MappingActions": [
         {
@@ -133,7 +133,7 @@
     },
     {
       "Name": "MtCd",
-      "Description": "[Mandatory] Mutatie code",
+      "Description": "[Required] Mutatie code",
       "Type": "Text",
       "MappingActions": [
         {
@@ -175,25 +175,9 @@
         }
       ]
     },
-    {
-      "Name": "Pw",
-      "Description": "[Mandatory] dummy pwd, not used, but required",
-      "Type": "Text",
-      "MappingActions": [
-        {
-          "MapForActions": [
-            "Create"
-          ],
-          "MappingMode": "Fixed",
-          "Value": "\"GHJKL!!!23456gfdgf\"",
-          "UsedInNotifications": false,
-          "StoreInAccountData": false
-        }
-      ]
-    },
     {
       "Name": "Site",
-      "Description": "[Mandatory] Outsite",
+      "Description": "Outsite",
       "Type": "Text",
       "MappingActions": [
         {
@@ -219,7 +203,7 @@
     },
     {
       "Name": "Nm",
-      "Description": "[Mandatory] Omschrijving",
+      "Description": "[Required] Omschrijving",
       "Type": "Text",
       "MappingActions": [
         {
@@ -236,7 +220,7 @@
     },
     {
       "Name": "InSi",
-      "Description": "[Mandatory] InSite",
+      "Description": "[Required when creating user] InSite.\nIf this field is not mapped, the default value is true.\nEnabling InSite will automatically enable Pocket.",
       "Type": "Text",
       "MappingActions": [
         {
@@ -262,7 +246,7 @@
     },
     {
       "Name": "Awin",
-      "Description": "[Mandatory] Profit Windows. Must be false to turn off InSite",
+      "Description": "[Required when creating user] Profit Windows.\nIf this field is not mapped, the default value is true.\nEnabling Profit Windows will automatically enable InSite and Pocket.",
       "Type": "Text",
       "MappingActions": [
         {
@@ -279,7 +263,7 @@
     },
     {
       "Name": "Upn",
-      "Description": "[Mandatory] userPrincipalName",
+      "Description": "UserPrincipalName",
       "Type": "Text",
       "MappingActions": [
         {
@@ -305,7 +289,7 @@
     },
     {
       "Name": "UsId",
-      "Description": "[Mandatory] Gebruiker code",
+      "Description": "[Required] Gebruiker code",
       "Type": "Text",
       "MappingActions": [
         {
@@ -322,7 +306,7 @@
     },
     {
       "Name": "EmAd",
-      "Description": "[Mandatory] E-mail",
+      "Description": "E-mail",
       "Type": "Text",
       "MappingActions": [
         {
@@ -348,4 +332,4 @@
     }
   ],
   "UniqueFieldNames": []
-}
+}