Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 132 additions & 0 deletions Notifications/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# HelloID Provisioning – Notification Templates

This folder contains reusable MJML templates for notifications in HelloID Provisioning.

The notifications are based on:
- Standard HelloID notification templates
- Practical experience from customer implementations
- Deliberate scope to prevent email overload

The templates are intended as a starting point. They can be imported into HelloID per customer and customized there, for example for recipients, filters, or subject.

---

## Structure

Notifications are organized by provisioning event:

```
notifications/
create/
enable/
update/
disable/
pre-offboard/
```

Within each event there are one or more variants.
Each variant has its own folder with:

- `template_en.mjml`
The complete MJML template that can be imported directly into HelloID (English version).

- `template_nl.mjml`
The complete MJML template that can be imported directly into HelloID (Dutch version).

- `README.md`
Explanation of purpose, recipient, usage and important notes for the notification.

The numbering (`01-`, `02-`, …) makes the sequence and relationships explicit and ensures that extensions can be added easily later.

---

## Notification Overview

### Create
Notifications sent when an account is created.

- **[01-manager-account-details](create/01-manager-account-details)**
Informs the manager about the account details of a new employee (without password)

- **[02-manager-account-password](create/02-manager-account-password)**
Sends the temporary password in a separate email to the manager (for security)

- **[03-applicatiebeheer-nieuwe-medewerker](create/03-applicatiebeheer-nieuwe-medewerker)**
Notification to application management about new employee for manual access provisioning

### Enable
Notifications sent when an account is activated.

- **[01-welkom-medewerker](enable/01-welkom-medewerker)**
Welcome email to new employee with instructions to set password via SSPR

- **[02-welkom-medewerker-sspr](enable/02-welkom-medewerker-sspr)**
Extended variant with detailed SSPR instructions (helps reduce support questions)

### Update
Notifications for changes to existing accounts.

- **[01-afdelingswijziging-applicatiebeheer](update/01-afdelingswijziging-applicatiebeheer)**
Notification to application management on department change for access management

### Pre-offboard
Notifications prior to employee exit.

- **[01-reminder-uitdienst-manager](pre-offboard/01-reminder-uitdienst-manager)**
Reminds manager X days before end date of employee exit for timely handover

### Disable
Notifications when accounts are disabled.

- **[01-uitdienst-applicatiebeheer](disable/01-uitdienst-applicatiebeheer)**
Informs application management of employee exit for manual account deactivation

---

## Usage

### General

Each notification has its own README with detailed instructions. The general steps are:

1. Open **Notification Configuration** in HelloID Provisioning
2. Click **Create New Notification**
3. Fill in the basic fields (Name, Event, Target System)
4. Import the `template_en.mjml` (English) or `template_nl.mjml` (Dutch) via the **Import MJML** icon (download icon)
5. Replace the URL `https://customer.helloid.com` with your own HelloID portal URL if needed
6. Configure recipient(s), subject and any filters
7. Thoroughly test the notification before deploying to production

**Note:** All templates are created for the **Microsoft Active Directory** target system. If using a different target system, the variables in the templates must be adjusted.

### Configure From Address

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).

69 changes: 69 additions & 0 deletions Notifications/create/01-manager-account-details/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Create Account – Employee Details to Manager

## Description

This notification informs the manager when a new account is created. The email contains the account details of the new employee (username, email, employee number, etc.), but **no password** for security reasons.

The password is sent in a separate email (see `02-manager-account-password`).

## Configuration

### Event
- **Create** - When an account is created

### From
- `no-reply@helloid.com` or a custom domain
- See [Configure a custom 'from' address for emails](https://docs.helloid.com/en/set-up-helloid.html#configure-a-custom--from--address-for-emails) for more information

### To
- Primary manager
- Variable: `{{ Manager.Accounts.MicrosoftActiveDirectory.mail || Manager.Email || "fallbackemailadres@domain.com" }}`
- **Note:** Update `fallbackemailadres@domain.com` to a valid email address for your organization
- For more information about variables, see [Notifications variable reference](https://docs.helloid.com/en/provisioning/notifications--provisioning-/notifications-variable-reference--provisioning-.html)

### Subject
- `New employee – {{person.displayName}}`

### Filter (optional)
- Filter on specific departments, employers, or other criteria via custom notification events
- Example: Only for departments A, B, and C of the primary contract
- See [Custom notification events](https://docs.helloid.com/en/provisioning/notifications--provisioning-/custom-notification-events--conditional-notifications-.html) for more information

## Usage

### Create Notification

1. Open **Notification Configuration** in HelloID Provisioning
2. Click **Create New Notification**
3. Fill in the following fields:
- **Name**: Give the notification a recognizable name (e.g., "Create - Employee Details to Manager")
- **Event**: Select **Create**
- **Target System**: Select the primary target system (e.g., Active Directory)
- **Notification System**: Leave as **Email** (default)
- **Note:** This template is created for Microsoft Active Directory. If using a different target system, the variables in the template must be adjusted

### Import Template

4. Go to the **Message** tab
5. Click the **Import MJML** icon (download icon) in the toolbar on the right
6. Open one of the template files from this folder and copy the full content:
- [template_nl.mjml](template_nl.mjml) - Dutch version
- [template_en.mjml](template_en.mjml) - English version
7. Paste the MJML code into the import screen
8. Replace the URL `https://customer.helloid.com` in the code with your own HelloID portal URL if needed
9. Click **Import**

### Configure Settings

10. Go to the **Configuration** tab
11. Fill in the fields as described in the **Configuration** section above:
- **Subject**
- **From** (From address)
- **To** (Recipient)
12. Configure CC and/or BCC if desired

### Finalize

13. Review the **Message** tab again and adjust the content if needed
14. Optional filters can be set via [custom notification events](https://docs.helloid.com/en/provisioning/notifications--provisioning-/custom-notification-events--conditional-notifications-.html)
15. Click **Save**
59 changes: 59 additions & 0 deletions Notifications/create/01-manager-account-details/template_en.mjml
Original file line number Diff line number Diff line change
@@ -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.com/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>
New employee – {{person.displayName||"Unknown"}}
<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">
Dear {{person.primaryManager.displayName||"manager"}},
<br/>
<br/>
A new employee will start in your team on {{person.primaryContract.startDate}}: {{person.displayName}}.
<br/>
<br/>
Below are the details of the new employee including the username.
The password for the new employee will be sent in a separate email.
<br/>
<br/>
Username: {{data.samAccountName}}
<br/>
Email address: {{data.mail||person.contact.business.email||"unknown"}}
<br/>
Personnel number: {{person.externalId}}
<br/>
Department: {{person.primaryContract.department||"unknown"}}
<br/>
Position: {{person.primaryContract.title||"unknown"}}
<br/>
<br/>
Kind regards,
<br/>
ICT Helpdesk
</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">
This is an automatically generated message.
</mj-text>
</mj-column>
</mj-section>
</mj-body>
</mjml>
59 changes: 59 additions & 0 deletions Notifications/create/01-manager-account-details/template_nl.mjml
Original file line number Diff line number Diff line change
@@ -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.com/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>
Loading