Skip to content

Commit

Permalink
Merging changes synced from https://github.com/MicrosoftDocs/azure-de…
Browse files Browse the repository at this point in the history
…vops-docs-pr (branch live)
  • Loading branch information
steved0x committed Sep 22, 2021
2 parents 9304d5d + 2a72c58 commit 64dd2bb
Show file tree
Hide file tree
Showing 54 changed files with 507 additions and 296 deletions.
1 change: 0 additions & 1 deletion docs/report/dashboards/burndown-guidance.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description: Review Scrum progress during and at the end of a sprint when workin
ms.custom: dashboards
ms.technology: devops-analytics
ms.topic: conceptual
ms.reviewer: greggboe
ms.author: kaelli
author: KathrynEE
monikerRange: '>= tfs-2013'
Expand Down
4 changes: 2 additions & 2 deletions docs/report/dashboards/charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ When creating a query to support your chart, follow these guidelines.
- Charts saved under **Shared Queries** are viewable by all team members, except members with Stakeholder access, and can be added to dashboards.
- Charts that you create for queries under your **My Queries** folder are visible only to you.
- You can copy and email the URL of any chart page to share it with a project member.
- To create similar charts for tests, see [Track your test results](../../test/track-test-status.md).
- To create similar charts for tests, see [Track test status](../../test/track-test-status.md).


### Display of areas and iterations
Expand Down Expand Up @@ -461,6 +461,6 @@ Query-based charts generate data from the work item tracking data store and ther
- [Cumulative flow diagram](cumulative-flow.md)
- [Team velocity](team-velocity.md)
- [View/configure sprint burndown](configure-sprint-burndown.md)
- [Test progress and test results](../../test/track-test-status.md)
- [Track test status](../../test/track-test-status.md)
- [Add widgets and chart to a dashboard](add-widget-to-dashboard.md)
- [Widget catalog](widget-catalog.md)
1 change: 0 additions & 1 deletion docs/report/dashboards/team-velocity.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ms.custom: dashboards
ms.technology: devops-analytics
ms.assetid: 31CBF001-CFF2-49CF-97A1-FDFFEFDDF3AB
ms.topic: tutorial
ms.reviewer: greggboe
ms.author: kaelli
author: KathrynEE
monikerRange: '>= tfs-2013'
Expand Down
138 changes: 85 additions & 53 deletions docs/report/extend-analytics/data-model-analytics-service.md

Large diffs are not rendered by default.

20 changes: 9 additions & 11 deletions docs/report/extend-analytics/odata-api-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
title: OData API versioning
titleSuffix: Azure DevOps
description: How Analytics for Azure DevOps manages changes to the OData API
ms.technology: devops-analytics
ms.reviewer: prprice
ms.technology: devops-analytics
ms.author: kaelli
author: KathrynEE
ms.topic: reference
monikerRange: '>= azure-devops-2019'
ms.date: 07/14/2020
ms.date: 09/21/2021
---

# OData API versioning
Expand All @@ -18,7 +17,7 @@ ms.date: 07/14/2020

As Analytics grows we are dedicated to providing consistency and reliability to our users. Therefore Analytics for Azure DevOps provides a versioned OData API that will remain compatible with clients designed for those versions. Each version may be enhanced with additional functionality and non-breaking changes. Incompatible or breaking changes will be rolled into future versions of the API.

The API version follows the _odata element in the request path and has value as one of our supported versions: **v1.0**, **v2.0** or **v3.0-preview**.
The API version follows the _odata element in the request path and has value as one of our supported versions: **v1.0**, **v2.0**, **v3.0-preview**, or **v4.0-preview**.

::: moniker range="azure-devops"

Expand All @@ -43,12 +42,13 @@ The API version follows the _odata element in the request path and has value as
## Preview versions
<strong>v3.0-preview</strong>
- **v3.0-preview**
- **v4.0-preview**
## Released versions
<strong>v1.0</strong>
<strong>v2.0</strong>
- **v1.0**
- **v2.0**
## Entity sets supported in each version
Expand All @@ -67,16 +67,14 @@ The preview of a version will be available for a minimum of 6 weeks after it is
### 2 - Released
Once a preview version matures enough for release it will be made available without the -preview suffix. No breaking changes will be introduced to released versions, but the data model may still grow with additive functionality. Released versions will be supported for a minimum of 12 months.
Once a preview version matures enough for release it will be made available without the **-preview** suffix. No breaking changes will be introduced to released versions, but the data model may still grow with additive functionality. Released versions will be supported for a minimum of 12 months.
### 3 - Deprecated
Deprecated versions are no longer supported, and requests made to them will not be fulfilled. If you attempt to request a deprecated or unsupported version you will receive an HTTP 410 response code and a message like:
> *The {version} OData endpoint for Analytics is not supported. Information on the latest recommended version is available here: https://go.microsoft.com/fwlink/?linkid=856818*
## Breaking vs non-breaking changes
The data model exposed by Analytics defines the contract between the service and its clients. The OData spec requires that clients be tolerant of additive changes to the data model, so breaking changes will be introduced in future versions. For more information see the OData spec:
Expand Down
29 changes: 0 additions & 29 deletions docs/report/extend-analytics/toc.yml

