Skip to content

Commit 090e81c

Browse files
authored
Merge pull request #217601 from OWinfreyATL/owinfreyATL-LCW-onboarding-task
Onboarding reminder email task added and updated images
2 parents 3189480 + d86035e commit 090e81c

18 files changed

+58
-20
lines changed

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

Lines changed: 55 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ Common task parameters are the non-unique parameters contained in every task. Wh
3333
|Parameter |Definition |
3434
|---------|---------|
3535
|category | A read-only string that identifies the category or categories of the task. Automatically determined when the taskDefinitionID is chosen. |
36-
|taskDefinitionId | A string referencing a taskDefinition which determines which task to run. |
36+
|taskDefinitionId | A string referencing a taskDefinition that determines which task to run. |
3737
|isEnabled | A boolean value that denotes whether the task is set to run or not. If set to “true" then the task will run. Defaults to true. |
3838
|displayName | A unique string that identifies the task. |
3939
|description | A string that describes the purpose of the task for administrative use. (Optional) |
40-
|executionSequence | An integer that is read-only which states in what order the task will run in a workflow. For more information about executionSequence and workflow order, see: [Configure Scope](understanding-lifecycle-workflows.md#configure-scope). |
40+
|executionSequence | A read-only integer that states in what order the task will run in a workflow. For more information about executionSequence and workflow order, see: [Configure Scope](understanding-lifecycle-workflows.md#configure-scope). |
4141
|continueOnError | A boolean value that determines if the failure of this task stops the subsequent workflows from running. |
4242
|arguments | Contains unique parameters relevant for the given task. |
4343

@@ -52,7 +52,7 @@ Below is each specific task, and detailed information such as parameters and pre
5252

5353

5454
Lifecycle Workflows allow you to automate the sending of welcome emails to new hires in your organization. You're able to customize the task name and description for this task in the Azure portal.
55-
:::image type="content" source="media/lifecycle-workflow-task/email-task.png" alt-text="Screenshot of Workflows task: Email task.":::
55+
:::image type="content" source="media/lifecycle-workflow-task/welcome-email-task.png" alt-text="Screenshot of Workflows task: Welcome email task.":::
5656

5757

5858
The Azure AD prerequisite to run the **Send welcome email to new hire** task is:
@@ -84,11 +84,48 @@ For Microsoft Graph the parameters for the **Send welcome email to new hire** ta
8484
8585
```
8686

87+
### Send onboarding reminder email
88+
89+
90+
Lifecycle Workflows allow you to automate the sending of onboarding reminder emails to managers of new hires in your organization. You're able to customize the task name and description for this task in the Azure portal.
91+
:::image type="content" source="media/lifecycle-workflow-task/send-onboarding-reminder-email.png" alt-text="Screenshot of Workflows task: Send onboarding reminder email task.":::
92+
93+
94+
The Azure AD prerequisite to run the **Send onboarding reminder email** task is:
95+
96+
- A populated manager attribute for the user.
97+
- A populated manager's mail attribute for the user.
98+
99+
100+
For Microsoft Graph the parameters for the **Send onboarding reminder email** task are as follows:
101+
102+
|Parameter |Definition |
103+
|---------|---------|
104+
|category | joiner |
105+
|displayName | Send onboarding reminder email (Customizable by user) |
106+
|description | Send onboarding reminder email to user’s manager (Customizable by user) |
107+
|taskDefinitionId | 3C860712-2D37-42A4-928F-5C93935D26A1 |
108+
109+
110+
111+
```Example for usage within the workflow
112+
{
113+
"category": "joiner",
114+
"continueOnError": true,
115+
"description": "Send onboarding reminder email to user’s manager",
116+
"displayName": "Send onboarding reminder email",
117+
"isEnabled": true,
118+
"taskDefinitionId": "3C860712-2D37-42A4-928F-5C93935D26A1",
119+
"arguments": []
120+
}
121+
122+
```
123+
87124
### Generate Temporary Access Pass and send via email to user's manager
88125

89-
When a compatible user joins your organization, Lifecycle Workflows allow you to automatically generate a Temporary Access Pass(TAP) and have it sent to the new user's manager.
126+
When a compatible user joins your organization, Lifecycle Workflows allow you to automatically generate a Temporary Access Pass(TAP), and have it sent to the new user's manager.
90127

91-
With this task in the Azure portal, you're able to give the task a name and description. You must also set the following:
128+
With this task in the Azure portal, you're able to give the task a name and description. You must also set:
92129

93130
**Activation duration**- How long the password is active.
94131
**One time use**- If the password is one use only.
@@ -154,11 +191,11 @@ For Microsoft Graph the parameters for the **Add user to groups** task are as fo
154191

155192
|Parameter |Definition |
156193
|---------|---------|
157-
|category | joiner,leaver |
194+
|category | joiner, leaver |
158195
|displayName | AddUserToGroup (Customizable by user) |
159196
|description | Add user to groups (Customizable by user) |
160197
|taskDefinitionId | 22085229-5809-45e8-97fd-270d28d66910 |
161-
|arguments | Argument contains a name parameter that is the "groupID", and a value parameter which is the group ID of the group you are adding the user to. |
198+
|arguments | Argument contains a name parameter that is the "groupID", and a value parameter that is the group ID of the group you're adding the user to. |
162199

163200

164201
```Example for usage within the workflow
@@ -190,11 +227,11 @@ For Microsoft Graph the parameters for the **Add user to teams** task are as fol
190227

191228
|Parameter |Definition |
192229
|---------|---------|
193-
|category | joiner,leaver |
230+
|category | joiner, leaver |
194231
|displayName | AddUserToTeam (Customizable by user) |
195232
|description | Add user to teams (Customizable by user) |
196233
|taskDefinitionId | e440ed8d-25a1-4618-84ce-091ed5be5594 |
197-
|argument | Argument contains a name parameter that is the "teamID", and a value parameter which is the team ID of the existing team you are adding a user to. |
234+
|argument | Argument contains a name parameter that is the "teamID", and a value parameter that is the team ID of the existing team you're adding a user to. |
198235

199236

200237

@@ -227,7 +264,7 @@ For Microsoft Graph the parameters for the **Enable user account** task are as f
227264

228265
|Parameter |Definition |
229266
|---------|---------|
230-
|category | joiner,leaver |
267+
|category | joiner, leaver |
231268
|displayName | EnableUserAccount (Customizable by user) |
232269
|description | Enable user account (Customizable by user) |
233270
|taskDefinitionId | 6fc52c9d-398b-4305-9763-15f42c1676fc |
@@ -261,11 +298,11 @@ For Microsoft Graph the parameters for the **Run a Custom Task Extension** task
261298

262299
|Parameter |Definition |
263300
|---------|---------|
264-
|category | joiner,leaver |
301+
|category | joiner, leaver |
265302
|displayName | Run a Custom Task Extension (Customizable by user) |
266303
|description | Run a Custom Task Extension to call-out to an external system. (Customizable by user) |
267304
|taskDefinitionId | "d79d1fcc-16be-490c-a865-f4533b1639ee |
268-
|argument | Argument contains a name parameter that is the "LogicAppURL", and a value parameter which is the Logic App HTTP trigger. |
305+
|argument | Argument contains a name parameter that is the "LogicAppURL", and a value parameter that is the Logic App HTTP trigger. |
269306

270307

271308

@@ -301,7 +338,7 @@ For Microsoft Graph the parameters for the **Disable user account** task are as
301338

302339
|Parameter |Definition |
303340
|---------|---------|
304-
|category | joiner,leaver |
341+
|category | joiner, leaver |
305342
|displayName | DisableUserAccount (Customizable by user) |
306343
|description | Disable user account (Customizable by user) |
307344
|taskDefinitionId | 1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 |
@@ -337,7 +374,7 @@ For Microsoft Graph the parameters for the **Remove user from selected groups**
337374
|displayName | Remove user from selected groups (Customizable by user) |
338375
|description | Remove user from membership of selected Azure AD groups (Customizable by user) |
339376
|taskDefinitionId | 1953a66c-751c-45e5-8bfe-01462c70da3c |
340-
|argument | Argument contains a name parameter that is the "groupID", and a value parameter which is the group Id(s) of the group or groups you are removing the user from. |
377+
|argument | Argument contains a name parameter that is the "groupID", and a value parameter that is the group Id(s) of the group or groups you're removing the user from. |
341378

342379

343380

@@ -361,7 +398,7 @@ For Microsoft Graph the parameters for the **Remove user from selected groups**
361398

362399
### Remove users from all groups
363400

364-
Allows users to be removed from every cloud-only group they are a member of. Dynamic and Privileged Access Groups not supported. To control access to on-premises applications and resources, you need to enable group writeback. For more information, see [Azure AD Connect group writeback](../hybrid/how-to-connect-group-writeback-v2.md).
401+
Allows users to be removed from every cloud-only group they're a member of. Dynamic and Privileged Access Groups not supported. To control access to on-premises applications and resources, you need to enable group writeback. For more information, see [Azure AD Connect group writeback](../hybrid/how-to-connect-group-writeback-v2.md).
365402

366403

367404
You're able to customize the task name and description for this task in the Azure portal.
@@ -402,11 +439,11 @@ For Microsoft Graph the parameters for the **Remove User from Teams** task are a
402439

403440
|Parameter |Definition |
404441
|---------|---------|
405-
|category | joiner,leaver |
442+
|category | joiner, leaver |
406443
|displayName | Remove user from selected Teams (Customizable by user) |
407444
|description | Remove user from membership of selected Teams (Customizable by user) |
408445
|taskDefinitionId | 06aa7acb-01af-4824-8899-b14e5ed788d6 |
409-
|arguments | Argument contains a name parameter that is the "teamID", and a value parameter which is the Teams ID of the Teams you are removing the user from. |
446+
|arguments | Argument contains a name parameter that is the "teamID", and a value parameter that is the Teams ID of the Teams you're removing the user from. |
410447

411448

412449
```Example for usage within the workflow
@@ -429,7 +466,7 @@ For Microsoft Graph the parameters for the **Remove User from Teams** task are a
429466

430467
### Remove users from all teams
431468

432-
Allows users to be removed from every static team they are a member of. You're able to customize the task name and description for this task in the Azure portal.
469+
Allows users to be removed from every static team they're a member of. You're able to customize the task name and description for this task in the Azure portal.
433470
:::image type="content" source="media/lifecycle-workflow-task/remove-user-all-team-task.png" alt-text="Screenshot of Workflows task: remove user from all teams.":::
434471

435472
For Microsoft Graph the parameters for the **Remove users from all teams** task are as follows:
-18.4 KB
Loading
-10.1 KB
Loading
-300 KB
Loading
-934 Bytes
Loading
Binary file not shown.
-4.6 KB
Loading
-297 KB
Loading
-2.63 KB
Loading
-690 KB
Loading

0 commit comments

Comments
 (0)