diff --git a/docs/report/dashboards/burndown-guidance.md b/docs/report/dashboards/burndown-guidance.md index d7fc8da672b..173c505cb7a 100644 --- a/docs/report/dashboards/burndown-guidance.md +++ b/docs/report/dashboards/burndown-guidance.md @@ -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' diff --git a/docs/report/dashboards/charts.md b/docs/report/dashboards/charts.md index a0ccf53f10d..5d82e5fba2e 100644 --- a/docs/report/dashboards/charts.md +++ b/docs/report/dashboards/charts.md @@ -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 @@ -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) \ No newline at end of file diff --git a/docs/report/dashboards/team-velocity.md b/docs/report/dashboards/team-velocity.md index e6a35fa48fa..89f9d373e5e 100644 --- a/docs/report/dashboards/team-velocity.md +++ b/docs/report/dashboards/team-velocity.md @@ -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' diff --git a/docs/report/extend-analytics/data-model-analytics-service.md b/docs/report/extend-analytics/data-model-analytics-service.md index 65b0c2a278f..c13178fb662 100644 --- a/docs/report/extend-analytics/data-model-analytics-service.md +++ b/docs/report/extend-analytics/data-model-analytics-service.md @@ -1,15 +1,14 @@ --- title: Data model for Analytics titleSuffix: Azure DevOps -description: Describes the data entities and relationships provided by Analytics for Azure DevOps +description: Describes the EntityTypes and relationships provided by Analytics for Azure DevOps ms.technology: devops-analytics -ms.assetid: 032FB76F-DC43-4863-AFC6-F8D67963B177 -ms.reviewer: angurusw +ms.assetid: 032FB76F-DC43-4863-AFC6-F8D67963B177 ms.author: kaelli author: KathrynEE ms.topic: reference monikerRange: '>= azure-devops-2019' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # Data model for Analytics @@ -24,10 +23,14 @@ Analytics data model for Azure DevOps consists of entity sets, whose members (en -## Entities +## EntityTypes and EntitySets + +Entity types are named structured types with a key. They define the named properties and relationships of each entity. The key of an **EntityType** is formed from a subset of the primitive properties, for example—*WorkItemId*, *PipelineId*, *ReleasePipelineId*—and more of the entity type. + +Entity sets are named collections of entities. For example, **WorkItems** is an entity set containing **WorkItem** entities. An entity's key uniquely identifies the entity within an entity set. If multiple entity sets use the same entity type, the same combination of key values can appear in more than one entity set and identifies different entities, one per entity set where this key combination appears. Each of these entities has a different entity-id. Entity sets provide entry points into the data model. > [!NOTE] ->Entity sets are described in OData metadata, and vary by project. A complete list of entity sets, entity types, and properties can be discovered by requesting the OData metadata for your project: +> Entity sets are described in OData metadata, and vary by project. You can explore the complete list of entity sets, entity types, and properties by requesting the OData metadata for your project. ::: moniker range="azure-devops" @@ -49,48 +52,73 @@ Analytics data model for Azure DevOps consists of entity sets, whose members (en [!INCLUDE [temp](../includes/api-versioning.md)] -The following EntitySets are supported with the indicated API versions. For the latest version information, see [OData API versioning](odata-api-version.md). +The following **EntitySets** are supported with the indicated API versions. For the latest version information, see [OData API versioning](odata-api-version.md). -## Work tracking EntitySets +## Work tracking EntityTypes and EntitySets > [!div class="mx-tdCol2BreakAll"] -> | EntitySet | Description | v1.0 | v2.0 | v3.0-preview | -> |-----------|-------------|------|------|--------------| -> |Areas | The work item Area Paths, with properties for grouping and filtering by area hierarchy | ✔️|✔️|✔️ | -> |Iterations | The work item Iteration Paths, with properties for grouping and filtering by iteration hierarchy |✔️|✔️|✔️ | -> |BoardLocations | The Kanban board cell locations, as identified by board column, lane, and split, includes historic board settings| ✔️|✔️|✔️ | -> |Dates | The dates used to filter and group other entities using relationships | ✔️|✔️|✔️ | -> |Projects | All projects defined for an organization |✔️|✔️|✔️ | -> |Processes | Backlog information - used to expand or filter work items and work item types| |✔️|✔️ | -> |Tags | All work item tags for each project | ✔️|✔️|✔️ | -> |Teams | All teams defined for the project (To add a team, see [Add teams](../../organizations/settings/add-teams.md)) | ✔️|✔️|✔️ | -> |Users | User information that is used to expand or filter various work item properties (e.g. Assigned To, Created By)| ✔️|✔️|✔️ | -> |WorkItems | The current state of work items| ✔️|✔️|✔️ | -> |WorkItemLinks | The links between work items (e.g. child, parent, related) - includes only latest revision of links (no history) - hyperlinks not included | ✔️|✔️|✔️ | -> |WorkItemRevisions | All historic work item revisions, including the current revision - does not include deleted work items| ✔️|✔️|✔️ | -> |WorkItemSnapshot | (Composite) The state of each work item on each calendar date - used for trend reporting| ✔️|✔️|✔️ | -> |WorkItemBoardSnapshot | (Composite) The state of each work item on each calendar date, including Kanban board location - used for trend reporting| ✔️|✔️|✔️ | -> |WorkItemTypeFields | The work item properties for each work item type and process - used for report building| ✔️|✔️|✔️ | +> |EntityType/EntitySet | Description | v1.0 | v2.0 | v3.0-preview | v4.0-preview | +> |----------------------|-------------|------|------|--------------|--------------| +> |**Area**/
**Areas** |The work item **Area Paths**, with properties for grouping and filtering by area hierarchy. | ✔️|✔️|✔️ | ✔️ | +> |**Iteration**/
**Iterations** | The work item **Iteration Paths**, with properties for grouping and filtering by iteration hierarchy. |✔️|✔️|✔️ | ✔️ | +> |**BoardLocation**/
**BoardLocations** |The Kanban board cell locations, as identified by board column, lane, and split, includes historic board settings. For a description of each Kanban board field, see [Workflow and Kanban board fields](../../boards/queries/query-by-workflow-changes.md#workflow-and-kanban-board-fields).| ✔️|✔️|✔️ | ✔️ | +> |**CalendarDate**/
**Dates** | The dates used to filter and group other entities using relationships. | ✔️|✔️|✔️ | ✔️ | +> |**Project**/
**Projects** |All projects defined for an organization. |✔️|✔️|✔️ | ✔️ | +> |**Process**/
**Processes** |Backlog information used to expand or filter work items and work item types. For an example that uses **Processes** to filter a report, see [Requirements tracking sample report](../powerbi/sample-stories-overview.md). | |✔️|✔️ | ✔️ | +> |**Tag**/
**Tags** | All work item tags for each project. For an example that uses **Tags** to filter a report, see [Release burndown sample report](../powerbi/sample-boards-releaseburndown.md). | ✔️|✔️|✔️ | +> |**Team**/
**Teams** | All teams defined for the project. For an example that uses **Teams** to filter a report, see [Add a Team slicer to a Power BI report](../powerbi/sample-boards-teamslicer.md). | ✔️|✔️|✔️ | ✔️ | +> |**User**/
**Users** |User information that is used to expand or filter various work item properties, for example **Assigned To**, **Created By**. | ✔️|✔️|✔️ | ✔️ | +> |**WorkItemBoardSnapshot**/
**WorkItemBoardSnapshot** |(Composite) The state of each work item on each calendar date, including Kanban board location, used to generate trend reports. For a sample report, see [Cumulative Flow Diagram (CFD) sample report](../powerbi/sample-boards-cfd.md). | ✔️|✔️|✔️ | ✔️ | +> |**WorkItemLink**/
**WorkItemLinks** | The links between work items, for example, *Child*, *Parent*, and *Related*. Includes only the latest revision of links, no history. Hyperlinks aren't included. | ✔️|✔️|✔️ | ✔️ | +> |**WorkItemRevision**/
**WorkItemRevisions** |All historic work item revisions, including the current revision. Does not include deleted work items. | ✔️|✔️|✔️ | ✔️ | +> |**WorkItemSnapshot**/
**WorkItemSnapshot** |(Composite) The state of each work item on each calendar date, used to support trend reporting. For a sample report, see [Bug trends sample report](../powerbi/sample-boards-bugtrend.md). | ✔️|✔️|✔️ | ✔️ | +> |**WorkItem**/
**WorkItems** |The current state of work items. Used to support status reports. For a sample report, see [Rollup child work item values to parent sample report](../powerbi/sample-boards-rollup.md). | ✔️|✔️|✔️ | ✔️ | +> |**WorkItemTypeField**/
**WorkItemTypeFields** |The work item properties for each work item type and process. Used to support building reports. | ✔️|✔️|✔️ | ✔️ | + +**Additional resources:** + +- [Analytics views dataset design](../powerbi/data-connector-dataset.md) +- [About area and iteration (sprint) paths](../../organizations/settings/about-areas-iterations.md) +- [About teams and Agile tools](../../settings/about-teams-and-settings.md) +- [Project and team quick reference](../../organizations/projects/project-team-quick-reference.md) +- [Add work item tags to categorize and filter lists and boards](../../boards/queries/add-tags-to-work-items.md) +- [Add teams](../../organizations/settings/add-teams.md) +- [Link type reference](../../boards/queries/link-type-reference.md) + ::: moniker range=">= azure-devops-2020" -## Branch, Pipelines, and Test EntitySets +## Branch, Pipelines, and Test EntityTypes and EntitySets -The following EntitySets are only supported with the **v3.0-preview** API version. +The following **EntityTypes** and **EntitySets** are supported with the **v3.0-preview** or **v4.0-preview** API versions. > [!div class="mx-tdCol2BreakAll"] -> | EntitySet | Description | v3.0-preview | -> |-----------|-------------|------| -> |Branches | Basic information about branches used in tests or pipelines | ✔️ | -> |Pipelines| Properties for a pipeline | ✔️ | -> |PipelineTasks | Properties for tasks that are used within a pipeline | ✔️ | -> |PipelineRunActivityResults | Merged log of all the stages/steps/jobs/tasks within a specific pipeline execution | ✔️ | -> |PipelineRuns | Execution information for pipelines | ✔️ | -> |TestResultsDaily | A daily snapshot aggregate of TestResult executions, grouped by Test (not TestRun) | ✔️ | -> |TestRuns | Execution information for tests run under a pipeline with aggregate TestResult | ✔️ | -> |Tests | Properties for a test | ✔️ | -> |TestResults | Individual execution results for a specific Test associated with a TestRun | ✔️ | - +> |EntityType/EntitySet | Description | v3.0-preview | v4.0-preview | +> |----------------------|-------------|--------------|--------------| +> |**Branch**/
**Branches** | Basic information about branches used in tests or pipelines. For a sample report, see [Progress status sample report](../powerbi/sample-test-plans-progress-status.md).| ✔️ | ✔️ | +> |**ParallelPipelineJobsSnapshot**/
**ParallelPipelineJobsSnapshot** | (Composite) Supports understanding of parallel pipeline consumption. To learn more about parallel pipeline tests, see [Run tests in parallel using the Visual Studio Test task](../../pipelines/test/parallel-testing-vstest.md). | | ✔️ | +> |**Pipeline**/
**Pipelines**| Properties for a pipeline. | ✔️ | ✔️ | +> |**PipelineJob**/
**PipelineJobs** |Individual execution results for a specific Test associated with a TestRun | ✔️ | ✔️ | +> |**PipelineRun**/
**PipelineRuns** | Execution information for pipelines. For a sample report, see [Pipeline pass rate trend sample report](../powerbi/sample-pipelines-pass-rate-trend.md). | ✔️ | ✔️ | +> |**PipelineRunActivityResult**/
**PipelineRunActivityResults** | Merged log of all the stages, steps, jobs, and tasks within a specific pipeline execution. For a sample report, see [Pipeline task duration sample report](../powerbi/sample-pipelines-task-duration.md). | ✔️ | ✔️ | +> |**PipelineTask**/
**PipelineTasks** | Properties for tasks that are used within a pipeline. | ✔️ | ✔️ | +> |**TestConfiguration**/
**TestConfigurations** |Test plan configuration information. For details on configuring tests, see [Test different configurations](../../test/test-different-configurations.md) | ✔️ | ✔️ | +> |**TestResult**/
**TestResults** | Individual execution results for a specific **Test** associated with a **TestRun**. | ✔️ | ✔️ | +> |**TestResultsDaily**/
**TestResultsDaily** | A daily snapshot aggregate of **TestResult** executions, grouped by Test (not TestRun). For a sample report, see [Test summary trend sample report](../powerbi/sample-test-summary-trend.md). | ✔️ | ✔️ | +> |**TestRun**/
**TestRuns** | Execution information for tests run under a pipeline with aggregate TestResult. | ✔️ | ✔️ | +> |**Test**/
**Tests** | Properties for a test case, such as test name and test owner. For details on defining test cases, see [Create manual test cases](../../test/create-test-cases.md). | ✔️ | ✔️ | +> |**TestPoint**/
**TestPoints** | Execution information for test points. A test point is a unique combination of test case, test suite, configuration, and tester. For a sample report, see [Progress status sample report](../powerbi/sample-test-plans-progress-status.md). | ✔️ | ✔️ | +> |**TestPointHistorySnapshot**/
**TestPointHistorySnapshots** | (Composite) Individual execution results for a specific **Test** associated with a **TestRun**. For a sample report, see [Manual test execution trend sample report](../powerbi/sample-test-plans-execution-trend.md)| ✔️ | ✔️ | +> |**TestSuite**/
**TestSuites**| Test suites information. For details on defining test suites, see [Create test plans and test suites](../../test/create-a-test-plan.md). | ✔️ | ✔️ | +> |**TaskAgentPoolSizeSnapshot**/
**TaskAgentPoolSizeSnapshots** |(Composite) Supports understanding of pool size, pipeline jobs, and concurrency. The [Historical graph for agent pools](../../pipelines/agents/pool-consumption-report.md) illustrates how this entity set can be used. | | ✔️ | +> |**TaskAgentRequestSnapshot**/
**TaskAgentRequestSnapshots** |(Composite) | | ✔️ | + +**Additional resources:** + +- [Use Azure Pipelines](../../pipelines/get-started/pipelines-get-started.md) +- [About pipeline tests](../../pipelines/test/test-glossary.md) +- [Test objects and terms](../../test/test-objects-overview.md) + ::: moniker-end @@ -98,9 +126,9 @@ The following EntitySets are only supported with the **v3.0-preview** API versio Composite entities support specific scenarios. They are composed from simpler entities, often require more computing resources to generate, and may return larger result sets. To achieve the best performance and avoid unnecessary throttling, ensure that you query the correct entity for your scenario. -For example, WorkItemSnapshot combines WorkItemRevisions and Dates such that each date has one revision for each work item. This representation supports OData queries that focus on trend data for a filtered set of work items. However, you should not use this composite entity to query the current state of work items. Instead, you should use the WorkItems entity set to generate a more quick-running query. +For example, **WorkItemSnapshot** combines **WorkItemRevisions** and **Dates** such that each date has one revision for each work item. This representation supports OData queries that focus on trend data for a filtered set of work items. However, you should not use this composite entity to query the current state of work items. Instead, you should use the **WorkItems** entity set to generate a more quick-running query. -Similarly, some entities may contain all historic values, while others may only contain current values. WorkItemRevision contains all work item history, which you should not use in scenarios where the current values are of interest. +Similarly, some entities may contain all historic values, while others may only contain current values. **WorkItemRevision** contains all work item history, which you should not use in scenarios where the current values are of interest. ## Relationships @@ -112,24 +140,27 @@ Some navigation properties result in a single entity, while others result in a c ## Relationship keys - Entity relationships are also represented as foreign keys so that external tools can join entities. These properties have the suffix "SK", and are either integer or GUID data types. Date properties have corresponding integer date key properties with the following format: YYYYMMDD. + Entity relationships are also represented as foreign keys so that external tools can join entities. These properties have the suffix "SK", and are either integer or GUID data types. Date properties have corresponding integer date key properties with the following format: **YYYYMMDD**. ## Entity properties -The following table provides a partial list of the WorkItemRevision entity properties to illustrate some common details. The last three properties—CreatedDate, CreatedDateSK, CreatedOn—show that the same value is often expressed in multiple properties, each designed for different scenarios. +The following table provides _*a partial list*_ of the **WorkItemRevision** entity properties to illustrate some common details. The first three properties—**CreatedDate**, **CreatedDateSK**, **CreatedOn**—show that the same value is often expressed in multiple properties, each designed for different scenarios. | Property | Type | Description| |--------|------------|------------| -|WorkItemRevisionSK | Int32 | The Analytics unique key for the work item revision - used by external tools to join related entities. -|WorkItemId | Int32 | The Id for the work item. -|Revision | Int32 | The revision of the work item. -|Title | String | The work item title. -|WorkItemType | String | The work item type (e.g. Bug, Task, User Story). -|StoryPoints | Double | The points assigned to this work item - commonly aggregated as a sum. -| Tags | Navigation | Navigation property to a Tag entity collection. Commonly used in ```$expand``` statements to access the Name property for multiple work item tags. -|CreatedDate | DateTimeOffset | The date the work item was created, expressed in the [time zone defined for the organization](../../organizations/accounts/change-organization-location.md). Commonly used for filtering and for display. -|CreatedDateSK | Int32 | The date the work item was created, expressed as YYYYMMDD in the time zone defined for the organization. Used by external tools to join related entities. -|CreatedOn | Navigation | Navigation property to the Date entity for the date the work item was created, in the time zone defined for the organization. Commonly used to reference properties from the Date entity in ```groupby``` statements. +|**CreatedDate** | DateTimeOffset | The date the work item was created, expressed in the [time zone defined for the organization](../../organizations/accounts/change-organization-location.md). Commonly used for filtering and for display. | +|**CreatedDateSK** | Int32 | The date the work item was created, expressed as `YYYYMMDD` in the time zone defined for the organization. Used by external tools to join related entities. | +|**CreatedOn** | Navigation | Navigation property to the Date entity for the date the work item was created, in the time zone defined for the organization. Commonly used to reference properties from the Date entity in ```groupby``` statements. | +|**StoryPoints** | Double | The points assigned to a work item, commonly aggregated as a sum. | +|**Tags** | Navigation | Navigation property to a Tag entity collection. Commonly used in ```$expand``` statements to access the Name property for multiple work item tags. | +|**Title** | String | The work item title. | +|**Revision** | Int32 | The revision of the work item. | +|**WorkItemId** | Int32 | The ID for the work item. | +|**WorkItemRevisionSK** | Int32 | The Analytics unique key for the work item revision - used by external tools to join related entities. | +|**WorkItemType** | String | The work item type, for example Bug, Task, User Story. | + + + > [!NOTE] > Changes to custom work item fields will affect the shape of your data model and will affect all work item revisions. For instance, if you add a new field, queries on pre-existing revision data will reflect the presence of the new field. @@ -137,6 +168,7 @@ The following table provides a partial list of the WorkItemRevision entity prope ## Related articles +- [Query guidelines for Analytics with OData](odata-query-guidelines.md) - [WIT analytics](wit-analytics.md) - [Aggregate data](aggregated-data-analytics.md) - [Exploring Analytics OData metadata](analytics-metadata.md) diff --git a/docs/report/extend-analytics/odata-api-version.md b/docs/report/extend-analytics/odata-api-version.md index 96bfa5f6337..3af6cfa20f8 100644 --- a/docs/report/extend-analytics/odata-api-version.md +++ b/docs/report/extend-analytics/odata-api-version.md @@ -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 @@ -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" @@ -43,12 +42,13 @@ The API version follows the _odata element in the request path and has value as ## Preview versions -v3.0-preview +- **v3.0-preview** +- **v4.0-preview** ## Released versions -v1.0 -v2.0 +- **v1.0** +- **v2.0** ## Entity sets supported in each version @@ -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: diff --git a/docs/report/extend-analytics/toc.yml b/docs/report/extend-analytics/toc.yml deleted file mode 100644 index e96708b4b07..00000000000 --- a/docs/report/extend-analytics/toc.yml +++ /dev/null @@ -1,29 +0,0 @@ -- name: Extend Analytics with OData (Preview) - href: quick-ref.md -- name: Query work item data - href: wit-analytics.md -- name: "Project & organization-scoped queries" - href: account-scoped-queries.md -- name: Query aggregate data - href: aggregated-data-analytics.md -- name: Query trend data - href: querying-for-trend-data.md -- name: Query work item links - href: work-item-links.md -- name: Explore Analytics metadata - href: analytics-metadata.md -- name: Samples - items: - - name: Work tracking queries - href: analytics-recipes.md -- name: Reference - items: - - name: Query guidelines - href: odata-query-guidelines.md - - name: Data model - href: data-model-analytics-service.md - - name: "Supported functions & clauses" - href: odata-supported-features.md - - name: API versioning - href: odata-api-version.md - diff --git a/docs/report/includes/analytics-preview.md b/docs/report/includes/analytics-preview.md index 69f0e69d2b8..153d2102149 100644 --- a/docs/report/includes/analytics-preview.md +++ b/docs/report/includes/analytics-preview.md @@ -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 \ No newline at end of file diff --git a/docs/report/includes/api-versioning.md b/docs/report/includes/api-versioning.md index e4d9fa57539..431be67497e 100644 --- a/docs/report/includes/api-versioning.md +++ b/docs/report/includes/api-versioning.md @@ -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). \ No newline at end of file +> 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). \ No newline at end of file diff --git a/docs/report/powerbi/analytics-historical-filtering.md b/docs/report/powerbi/analytics-historical-filtering.md index 80d134cfa4c..b4d1ed16e89 100644 --- a/docs/report/powerbi/analytics-historical-filtering.md +++ b/docs/report/powerbi/analytics-historical-filtering.md @@ -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 --- diff --git a/docs/report/powerbi/data-available-in-analytics.md b/docs/report/powerbi/data-available-in-analytics.md index 12149db78eb..0e2855f3d64 100644 --- a/docs/report/powerbi/data-available-in-analytics.md +++ b/docs/report/powerbi/data-available-in-analytics.md @@ -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 @@ -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=""::: @@ -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=""::: @@ -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 @@ -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 diff --git a/docs/report/powerbi/data-connector-connect.md b/docs/report/powerbi/data-connector-connect.md index f376c26fd84..da0957b43c2 100644 --- a/docs/report/powerbi/data-connector-connect.md +++ b/docs/report/powerbi/data-connector-connect.md @@ -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 diff --git a/docs/report/powerbi/includes/pipelines-sample-query-substitutions-task-name.md b/docs/report/powerbi/includes/pipelines-sample-query-substitutions-task-name.md index 2b0028daabf..d1102587ce6 100644 --- a/docs/report/powerbi/includes/pipelines-sample-query-substitutions-task-name.md +++ b/docs/report/powerbi/includes/pipelines-sample-query-substitutions-task-name.md @@ -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. diff --git a/docs/report/powerbi/includes/pipelines-sample-query-substitutions.md b/docs/report/powerbi/includes/pipelines-sample-query-substitutions.md index 1c0f608fffc..a846a7fd0bf 100644 --- a/docs/report/powerbi/includes/pipelines-sample-query-substitutions.md +++ b/docs/report/powerbi/includes/pipelines-sample-query-substitutions.md @@ -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. diff --git a/docs/report/powerbi/includes/preview-note.md b/docs/report/powerbi/includes/preview-note.md index 12c97e209a0..dd8e29004cb 100644 --- a/docs/report/powerbi/includes/preview-note.md +++ b/docs/report/powerbi/includes/preview-note.md @@ -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. diff --git a/docs/report/powerbi/includes/query-filters-pipelines.md b/docs/report/powerbi/includes/query-filters-pipelines.md new file mode 100644 index 00000000000..ef430102570 --- /dev/null +++ b/docs/report/powerbi/includes/query-filters-pipelines.md @@ -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 +> +> +> +> +> +> +> +> +> +> +> +> +> ``` + + diff --git a/docs/report/powerbi/includes/query-filters-test.md b/docs/report/powerbi/includes/query-filters-test.md new file mode 100644 index 00000000000..6cd98d94a33 --- /dev/null +++ b/docs/report/powerbi/includes/query-filters-test.md @@ -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 +> +> +> +> +> +> +> +> +> +> +> ``` + + diff --git a/docs/report/powerbi/includes/query-filters-work-items.md b/docs/report/powerbi/includes/query-filters-work-items.md new file mode 100644 index 00000000000..5f5c4c265d7 --- /dev/null +++ b/docs/report/powerbi/includes/query-filters-work-items.md @@ -0,0 +1,42 @@ +--- +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 an **EntityType**. + +For example, the **EntitySet Name="WorkItemSnapshot"** corresponds to the **EntityType Name="WorkItemSnapshot"**. The OData metadata for **EntitySet Name="WorkItemSnapshot"** 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 +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> ``` + + diff --git a/docs/report/powerbi/odataquery-connect.md b/docs/report/powerbi/odataquery-connect.md index c499154224a..e145f7bbe4e 100644 --- a/docs/report/powerbi/odataquery-connect.md +++ b/docs/report/powerbi/odataquery-connect.md @@ -7,7 +7,7 @@ ms.author: kaelli author: KathrynEE ms.topic: tutorial monikerRange: '>= azure-devops-2019' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Connect with data by using Power BI and OData queries diff --git a/docs/report/powerbi/overview.md b/docs/report/powerbi/overview.md index 892fb268e35..9399cc74e2a 100644 --- a/docs/report/powerbi/overview.md +++ b/docs/report/powerbi/overview.md @@ -1,5 +1,5 @@ --- -title: Learn about Power BI integration and supported connection methods +title: Learn about Power BI integration and supported connections methods titleSuffix: Azure DevOps description: Describes the different integration options you can use to connect to Power BI to access Analytics for Azure DevOps ms.assetid: 8026A5ED-CD58-417A-913F-72A20272E7DC @@ -8,16 +8,16 @@ ms.topic: conceptual ms.author: kaelli author: KathrynEE monikerRange: '>=azure-devops-2019' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # About Power BI integration [!INCLUDE [temp](../includes/version-azure-devops.md)] -With Azure DevOps, you can create [dashboards](../dashboards/dashboards.md) and [add widgets to them](../dashboards/add-widget-to-dashboard.md). Azure DevOps also provides several reports in the product itself. Both dashboards and in-line reports offer easy access to [Azure DevOps Analytics](what-is-analytics.md) to enable data-driven decisions. However, we acknowledge that customers often need more than what is provided in the product. +With Azure DevOps, you can create [dashboards](../dashboards/dashboards.md) and [add widgets to them](../dashboards/add-widget-to-dashboard.md). Azure DevOps also provides several reports in the product itself. Both dashboards and in-line reports offer easy access to Azure DevOps Analytics to enable data-driven decisions. However, we acknowledge that customers often need more than what is provided in the product. -With Power BI, you can pull data from [Azure DevOps Analytics](what-is-analytics.md), generate reports, and customize them to meet your needs. [Power BI](https://powerbi.microsoft.com) is a suite of business analytics tools. Use it to do ad hoc analysis, produce beautiful reports, and publish for enterprise consumption. +With Power BI, you can pull data from [Analytics](what-is-analytics.md), generate reports, and customize them to meet your needs. [Power BI](https://powerbi.microsoft.com) is a suite of business analytics tools. Use it to do ad hoc analysis, produce beautiful reports, and publish for enterprise consumption. [!INCLUDE [temp](../includes/analytics-preview.md)] diff --git a/docs/report/powerbi/reporting-roadmap.md b/docs/report/powerbi/reporting-roadmap.md index bc42c5d86c8..898b1b583fa 100644 --- a/docs/report/powerbi/reporting-roadmap.md +++ b/docs/report/powerbi/reporting-roadmap.md @@ -1,9 +1,8 @@ --- title: Reporting roadmap titleSuffix: Azure DevOps -description: Reporting roadmap for Azure DevOps and Team Foundation Server (TFS) +description: Reporting roadmap for Azure DevOps ms.technology: devops-analytics -ms.reviewer: greggboe ms.author: kaelli author: KathrynEE ms.topic: conceptual diff --git a/docs/report/powerbi/sample-boards-bugtrend.md b/docs/report/powerbi/sample-boards-bugtrend.md index 9b91c2f179c..cf924315203 100644 --- a/docs/report/powerbi/sample-boards-bugtrend.md +++ b/docs/report/powerbi/sample-boards-bugtrend.md @@ -1,15 +1,14 @@ --- title: Bug trends sample Power BI report titleSuffix: Azure DevOps -description: Sample Power BI queries to display bug trend reports +description: How to generate a bug trend Power BI report ms.technology: devops-analytics -ms.reviewer: greggboe ms.author: kaelli ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 08/07/2019 +ms.date: 09/21/2021 --- # Bug trends sample report @@ -99,6 +98,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms diff --git a/docs/report/powerbi/sample-boards-cfd.md b/docs/report/powerbi/sample-boards-cfd.md index 482ded0beed..e438a8bfcdb 100644 --- a/docs/report/powerbi/sample-boards-cfd.md +++ b/docs/report/powerbi/sample-boards-cfd.md @@ -1,15 +1,14 @@ --- title: Cumulative Flow Diagram (CFD) sample Power BI report titleSuffix: Azure DevOps -description: Sample Power BI queries to generate a Cumulative Flow Diagram (CFD) +description: How generate a Cumulative Flow Diagram (CFD) Power BI report ms.technology: devops-analytics -ms.reviewer: greggboe ms.author: kaelli ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 08/07/2019 +ms.date: 09/21/2021 --- # Cumulative Flow Diagram (CFD) sample report @@ -92,6 +91,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms diff --git a/docs/report/powerbi/sample-boards-directlinks.md b/docs/report/powerbi/sample-boards-directlinks.md index 17e0b843195..ebf6c54f1c0 100644 --- a/docs/report/powerbi/sample-boards-directlinks.md +++ b/docs/report/powerbi/sample-boards-directlinks.md @@ -1,15 +1,14 @@ --- title: Work Items with Direct Links sample report titleSuffix: Azure DevOps -description: Sample Power BI queries to generate reports based on Work Items with Direct Links +description: How to generate Power BI reports based on Work Items with Direct Links ms.technology: devops-analytics -ms.reviewer: greggboe ms.author: kaelli ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 08/07/2019 +ms.date: 09/21/2021 --- # Work items with direct links sample reports @@ -102,6 +101,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms [!INCLUDE [temp](includes/sample-expandcolumns.md)] diff --git a/docs/report/powerbi/sample-boards-featureprogress.md b/docs/report/powerbi/sample-boards-featureprogress.md index 19d57833777..27a4f2d8ded 100644 --- a/docs/report/powerbi/sample-boards-featureprogress.md +++ b/docs/report/powerbi/sample-boards-featureprogress.md @@ -1,15 +1,14 @@ --- title: Feature Progress rollup sample Power BI report titleSuffix: Azure DevOps -description: Sample Power BI queries to display Feature progress rollup by Story Pointas +description: How to generate feature progress rollup by Story Points Power BI report ms.technology: devops-analytics -ms.reviewer: greggboe ms.author: kaelli ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 03/06/2020 +ms.date: 09/21/2021 --- # Feature progress rollup sample report @@ -190,6 +189,8 @@ The following table describes each part of the query. :::row-end::: +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms [!INCLUDE [temp](includes/sample-expandcolumns.md)] diff --git a/docs/report/powerbi/sample-boards-leadcycletime.md b/docs/report/powerbi/sample-boards-leadcycletime.md index fe6dbdd5c31..aecfad9eb05 100644 --- a/docs/report/powerbi/sample-boards-leadcycletime.md +++ b/docs/report/powerbi/sample-boards-leadcycletime.md @@ -1,15 +1,14 @@ --- title: Lead/Cycle time sample Power BI report titleSuffix: Azure DevOps -description: Sample Power BI queries to generate Lead/Cycle Time reports +description: How to generate Lead/Cycle time Power BI reports ms.technology: devops-analytics -ms.reviewer: greggboe ms.author: kaelli ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 08/07/2019 +ms.date: 09/21/2021 --- # Lead/cycle time sample report @@ -88,6 +87,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms [!INCLUDE [temp](includes/sample-expandcolumns.md)] diff --git a/docs/report/powerbi/sample-boards-openbugs.md b/docs/report/powerbi/sample-boards-openbugs.md index bdb78d7980d..b8ff51ac602 100644 --- a/docs/report/powerbi/sample-boards-openbugs.md +++ b/docs/report/powerbi/sample-boards-openbugs.md @@ -1,14 +1,14 @@ --- title: Open bugs sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate an open bugs Power BI report +description: How-to generate an open bugs Power BI report ms.technology: devops-analytics ms.custom: powerbisample ms.author: kaelli author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 08/07/2019 +ms.date: 09/21/2021 --- # Open bugs sample report @@ -93,6 +93,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms [!INCLUDE [temp](includes/sample-expandcolumns.md)] diff --git a/docs/report/powerbi/sample-boards-releaseburndown.md b/docs/report/powerbi/sample-boards-releaseburndown.md index 11ffec53aaa..6c88079b6ed 100644 --- a/docs/report/powerbi/sample-boards-releaseburndown.md +++ b/docs/report/powerbi/sample-boards-releaseburndown.md @@ -1,17 +1,17 @@ --- title: Release Burndown sample Power BI report titleSuffix: Azure DevOps -description: Sample Power BI queries to generate a Release Burndown report +description: How to generate a release burndown Power BI report ms.technology: devops-analytics ms.custom: powerbisample ms.author: kaelli author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- -# Sample - Release Burndown +# Release burndown sample report [!INCLUDE [temp](../includes/version-azure-devops.md)] @@ -102,6 +102,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms [!INCLUDE [temp](includes/sample-expandcolumns.md)] diff --git a/docs/report/powerbi/sample-boards-rollup.md b/docs/report/powerbi/sample-boards-rollup.md index 9893ec12527..60142d59a28 100644 --- a/docs/report/powerbi/sample-boards-rollup.md +++ b/docs/report/powerbi/sample-boards-rollup.md @@ -1,14 +1,14 @@ --- title: Rollup child work item values to sample report titleSuffix: Azure DevOps -description: Sample Power BI queries to display rollup of child work item values to the parent +description: How to generate a rollup of child work item values to the parent Power BI report ms.technology: devops-analytics ms.custom: powerbisample ms.author: kaelli author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Rollup child work item values to parent sample report @@ -96,6 +96,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] + ## Power BI transforms [!INCLUDE [temp](includes/sample-expandcolumns.md)] diff --git a/docs/report/powerbi/sample-boards-sprintburndown.md b/docs/report/powerbi/sample-boards-sprintburndown.md index df11c920675..69854cffe7e 100644 --- a/docs/report/powerbi/sample-boards-sprintburndown.md +++ b/docs/report/powerbi/sample-boards-sprintburndown.md @@ -1,14 +1,14 @@ --- title: Sprint Burndown sample Power BI report titleSuffix: Azure DevOps -description: Sample Power BI queries to generate a Sprint Burndown report +description: How to generate a sprint burndown Power BI report ms.technology: devops-analytics ms.custom: powerbisample ms.author: kaelli author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Sprint burndown sample reports @@ -108,6 +108,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-boards-teamslicer.md b/docs/report/powerbi/sample-boards-teamslicer.md index dd73cd3e602..7e274d5d90c 100644 --- a/docs/report/powerbi/sample-boards-teamslicer.md +++ b/docs/report/powerbi/sample-boards-teamslicer.md @@ -1,18 +1,18 @@ --- title: Add a Team slicer to a Power BI report titleSuffix: Azure DevOps -description: Sample Power BI queries to add a Team slicer to a Power BI report +description: How to add a team slicer to a Power BI report ms.technology: devops-analytics ms.custom: powerbisample ms.author: kaelli author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- -# Add a Team slicer to a Power BI report +# Add a team slicer to a Power BI report [!INCLUDE [temp](../includes/version-azure-devops.md)] @@ -81,6 +81,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-work-items.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-odata-overview.md b/docs/report/powerbi/sample-odata-overview.md index 46ab49da855..fe1254f0447 100644 --- a/docs/report/powerbi/sample-odata-overview.md +++ b/docs/report/powerbi/sample-odata-overview.md @@ -8,7 +8,7 @@ ms.author: kaelli author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2019' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Overview of sample reports using OData queries @@ -107,3 +107,9 @@ The OData Query is provided in case you want to modify and test the OData query For more information on how to write OData queries against Analytics, check out the [OData Query Quick Reference](../extend-analytics/quick-ref.md) +## Related articles + +- [Data available from Analytics](data-available-in-analytics.md) +- [Data model for Analytics](../extend-analytics/data-model-analytics-service.md) +- [Analytics views dataset design](data-connector-dataset.md) +- [OData API versioning](../extend-analytics/odata-api-version.md) \ No newline at end of file diff --git a/docs/report/powerbi/sample-pipelines-allpipelines.md b/docs/report/powerbi/sample-pipelines-allpipelines.md index 8868bbb342d..f25203282aa 100644 --- a/docs/report/powerbi/sample-pipelines-allpipelines.md +++ b/docs/report/powerbi/sample-pipelines-allpipelines.md @@ -1,7 +1,7 @@ --- title: Pipeline outcome summary for all pipelines sample report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline outcome summary Power BI report for all pipelines in the project +description: How to generate a pipeline outcome summary Power BI report for all pipelines in the project ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Pipeline outcome summary for all pipelines sample report @@ -89,7 +89,7 @@ Each query contains the following strings that you must substitute with your val   - {organization} - Your organization name - {project} - Your team project name -- {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. ### Query breakdown @@ -138,6 +138,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-pipelines-duration-trend.md b/docs/report/powerbi/sample-pipelines-duration-trend.md index fec7df94eb1..fbeda67e4fe 100644 --- a/docs/report/powerbi/sample-pipelines-duration-trend.md +++ b/docs/report/powerbi/sample-pipelines-duration-trend.md @@ -1,7 +1,7 @@ --- title: Pipeline duration trend sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline duration trend Power BI report +description: How-to generate a pipeline duration trend Power BI report ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Pipeline duration trend sample report @@ -122,6 +122,9 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] + + ## Power BI transforms The query returns some columns that you need to expand and flatten into its fields before you can use them in Power BI. In this example such an entity is CompletedOn. diff --git a/docs/report/powerbi/sample-pipelines-duration.md b/docs/report/powerbi/sample-pipelines-duration.md index 4518b2a6a01..48f841a476b 100644 --- a/docs/report/powerbi/sample-pipelines-duration.md +++ b/docs/report/powerbi/sample-pipelines-duration.md @@ -1,7 +1,7 @@ --- title: Pipeline duration sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline duration Power BI report +description: How-to generate a pipeline duration Power BI report ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Pipeline duration sample report @@ -126,6 +126,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-pipelines-outcome-summary.md b/docs/report/powerbi/sample-pipelines-outcome-summary.md index 20219206291..9c684f10bf7 100644 --- a/docs/report/powerbi/sample-pipelines-outcome-summary.md +++ b/docs/report/powerbi/sample-pipelines-outcome-summary.md @@ -1,7 +1,7 @@ --- title: Pipeline outcome summary sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline outcome summary Power BI report +description: How-to generate a pipeline outcome summary Power BI report ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 06/11/2021 +ms.date: 09/21/2021 --- # Pipeline outcome summary sample report @@ -127,6 +127,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-pipelines-pass-rate-trend.md b/docs/report/powerbi/sample-pipelines-pass-rate-trend.md index cef20b2fd78..885125c0155 100644 --- a/docs/report/powerbi/sample-pipelines-pass-rate-trend.md +++ b/docs/report/powerbi/sample-pipelines-pass-rate-trend.md @@ -1,7 +1,7 @@ --- title: Pipeline pass rate sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline pass rate Power BI report +description: How-to generate a pipeline pass rate Power BI report ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Pipeline pass rate trend sample report @@ -156,6 +156,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] + ## Power BI transforms diff --git a/docs/report/powerbi/sample-pipelines-stagewise-failures.md b/docs/report/powerbi/sample-pipelines-stagewise-failures.md index 6021aa3b7b2..05456ec1cc3 100644 --- a/docs/report/powerbi/sample-pipelines-stagewise-failures.md +++ b/docs/report/powerbi/sample-pipelines-stagewise-failures.md @@ -1,7 +1,7 @@ --- title: Pipeline stage wise failures sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline stage wise failure Power BI report +description: How-to generate a pipeline stage wise failure Power BI report ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 12/18/2020 +ms.date: 09/21/2021 --- # Pipeline stage wise failures sample report @@ -137,6 +137,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-pipelines-task-duration-trend.md b/docs/report/powerbi/sample-pipelines-task-duration-trend.md index f5b68b1d426..b4ddb614cdb 100644 --- a/docs/report/powerbi/sample-pipelines-task-duration-trend.md +++ b/docs/report/powerbi/sample-pipelines-task-duration-trend.md @@ -1,7 +1,7 @@ --- title: Pipeline task duration trend sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline task duration trend Power BI report +description: How-to generate a pipeline task duration trend Power BI report ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # Pipeline task duration trend sample report @@ -132,6 +132,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-pipelines-task-duration.md b/docs/report/powerbi/sample-pipelines-task-duration.md index 4a23db5bba8..5bd01c19d23 100644 --- a/docs/report/powerbi/sample-pipelines-task-duration.md +++ b/docs/report/powerbi/sample-pipelines-task-duration.md @@ -1,7 +1,7 @@ --- title: Pipeline task duration sample Power BI report titleSuffix: Azure DevOps -description: How-to guide to generate a pipeline task duration Power BI report +description: How-to generate a pipeline task duration Power BI report ms.technology: devops-analytics ms.reviewer: ravishan ms.author: kaghai @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 06/11/2021 +ms.date: 09/21/2021 --- # Pipeline task duration sample report @@ -136,6 +136,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-pipelines.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-analyics-test-duration-trend.md b/docs/report/powerbi/sample-test-analyics-test-duration-trend.md index fbb5af6b536..64983335610 100644 --- a/docs/report/powerbi/sample-test-analyics-test-duration-trend.md +++ b/docs/report/powerbi/sample-test-analyics-test-duration-trend.md @@ -11,7 +11,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops' -ms.date: 01/30/2020 +ms.date: 09/21/2021 --- # Test duration trend sample report @@ -91,7 +91,7 @@ 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. ### Query breakdown @@ -146,6 +146,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-analytics-failed-tests.md b/docs/report/powerbi/sample-test-analytics-failed-tests.md index ae7734036c3..223ce66896f 100644 --- a/docs/report/powerbi/sample-test-analytics-failed-tests.md +++ b/docs/report/powerbi/sample-test-analytics-failed-tests.md @@ -103,7 +103,7 @@ 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. ### Query breakdown diff --git a/docs/report/powerbi/sample-test-analytics-flaky-tests.md b/docs/report/powerbi/sample-test-analytics-flaky-tests.md index 8fd7e7adcf7..ad136bacd5f 100644 --- a/docs/report/powerbi/sample-test-analytics-flaky-tests.md +++ b/docs/report/powerbi/sample-test-analytics-flaky-tests.md @@ -101,7 +101,7 @@ 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. ### Query breakdown diff --git a/docs/report/powerbi/sample-test-analytics-pass-rate-trend-test.md b/docs/report/powerbi/sample-test-analytics-pass-rate-trend-test.md index 86e503e703e..4d990f75800 100644 --- a/docs/report/powerbi/sample-test-analytics-pass-rate-trend-test.md +++ b/docs/report/powerbi/sample-test-analytics-pass-rate-trend-test.md @@ -100,7 +100,7 @@ Each query contains the following strings that you must substitute with your val - {project} - Your team project name - {pipelinename} - Your pipeline name. Example: **Fabrikam hourly build pipeline**. - {testName} - Your test name -- {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. ### Query breakdown diff --git a/docs/report/powerbi/sample-test-analytics-test-duration.md b/docs/report/powerbi/sample-test-analytics-test-duration.md index c811639392f..562932babe1 100644 --- a/docs/report/powerbi/sample-test-analytics-test-duration.md +++ b/docs/report/powerbi/sample-test-analytics-test-duration.md @@ -11,7 +11,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops' -ms.date: 08/14/2020 +ms.date: 09/21/2021 --- # Test duration sample report @@ -98,7 +98,7 @@ 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. ### Query breakdown @@ -154,6 +154,9 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] + + ## Power BI transforms The query returns some columns that you need to expand and flatten into its fields before you can use them in Power BI. In this example such an entity is Test. diff --git a/docs/report/powerbi/sample-test-analytics-test-summary.md b/docs/report/powerbi/sample-test-analytics-test-summary.md index 6bc52a8fa80..af4f528bd2d 100644 --- a/docs/report/powerbi/sample-test-analytics-test-summary.md +++ b/docs/report/powerbi/sample-test-analytics-test-summary.md @@ -11,7 +11,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops' -ms.date: 08/14/2020 +ms.date: 09/21/2021 --- # Test summary sample report @@ -95,7 +95,7 @@ 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. ### Query breakdown @@ -144,6 +144,8 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] + ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-plans-aggregate-data-level.md b/docs/report/powerbi/sample-test-plans-aggregate-data-level.md index 86944a0a5d4..1566daf9680 100644 --- a/docs/report/powerbi/sample-test-plans-aggregate-data-level.md +++ b/docs/report/powerbi/sample-test-plans-aggregate-data-level.md @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # Manual test suites aggregated view sample report @@ -123,6 +123,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-plans-configuration-by-outcome.md b/docs/report/powerbi/sample-test-plans-configuration-by-outcome.md index b193130af42..bfb06f797d2 100644 --- a/docs/report/powerbi/sample-test-plans-configuration-by-outcome.md +++ b/docs/report/powerbi/sample-test-plans-configuration-by-outcome.md @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # Configuration by outcome matrix sample report @@ -90,6 +90,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-plans-execution-trend.md b/docs/report/powerbi/sample-test-plans-execution-trend.md index d974a8070ca..425f7822a9c 100644 --- a/docs/report/powerbi/sample-test-plans-execution-trend.md +++ b/docs/report/powerbi/sample-test-plans-execution-trend.md @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # Manual test execution trend sample report @@ -20,7 +20,7 @@ This article shows you how to get the execution state of one or more Test Plans [!INCLUDE [temp](includes/preview-note.md)] -The report generated is similar to following image and the Outcome trend chart of the [Track test status - Progress report](../../test/track-test-status.md). +The report generated is similar to following image and the Outcome trend chart of the [Progress report](../../test/progress-report.md). > [!div class="mx-imgBorder"] > ![Sample - Execution Trend - Report](media/odatapowerbi-executiontrend.png) @@ -125,18 +125,59 @@ Each query contains the following strings that you must substitute with your val The following table describes each part of the query. +--- +:::row::: + :::column span="1"::: + **Query part** + :::column-end::: + :::column span="2"::: + **Description** + :::column-end::: +:::row-end::: +--- +:::row::: + :::column span="1"::: + `filter((TestSuite/TestPlanTitle eq '{testPlanTitle}'))` + :::column-end::: + :::column span="2"::: + Return data for only selected test plan. You can add multiple plans with a clause like `filter((TestSuite/TestPlanTitle eq '{testPlanTitle1}'` or `TestSuite/TestPlanTitle eq '{testPlanTitle2}'))`. You can also apply any other filters related to test suites, test configurations here. + :::column-end::: +:::row-end::: +:::row::: + :::column span="1"::: + `and (DateSK ge {startDate} and DateSK le {endDate})` + :::column-end::: + :::column span="2"::: + Date range of interest. You can enter the dates in **YYYYMMDD** format. + :::column-end::: +:::row-end::: +:::row::: + :::column span="1"::: + `/groupby((DateSK)` + :::column-end::: + :::column span="2"::: + Group the data into bins of same date. This produces one set of values per day in given date range. + :::column-end::: +:::row-end::: +:::row::: + :::column span="1"::: + `/aggregate($count as TotalCount,` + :::column-end::: + :::column span="2"::: + Aggregate data across the filtered test points with having count as `TotalCount`. + :::column-end::: +:::row-end::: +:::row::: + :::column span="1"::: + `cast(LastResultOutcome eq 'Passed', Edm.Int32) with sum as Passed,` + :::column-end::: + :::column span="2"::: + While aggregating, type-cast test points having latest execution outcome 'Passed' to 1 and sum them up as `Passed` metric. + :::column-end::: +:::row-end::: - - - - - - - - - -
Query partDescription
filter((TestSuite/TestPlanTitle eq '{testPlanTitle}'))Return data for only selected test plan. You can add multiple plans with a clause like filter((TestSuite/TestPlanTitle eq '{testPlanTitle1}' or TestSuite/TestPlanTitle eq '{testPlanTitle2}')). You can also apply any other filters related to test suites, test configurations here.
and (DateSK ge {startDate} and DateSK le {endDate})Date range of interest. You can enter the dates in YYYYMMDD format.
/groupby((DateSK)Group the data into bins of same date. This produces one set of values per day in given date range.
/aggregate($count as TotalCount,Aggregate data across the filtered test points with having count as TotalCount
cast(LastResultOutcome eq 'Passed', Edm.Int32) with sum as Passed,While aggregating, type-cast test points having latest execution outcome 'Passed' to 1 and sum them up as 'Passed' metric.
- + +[!INCLUDE [temp](includes/query-filters-test.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-plans-progress-status.md b/docs/report/powerbi/sample-test-plans-progress-status.md index 3ae15cc7584..f6f33525810 100644 --- a/docs/report/powerbi/sample-test-plans-progress-status.md +++ b/docs/report/powerbi/sample-test-plans-progress-status.md @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # Progress status sample report @@ -131,6 +131,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-plans-tester-by-outcome.md b/docs/report/powerbi/sample-test-plans-tester-by-outcome.md index 426cc8b5985..34b4ee52185 100644 --- a/docs/report/powerbi/sample-test-plans-tester-by-outcome.md +++ b/docs/report/powerbi/sample-test-plans-tester-by-outcome.md @@ -9,7 +9,7 @@ ms.custom: powerbisample author: KathrynEE ms.topic: sample monikerRange: '>= azure-devops-2020' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # Tester by outcome matrix sample report @@ -89,6 +89,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] ## Power BI transforms diff --git a/docs/report/powerbi/sample-test-summary-trend.md b/docs/report/powerbi/sample-test-summary-trend.md index f2c0d7558dc..d2b52f3b936 100644 --- a/docs/report/powerbi/sample-test-summary-trend.md +++ b/docs/report/powerbi/sample-test-summary-trend.md @@ -105,7 +105,7 @@ 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. ### Query breakdown @@ -169,6 +169,7 @@ The following table describes each part of the query. +[!INCLUDE [temp](includes/query-filters-test.md)] ## Power BI transforms diff --git a/docs/report/powerbi/toc.yml b/docs/report/powerbi/toc.yml index b0c59cd9c8c..826fbb7e1e7 100644 --- a/docs/report/powerbi/toc.yml +++ b/docs/report/powerbi/toc.yml @@ -1,5 +1,7 @@ - name: About Power BI integration href: overview.md +- name: Extend Analytics with OData (Preview) + href: ../extend-analytics/quick-ref.md - name: Enable or install Analytics href: ../dashboards/analytics-extension.md - name: Set Analytics permissions (Security) @@ -33,7 +35,21 @@ href: access-analytics-power-bi.md - name: Connect using Advanced Functions href: data-connector-functions.md -- name: Sample reports-Analytics views +- name: Sample queries>Work tracking + items: + - name: Query work item data + href: ../extend-analytics/wit-analytics.md + - name: "Project & organization-scoped queries" + href: ../extend-analytics/account-scoped-queries.md + - name: Query aggregate data + href: ../extend-analytics/aggregated-data-analytics.md + - name: Query trend data + href: ../extend-analytics/querying-for-trend-data.md + - name: Query work item links + href: ../extend-analytics/work-item-links.md + - name: Basic work tracking queries + href: ../extend-analytics/analytics-recipes.md +- name: Sample reports>Analytics views items: - name: Active bugs report href: active-bugs-sample-report.md @@ -45,91 +61,101 @@ href: create-team-filter.md - name: Calculate time-in-state href: create-timeinstate-report.md -- name: Sample reports-OData query +- name: Sample reports (Power BI and OData) + href: sample-odata-overview.md +- name: Sample reports>Boards + items: + - name: Open bugs + href: sample-boards-openbugs.md + - name: Bug trends + href: sample-boards-bugtrend.md + - name: Rollup + href: sample-boards-rollup.md + - name: Feature progress + href: sample-boards-featureprogress.md + - name: Work Items and Direct Links + href: sample-boards-directlinks.md + - name: Release burndown + href: sample-boards-releaseburndown.md + - name: Sprint burndown + href: sample-boards-sprintburndown.md + - name: Cumulative Flow Diagram + href: sample-boards-cfd.md + displayname: CFD + - name: Lead/Cycle time + href: sample-boards-leadcycletime.md + - name: Add a team slicer + href: sample-boards-teamslicer.md +- name: Sample reports>Pipelines + items: + - name: Outcome summary + href: sample-pipelines-outcome-summary.md + - name: Outcome summary for all pipelines + href: sample-pipelines-allpipelines.md + - name: Pass rate trend + href: sample-pipelines-pass-rate-trend.md + - name: Stage wise failures + href: sample-pipelines-stagewise-failures.md + - name: Duration + href: sample-pipelines-duration.md + - name: Duration trend + href: sample-pipelines-duration-trend.md + - name: Task duration + href: sample-pipelines-task-duration.md + - name: Task duration trend + href: sample-pipelines-task-duration-trend.md +- name: Sample reports>Pipelines test items: - - name: Sample OData reports overview - href: sample-odata-overview.md - - name: Boards - items: - - name: Open bugs - href: sample-boards-openbugs.md - - name: Bug trends - href: sample-boards-bugtrend.md - - name: Rollup - href: sample-boards-rollup.md - - name: Feature progress - href: sample-boards-featureprogress.md - - name: Work Items and Direct Links - href: sample-boards-directlinks.md - - name: Release burndown - href: sample-boards-releaseburndown.md - - name: Sprint burndown - href: sample-boards-sprintburndown.md - - name: Cumulative Flow Diagram - href: sample-boards-cfd.md - displayname: CFD - - name: Lead/Cycle time - href: sample-boards-leadcycletime.md - - name: Add a team slicer - href: sample-boards-teamslicer.md - - name: Pipelines - items: - - name: Outcome summary - href: sample-pipelines-outcome-summary.md - - name: Outcome summary for all pipelines - href: sample-pipelines-allpipelines.md - - name: Pass rate trend - href: sample-pipelines-pass-rate-trend.md - - name: Stage wise failures - href: sample-pipelines-stagewise-failures.md - - name: Duration - href: sample-pipelines-duration.md - - name: Duration trend - href: sample-pipelines-duration-trend.md - - name: Task duration - href: sample-pipelines-task-duration.md - - name: Task duration trend - href: sample-pipelines-task-duration-trend.md - - name: Pipelines test sample reports - items: - - name: Test summary - href: sample-test-analytics-test-summary.md - - name: Test summary trend - href: sample-test-summary-trend.md - - name: Failed tests - href: sample-test-analytics-failed-tests.md - - name: Flaky tests - href: sample-test-analytics-flaky-tests.md - - name: Test duration - href: sample-test-analytics-test-duration.md - - name: Test duration trend - href: sample-test-analyics-test-duration-trend.md - - name: Pass rate trend of test - href: sample-test-analytics-pass-rate-trend-test.md - - name: Test Plans - items: - - name: Progress status - href: sample-test-plans-progress-status.md - - name: Requirements tracking - href: sample-stories-overview.md - - name: Requirements tracking - Rollup - href: sample-stories-overview-rollup.md - - name: Execution trends - href: sample-test-plans-execution-trend.md - - name: Suite-level aggregation - href: sample-test-plans-aggregate-data-level.md - - name: Tester by outcome matrix - href: sample-test-plans-tester-by-outcome.md - - name: Configuration by outcome matrix - href: sample-test-plans-configuration-by-outcome.md -- name: Reference + - name: Test summary + href: sample-test-analytics-test-summary.md + - name: Test summary trend + href: sample-test-summary-trend.md + - name: Failed tests + href: sample-test-analytics-failed-tests.md + - name: Flaky tests + href: sample-test-analytics-flaky-tests.md + - name: Test duration + href: sample-test-analytics-test-duration.md + - name: Test duration trend + href: sample-test-analyics-test-duration-trend.md + - name: Pass rate trend of test + href: sample-test-analytics-pass-rate-trend-test.md +- name: Sample reports>Test Plans + items: + - name: Progress status + href: sample-test-plans-progress-status.md + - name: Requirements tracking + href: sample-stories-overview.md + - name: Requirements tracking - Rollup + href: sample-stories-overview-rollup.md + - name: Execution trends + href: sample-test-plans-execution-trend.md + - name: Suite-level aggregation + href: sample-test-plans-aggregate-data-level.md + - name: Tester by outcome matrix + href: sample-test-plans-tester-by-outcome.md + - name: Configuration by outcome matrix + href: sample-test-plans-configuration-by-outcome.md +- name: Data model reference items: - name: Data available from Analytics href: data-available-in-analytics.md - - name: Dataset design + - name: Data model for Analytics + href: ../extend-analytics/data-model-analytics-service.md + - name: Explore Analytics metadata + href: ../extend-analytics/analytics-metadata.md + - name: Analytics views dataset design href: data-connector-dataset.md - name: Filters applied to historical data href: analytics-historical-filtering.md + - name: "Supported functions & clauses" + href: ../extend-analytics/odata-supported-features.md + - name: API versioning + href: ../extend-analytics/odata-api-version.md +- name: Troubleshooting + items: + - name: Query guidelines + href: ../extend-analytics/odata-query-guidelines.md - name: Performance & latency - href: performance-latency.md - + href: performance-latency.md + \ No newline at end of file diff --git a/docs/report/powerbi/what-is-analytics.md b/docs/report/powerbi/what-is-analytics.md index d7ed5d391a1..bff8d88f8b3 100644 --- a/docs/report/powerbi/what-is-analytics.md +++ b/docs/report/powerbi/what-is-analytics.md @@ -3,12 +3,11 @@ title: What is the Analytics service titleSuffix: Azure DevOps description: Understand how you can use Analytics data to answer quantitative questions about your projects in Azure DevOps ms.technology: devops-analytics -ms.reviewer: greggboe ms.author: kaelli author: KathrynEE ms.topic: overview monikerRange: '>= azure-devops-2019' -ms.date: 07/14/2020 +ms.date: 09/21/2021 --- # What is the Analytics service? @@ -46,8 +45,8 @@ Specifically, Analytics provides you with insights about your Azure DevOps proje > - Support to develop and add your custom Analytics widgets you can add to dashboards ::: moniker-end - -[!INCLUDE [temp](../../includes/version-selector-minimize.md)] + +[!INCLUDE [temp](../includes/analytics-preview.md)] ## Data available in Analytics @@ -56,7 +55,7 @@ Analytics is generally available for Azure DevOps Service and Azure DevOps Serve Data available via the Analytics service depends on your version and platform. For specifics, read [Data available in Analytics](./data-available-in-analytics.md) and [Data model for Analytics](../extend-analytics/data-model-analytics-service.md). -[!INCLUDE [temp](../includes/analytics-preview.md)] + ::: moniker range="azure-devops" diff --git a/docs/report/toc.yml b/docs/report/toc.yml index 00c66d3fafd..0b0cd71f86b 100644 --- a/docs/report/toc.yml +++ b/docs/report/toc.yml @@ -76,17 +76,15 @@ href: ../boards/plans/visibility-across-teams.md?toc=/azure/devops/report/toc.json&bc=/azure/devops/report/breadcrumb/toc.json displayname: delivery plans, calendar, portfolio backlogs, multi-teams - name: Analytics & Power BI integration - href: powerbi/toc.yml -- name: Extend Analytics with OData (Preview) - href: extend-analytics/toc.yml + href: powerbi/toc.yml - name: SQL Server Reporting (Legacy) href: sql-reports/toc.yml - name: Work tracking field reference items: - - name: "Rollup of work & other fields" - href: ../reference/xml/support-rollup-of-work-and-other-fields.md?toc=/azure/devops/report/toc.json&bc=/azure/devops/report/breadcrumb/toc.json - name: Work item field index href: ../boards/work-items/guidance/work-item-field.md?bc=%252fazure%252fdevops%252freport%252fbreadcrumb%252ftoc.json&toc=%252fazure%252fdevops%252freport%252ftoc.json + - name: "Rollup of work & other fields" + href: ../reference/xml/support-rollup-of-work-and-other-fields.md?toc=/azure/devops/report/toc.json&bc=/azure/devops/report/breadcrumb/toc.json - name: Reportable fields reference href: ../reference/xml/reportable-fields-reference.md?toc=/azure/devops/report/toc.json&bc=/azure/devops/report/breadcrumb/toc.json - name: Change reporting attributes @@ -99,8 +97,6 @@ href: ../project/configure-or-add-a-project-portal.md - name: Configure or redirect process guidance href: ../project/configure-or-redirect-process-guidance.md - - name: SharePoint Integration (Deprecated) - href: /previous-versions/azure/devops/report/sharepoint-dashboards/about-sharepoint-integration - name: Extension samples (REST API) items: - name: Add a dashboard widget @@ -136,4 +132,6 @@ - name: "Developer Community: Power BI support forum" href: https://developercommunity.visualstudio.com/search.html?f=&type=question+OR+problem&type=question+OR+problem&c=&redirect=search%2Fsearch&sort=relevance&q=PowerBI - name: OData Extension for Data Aggregation Version 4.0 - href: https://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/cs01/odata-data-aggregation-ext-v4.0-cs01.html \ No newline at end of file + href: https://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/cs01/odata-data-aggregation-ext-v4.0-cs01.html + - name: SharePoint Integration (Deprecated) + href: /previous-versions/azure/devops/report/sharepoint-dashboards/about-sharepoint-integration \ No newline at end of file