This file was deleted.

8 changes: 4 additions & 4 deletions docs/report/includes/analytics-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,26 @@ ms.technology: devops-analytics
ms.author: kaelli
author: KathrynEE
ms.topic: include
ms.date: 08/24/2020
ms.date: 09/21/2021
---

::: moniker range="azure-devops"

> [!NOTE]
> The Analytics service is automatically enabled for all Azure DevOps Services. It is supported for use in production. [Power BI integration](../powerbi/overview.md) and access to the [OData feed](../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. We encourage you to use it and provide us feedback. As we add features, we will post them on the [Microsoft DevOps Blog](https://devblogs.microsoft.com/devops/).
> The Analytics service is automatically enabled for all Azure DevOps Services. It is supported for use in production. [Power BI integration](../powerbi/overview.md) and access to the [OData feed](../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. We encourage you to use it and provide us feedback. .
::: moniker-end

::: moniker range="azure-devops-2020"

> [!NOTE]
> The Analytics service is automatically installed on all new project collections for Azure DevOps Server 2020. It is supported for use in production. [Power BI integration](../powerbi/overview.md) and access to the [OData feed](../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. We encourage you to use it and provide us feedback. If you upgraded from Azure DevOps Server 2019, then you're provided with the option to install the Analytics service during upgrade.
> The Analytics service is automatically installed on all new project collections for Azure DevOps Server 2020. It is supported for use in production. [Power BI integration](../powerbi/overview.md) and access to the [OData feed](../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. We encourage you to use it and provide us feedback. If you upgraded from Azure DevOps Server 2019, then you're provided with the option to install the Analytics service during upgrade.
::: moniker-end

::: moniker range="azure-devops-2019"

> [!NOTE]
> The Analytics service is in preview for Azure DevOps Server 2019. You access Analytics by [enabling or installing it](../dashboards/analytics-extension.md) for a project collection. [Power BI integration](../powerbi/overview.md) and access to the [OData feed](../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. We encourage you to use it and provide us feedback. As we add features, we will post them on the [Microsoft DevOps Blog](https://devblogs.microsoft.com/devops/).
> The Analytics service is in preview for Azure DevOps Server 2019. You access Analytics by [enabling or installing it](../dashboards/analytics-extension.md) for a project collection. [Power BI integration](../powerbi/overview.md) and access to the [OData feed](../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. We encourage you to use it and provide us feedback.
::: moniker-end
4 changes: 2 additions & 2 deletions docs/report/includes/api-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ ms.technology: devops-analytics
ms.reviewer: prprice
ms.author: kaelli
author: KathrynEE
ms.date: 07/14/2020
ms.date: 09/21/2021
---

> [!NOTE]
> The `{version}` value is formatted as `v1.0`. The latest supported version is `v2.0`, and the latest preview version is `v3.0-preview`. For more information, see [OData API versioning](../extend-analytics/odata-api-version.md).
> The `{version}` value is formatted as `v1.0`. The latest supported version is `v2.0`, and the latest preview version is `v4.0-preview`. For more information, see [OData API versioning](../extend-analytics/odata-api-version.md).
5 changes: 2 additions & 3 deletions docs/report/powerbi/analytics-historical-filtering.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: Filtering on historical data from Analytics
titleSuffix: Azure DevOps
description: TBD
description: Understand how filters are applied to historical Analytics data for work tracking.
ms.technology: devops-analytics
ms.reviewer: greggboe
ms.author: kaelli
author: KathrynEE
ms.topic: tutorial
ms.topic: conceptual
monikerRange: '>= azure-devops-2019'
ms.date: 04/05/2019
---
Expand Down
25 changes: 14 additions & 11 deletions docs/report/powerbi/data-available-in-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ title: Data available from Analytics
titleSuffix: Azure DevOps
description: Data available for reporting purposes using Analytics for Azure DevOps
ms.technology: devops-analytics
ms.reviewer: greggboe
ms.author: kaelli
author: KathrynEE
ms.topic: conceptual
monikerRange: '>= azure-devops-2019'
ms.date: 07/14/2020
ms.date: 09/21/2021
---

# Data available from Analytics
Expand Down Expand Up @@ -50,10 +49,15 @@ Currently, you can access the following data from Analytics. This information wa
[Boards](https://azure.microsoft.com/services/devops/boards/)
:::column-end:::
:::column span="":::
[In-context reports](../dashboards/overview.md#in-context-reports-work-tracking), [Widgets](../dashboards/analytics-widgets.md), [OData](../extend-analytics/quick-ref.md), [Power BI](overview.md)
- [In-context reports](../dashboards/overview.md#in-context-reports-work-tracking)
- [Widgets](../dashboards/analytics-widgets.md)
- [OData](../extend-analytics/quick-ref.md)
- [Power BI](overview.md)
:::column-end:::
:::column span="":::
[Widgets](../dashboards/analytics-widgets.md), [OData](../extend-analytics/quick-ref.md), [Power BI](overview.md)
- [Widgets](../dashboards/analytics-widgets.md)
- [OData](../extend-analytics/quick-ref.md)
- [Power BI](overview.md)
:::column-end:::
:::column span="":::

Expand All @@ -65,10 +69,12 @@ Currently, you can access the following data from Analytics. This information wa
[Pipelines](https://azure.microsoft.com/services/devops/pipelines/)
:::column-end:::
:::column span="":::
[Test Analytics](../../pipelines/test/test-analytics.md), [Pipeline Analytics](../../pipelines/reports/pipelinereport.md), [OData Preview](../extend-analytics/quick-ref.md)
- [Test Analytics](../../pipelines/test/test-analytics.md)
- [Pipeline Analytics](../../pipelines/reports/pipelinereport.md)
- [OData Preview](../extend-analytics/quick-ref.md)
:::column-end:::
:::column span="":::
[Test Analytics](../../pipelines/test/test-analytics.md)
- [Test Analytics](../../pipelines/test/test-analytics.md)
:::column-end:::
:::column span="":::

Expand All @@ -80,7 +86,7 @@ Currently, you can access the following data from Analytics. This information wa
[Test Plans](https://azure.microsoft.com/services/devops/test-plans/)
:::column-end:::
:::column span="":::
[Progress Report](../../test/track-test-status.md)
- [Progress Report](../../test/progress-report.md)
:::column-end:::
:::column span="":::
None
Expand Down Expand Up @@ -123,10 +129,7 @@ Currently, you can access the following data from Analytics. This information wa


> [!NOTE]
> Analytics doesn't support reporting on plain text and HTML fields at this time.
As more data types come online, we will update this page. Look for announcements on the [Microsoft DevOps Blog](https://devblogs.microsoft.com/devops/).

> Analytics doesn't support reporting on plain text and HTML fields.
## Try this next

Expand Down
5 changes: 2 additions & 3 deletions docs/report/powerbi/data-connector-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ title: Connect to Power BI Data Connector
titleSuffix: Azure DevOps
description: Step-by-step guidance on how to connect to Power BI Data Connector and Analytics to access Azure DevOps data
ms.assetid: 509ECCF2-E18E-4F14-B7EE-8802AB8938A2
ms.technology: devops-analytics
ms.reviewer: angurusw
ms.technology: devops-analytics
ms.author: kaelli
author: KathrynEE
ms.topic: conceptual
monikerRange: '>= azure-devops-2019'
ms.date: 08/10/2020
ms.date: 09/21/2021
---

# Connect to Analytics with Power BI Data Connector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ Each query contains the following strings that you must substitute with your val
- {organization} - Your organization name.
- {project} - Your team project name.
- {pipelinename} - Your pipeline name. Example: **Fabrikam hourly build pipeline**.
- {startdate} - The date to start your report. Format: YYYY-MM-DDZ. Example: **2019-09-04Z** represents September 4, 2019. Don't enclose in quotes or brackets and use two digits for both, month and date.
- {startdate} - The date to start your report. Format: YYYY-MM-DDZ. Example: **2021-09-01Z** represents September 1, 2021. Don't enclose in quotes or brackets and use two digits for both, month and date.
- {taskname} - The display name of the task for which the duration trend is needed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Each query contains the following strings that you must substitute with your val
- {organization} - Your organization name
- {project} - Your team project name
- {pipelinename} - Your pipeline name. Example: **Fabrikam hourly build pipeline**.
- {startdate} - The date to start your report. Format: YYYY-MM-DDZ. Example: **2019-09-04Z** represents September 4, 2019. Don't enclose in quotes or brackets and use two digits for both, month and date.
- {startdate} - The date to start your report. Format: YYYY-MM-DDZ. Example: **2021-09-01Z** represents September 1, 2021. Don't enclose in quotes or brackets and use two digits for both, month and date.
6 changes: 5 additions & 1 deletion docs/report/powerbi/includes/preview-note.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
ms.technology: devops-analytics
ms.author: kaelli
author: KathrynEE
ms.topic: include
ms.date: 09/21/2021
---

> [!IMPORTANT]
> [Power BI integration](../overview.md) and access to the [OData feed](../../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. The sample queries provided in this article are valid only against Azure DevOps Services and depend on [**v3.0-preview**](../../extend-analytics/odata-api-version.md). We encourage you to use these queries and provide us feedback. As we add features, we will post them on the [Microsoft DevOps blog](https://devblogs.microsoft.com/devops/?s=reporting).
> [Power BI integration](../overview.md) and access to the [OData feed](../../extend-analytics/quick-ref.md) of the Analytics Service are in Preview. The sample queries provided in this article are valid only against Azure DevOps Services and depend on [**v3.0-preview**](../../extend-analytics/odata-api-version.md) or later version. We encourage you to use these queries and provide us feedback.
31 changes: 31 additions & 0 deletions docs/report/powerbi/includes/query-filters-pipelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
ms.technology: devops-analytics
ms.author: kaelli
author: KathrynEE
ms.topic: include
ms.date: 09/21/2021
---

## Query filters

To determine available query filters, query the metadata as described in [Explore the Analytics OData metadata](../../extend-analytics/analytics-metadata.md). You can filter your queries using any of the **NavigationPropertyBinding Path** values listed under an **EntitySet**. To learn more about the data type of each value, review the metadata provided for the corresponding **EntityType**. Each **EntitySet** corresponds to the singular value for an **EntityType**.

For example, the **EntitySet Name="PipelineRunActivityResults"** corresponds to the **EntityType Name="PipelineRunActivityResult"**. The OData metadata for **EntitySet Name="PipelineRunActivityResults"** is as shown below for **v4.0-preview**. You can add filters based on any of the listed **NavigationPropertyBinding Path** values.

> [!div class="tabbedCodeSnippets"]
> ```XML
> <EntitySet Name="PipelineRunActivityResults" EntityType="Microsoft.VisualStudio.Services.Analytics.Model.PipelineRunActivityResult">
> <NavigationPropertyBinding Path="Project" Target="Projects"/>
> <NavigationPropertyBinding Path="Pipeline" Target="Pipelines"/>
> <NavigationPropertyBinding Path="PipelineTask" Target="PipelineTasks"/>
> <NavigationPropertyBinding Path="PipelineJob" Target="PipelineJobs"/>
> <NavigationPropertyBinding Path="Branch" Target="Branches"/>
> <NavigationPropertyBinding Path="PipelineRunQueuedOn" Target="Dates"/>
> <NavigationPropertyBinding Path="PipelineRunStartedOn" Target="Dates"/>
> <NavigationPropertyBinding Path="PipelineRunCompletedOn" Target="Dates"/>
> <NavigationPropertyBinding Path="ActivityStartedOn" Target="Dates"/>
> <NavigationPropertyBinding Path="ActivityCompletedOn" Target="Dates"/>
> </EntitySet>
> ```
30 changes: 30 additions & 0 deletions docs/report/powerbi/includes/query-filters-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
ms.technology: devops-analytics
ms.author: kaelli
author: KathrynEE
ms.topic: include
ms.date: 09/21/2021
---

## Query filters

To determine available query filters, query the metadata as described in [Explore the Analytics OData metadata](../../extend-analytics/analytics-metadata.md). You can filter your queries using any of the **NavigationPropertyBinding Path** values listed under an **EntitySet**. To learn more about the data type of each value, review the metadata provided for the corresponding **EntityType**. Each **EntitySet** corresponds to the singular value for an **EntityType**.


For example, the **EntitySet Name="TestPoints"** corresponds to the **EntityType Name="TestPoint"**. The OData metadata for the **EntitySet Name="TestPoints"** is as shown below for **v4.0-preview**. You can add filters based on any of the listed **NavigationPropertyBinding Path** values.

> [!div class="tabbedCodeSnippets"]
> ```XML
> <EntitySet Name="TestPoints" EntityType="Microsoft.VisualStudio.Services.Analytics.Model.TestPoint">
> <NavigationPropertyBinding Path="ChangedOn" Target="Dates"/>
> <NavigationPropertyBinding Path="Project" Target="Projects"/>
> <NavigationPropertyBinding Path="TestSuite" Target="TestSuites"/>
> <NavigationPropertyBinding Path="TestConfiguration" Target="TestConfigurations"/>
> <NavigationPropertyBinding Path="TestCase" Target="WorkItems"/>
> <NavigationPropertyBinding Path="Tester" Target="Users"/>
> <NavigationPropertyBinding Path="AssignedTo" Target="Users"/>
> <Annotation Term="Org.OData.Display.V1.DisplayName" String="Test Points"/>
> </EntitySet>
> ```
Loading

0 comments on commit 64dd2bb

Please sign in to comment.