|
| 1 | +--- |
| 2 | +title: Check status of a Lifecycle workflow - Azure Active Directory |
| 3 | +description: This article guides a user on checking the status of a Lifecycle workflow |
| 4 | +author: OWinfreyATL |
| 5 | +ms.author: owinfrey |
| 6 | +manager: amycolannino |
| 7 | +ms.service: active-directory |
| 8 | +ms.workload: identity |
| 9 | +ms.topic: how-to |
| 10 | +ms.date: 03/10/2022 |
| 11 | +ms.subservice: compliance |
| 12 | +ms.custom: template-how-to |
| 13 | +--- |
| 14 | + |
| 15 | + |
| 16 | +# Check the status of a workflow (Preview) |
| 17 | + |
| 18 | +When a workflow is created, it's important to check its status, and run history to make sure it ran properly for the users it processed both by schedule and by on-demand. To get information about the status of workflows, Lifecycle Workflows allows you to check run and user processing history. This history also gives you summaries to see how often a workflow has run, and who it ran successfully for. You're also able to check the status of both the workflow, and its tasks. Checking the status of workflows and their tasks allows you to troubleshoot potential problems that could come up during their execution. |
| 19 | + |
| 20 | + |
| 21 | +## Run workflow history using the Azure portal |
| 22 | + |
| 23 | +You're able to retrieve run information of a workflow using Lifecycle Workflows. To check the runs of a workflow using the Azure portal, you would do the following steps: |
| 24 | + |
| 25 | +1. Sign in to the [Azure portal](https://portal.azure.com). |
| 26 | + |
| 27 | +1. Select **Azure Active Directory** and then select **Identity Governance**. |
| 28 | + |
| 29 | +1. On the left menu, select **Lifecycle Workflows (Preview)**. |
| 30 | + |
| 31 | +1. On the Lifecycle Workflows overview page, select **Workflows (Preview)**. |
| 32 | + |
| 33 | +1. Select the workflow you want to run history of. |
| 34 | + |
| 35 | +1. On the workflow overview screen, select **Audit logs**. |
| 36 | + |
| 37 | +1. On the history page, select the **Runs** button. |
| 38 | + |
| 39 | +1. Here you'll see a summary of workflow runs. |
| 40 | + :::image type="content" source="media/check-status-workflow/run-list.png" alt-text="Screenshot of a workflow Runs list."::: |
| 41 | +1. The runs summary cards include the total number of processed runs, the number of successful runs, the number of failed runs, and the total number of failed tasks. |
| 42 | + |
| 43 | +## User workflow history using the Azure portal |
| 44 | + |
| 45 | +To get further information than just the runs summary for a workflow, you're also able to get information about users processed by a workflow. To check the status of users a workflow has processed using the Azure portal, you would do the following steps: |
| 46 | + |
| 47 | + |
| 48 | +1. In the left menu, select **Lifecycle Workflows (Preview)**. |
| 49 | + |
| 50 | +1. select **Workflows (Preview)**. |
| 51 | + |
| 52 | +1. select the workflow you want to see user processing information for. |
| 53 | + |
| 54 | +1. On the workflow overview screen, select **Workflow history (Preview)**. |
| 55 | + :::image type="content" source="media/check-status-workflow/workflow-history.png" alt-text="Screenshot of a workflow overview history."::: |
| 56 | +1. On the workflow history page, you're presented with a summary of every user processed by the workflow along with counts of successful and failed users and tasks. |
| 57 | + :::image type="content" source="media/check-status-workflow/workflow-history-list.png" alt-text="Screenshot of a list of workflow summaries."::: |
| 58 | +1. By selecting total tasks by a user you're able to see which tasks have successfully completed, or are currently in progress. |
| 59 | + :::image type="content" source="media/check-status-workflow/task-history-status.png" alt-text="Screenshot of workflow task history status."::: |
| 60 | +1. By selecting failed tasks, you're able to see which tasks have failed for a specific user. |
| 61 | + :::image type="content" source="media/check-status-workflow/task-history-failed.png" alt-text="Screenshot of workflow failed tasks history."::: |
| 62 | +1. By selecting unprocessed tasks, you're able to see which tasks are unprocessed. |
| 63 | + :::image type="content" source="media/check-status-workflow/task-history-unprocessed.png" alt-text="Screenshot of unprocessed tasks of a workflow."::: |
| 64 | + |
| 65 | + |
| 66 | +## User workflow history using Microsoft Graph |
| 67 | + |
| 68 | +### List user processing results using Microsoft Graph |
| 69 | + |
| 70 | +To view a status list of users processed by a workflow, which are UserProcessingResults, you'd make the following API call: |
| 71 | + |
| 72 | +```http |
| 73 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults |
| 74 | +``` |
| 75 | + |
| 76 | +By default **userProcessingResults** returns only information from the last 7 days. To get information as far back as 30 days, you would run the following API call: |
| 77 | + |
| 78 | +```http |
| 79 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults?$filter=<Date range for processing results> |
| 80 | +``` |
| 81 | + |
| 82 | +by default **userProcessingResults** returns only information from the last 7 days. To filter information as far back as 30 days, you would run the following API call: |
| 83 | + |
| 84 | +```http |
| 85 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<id>/userProcessingResults?$filter=<Date range for processing results> |
| 86 | +``` |
| 87 | + |
| 88 | +An example of a call to get **userProcessingResults** for a month would be as follows: |
| 89 | + |
| 90 | +```http |
| 91 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults?$filter=< startedDateTime ge 2022-05-23T00:00:00Z and startedDateTime le 2022-06-22T00:00:00Z |
| 92 | +``` |
| 93 | + |
| 94 | +### User processing results using Microsoft Graph |
| 95 | + |
| 96 | +When multiple user events are processed by a workflow, running the **userProcessingResults** may give incomprehensible information. To get a summary of information such as total users and tasks, and failed users and tasks, Lifecycle Workflows provides a call to get count totals. |
| 97 | + |
| 98 | +To view a summary in count form, you would run the following API call: |
| 99 | +```http |
| 100 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/summary(<Date Range>) |
| 101 | +``` |
| 102 | + |
| 103 | +An example to get the summary between May 1, and May 30, you would run the following call: |
| 104 | + |
| 105 | +```http |
| 106 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/summary(startDateTime=2022-05-01T00:00:00Z,endDateTime=2022-05-30T00:00:00Z) |
| 107 | +``` |
| 108 | + |
| 109 | +### List task processing results of a given user processing result |
| 110 | + |
| 111 | +```http |
| 112 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/<userProcessingResultId>/taskProcessingResults/ |
| 113 | +``` |
| 114 | + |
| 115 | +## Run workflow history via Microsoft Graph |
| 116 | + |
| 117 | +### List runs using Microsoft Graph |
| 118 | + |
| 119 | +With Microsoft Graph, you're able to get full details of workflow and user processing run information. |
| 120 | + |
| 121 | +To view a list of runs, you'd make the following API call: |
| 122 | + |
| 123 | +```http |
| 124 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs |
| 125 | +``` |
| 126 | + |
| 127 | +### Get a summary of runs using Microsoft Graph |
| 128 | + |
| 129 | +To get a summary of runs for a workflow, which includes detailed information for counts of failed runs and tasks, along with successful runs and tasks for a time range, you'd make the following API call: |
| 130 | + |
| 131 | +```http |
| 132 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/summary(startDateTime=<time>,endDateTime=<time>) |
| 133 | +``` |
| 134 | +An example to get a summary of runs of a workflow through the time interval of May 2022 would be as follows: |
| 135 | + |
| 136 | +```http |
| 137 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/summary(startDateTime=2022-05-01T00:00:00Z,endDateTime=202205-31T00:00:00Z) |
| 138 | +``` |
| 139 | + |
| 140 | +### List user and task processing results of a given run using Microsoft Graph |
| 141 | + |
| 142 | +With Lifecycle Workflows, you're able to check the status of each user and task who had a workflow processed for them as part of a run. |
| 143 | + |
| 144 | + |
| 145 | +You're also able to use **userProcessingResults** with the run call to get users processed for a run by making the following API call: |
| 146 | + |
| 147 | +```http |
| 148 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/<runId>/userProcessingResults |
| 149 | +``` |
| 150 | + |
| 151 | +This API call will also return a **userProcessingResults ID** value, which can be used to retrieve task processing information in the following call: |
| 152 | + |
| 153 | +```http |
| 154 | +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId> /runs/<runId>/userProcessingResults/<userProcessingResultId>/taskProcessingResults |
| 155 | +``` |
| 156 | + |
| 157 | +> [!NOTE] |
| 158 | +> A workflow must have activity in the past 7 days to get **userProcessingResults ID**. If there has not been any activity in that time-frame, the **userProcessingResults** call will not return a value. |
| 159 | +
|
| 160 | + |
| 161 | +## Next steps |
| 162 | + |
| 163 | +- [Manage workflow versions](manage-workflow-tasks.md) |
| 164 | +- [Delete Lifecycle Workflows](delete-lifecycle-workflow.md) |
0 commit comments