Skip to content

Commit c2024af

Browse files
authored
Merge pull request #210778 from OWinfreyATL/owinfreyATL-History-Update
added audit concept and updated history concept
2 parents 1d0932c + 9b6f58d commit c2024af

File tree

4 files changed

+64
-34
lines changed

4 files changed

+64
-34
lines changed

articles/active-directory/governance/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@
8989
href: lifecycle-workflow-extensibility.md
9090
- name: Versioning (Preview)
9191
href: lifecycle-workflow-versioning.md
92+
- name: Workflow Audit logs
93+
href: lifecycle-workflow-audits.md
9294
- name: Workflow History (Preview)
9395
href: lifecycle-workflow-history.md
9496
- name: How-to guides
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Auditing Lifecycle Workflows
3+
description: Information about audit logs with Lifecycle Workflows
4+
author: owinfreyATL
5+
ms.author: owinfrey
6+
manager: amycolannino
7+
ms.service: active-directory
8+
ms.workload: identity
9+
ms.topic: conceptual
10+
ms.date: 08/01/2022
11+
ms.custom: template-concept
12+
---
13+
14+
# Auditing Lifecycle Workflows
15+
16+
Workflows created using Lifecycle Workflows allow for the automation of lifecycle task for users no matter where they fall in the Joiner-Mover-Leaver (JML) model of their identity lifecycle in your organization. Making sure workflows are processed correctly is an important part of an organization's lifecycle management process. Workflows that aren't processed correctly can lead to many issues in terms of security and compliance. With audit logs, every action that Lifecycle Workflows complete over a time-frame up to 30 days are recorded.
17+
18+
## Audit Logs
19+
20+
Every time a workflow is processed, an event is logged. These events are stored in the **Audit Logs** section, and can be used to gain information about workflows for historical, and auditing, purposes.
21+
22+
:::image type="content" source="media/lifecycle-workflow-audits/audit-logs-concept.png" alt-text="Screenshot of a workflow audit log.":::
23+
24+
On the **Audit Log** page you're presented a sequential list, by date, of every action Lifecycle Workflows has taken. From this information you're able to filter based on the following parameters:
25+
26+
|Filter |Description |
27+
|---------|---------|
28+
|Date | You can filter a specific range for the audit logs from as short as 24 hours up to 30 days. |
29+
|Date option | You can filter by your tenant's local time, or by UTC. |
30+
|Service | The Lifecycle Workflow service. |
31+
|Category | Categories of the event being logged. Separated into <br><br> **All**- All events logged by Lifecycle Workflows.<br><br> **TaskManagement**- Task specific related events logged by Lifecycle Workflows. <br><br> **WorkflowManagement**- Events dealing with the workflow itself. |
32+
|Activity | You can filter based on specific activities, which are based on categories. |
33+
34+
After filtering this information, you're also able to see other information in the log such as:
35+
36+
- **Status**: Whether or not the logged event was successful or not.
37+
- **Status Reason**: If the event failed, a reason is given why.
38+
- **Target(s)**: Who the logged event ran for. Information given as their Azure Active Directory object ID.
39+
- **Initiated by (actor)**: Who did the event being logged. Information given by the user name.
40+
41+
42+
43+
## Next steps
44+
45+
- [Lifecycle Workflow History](lifecycle-workflow-history.md)
46+
- [Check the status of a workflow (Preview)](check-status-workflow.md)
47+
48+

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

Lines changed: 14 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,11 @@ ms.custom: template-concept
1616

1717

1818

19-
Workflows created using Lifecycle Workflows allow for the automation of lifecycle task for users no matter where they fall in the Joiner-Mover-Leaver (JML) model of their identity lifecycle in your organization. Making sure workflows are processed correctly is an important part of an organization's lifecycle management process. Workflows that aren't processed correctly can lead to many issues in terms of security and compliance. With Audit logs every action that Lifecycle Workflows complete are recorded. With history features, Lifecycle Workflows allow you to specify workflow events based on user, runs, or task summaries. This reporting feature allows you to quickly see what ran for who, and rather or not it was successful. In this article you'll learn the difference between auditing logs and 3 different type of history summaries you can query with Lifecycle Workflows. You'll also learn when you would use each when getting more information about how your workflows were utilized for users in your organization.
20-
21-
22-
23-
## Audit Logs
24-
25-
Every time a workflow is processed, an event is logged. These events are stored in the **Audit Logs** section, and can be used to gain information about workflows for historical, and auditing, purposes.
26-
27-
:::image type="content" source="media/lifecycle-workflow-history/audit-logs-concept.png" alt-text="Screenshot of a workflow audit log.":::
28-
29-
On the **Audit Log** page you're presented a sequential list, by date, of every action Lifecycle Workflows has taken. From this information you're able to filter based on the following parameters:
30-
31-
32-
|Filter |Description |
33-
|---------|---------|
34-
|Date | You can filter a specific range for the audit logs from as short as 24 hours up to 30 days. |
35-
|Date option | You can filter by your tenant's local time, or by UTC. |
36-
|Service | The Lifecycle Workflow service. |
37-
|Category | Categories of the event being logged. Separated into <br><br> **All**- All events logged by Lifecycle Workflows.<br><br> **TaskManagement**- Task specific related events logged by Lifecycle Workflows. <br><br> **WorkflowManagement**- Events dealing with the workflow itself. |
38-
|Activity | You can filter based on specific activities, which are based on categories. |
39-
40-
After filtering this information, you're also able to see other information in the log such as:
41-
42-
- **Status**: Whether or not the logged event was successful or not.
43-
- **Status Reason**: If the event failed, a reason is given why.
44-
- **Target(s)**: Who the logged event ran for. Information given as their Azure Active Directory object ID.
45-
- **Initiated by (actor)**: Who did the event being logged. Information given by the user name.
19+
Workflows created using Lifecycle Workflows allow for the automation of lifecycle task for users no matter where they fall in the Joiner-Mover-Leaver (JML) model of their identity lifecycle in your organization. Making sure workflows are processed correctly is an important part of an organization's lifecycle management process. Workflows that aren't processed correctly can lead to many issues in terms of security and compliance. With Lifecycle Workflow's history features, you can specify which workflow events you want to view a history of based on user, runs, or task summaries. This reporting feature allows you to quickly see what ran for who, and rather or not it was successful. Along with the summaries in these specific areas, you're also able to view detailed information about each specific event recorded in their respective summary section. In this article you'll learn the difference between the three different type of history summaries, and details, you can query with Lifecycle Workflows. You'll also learn when you would use each when getting more information about how your workflows were utilized for users in your organization. For detailed information about every action Lifecycle Workflows take, see: [Auditing Lifecycle Workflows](lifecycle-workflow-audits.md).
4620

