Skip to content

Commit 146fcca

Browse files
Merge pull request #229579 from OWinfreyATL/owinfreyATL-CustomizeEmails
Customize Email Updates
2 parents fdc1754 + 7c60b24 commit 146fcca

File tree

9 files changed

+286
-31
lines changed

9 files changed

+286
-31
lines changed
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
title: Customize emails sent out by workflow tasks
3+
description: A step by step guide for customizing emails sent out using tasks within Lifecycle Workflows
4+
author: owinfreyATL
5+
ms.author: owinfrey
6+
manager: amycolannino
7+
ms.service: active-directory
8+
ms.subservice: compliance
9+
ms.topic: how-to
10+
ms.date: 02/06/2023
11+
ms.custom: template-how-to
12+
---
13+
14+
# Customize emails sent out by workflow tasks (Preview)
15+
16+
Lifecycle Workflows provide several tasks that send out email notifications. Email notifications can be customized to suit the needs of a specific workflow. For a list of these tasks, see: [Lifecycle Workflows tasks and definitions (Preview)](lifecycle-workflow-tasks.md).
17+
18+
Emails tasks allow for the customization of the following aspects:
19+
20+
- Additional CC recipients
21+
- Sender domain
22+
- Organizational branding of the email
23+
- Subject
24+
- Message body
25+
- Email language
26+
27+
> [!NOTE]
28+
> To avoid additional security disclaimers, you should opt in to using customized domain and organizational branding.
29+
30+
For more information on these customizable parameters, see: [Common email task parameters](lifecycle-workflow-tasks.md#common-email-task-parameters).
31+
32+
## Prerequisites
33+
34+
- Azure AD Premium P2
35+
36+
For more information, see: [License requirements](what-are-lifecycle-workflows.md#license-requirements)
37+
38+
## Customize email using the Azure portal
39+
40+
When customizing an email sent via Lifecycle workflows, you can choose to customize either a new or existing task. These customizations are done the same way no matter if the task is new or existing, but the following steps walk you through updating an existing task. To customize emails sent out from tasks within workflows using the Azure portal, you'd follow these steps:
41+
42+
1. Sign in to the [Azure portal](https://portal.azure.com).
43+
44+
1. Type in **Identity Governance** in the search bar near the top of the page, and select it.
45+
46+
1. In the left menu, select **Lifecycle workflows (Preview)**.
47+
48+
1. In the left menu, select **workflows (Preview)**.
49+
50+
1. On the left side of the screen, select **Tasks (Preview)**.
51+
52+
1. On the tasks screen, select the task for which you want to customize the email.
53+
54+
1. On the specific task screen, you're able to set CC to include others in the email outside of the default audience.
55+
56+
1. Select the **Email Customization** tab.
57+
58+
1. On the email customization screen, enter a custom subject, message body, and the email language translation option that will be used to translate the message body of the email.
59+
:::image type="content" source="media/customize-workflow-email/customize-workflow-email-example.png" alt-text="Screenshot of an example of a customized email from a workflow.":::
60+
1. After making changes, select **save** to capture changes to the customized email.
61+
62+
63+
## Format attributes within customized emails
64+
65+
To further personalize customized emails, you can take advantage of dynamic attributes. With dynamic attributes by placing in specific attributes, you're able to specifically call out values such as a user's name, their generated Temporary Access Pass, or even their manager's email.
66+
67+
To use dynamic attributes within your customized emails, you must follow the formatting rules within the customized email. The proper format is:
68+
69+
{{**dynamic attribute**}}
70+
71+
The following screenshot is an example of the proper format for dynamic attributes within a customized email:
72+
73+
:::image type="content" source="media/customize-workflow-email/workflow-dynamic-attribute-example.png" alt-text="Screenshot of an example of dynamic attributes within a customized email.":::
74+
75+
When typing this it's written the following way:
76+
77+
```html
78+
Welcome to the team, {{userGivenName}}
79+
80+
We're excited to have you join our growing team and look forward to a successful and memorable journey together.
81+
82+
We've already set up a few things to help you get started quickly and make your onboarding process as smooth as possible.
83+
84+
For more information and next steps, please contact your manager, {{managerDisplayName}}
85+
86+
```
87+
88+
For a full list of dynamic attributes that can be used with customized emails, see:[Dynamic attributes within email](lifecycle-workflow-tasks.md#dynamic-attributes-within-email).
89+
90+
## Use custom branding and domain in emails sent out using workflows
91+
92+
Emails sent out using Lifecycle workflows can be customized to have your own company branding, and be sent out using your company domain. When you opt in to using custom branding and domain, every email sent out using Lifecycle Workflows reflect these settings. To enable these features the following prerequisites are required:
93+
94+
- A verified domain. To add a custom domain, see: [Managing custom domain names in your Azure Active Directory](../enterprise-users/domains-manage.md)
95+
- Custom Branding set within Azure AD if you want to have your custom branding used in emails. To set organizational branding within your Azure tenant, see: [Configure your company branding (preview)](../fundamentals/how-to-customize-branding.md).
96+
97+
After these prerequisites are satisfied, you'd follow these steps:
98+
99+
1. On the Lifecycle workflows page, select **Workflow settings (Preview)**.
100+
101+
1. On the settings page, with **email domain** you're able to select your domain from a drop-down list of your verified domains.
102+
:::image type="content" source="media/customize-workflow-email/workflow-email-settings.png" alt-text="Screenshot of workflow domain settings.":::
103+
1. With the Use company branding banner logo setting, you're able to turn on whether or not company branding is used in emails.
104+
:::image type="content" source="media/customize-workflow-email/customize-email-logo-setting.png" alt-text="Screenshot of email logo setting.":::
105+
106+
107+
## Customize email using Microsoft Graph
108+
109+
To customize email using Microsoft Graph API see: [workflow: createNewVersion](/graph/api/identitygovernance-workflow-createnewversion).
110+
111+
## Set custom branding and domain workflow settings in Lifecycle Workflows using Microsoft Graph
112+
113+
To turn on custom branding and domain feature settings in Lifecycle Workflows using Microsoft Graph API, see: [lifecycleManagementSettings resource type](/graph/api/resources/identitygovernance-lifecyclemanagementsettings)
114+
115+
## Next steps
116+
117+
- [Lifecycle Workflow tasks](lifecycle-workflow-tasks.md)
118+
- [Manage workflow versions](manage-workflow-tasks.md)
119+
120+

articles/active-directory/governance/lifecycle-workflow-history.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Task detailed history information allows you to filter for specific information
113113
- **Completed date**: You can filter a specific range from as short as 24 hours up to 30 days of when the workflow ran.
114114
- **Tasks**: You can filter based on specific task names.
115115

116-
Separating processing of the workflow from the tasks is important because, in a workflow, processing a user certain tasks could be successful, while others could fail. Whether or not a task runs after a failed task in a workflow depends on parameters such as enabling continue On Error, and their placement within the workflow. For more information, see [Common task parameters (preview)](lifecycle-workflow-tasks.md#common-task-parameters-preview).
116+
Separating processing of the workflow from the tasks is important because, in a workflow, processing a user certain tasks could be successful, while others could fail. Whether or not a task runs after a failed task in a workflow depends on parameters such as enabling continue On Error, and their placement within the workflow. For more information, see [Common task parameters (preview)](lifecycle-workflow-tasks.md#common-task-parameters).
117117

118118
## Next steps
119119

0 commit comments

Comments
 (0)