Skip to content

Commit ce4615a

Browse files
Merge pull request #230175 from OWinfreyATL/owinfreyATL-ExecutionScope
Execution scope and offset updates
2 parents a6cc19e + 85e0809 commit ce4615a

12 files changed

+86
-130
lines changed

.openpublishing.redirection.active-directory.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,11 @@
9595
"redirect_url": "/graph/tutorial-lifecycle-workflows-onboard-custom-workflow",
9696
"redirect_document_id": false
9797
},
98+
{
99+
"source_path_from_root": "/articles/active-directory/governance/manage-lifecycle-workflows.md",
100+
"redirect_url": "/azure/active-directory/governance/understanding-lifecycle-workflows",
101+
"redirect_document_id": false
102+
},
98103
{
99104
"source_path_from_root": "/articles/active-directory/governance/lifecycle-workflows-developer-reference.md",
100105
"redirect_url": "/graph/api/resources/identitygovernance-workflow",

articles/active-directory/governance/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,8 @@
236236
href: on-demand-workflow.md
237237
- name: Check the status of a workflow
238238
href: check-status-workflow.md
239+
- name: Check execution user scope
240+
href: check-workflow-execution-scope.md
239241
- name: Customize the schedule of workflows
240242
href: customize-workflow-schedule.md
241243
- name: Delete
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: 'Check execution user scope of a workflow - Azure Active Directory'
3+
description: Describes how to check the users who fall into the execution scope of a Lifecycle Workflow.
4+
services: active-directory
5+
author: owinfreyATL
6+
manager: amycolannino
7+
ms.service: active-directory
8+
ms.workload: identity
9+
ms.topic: how-to
10+
ms.date: 03/09/2023
11+
ms.subservice: compliance
12+
ms.author: owinfrey
13+
ms.reviewer: krbain
14+
ms.collection: M365-identity-device-management
15+
---
16+
17+
# Check execution user scope of a workflow (Preview)
18+
19+
Workflow scheduling will automatically process the workflow for users meeting the workflows execution conditions. This article walks you through the steps to check the users who fall into the execution scope of a workflow. For more information about execution conditions, see: [workflow basics](../governance/understanding-lifecycle-workflows.md#workflow-basics).
20+
21+
## Check execution user scope of a workflow using the Azure portal
22+
23+
To check the users who fall under the execution scope of a workflow, you'd follow these steps:
24+
25+
1. Sign in to the [Azure portal](https://portal.azure.com).
26+
27+
1. Type in **Identity Governance** on the search bar near the top of the page and select it.
28+
29+
1. In the left menu, select **Lifecycle workflows (Preview)**.
30+
31+
1. From the list of workflows, select the workflow you want to check the execution scope of.
32+
33+
1. On the workflow overview page, select **Execution conditions (Preview)**.
34+
35+
1. On the Execution conditions page, select the **Execution User Scope** tab.
36+
37+
1. On this page you're presented with a list of users who currently meet the scope for execution for the workflow.
38+
:::image type="content" source="media/check-workflow-execution-scope/execution-user-scope-list.png" alt-text="Screenshot of users under scope of workflow execution." lightbox="media/check-workflow-execution-scope/execution-user-scope-list.png":::
39+
40+
> [!NOTE]
41+
> The workflow engine routinely evaluates the users that meet the execution conditions. The results will not be up to date if the execution conditions have been changed recently, relevant attributes on the user have been changed recently, or the time based trigger has recently passed.
42+
43+
## Check execution user scope of a workflow using Microsoft Graph
44+
45+
To check execution user scope of a workflow using API via Microsoft Graph, see: [List executionScope](/graph/api/workflow-list-executionscope).
46+
47+
## Next steps
48+
49+
- [Manage workflow properties](manage-workflow-properties.md)
50+
- [Delete Lifecycle Workflows](delete-lifecycle-workflow.md)

articles/active-directory/governance/customize-workflow-schedule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.reviewer: krbain
1414
ms.collection: M365-identity-device-management
1515
---
1616

17-
# Customize the schedule of workflows
17+
# Customize the schedule of workflows (Preview)
1818

1919
Workflows created using Lifecycle Workflows can be fully customized to match the schedule that fits your organization's needs. By default, workflows are scheduled to run every 3 hours, but the interval can be set as frequent as 1 hour, or as infrequent as 24 hours.
2020

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The Lifecycle Workflows preview requires Azure AD Premium P2. For more informati
2626

2727
1. Sign in to the [Azure portal](https://portal.azure.com).
2828

29-
1. Select **Azure Active Directory** and then select **Identity Governance**.
29+
1. Type in **Identity Governance** on the search bar near the top of the page and select it.
3030

3131
1. In the left menu, select **Lifecycle Workflows (Preview)**.
3232

@@ -64,18 +64,10 @@ After deleting workflows, you can view them on the **Deleted Workflows (Preview)
6464

6565
To delete a workflow using API via Microsoft Graph, see: [Delete workflow (lifecycle workflow)](/graph/api/identitygovernance-workflow-delete?view=graph-rest-beta&preserve-view=true).
6666

67-
68-
To view
69-
70-
Workflows can be deleted by running the following call:
71-
```http
72-
DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<id>
73-
```
7467
## View deleted workflows using Microsoft Graph
7568

7669
To View a list of deleted workflows using API via Microsoft Graph, see: [List deleted workflows](/graph/api/identitygovernance-lifecycleworkflowscontainer-list-deleteditems).
7770

78-
7971
## Permanently delete a workflow using Microsoft Graph
8072

8173
To permanently delete a workflow using API via Microsoft Graph, see: [Permanently delete a deleted workflow](/graph/api/identitygovernance-deleteditemcontainer-delete)

articles/active-directory/governance/lifecycle-workflows-deployment.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ For Lifecycle Workflows, you'll likely include representatives from the followin
6767
* Ensures that programmatic Lifecycle Workflows, via GRAPH or extensibility, are governed and reviewed.
6868

6969

70-
- **Security Owner** ensures that the plan will meet the security requirements of your organization. This team:
70+
- **Security Owner** ensures that the plan meets the security requirements of your organization. This team:
7171
- Ensure Lifecycle Workflows meet organizational security policies
7272

7373
- **Compliance manager** ensures that the organization follows internal policy and complies with regulations. This team:
@@ -76,7 +76,7 @@ For Lifecycle Workflows, you'll likely include representatives from the followin
7676
* Assesses processes and procedures for reviewing Lifecycle Workflows, which include documentation and record keeping for compliance.
7777
* Reviews results of past reviews for most critical resources.
7878
- **HR Representative** - Assists with attribute mapping and population in HR provisioning scenarios. This team:
79-
* Helps determine attributes that will be used to populate employeeHireDate and employeeLeaveDateTime.
79+
* Helps determine attributes that are used to populate employeeHireDate and employeeLeaveDateTime.
8080
* Ensures source attributes are populated and have values
8181
* Identifies and suggests alternate attributes that could be mapped to employeeHireDate and employeeLeaveDateTime
8282

@@ -110,7 +110,7 @@ The following information is important information about your organization and t
110110
|Item|Description|Documentation|
111111
|-----|-----|-----|
112112
|Inbound Provisioning|You have a process to create user accounts for employees in Azure AD such as HR inbound, SuccessFactors, or MIM.<br><br> Alternatively you have a process to create user accounts in Active Directory and those accounts are provisioned to Azure AD.|[Workday to Active Directory](../saas-apps/workday-inbound-tutorial.md)<br><br>[Workday to Azure AD](../saas-apps/workday-inbound-tutorial.md)<br><br>[SuccessFactors to Active Directory](../saas-apps/sap-successfactors-inbound-provisioning-tutorial.md)</br></br>[SuccessFactors to Azure AD](../saas-apps/sap-successfactors-inbound-provisioning-cloud-only-tutorial.md)<br><br>[Azure AD Connect](../hybrid/whatis-azure-ad-connect-v2.md)<br><br>[Azure AD Connect cloud sync](../cloud-sync/what-is-cloud-sync.md)|
113-
|Attribute synchronization|The accounts in Azure AD have the employeeHireDate and employeeLeaveDateTime attributes populated. The values may be populated when the accounts are created from an HR system or synchronized from AD using Azure AD Connect or cloud sync. You have additional attributes that will be used to determine the scope such as department, populated or the ability to populate, with data.|[How to synchronize attributes for Lifecycle Workflows](how-to-lifecycle-workflow-sync-attributes.md)
113+
|Attribute synchronization|The accounts in Azure AD have the employeeHireDate and employeeLeaveDateTime attributes populated. The values may be populated when the accounts are created from an HR system or synchronized from AD using Azure AD Connect or cloud sync. You have extra attributes that are used to determine the scope such as department, populated or the ability to populate, with data.|[How to synchronize attributes for Lifecycle Workflows](how-to-lifecycle-workflow-sync-attributes.md)
114114

115115
## Understanding parts of a workflow
116116

@@ -128,7 +128,7 @@ The following table provides information that you need to be aware of as you cre
128128
|-----|-----|
129129
|Workflows|50 workflow limit per tenant|
130130
|Number of custom tasks|limit of 25 per workflow|
131-
|Value range for offsetInDays|Between -60 and 60 days|
131+
|Value range for offsetInDays|Between -180 and 180 days|
132132
|Workflow execution schedule|Default every 3 hours - can be set to run anywhere from 1 to 24 hours|
133133
|Custom task extensions|Limit of 100|
134134
|On-demand user limit|You can run an on-demand workflow against a maximum of 10 users|
@@ -147,17 +147,17 @@ The following table provides a quick checklist of steps you can use when designi
147147
|Step|Description|
148148
|-----|-----|
149149
|[Determine your scenario](#determine-your-scenario)|Determine what scenario you're addressing with a workflow|
150-
|[Determine the execution conditions](#determine-the-execution-conditions)|Determine who and when the workflow will run|
150+
|[Determine the execution conditions](#determine-the-execution-conditions)|Determine who and when the workflow runs|
151151
|[Review the tasks](#review-the-tasks)|Review and add additional tasks to the workflow|
152152
|[Create your workflow](#create-your-workflow)|Create your workflow after planning and design.|
153153
|[Plan a pilot](#plan-a-pilot)|Plan to pilot, run, and test your workflow.|
154154

155155
## Determine your scenario
156-
Before building a Lifecycle Workflow in the portal, you should determine which scenario or scenarios you wish to deploy. You can use the table below to see a current list of the available scenarios. These are based on the templates that are available in the portal and list the task associated with each one.
156+
Before building a Lifecycle Workflow in the portal, you should determine which scenario or scenarios you wish to deploy. You can use the following table to see a current list of the available scenarios. These are based on the templates that are available in the portal and list the task associated with each one.
157157

158-
|Scenario|Pre-defined Tasks|
158+
|Scenario|Predefined Tasks|
159159
|-----|-----|
160-
|Onboard pre-hire employee| Generate TAP and Send Email|
160+
|Onboard prehire employee| Generate TAP and Send Email|
161161
|Onboard new hire employee|Enable User Account</br>Send Welcome Email</br>Add User To Groups|
162162
|Real-time employee termination|Remove user from all groups</br>Remove user from all Teams</br>Delete User Account|
163163
|Pre-Offboarding of an employee|Remove user from selected groups</br>Remove user from selected Teams|
@@ -168,13 +168,13 @@ For more information on the built-in templates, see [Lifecycle Workflow template
168168

169169

170170
## Determine the execution conditions
171-
Now that you've determined your scenarios, you need to look at what users in your organization the scenarios will apply to.
171+
Now that you've determined your scenarios, you need to look at what users in your organization the scenarios apply to.
172172

173173
An Execution condition is the part of a workflow that defines the scope of **who** and the trigger of **when** a workflow will be performed.
174174

175-
The [scope](understanding-lifecycle-workflows.md#configure-scope) determines who the workflow runs against. This is defined by a rule that will filter users based on a condition. For example, the rule, `"rule": "(department eq 'sales')"` will run the task only on users who are members of the sales department.
175+
The [scope](understanding-lifecycle-workflows.md#configure-scope) determines who the workflow runs against. This is defined by a rule that will filter users based on a condition. For example, the rule, `"rule": "(department eq 'sales')"` runs the task only on users who are members of the sales department.
176176

177-
The [trigger](understanding-lifecycle-workflows.md#trigger-details) determines when the workflow will run. This can either be, on-demand, which is immediate, or time based. Most of the pre-defined templates in the portal are time based.
177+
The [trigger](understanding-lifecycle-workflows.md#trigger-details) determines when the workflow runs. This can either be, on-demand, which is immediate, or time based. Most of the predefined templates in the portal are time based.
178178

179179
### Attribute information
180180
The scope of a workflow uses attributes under the rule section. You can add the following extra conditionals to further refine **who** the tasks are applied to.
@@ -200,7 +200,7 @@ The following is some important information regarding time zones that you should
200200
For more information, see [How to synchronize attributes for Lifecycle Workflows](../governance/how-to-lifecycle-workflow-sync-attributes.md)
201201

202202
## Review the tasks
203-
Now that we've determined the scenario and the who and when, you should consider whether the pre-defined tasks are sufficient or are you going to need additional tasks. The table below has a list of the pre-defined tasks that are currently in the portal. Use this table to determine if you want to add more tasks.
203+
Now that we've determined the scenario and the who and when, you should consider whether the predefined tasks are sufficient or are you going to need extra tasks. The following table has a list of the predefined tasks that are currently in the portal. Use this table to determine if you want to add more tasks.
204204

205205
|Task|Description|Relevant Scenarios|
206206
|-----|-----|-----|
@@ -225,18 +225,18 @@ Now that we've determined the scenario and the who and when, you should consider
225225
For more information on tasks, see [Lifecycle Workflow tasks](lifecycle-workflow-tasks.md).
226226

227227
### Group and team tasks
228-
If you're using a group or team task, the workflow will need you to specify the group or groups. In the screenshot below, you'll see the yellow triangle on the task indicating that it's missing information.
228+
If you're using a group or team task, the workflow needs you to specify the group or groups. In the following screenshot, you see the yellow triangle on the task indicating that it's missing information.
229229

230230
[![Screenshot of onboard new hire.](media/lifecycle-workflows-deployment/group-1.png)](media/lifecycle-workflows-deployment/group-1.png#lightbox)
231231

232-
By clicking on the task, you'll be presented with a navigation bar to add or remove groups. Select the "x groups selected" link to add groups.
232+
By clicking on the task, you are presented with a navigation bar to add or remove groups. Select the "x groups selected" link to add groups.
233233

234234
[![Screenshot of add groups.](media/lifecycle-workflows-deployment/group-2.png)](media/lifecycle-workflows-deployment/group-2.png#lightbox)
235235

236236
### Custom task extensions
237-
Lifecycle Workflows allow you to create workflows that can be triggered based on joiner, mover, or leaver scenarios. While Lifecycle Workflows provide several built-in tasks to automate common scenarios throughout the lifecycle of users, eventually you may reach the limits of these built-in tasks. With the extensibility feature, you'll be able to utilize the concept of custom task extensions to call-out to external systems as part of a Lifecycle Workflow.
237+
Lifecycle Workflows allow you to create workflows that can be triggered based on joiner, mover, or leaver scenarios. While Lifecycle Workflows provide several built-in tasks to automate common scenarios throughout the lifecycle of users, eventually you may reach the limits of these built-in tasks. With the extensibility feature, you are able to utilize the concept of custom task extensions to call-out to external systems as part of a Lifecycle Workflow.
238238

239-
When creating custom task extensions, the scenarios for how it will interact with Lifecycle Workflows can be one of three ways:
239+
When creating custom task extensions, the scenarios for how it interacts with Lifecycle Workflows can be one of three ways:
240240

241241
- **Fire-and-forget scenario**- The Logic App is started, and the sequential task execution immediately continues with no response expected from the Logic App.
242242
- **Sequential task execution waiting for response from the Logic App** - The Logic app is started, and the sequential task execution waits on the response from the Logic App.
@@ -263,7 +263,7 @@ For more information, see [Best practices for a pilot.](../fundamentals/active-d
263263
#### Test and run the workflow
264264
Once you've created a workflow, you should test it by running the workflow [on-demand](on-demand-workflow.md)
265265

266-
Using the on-demand feature will allow you to test and evaluate whether the Lifecycle Workflow is working as intended.
266+
Using the on-demand feature allows you to test and evaluate whether the Lifecycle Workflow is working as intended.
267267

268268
Once you have completed testing, you can either rework the Lifecycle Workflow or get ready for a broader distribution.
269269

@@ -276,10 +276,10 @@ You can also get more information from the audit logs. These logs can be access
276276

277277
|Stage|Description|
278278
| - | - |
279-
|Determine the scenario| A pre-hire workflow that sends email to new manager. |
280-
|Determine the execution conditions|The workflow will run on new employees in the sales department, two(2) days before the employeeHireDate.|
281-
|Review the tasks.|We'll use the pre-defined tasks in the workflow. No extra tasks will be added.|
282-
|Create the workflow in the portal|Use the pre-defined template for new hire in the portal.|
279+
|Determine the scenario| A prehire workflow that sends email to new manager. |
280+
|Determine the execution conditions|The workflow runs on new employees in the sales department, two (2) days before the employeeHireDate.|
281+
|Review the tasks.|We use the predefined tasks in the workflow. No extra tasks are added.|
282+
|Create the workflow in the portal|Use the predefined template for new hire in the portal.|
283283
|Enable and test the workflow| Use the on-demand feature to test the workflow on one user.|
284284
|Review the test results|Review the test results and ensure the Lifecycle Workflow is working as intended.|
285285
|Roll out the workflow to a broader audience|Communicate with stakeholders, letting them know that is going live and that HR will no longer need to send an email to the hiring manager.

0 commit comments

Comments
 (0)