You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/active-directory/governance/tutorial-offboard-custom-workflow-portal.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,24 @@
1
1
---
2
-
title: 'Execute employee offboarding tasks in real-time on their last day of work with Azure portal (preview)'
2
+
title: 'Execute employee off-boarding tasks in real-time on their last day of work with Azure portal (preview)'
3
3
description: Tutorial for off-boarding users from an organization using Lifecycle workflows with Azure portal (preview).
4
4
services: active-directory
5
-
author: amsliu
5
+
author: owinfreyATL
6
6
manager: amycolannino
7
7
ms.service: active-directory
8
8
ms.workload: identity
9
9
ms.topic: tutorial
10
10
ms.subservice: compliance
11
-
ms.date: 08/18/2022
12
-
ms.author: amsliu
11
+
ms.date: 03/18/2023
12
+
ms.author: owinfrey
13
13
ms.reviewer: krbain
14
14
ms.custom: template-tutorial
15
15
---
16
16
17
-
# Execute employee offboarding tasks in real-time on their last day of work with Azure portal (preview)
17
+
# Execute employee off-boarding tasks in real-time on their last day of work with Azure portal (preview)
18
18
19
19
This tutorial provides a step-by-step guide on how to execute a real-time employee termination with Lifecycle workflows using the Azure portal.
20
20
21
-
This off-boarding scenario will run a workflow on-demand and accomplish the following tasks:
21
+
This off-boarding scenario runs a workflow on-demand and accomplishes the following tasks:
22
22
23
23
1. Remove user from all groups
24
24
2. Remove user from all Teams
@@ -33,7 +33,7 @@ The Lifecycle Workflows preview requires Azure AD Premium P2. For more informati
33
33
34
34
## Before you begin
35
35
36
-
As part of the prerequisites for completing this tutorial, you'll need an account that has group and Teams memberships and that can be deleted during the tutorial. For more comprehensive instructions on how to complete these prerequisite steps, you may refer to the [Preparing user accounts for Lifecycle workflows tutorial](tutorial-prepare-azure-ad-user-accounts.md).
36
+
As part of the prerequisites for completing this tutorial, you need an account that has group and Teams memberships and that can be deleted during the tutorial. For more comprehensive instructions on how to complete these prerequisite steps, you may refer to the [Preparing user accounts for Lifecycle workflows tutorial](tutorial-prepare-azure-ad-user-accounts.md).
37
37
38
38
The leaver scenario can be broken down into the following:
39
39
-**Prerequisite:** Create a user account that represents an employee leaving your organization
@@ -55,7 +55,7 @@ Use the following steps to create a leaver on-demand workflow that will execute
55
55
6. From the templates, select **Select** under **Real-time employee termination**.
56
56
:::image type="content" source="media/tutorial-lifecycle-workflows/select-template.png" alt-text="Screenshot of selecting template leaver workflow." lightbox="media/tutorial-lifecycle-workflows/select-template.png":::
57
57
58
-
7. Next, you'll configure the basic information about the workflow. Select **Next:Review tasks** when you're done with this step.
58
+
7. Next, you configure the basic information about the workflow. Select **Next:Review tasks** when you're done with this step.
59
59
:::image type="content" source="media/tutorial-lifecycle-workflows/real-time-leaver.png" alt-text="Screenshot of review template tasks." lightbox="media/tutorial-lifecycle-workflows/real-time-leaver.png":::
60
60
61
61
8. On the following page, you may inspect the tasks if desired but no additional configuration is needed. Select **Next: Select users** when you're finished.
@@ -67,7 +67,7 @@ Use the following steps to create a leaver on-demand workflow that will execute
67
67
10. Next, select on **+Add users** to designate the users to be executed on this workflow.
68
68
:::image type="content" source="media/tutorial-lifecycle-workflows/real-time-add-users.png" alt-text="Screenshot of real time leaver add users." lightbox="media/tutorial-lifecycle-workflows/real-time-add-users.png":::
69
69
70
-
11. A panel with the list of available users will pop up on the right side of the screen. Select **Select** when you're done with your selection.
70
+
11. A panel with the list of available users pops up on the right side of the screen. Select **Select** when you're done with your selection.
71
71
:::image type="content" source="media/tutorial-lifecycle-workflows/real-time-user-list.png" alt-text="Screenshot of real time leaver template selected users." lightbox="media/tutorial-lifecycle-workflows/real-time-user-list.png":::
72
72
73
73
12. Select **Next: Review and create** when you're satisfied with your selection.
@@ -77,7 +77,7 @@ Use the following steps to create a leaver on-demand workflow that will execute
77
77
:::image type="content" source="media/tutorial-lifecycle-workflows/real-time-create.png" alt-text="Screenshot of creating real time leaver workflow." lightbox="media/tutorial-lifecycle-workflows/real-time-create.png":::
78
78
79
79
## Run the workflow
80
-
Now that the workflow is created, it will automatically run the workflow every 3 hours. Lifecycle workflows will check every 3 hours for users in the associated execution condition and execute the configured tasks for those users. However, for the tutorial, we would like to run it immediately. To run a workflow immediately, we can use the on-demand feature.
80
+
Now that the workflow is created, it will automatically run the workflow every 3 hours. Lifecycle workflows check every 3 hours for users in the associated execution condition and execute the configured tasks for those users. However, for the tutorial, we would like to run it immediately. To run a workflow immediately, we can use the on-demand feature.
81
81
82
82
>[!NOTE]
83
83
>Be aware that you currently cannot run a workflow on-demand if it is set to disabled. You need to set the workflow to enabled to use the on-demand feature.
@@ -92,12 +92,12 @@ To run a workflow on-demand, for users using the Azure portal, do the following
92
92
93
93
## Check tasks and workflow status
94
94
95
-
At any time, you may monitor the status of the workflows and the tasks. As a reminder, there are three different data pivots, users runs, and tasks that are currently available in public preview. You may learn more in the how-to guide [Check the status of a workflow (preview)](check-status-workflow.md). In the course of this tutorial, we'll look at the status using the user focused reports.
95
+
At any time, you may monitor the status of the workflows and the tasks. As a reminder, there are three different data pivots, users runs, and tasks that are currently available in public preview. You may learn more in the how-to guide [Check the status of a workflow (preview)](check-status-workflow.md). In the course of this tutorial, we look at the status using the user focused reports.
96
96
97
-
1. To begin, select the **Workflow history (Preview)** tab on the left to view the user summary and associated workflow tasks and statuses.
97
+
1. To begin, select the **Workflow history (Preview)** tab to view the user summary and associated workflow tasks and statuses.
98
98
:::image type="content" source="media/tutorial-lifecycle-workflows/workflow-history-real-time.png" alt-text="Screenshot of real time history overview." lightbox="media/tutorial-lifecycle-workflows/workflow-history-real-time.png":::
99
99
100
-
1. Once the **Workflow history (Preview)** tab has been selected, you'll land on the workflow history page as shown.
100
+
1. Once the **Workflow history (Preview)** tab has been selected, you land on the workflow history page as shown.
101
101
:::image type="content" source="media/tutorial-lifecycle-workflows/user-summary-real-time.png" alt-text="Screenshot of real time workflow history." lightbox="media/tutorial-lifecycle-workflows/user-summary-real-time.png":::
102
102
103
103
1. Next, you may select **Total tasks** for the user Jane Smith to view the total number of tasks created and their statuses. In this example, there are three total tasks assigned to the user Jane Smith.
Copy file name to clipboardExpand all lines: articles/active-directory/governance/tutorial-onboard-custom-workflow-portal.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
title: 'Automate employee onboarding tasks before their first day of work with Azure portal (preview)'
3
3
description: Tutorial for onboarding users to an organization using Lifecycle workflows with Azure portal (preview).
4
4
services: active-directory
5
-
author: amsliu
5
+
author: owinfreyATL
6
6
manager: amycolannino
7
7
ms.service: active-directory
8
8
ms.workload: identity
9
9
ms.topic: tutorial
10
10
ms.subservice: compliance
11
-
ms.date: 08/18/2022
12
-
ms.author: amsliu
11
+
ms.date: 03/18/2023
12
+
ms.author: owinfrey
13
13
ms.reviewer: krbain
14
14
ms.custom: template-tutorial
15
15
---
@@ -45,7 +45,7 @@ Detailed breakdown of the relevant attributes:
45
45
|employeeHireDate|Used to trigger the workflow|Employee|
46
46
|department|Used to provide the scope for the workflow|Employee|
47
47
48
-
The prehire scenario can be broken down into the following:
48
+
The pre-hire scenario can be broken down into the following:
49
49
-**Prerequisite:** Create two user accounts, one to represent an employee and one to represent a manager
50
50
-**Prerequisite:** Editing the attributes required for this scenario in the portal
51
51
-**Prerequisite:** Edit the attributes for this scenario using Microsoft Graph Explorer
@@ -54,8 +54,8 @@ The prehire scenario can be broken down into the following:
54
54
- Triggering the workflow
55
55
- Verifying the workflow was successfully executed
56
56
57
-
## Create a workflow using pre-hire template
58
-
Use the following steps to create a prehire workflow that will generate a TAP and send it via email to the user's manager using the Azure portal.
57
+
## Create a workflow using prehire template
58
+
Use the following steps to create a pre-hire workflow that generates a TAP and send it via email to the user's manager using the Azure portal.
59
59
60
60
1. Sign in to Azure portal.
61
61
2. On the right, select **Azure Active Directory**.
@@ -67,11 +67,11 @@ Use the following steps to create a prehire workflow that will generate a TAP an
67
67
6. From the templates, select **select** under **Onboard pre-hire employee**.
68
68
:::image type="content" source="media/tutorial-lifecycle-workflows/select-template.png" alt-text="Screenshot of selecting workflow template." lightbox="media/tutorial-lifecycle-workflows/select-template.png":::
69
69
70
-
7. Next, you'll configure the basic information about the workflow. This information includes when the workflow triggers, known as **Days from event**. So in this case, the workflow triggers two days before the employee's hire date. On the onboard prehire employee screen, add the following settings and then select **Next: Configure Scope**.
70
+
7. Next, you configure the basic information about the workflow. This information includes when the workflow triggers, known as **Days from event**. So in this case, the workflow triggers two days before the employee's hire date. On the onboard pre-hire employee screen, add the following settings and then select **Next: Configure Scope**.
71
71
72
72
:::image type="content" source="media/tutorial-lifecycle-workflows/configure-scope.png" alt-text="Screenshot of selecting a configuration scope." lightbox="media/tutorial-lifecycle-workflows/configure-scope.png":::
73
73
74
-
8. Next, you'll configure the scope. The scope determines which users this workflow runs against. In this case, it is on all users in the Sales department. On the configure scope screen, under **Rule** add the following settings and then select **Next: Review tasks**. For a full list of supported user properties, see [Supported user properties and query parameters](/graph/api/resources/identitygovernance-rulebasedsubjectset?view=graph-rest-beta&preserve-view=true#supported-user-properties-and-query-parameters).
74
+
8. Next, you configure the scope. The scope determines which users this workflow runs against. In this case, it is on all users in the Sales department. On the configure scope screen, under **Rule** add the following settings and then select **Next: Review tasks**. For a full list of supported user properties, see [Supported user properties and query parameters](/graph/api/resources/identitygovernance-rulebasedsubjectset?view=graph-rest-beta&preserve-view=true#supported-user-properties-and-query-parameters).
75
75
76
76
:::image type="content" source="media/tutorial-lifecycle-workflows/review-tasks.png" alt-text="Screenshot of selecting review tasks." lightbox="media/tutorial-lifecycle-workflows/review-tasks.png":::
77
77
@@ -99,12 +99,12 @@ To run a workflow on-demand, for users using the Azure portal, do the following
99
99
100
100
## Check tasks and workflow status
101
101
102
-
At any time, you may monitor the status of the workflows and the tasks. As a reminder, there are three different data pivots, users runs, and tasks that are currently available in public preview. You may learn more in the how-to guide [Check the status of a workflow (preview)](check-status-workflow.md). In the course of this tutorial, we'll look at the status using the user focused reports.
102
+
At any time, you may monitor the status of the workflows and the tasks. As a reminder, there are three different data pivots, users runs, and tasks that are currently available in public preview. You may learn more in the how-to guide [Check the status of a workflow (preview)](check-status-workflow.md). In the course of this tutorial, we look at the status using the user focused reports.
103
103
104
-
1. To begin, select the **Workflow history (Preview)** tab on the left to view the user summary and associated workflow tasks and statuses.
104
+
1. To begin, select the **Workflow history (Preview)** tab to view the user summary and associated workflow tasks and statuses.
105
105
:::image type="content" source="media/tutorial-lifecycle-workflows/workflow-history.png" alt-text="Screenshot of workflow History status." lightbox="media/tutorial-lifecycle-workflows/workflow-history.png":::
106
106
107
-
1. Once the **Workflow history (Preview)** tab has been selected, you'll land on the workflow history page as shown.
107
+
1. Once the **Workflow history (Preview)** tab has been selected, you land on the workflow history page as shown.
108
108
:::image type="content" source="media/tutorial-lifecycle-workflows/user-summary.png" alt-text="Screenshot of workflow history overview" lightbox="media/tutorial-lifecycle-workflows/user-summary.png":::
109
109
110
110
1. Next, you may select **Total tasks** for the user Jane Smith to view the total number of tasks created and their statuses. In this example, there are three total tasks assigned to the user Jane Smith.
Copy file name to clipboardExpand all lines: articles/active-directory/governance/tutorial-prepare-azure-ad-user-accounts.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,20 @@
2
2
title: 'Tutorial: Preparing user accounts for Lifecycle workflows (preview)'
3
3
description: Tutorial for preparing user accounts for Lifecycle workflows (preview).
4
4
services: active-directory
5
-
author: amsliu
5
+
author: owinfreyATL
6
6
manager: amycolannino
7
7
ms.service: active-directory
8
8
ms.workload: identity
9
9
ms.topic: tutorial
10
10
ms.subservice: compliance
11
-
ms.date: 06/13/2022
12
-
ms.author: amsliu
11
+
ms.date: 03/18/2023
12
+
ms.author: owinfrey
13
13
ms.reviewer: krbain
14
14
ms.custom: template-tutorial
15
15
---
16
16
# Preparing user accounts for Lifecycle workflows tutorials (Preview)
17
17
18
-
For the on-boarding and off-boarding tutorials you'll need accounts for which the workflows will be executed, the following section will help you prepare these accounts, if you already have test accounts that meet the following requirements you can proceed directly to the on-boarding and off-boarding tutorials. Two accounts are required for the on-boarding tutorials, one account for the new hire and another account that acts as the manager of the new hire. The new hire account must have the following attributes set:
18
+
For the on-boarding and off-boarding tutorials you need accounts for which the workflows will be executed, the following section helps you prepare these accounts, if you already have test accounts that meet the following requirements you can proceed directly to the on-boarding and off-boarding tutorials. Two accounts are required for the on-boarding tutorials, one account for the new hire and another account that acts as the manager of the new hire. The new hire account must have the following attributes set:
19
19
20
20
- employeeHireDate must be set to today
21
21
- department must be set to sales
@@ -27,30 +27,30 @@ The off-boarding tutorials only require one account that has group and Teams mem
- A global administrator account for the Azure AD tenant. This account will be used to create our users and workflows.
30
+
- A global administrator account for the Azure AD tenant. This account is used to create our users and workflows.
31
31
32
32
## Before you begin
33
33
34
-
In most cases, users are going to be provisioned to Azure AD either from an on-premises solution (Azure AD Connect, Cloud sync, etc.) or with an HR solution. These users will have the attributes and values populated at the time of creation. Setting up the infrastructure to provision users is outside the scope of this tutorial. For information, see [Tutorial: Basic Active Directory environment](../cloud-sync/tutorial-basic-ad-azure.md) and [Tutorial: Integrate a single forest with a single Azure AD tenant](../cloud-sync/tutorial-single-forest.md)
34
+
In most cases, users are going to be provisioned to Azure AD either from an on-premises solution (Azure AD Connect, Cloud sync, etc.) or with an HR solution. These users have the attributes and values populated at the time of creation. Setting up the infrastructure to provision users is outside the scope of this tutorial. For information, see [Tutorial: Basic Active Directory environment](../cloud-sync/tutorial-basic-ad-azure.md) and [Tutorial: Integrate a single forest with a single Azure AD tenant](../cloud-sync/tutorial-single-forest.md)
35
35
36
36
## Create users in Azure AD
37
37
38
-
We'll use the Graph Explorer to quickly create two users needed to execute the Lifecycle Workflows in the tutorials. One user will represent our new employee and the second will represent the new employee's manager.
38
+
We use the Graph Explorer to quickly create two users needed to execute the Lifecycle Workflows in the tutorials. One user represents our new employee and the second represents the new employee's manager.
39
39
40
-
You'll need to edit the POST and replace the <your tenant name here> portion with the name of your tenant. For example: $UPN_manager = "bsimon@<your tenant name here>" to $UPN_manager = "[email protected]".
40
+
You need to edit the POST and replace the <your tenant name here> portion with the name of your tenant. For example: $UPN_manager = "bsimon@<your tenant name here>" to $UPN_manager = "[email protected]".
41
41
42
42
>[!NOTE]
43
43
>Be aware that a workflow will not trigger when the employee hire date (Days from event) is prior to the workflow creation date. You must set a employeeHiredate in the future by design. The dates used in this tutorial are a snapshot in time. Therefore, you should change the dates accordingly to accommodate for this situation.
44
44
45
-
First we'll create our employee, Melva Prince.
45
+
First we create our employee, Melva Prince.
46
46
47
47
1. Now navigate to [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer).
48
48
2. Sign-in to Graph Explorer with the global administrator account for your tenant.
49
49
3. At the top, change **GET** to **POST** and add `https://graph.microsoft.com/v1.0/users/` to the box.
50
50
4. Copy the code below in to the **Request body**
51
51
5. Replace `<your tenant here>` in the code below with the value of your Azure AD tenant.
52
52
6. Select **Run query**
53
-
7. Copy the ID that is returned in the results. This will be used later to assign a manager.
53
+
7. Copy the ID that is returned in the results. This is used later to assign a manager.
:::image type="content" source="media/tutorial-lifecycle-workflows/graph-post-user.png" alt-text="Screenshot of POST create Melva in graph explorer." lightbox="media/tutorial-lifecycle-workflows/graph-post-user.png":::
71
71
72
-
Next, we'll create Britta Simon. This is the account that will be used as our manager.
72
+
Next, we create Britta Simon. This is the account that will be used as our manager.
73
73
74
74
1. Still in [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer).
75
75
2. Make sure the top is still set to **POST** and `https://graph.microsoft.com/v1.0/users/` is in the box.
0 commit comments