Notification Templates - Documentation Improvements

Notifications/README.md

@@ -0,0 +1,129 @@
+# HelloID Provisioning – Notification Templates
+
+Deze map bevat herbruikbare MJML-templates voor notificaties binnen HelloID Provisioning.
+
+De notificaties zijn gebaseerd op:
+- de standaard HelloID notificatie-templates
+- praktijkervaring bij klantimplementaties
+- een bewuste afbakening om mailoverload te voorkomen
+
+De templates zijn bedoeld als startpunt. Ze kunnen per klant worden geïmporteerd in HelloID en daar verder worden afgestemd, bijvoorbeeld ontvangers, filters of onderwerp.
+
+---
+
+## Structuur
+
+De notificaties zijn ingedeeld per provisioning event:
+
+```
+notifications/
+  create/
+  enable/
+  update/
+  disable/
+  pre-offboard/
+```
+
+Binnen elk event staan één of meerdere varianten.  
+Elke variant heeft een eigen map met:
+
+- `template.mjml`  
+  De volledige MJML-template die direct in HelloID kan worden geïmporteerd.
+
+- `README.md`  
+  Toelichting op doel, ontvanger, gebruik en aandachtspunten van de notificatie.
+
+De nummering (`01-`, `02-`, …) maakt de volgorde en onderlinge samenhang expliciet en zorgt ervoor dat uitbreidingen later eenvoudig kunnen worden toegevoegd.
+
+---
+
+## Overzicht notificaties
+
+### Create
+Notificaties die worden verstuurd bij het aanmaken van een account.
+
+- **[01-manager-account-details](create/01-manager-account-details)**  
+  Informeert de manager over de accountgegevens van een nieuwe medewerker (zonder wachtwoord)
+
+- **[02-manager-account-password](create/02-manager-account-password)**  
+  Stuurt het tijdelijke wachtwoord in een aparte mail naar de manager (voor security)
+
+- **[03-applicatiebeheer-nieuwe-medewerker](create/03-applicatiebeheer-nieuwe-medewerker)**  
+  Notificatie naar applicatiebeheer over nieuwe medewerker voor handmatige toegangsverlening
+
+### Enable
+Notificaties die worden verstuurd wanneer een account actief wordt.
+
+- **[01-welkom-medewerker](enable/01-welkom-medewerker)**  
+  Welkomstmail naar nieuwe medewerker met instructies voor wachtwoord instellen via SSPR
+
+- **[02-welkom-medewerker-sspr](enable/02-welkom-medewerker-sspr)**  
+  Uitgebreide variant met gedetailleerde SSPR instructies (helpt supportvragen te verminderen)
+
+### Update
+Notificaties bij wijzigingen in bestaande accounts.
+
+- **[01-afdelingswijziging-applicatiebeheer](update/01-afdelingswijziging-applicatiebeheer)**  
+  Notificatie naar applicatiebeheer bij afdelingswijziging voor toegangsbeheer
+
+### Pre-offboard
+Notificaties voorafgaand aan uitdienst.
+
+- **[01-reminder-uitdienst-manager](pre-offboard/01-reminder-uitdienst-manager)**  
+  Herinnert manager X dagen voor einddatum aan uitdienst voor tijdige overdracht  
+
+### Disable
+Notificaties bij het deactiveren van accounts.
+
+- **[01-uitdienst-applicatiebeheer](disable/01-uitdienst-applicatiebeheer)**  
+  Informeert applicatiebeheer over uitdiensttreding voor handmatige account deactivering
+
+---
+
+## Gebruik
+
+### Algemeen
+
+Elke notificatie heeft een eigen README met gedetailleerde instructies. De algemene stappen zijn:
+
+1. Open in HelloID Provisioning de **Notification Configuration**
+2. Klik op **Nieuwe notificatie maken**
+3. Vul de basisvelden in (Name, Event, Target System)
+4. Importeer de `template.mjml` via het **Import MJML** icoon (download icoon)
+5. Vervang de URL `https://customer.helloid.training` door je eigen HelloID portal URL
+6. Configureer ontvanger(s), onderwerp en eventuele filters
+7. Test de notificatie grondig voordat je deze in productie neemt
+
+**Let op:** Alle templates zijn gemaakt voor het doelsysteem **Microsoft Active Directory**. Bij gebruik van een ander doelsysteem moeten de variabelen in de templates aangepast worden.
+
+### From adres configureren
+
+Voor het configureren van een custom 'from' adres, zie de [HelloID documentatie](https://docs.helloid.com/en/set-up-helloid.html#configure-a-custom--from--address-for-emails).
+
+### Variabelen
+
+Voor meer informatie over beschikbare variabelen in notificaties, zie de [Notifications variable reference](https://docs.helloid.com/en/provisioning/notifications--provisioning-/notifications-variable-reference--provisioning-.html).
+
+### Conditionele notificaties
+
+Voor het instellen van conditional notifications (filters), zie [Custom notification events](https://docs.helloid.com/en/provisioning/notifications--provisioning-/custom-notification-events--conditional-notifications-.html).
+
+---
+
+## Aandachtspunten
+
+- Alle templates zijn opgesteld in het **Nederlands**
+- Templates bevatten geen klant-specifieke informatie - deze moet je zelf invullen
+- Test notificaties altijd eerst met testaccounts voordat je ze in productie neemt
+- Overweeg CC/BCC voor escalaties of logging naar andere afdelingen
+
+### Pre-offboard configuratie
+
+Pre-offboard notificaties vereisen een speciale configuratie in HelloID:
+
+1. **Person Lifecycle inschakelen** - Pre-offboarding moet worden geconfigureerd in de person lifecycle settings
+2. **Aantal dagen instellen** - Bepaal hoeveel dagen vóór de einddatum de notificatie moet worden verstuurd
+3. **Timing overwegen** - Kies een periode die voldoende tijd geeft voor overdracht (aanbeveling: 7-14 dagen)
+
+Voor meer informatie, zie [Pre-offboarding notification event](https://docs.helloid.com/en/provisioning/notifications--provisioning-/notification-events--provisioning-.html#pre-offboarding-notification-event).
+

Notifications/create/01-manager-account-details/README.md

@@ -0,0 +1,67 @@
+# Aanmaken account – Gegevens nieuwe medewerker naar leidinggevende
+
+## Omschrijving
+
+Deze notificatie kan gebruikt worden om de leidinggevende te informeren wanneer een nieuw account wordt aangemaakt. De mail bevat de accountgegevens van de nieuwe medewerker (gebruikersnaam, e-mail, personeelsnummer, etc.), maar **geen wachtwoord** vanwege security.
+
+Het wachtwoord wordt in een aparte mail verstuurd (zie `02-manager-account-password`).
+
+## Configuratie
+
+### Event
+- **Create** - Bij het aanmaken van een account
+
+### Van
+- `no-reply@helloid.com` of een eigen domein
+- Zie [From adres configureren](https://docs.helloid.com/en/set-up-helloid.html#configure-a-custom--from--address-for-emails) voor meer informatie
+
+### Naar
+- Primaire manager
+- Variabele: `{{ Manager.Accounts.MicrosoftActiveDirectory.mail || Manager.Email || "fallbackemailadres@domein.nl" }}`
+- **Let op:** Pas `fallbackemailadres@domein.nl` aan naar een geldig e-mailadres voor jouw organisatie
+- Voor meer informatie over variabelen, zie [Notifications variable reference](https://docs.helloid.com/en/provisioning/notifications--provisioning-/notifications-variable-reference--provisioning-.html)
+
+### Onderwerp
+- `Nieuwe medewerker – {{person.displayName}}`
+
+### Filter (optioneel)
+- Filteren op specifieke afdelingen, werkgevers of andere criteria kan via custom notification events
+- Voorbeeld: Alleen voor afdeling A, B en C van het primaire contract
+- Zie [Custom notification events](https://docs.helloid.com/en/provisioning/notifications--provisioning-/custom-notification-events--conditional-notifications-.html) voor meer informatie
+
+## Gebruik
+
+### Notificatie aanmaken
+
+1. Open in HelloID Provisioning de **Notification Configuration**
+2. Klik op **Nieuwe notificatie maken**
+3. Vul de volgende velden in:
+   - **Name**: Geef de notificatie een herkenbare naam (bijv. "Create - Gegevens naar manager")
+   - **Event**: Selecteer **Create**
+   - **Target System**: Selecteer het primaire doelsysteem (bijv. Active Directory)
+   - **Notification System**: Laat staan op **Email** (standaard)
+   - **Let op:** Deze template is gemaakt voor het doelsysteem Microsoft Active Directory. Bij gebruik van een ander doelsysteem moeten de variabelen in de template aangepast worden
+
+### Template importeren
+
+4. Ga naar het tabblad **Message**
+5. Klik rechts bovenin de toolbar op het **Import MJML** icoon (download icoon)
+6. Open het bestand `template.mjml` uit deze map en kopieer de volledige inhoud
+7. Plak de MJML code in het import scherm
+8. Vervang in de code de URL `https://customer.helloid.training` (in de `mj-image src`) door de URL van je eigen HelloID portal
+9. Klik op **Import**
+
+### Configuratie invullen
+
+10. Ga naar het tabblad **Configuration**
+11. Vul de velden in zoals beschreven in de sectie **Configuratie** bovenaan deze README:
+    - **Onderwerp**
+    - **Afzender** (Van)
+    - **Ontvanger** (Naar)
+12. Configureer eventueel CC en/of BCC indien gewenst
+
+### Afronden
+
+13. Bekijk het tabblad **Message** opnieuw en pas indien nodig de inhoud verder aan
+14. Eventuele filters kunnen worden ingesteld via [custom notification events](https://docs.helloid.com/en/provisioning/notifications--provisioning-/custom-notification-events--conditional-notifications-.html)
+15. Klik op **Opslaan**

Notifications/create/01-manager-account-details/template.mjml

@@ -0,0 +1,59 @@
+<mjml>
+  <mj-body background-color="#E7E7E7">
+    <mj-section>
+      <mj-column>
+      </mj-column>
+    </mj-section>
+    <mj-section background-color="#4a8fca" padding-top="0" padding-bottom="0">
+      <mj-column width="25%">
+        <mj-image src="https://customer.helloid.training/appearance/companyicon" width="50px" height="50px">
+        </mj-image>
+      </mj-column>
+      <mj-column width="75%">
+        <mj-text font-family="Arial, Helvetica, sans-serif" font-size="14px" color="#FFFFFF" padding-top="25px" padding-bottom="25px">
+          <b>
+            Nieuwe medewerker – {{person.displayName||"Onbekend"}}
+            <br/>
+          </b>
+        </mj-text>
+      </mj-column>
+    </mj-section>
+    <mj-section background-color="#FFFFFF">
+      <mj-column width="100%">
+        <mj-text font-family="Arial, Helvetica, sans-serif" font-size="14px" color="#111111">
+          Beste {{person.primaryManager.displayName||"leidinggevende"}},
+          <br/>
+          <br/>
+          Op {{person.primaryContract.startDate}} start een nieuwe medewerker in jouw team: {{person.displayName}}.
+          <br/>
+          <br/>
+          Onderstaand de gegevens van de nieuwe medewerker inclusief de gebruikersnaam.
+          In een losse mail zal het wachtwoord van de nieuwe medewerker verstuurd worden.
+          <br/>
+          <br/>
+          Gebruikersnaam: {{data.samAccountName}}
+          <br/>
+          E-mailadres: {{data.mail||person.contact.business.email||"onbekend"}}
+          <br/>
+          Personeelsnummer: {{person.externalId}}
+          <br/>
+          Afdeling: {{person.primaryContract.department||"onbekend"}}
+          <br/>
+          Functie: {{person.primaryContract.title||"onbekend"}}
+          <br/>
+          <br/>
+          Met vriendelijke groet,
+          <br/>
+          ICT Servicedesk
+        </mj-text>
+      </mj-column>
+    </mj-section>
+    <mj-section background-color="#ffffff">
+      <mj-column width="100%">
+        <mj-text align="center" font-family="Arial, Helvetica, sans-serif" font-size="12px" color="#999999">
+          Dit is een automatisch gegenereerd bericht.
+        </mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>

Notifications/create/02-manager-account-password/README.md

@@ -0,0 +1,79 @@
+# Aanmaken account – Wachtwoord naar leidinggevende
+
+## Omschrijving
+
+Deze notificatie wordt verstuurd naar de leidinggevende als aanvulling op de eerste mail (`01-manager-account-details`). 
+
+Om security redenen wordt het wachtwoord in een **aparte mail** verstuurd. Deze mail bevat alleen:
+- De naam van de medewerker (voor context)
+- Het tijdelijke wachtwoord
+- Een reminder dat het wachtwoord moet worden aangepast bij eerste login
+
+Alle overige gegevens staan in de eerste mail.
+
+## Configuratie
+
+### Event
+- **Create** - Bij het aanmaken van een account
+
+### Van
+- `no-reply@helloid.com` of een eigen domein
+- Zie [From adres configureren](https://docs.helloid.com/en/set-up-helloid.html#configure-a-custom--from--address-for-emails) voor meer informatie
+
+### Naar
+- Primaire manager
+- Variabele: `{{ Manager.Accounts.MicrosoftActiveDirectory.mail || Manager.Email || "fallbackemailadres@domein.nl" }}`
+- **Let op:** Pas `fallbackemailadres@domein.nl` aan naar een geldig e-mailadres voor jouw organisatie
+- Voor meer informatie over variabelen, zie [Notifications variable reference](https://docs.helloid.com/en/provisioning/notifications--provisioning-/notifications-variable-reference--provisioning-.html)
+
+### Onderwerp
+- `Nieuwe medewerker – {{person.displayName}}`
+
+### Filter (optioneel)
+- Filteren kan op gegevens die op het account van het primaire doelsysteem (bijv. AD) worden geschreven
+- Voorbeeld: Alleen voor afdeling A, B en C
+- Let op: Dit zijn primaire contractgegevens
+- **Gebruik hetzelfde filter als bij `01-manager-account-details`**
+
+## Gebruik
+
+### Notificatie aanmaken
+
+1. Open in HelloID Provisioning de **Notification Configuration**
+2. Klik op **Nieuwe notificatie maken**
+3. Vul de volgende velden in:
+   - **Name**: Geef de notificatie een herkenbare naam (bijv. "Create - Wachtwoord naar manager")
+   - **Event**: Selecteer **Create**
+   - **Target System**: Selecteer het primaire doelsysteem (bijv. Active Directory)
+   - **Notification System**: Laat staan op **Email** (standaard)
+   - **Let op:** Deze template is gemaakt voor het doelsysteem Microsoft Active Directory. Bij gebruik van een ander doelsysteem moeten de variabelen in de template aangepast worden
+
+### Template importeren
+
+4. Ga naar het tabblad **Message**
+5. Klik rechts bovenin de toolbar op het **Import MJML** icoon (download icoon)
+6. Open het bestand `template.mjml` uit deze map en kopieer de volledige inhoud
+7. Plak de MJML code in het import scherm
+8. Vervang in de code de URL `https://customer.helloid.training` (in de `mj-image src`) door de URL van je eigen HelloID portal
+9. Klik op **Import**
+
+### Configuratie invullen
+
+10. Ga naar het tabblad **Configuration**
+11. Vul de velden in zoals beschreven in de sectie **Configuratie** bovenaan deze README:
+    - **Onderwerp**
+    - **Afzender** (Van)
+    - **Ontvanger** (Naar)
+12. Configureer eventueel CC en/of BCC indien gewenst
+
+### Afronden
+
+13. Bekijk het tabblad **Message** opnieuw en pas indien nodig de inhoud verder aan
+14. **Gebruik hetzelfde filter** als bij notificatie `01-manager-account-details`
+15. Klik op **Opslaan**
+
+## Aandachtspunten
+
+- Deze notificatie moet **altijd samen** met `01-manager-account-details` worden gebruikt
+- Gebruik **identieke filters** voor beide notificaties
+- Het wachtwoord is alleen beschikbaar tijdens het create event

Notifications/create/02-manager-account-password/template.mjml

@@ -0,0 +1,50 @@
+<mjml>
+  <mj-body background-color="#E7E7E7">
+    <mj-section>
+      <mj-column>
+      </mj-column>
+    </mj-section>
+    <mj-section background-color="#4a8fca" padding-top="0" padding-bottom="0">
+      <mj-column width="25%">
+        <mj-image src="https://customer.helloid.training/appearance/companyicon" width="50px" height="50px">
+        </mj-image>
+      </mj-column>
+      <mj-column width="75%">
+        <mj-text font-family="Arial, Helvetica, sans-serif" font-size="14px" color="#FFFFFF" padding-top="25px" padding-bottom="25px">
+          <b>
+            Nieuwe medewerker – {{person.displayName||"Onbekend"}}
+            <br/>
+          </b>
+        </mj-text>
+      </mj-column>
+    </mj-section>
+    <mj-section background-color="#FFFFFF">
+      <mj-column width="100%">
+        <mj-text font-family="Arial, Helvetica, sans-serif" font-size="14px" color="#111111">
+          Beste {{person.primaryManager.displayName||"leidinggevende"}},
+          <br/>
+          <br/>
+          In aanvulling op het eerdere bericht over de nieuwe medewerker {{person.displayName}}, sturen we in deze mail het tijdelijke wachtwoord.
+          <br/>
+          <br/>
+          Tijdelijk wachtwoord: {{data.password}}
+          <br/>
+          <br/>
+          Dit wachtwoord moet bij de eerste keer inloggen worden aangepast.
+          <br/>
+          <br/>
+          Met vriendelijke groet,
+          <br/>
+          ICT Servicedesk
+        </mj-text>
+      </mj-column>
+    </mj-section>
+    <mj-section background-color="#ffffff">
+      <mj-column width="100%">
+        <mj-text align="center" font-family="Arial, Helvetica, sans-serif" font-size="12px" color="#999999">
+          Dit is een automatisch gegenereerd bericht.
+        </mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>