4721
## Lifecycle Workflow History Summaries
4822

49-
While the large set of information contained in audit logs can be useful for compliance reasons, for regular administration use it might be too much information. To make this large set of information processed easier to read, Lifecycle Workflows provide summaries for quick use. You can view these history summaries in three ways:
23+
Lifecycle Workflows introduce a history feature based on summaries and details. These history summaries allow you to quickly get information about for who a workflow ran, and whether or not this run was successful or not. This is valuable because the large set of information given by audit logs might become too numerous to be efficiently used. To make a large set of information processed easier to read, Lifecycle Workflows provide summaries for quick use. You can view these history summaries in three ways:
5024

5125
- **Users summary**: Shows a summary of users processed by a workflow, and which tasks failed, successfully, and totally ran for each specific user.
5226
- **Runs summary**: Shows a summary of workflow runs in terms of the workflow. Successful, failed, and total task information when workflow runs are noted.
@@ -61,7 +35,7 @@ User summaries allow you to view workflow information through the lens of users
6135
:::image type="content" source="media/lifecycle-workflow-history/users-summary-concept.png" alt-text="Screenshot of a workflow user summary.":::
6236

6337

64-
Within the user summary you're able to find the following information:
38+
Within the user summary, you're able to find the following information:
6539

6640

6741
|Parameter |Description |
@@ -72,8 +46,9 @@ Within the user summary you're able to find the following information:
7246
|Total tasks | The total number of tasks processed for users in a workflow during the selected time frame. |
7347
|Failed tasks | The total number of failed tasks processed for users in a workflow during the selected time frame. |
7448

49+
### User history details
7550

76-
User summaries allow you to filter based on:
51+
User detailed history information allows you to filter for specific information based on:
7752

7853
- **Date**: You can filter a specific range from as short as 24 hours up to 30 days of when workflow ran.
7954
- **Status**: You can filter a specific status of the user processed. The supported statuses are: **Completed**, **In Progress**, **Queued**, **Canceled**, **Completed with errors**, and **Failed**.
@@ -89,7 +64,7 @@ Runs summaries allow you to view workflow information through the lens of its ru
8964

9065
:::image type="content" source="media/lifecycle-workflow-history/runs-status-concept.png" alt-text="Screenshot of a workflow runs summary.":::
9166

92-
Within the runs summary you're able to find the following information:
67+
Within the runs summary, you're able to find the following information:
9368

9469

9570
|Parameter |Description |
@@ -99,7 +74,9 @@ Within the runs summary you're able to find the following information:
9974
|Failed | Workflows that failed to run. |
10075
|Failed tasks | Workflows that ran with failed tasks. |
10176

102-
Runs summaries allow you to filter based on:
77+
### Runs history details
78+
79+
Runs detailed history information allows you to filter for specific information based on:
10380

10481
- **Date**: You can filter a specific range from as short as 24 hours up to 30 days of when workflow ran.
10582
- **Status**: You can filter a specific status of the workflow run. The supported statuses are: **Completed**, **In Progress**, **Queued**, **Canceled**, **Completed with errors**, and **Failed**.
@@ -115,7 +92,7 @@ Task summaries allow you to view workflow information through the lens of its ta
11592

11693
:::image type="content" source="media/lifecycle-workflow-history/task-summary-concept.png" alt-text="Screenshot of a workflow task summary.":::
11794

118-
Within the tasks summary you're able to find the following information:
95+
Within the tasks summary, you're able to find the following information:
11996

12097

12198
|Parameter |Description |
@@ -125,7 +102,10 @@ Within the tasks summary you're able to find the following information:
125102
|Failed | The number of failed processed tasks by a workflow. |
126103
|Unprocessed | The number of unprocessed tasks by a workflow. |
127104

128-
Task summaries allow you to filter based on:
105+
106+
### Task history details
107+
108+
Task detailed history information allows you to filter for specific information based on:
129109

130110
- **Date**: You can filter a specific range from as short as 24 hours up to 30 days of when workflow ran.
131111
- **Status**: You can filter a specific status of the workflow run. The supported statuses are: **Completed**, **In Progress**, **Queued**, **Canceled**, **Completed with errors**, and **Failed**.

0 commit comments

Comments
 (0)