Azure Boards Analytics 的元数据参考

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022 |Azure DevOps Server 2020

Analytics 服务收集所有 Azure Boards 工作跟踪定义和更新活动。 可以直接在浏览器中运行 Analytics 查询,并使用属性组合来筛选查询、聚合数据或生成报表。 有关详细信息,请参阅 使用 OData Analytics 定义基本查询。

本文介绍可用于生成工作跟踪分析报表的大部分属性。 分析将所有工作跟踪字段存储为除 HTML/格式文本和历史记录字段以外的属性。 自定义字段作为自定义属性自动添加到 Analytics。

注意

本文介绍 Analytics 数据模型支持的实体、属性和枚举类型。 若要查询数据模型,请参阅 为 Analytics 构造 OData 查询

实体集概述

查询 Analytics 以获取工作跟踪数据时,查询 WorkItems 实体集以生成状态和汇总报告。 使用 WorkItemSnapshot 实体集生成趋势、烧毁和烧毁报表。

使用其他实体类型(如 “区域”、“ 迭代”、“ 项目”或 “团队 ”)筛选数据或选择要报告的属性。 有关示例报表,请参阅 示例报表和快速参考索引

注意

若要针对测试运行、测试结果或其他测试数据生成状态和趋势报告,请查询 WorkItems 和 WorkItemSnapshot 实体类型,并根据 TestRuns、TestPoints、TestResultsDailyTestSuiteTestPointHistorySnapshot 实体类型进行筛选。 有关详细信息,请参阅 Azure DevOps 的测试元数据参考。

实体集 实体类型 说明
地区 区域 工作项 区域路径,具有按区域层次结构分组和筛选的属性。
日期 CalendarDate 用于使用关系筛选和分组其他实体的日期。
迭代次数 迭代 工作项 迭代路径,具有按迭代层次结构进行分组和筛选的属性。
BoardLocations BoardLocation 板单元位置,由板柱、泳道和拆分标识,包括历史板设置。 有关每个板字段的说明,请参阅 “工作流”和“板”字段
进程 处理 用于展开或筛选工作项和工作项类型的积压工作信息。 有关使用 进程 筛选报表的示例,请参阅 要求跟踪示例报表。 支持 Analytics v2.0 及更高版本。
项目 项目 为组织或项目集合定义的所有项目。
标记 标记 每个项目的所有工作项标记。 有关使用 标记 筛选报表的示例,请参阅 发布进度示例报表
团队 团队 为项目定义的所有团队。 有关使用 Teams 筛选报表的示例,请参阅 向 Power BI 报表添加团队切片器
用户 用户 用于展开或筛选各种工作项属性的用户信息,例如 “分配给 ”或 “创建者”。
工作项看板快照 工作项看板快照 复合实体类型,用于描述每个日历日期上每个工作项的状态,包括板位置。 用于生成趋势报告。 有关示例报表,请参阅 (CFD) 示例报表的累积流程图
工作项链接 WorkItemLink 工作项之间的链接,例如项、项和相关项。 仅包含最新修订的链接,不包含历史记录,不包含超链接。
工作项修订 WorkItemRevision 所有历史工作项修订,包括当前修订。 不包括已删除的工作项。
WorkItemSnapshot WorkItemSnapshot 描述每个日历日期上每个工作项的状态的复合实体类型。 用于支持趋势报告。 有关示例报告,请参阅 Bug 趋势示例报告
WorkItems WorkItem 工作项的当前状态。 用于支持状态报告。 有关示例报表,请参阅 将子工作项值汇总到父示例报表
工作项类型字段 工作项类型字段 每个工作项类型和进程的工作项属性。 用于支持生成报表。

快照

工作跟踪快照实体集是 WorkItemSnapshotWorkItemBoardSnapshot。 快照每天同时写入 Analytics,并提供为当天的工作项定义的值的记录。 可以使用快照生成趋势报告。

默认情况下,所有快照表都建模为每日快照事实数据表。 对时间范围的查询获取每天的值,长时间范围会导致大量记录。 如果不需要如此高的精度,则可以使用每周或每月快照。 有关详细信息,请参阅 针对跨长时间段的趋势查询使用每周或每月快照

工作项修订

每次更新工作项时,系统都会创建新的修订并将其记录在 System.RevisedDate 字段中,这对于指定历史记录筛选器很有用。 可以按 RevisedDate (DateTime) 属性 RevisedDateSK (Int32) 表示修订的日期。

使用后一个日期代理项键属性获得最佳性能。 此键显示已创建修订的日期,或显示活动修订或不完整修订的 OData datetime null 值 "9999-01-01T00:00:00Z" 。 如果想要自 {startDate}以来的所有日期(含),请将以下筛选器添加到查询中: RevisedDateSK eq null or RevisedDateSK gt {startDateSK}

使用 WorkItemRevisions 实体集加载给定工作项的所有修订。 该查询返回筛选的工作项的所有历史工作项修订,包括当前修订,不包括已删除的工作项。

跨实体类型的共享属性

可以在分析视图中选择的属性对应于常规工作跟踪字段和所选的分析属性,例如 周期时间天数潜在顾客时间日期。 这些属性是为以下实体类型定义的,除非另有指定:

  • WorkItem
  • WorkItemRevision
  • WorkItemSnapshot
  • 工作项看板快照

注意

  • 分析服务不会为分配 HTML 或格式文本数据类型的长文本字段存储数据,例如 DescriptionHistory 字段,也不会存储链接或附加的文件计数。 有关默认进程模板中定义的字段的完整列表,请参阅 “工作项”字段索引。 有关数据类型说明,请参阅 查询字段、运算符和宏

  • 下表不包括与 Scrum 和 Capability Maturity Model Integration (CMMI) 进程特定的字段关联的所有属性。 有关这些字段的列表,请参阅 用于跟踪 CMMI 工作项的字段

  • 基于日期或基于用户的属性与日历日期、项目和用户元数据引用中所述的 CalendarDateUser 实体集相关联。

下表列出了并描述了可在 Analytics 视图中选择的大多数属性,包括常规工作跟踪字段和其他 Analytics 属性。

显示名称 属性名称 数据类型 说明 引用名称
接受者 Microsoft_VSTS_CodeReview_AcceptedBy UserSK 对代码评审做出响应的人员的姓名。 (CMMI 进程) Microsoft.VSTS.CodeReview.AcceptedBy
接受日期 AcceptedDate 日期时间 人员响应代码评审的日期和时间。 (CMMI 进程) Microsoft.VSTS.CodeReview.AcceptedDate
激活者 ActivatedByActivatedByUserSK UserSK 激活或重新激活工作项的团队成员的姓名。 Microsoft.VSTS.Common.ActivatedBy
激活日期 ActivatedDate 日期时间 团队成员激活或重新激活 bug 或工作项的日期和时间。 Microsoft.VSTS.CodeReview.ActivatedDate
活动 Activity 字符串 分配给执行任务的活动或规则的类型。 允许的值为: DeploymentDesignDevelopmentDocumentationRequirementsTesting。 (敏捷、Scrum 和基本流程) Microsoft.VSTS.Common.Activity
AnalyticsUpdatedDate 日期时间偏移 (DateTimeOffset) 上次更新实体的数据和时间。
应用程序类型 字符串 利益干系人提供反馈的应用程序类型。 默认值为 Web 应用程序远程计算机客户端应用程序。 有效类型是在进程配置文件中为使用本地 XML 进程的项目指定的。 Microsoft_VSTS_Feedback_ApplicationType
区域路径 AreaPathAreaSK 字符串 产品功能或团队区域工作项分组到。 必须是项目层次结构中的有效节点。 System.AreaPath
分配到 AssignedToAssignedToUserSK UserSK 当前拥有工作项的团队成员的名称。 System.AssignedTo
自动测试 ID AutomatedTestId 字符串 自动执行测试用例的测试的 ID。 Microsoft.VSTS.TCM.AutomatedTestId
自动测试名称 AutomatedTestName 字符串 激活或重新激活工作项的团队成员的姓名。 Microsoft.VSTS.TCM.AutomatedTestName
自动测试存储 AutomatedTestStorage 字符串 包含自动执行测试用例的测试的程序集。 Microsoft.VSTS.TCM.AutomatedTestStorage
自动测试类型 AutomatedTestType 字符串 自动执行测试用例的测试类型。 Microsoft.VSTS.TCM.AutomatedTestType
自动化状态 AutomatedStatus 字符串 测试用例的状态,其中包含“自动”、“非自动”或“计划”值。 Microsoft.VSTS.TCM.AutomationStatus
积压工作优先级 BacklogPriority 加倍 由系统后台进程分配的编号,用于对积压工作或板上的项目序列进行堆栈排名或跟踪。 (Scrum 进程) Microsoft.VSTS.Common.BacklogPriority
被阻止 Blocked 字符串 指示无法对工作项执行进一步的工作。 有效值为 “是”“否”。 (CMMI 进程) Microsoft.VSTS.CMMI.Blocked
业务价值 BusinessValue 加倍 与相同类型的其他项目相比,捕获产品积压工作项或功能的相对业务价值的主观度量单位。 分配的项数越高,其业务价值比分配的编号较低的项多。 Microsoft.VSTS.Common.BusinessValue
更改者 ChangedByChangedByUserSK UserSK 最近修改工作项的人员的名称。 System.ChangedBy
更改日期 ChangedDate 日期时间 修改工作项的日期和时间。 System.ChangedDate
ChangedDateSK Int32 修改工作项的日期,以YYYYMMDD组织定义的时区表示。 由外部工具用于联接相关实体。
ChangedOn 导航 在为组织定义的时区中,修改工作项的日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
关闭者 ClosedByClosedByUserSK UserSK 关闭工作项的人员的名称。 Microsoft.VSTS.Common.ClosedBy
关闭日期 ClosedDateClosedDateSK、、 ClosedOn 日期时间 关闭工作项的日期和时间。 Microsoft.VSTS.Common.ClosedDate
批注计数 CommentCount Int32 添加到工作项 的“讨论 ”部分的注释数。 System.CommentCount
承诺 Committed 字符串 指示是否在项目中提交要求。 有效值为 “是”“否”。 (CMMI 进程) Microsoft.VSTS.CMMI.Committed
CompletedDateSK Int32 Analytics 捕获的导航属性日期,用于存储工作项进入与 “已完成 ”状态类别关联的工作流状态时。
CompletedOn 导航 工作项在为组织定义的时区中输入与“已完成”状态类别关联的工作流状态的日期的实体的导航属性Date。 通常用于在 语句中引用实体中的Dategroupby属性。
已完成工作 CompletedWork 加倍 度量任务所花费的工时量。 Microsoft.VSTS.Scheduling.CompletedWork
创建者 CreatedByCreatedByUserSK UserSK 创建工作项的人员的名称。 Microsoft.VSTS.Common.CreatedBy
创建日期 CreatedDateCreatedDateSK 日期时间 创建工作项的日期,以组织定义的时区表示。 通常用于筛选和显示。 Microsoft.VSTS.Common.CreatedDate
CreatedDateSK Int32 创建工作项的日期,以 YYYYMMDD 组织定义的时区表示。 由外部工具用于联接相关实体。
CreatedOn 导航 在为组织定义的时区中创建工作项的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
周期时间天数 CycleTimeDays 加倍 从第一次输入 “正在进行 ”或 “已解决 ”状态类别到输入 “已完成 ”状态类别计算的周期时间。 有关详细信息,请参阅 “潜在顾客时间和周期时间”小组件
规则 Discipline 字符串 分配给任务的活动或规则的类型。 允许的值包括:分析开发测试用户教育和用户体验。 (CMMI 进程) Microsoft.VSTS.Common.Activity
截止日期 DueDate 日期时间 要解决的问题或工作项的预测截止日期。 (敏捷流程) Microsoft.VSTS.Scheduling.DueDate
工作量 Effort 加倍 产品积压工作项(Scrum 流程)或问题(基本流程)需要实现的估计工作量。 Microsoft.VSTS.Scheduling.Effort
完成日期 FinishDate 日期时间 日程的日期和时间指示工作项已完成。 Microsoft.VSTS.Scheduling.FinishDate
发现版本 FoundIn 字符串 产品内部版本号(也称为修订),在其中发现了 bug。 Microsoft.VSTS.Build.FoundIn
InProgress 日期 InProgressDate 日期时间 分析存储的日期,用于捕获工作项移动到属于 “正在进行 ”状态类别的状态时的日期时间。
InProgressDateSK Int32 工作项移动到属于“正在进行”状态类别的状态中,以组织定义的时区表示YYYYMMDD。 由外部工具用于联接相关实体。
集成版本 IntegrationBuild 字符串 集成代码或修复 Bug 的产品生成号。 Microsoft.VSTS.Build.IntegrationBuild
是否为最新 IsCurrent 布尔 支持筛选数据,以便通过将值设置为 True 来查看筛选的工作项集的最新快照。 对实体类型 WorkItemRevisionWorkItemBoardSnapshotBoardLocation 有效。
是当天的最后一次修订 IsLastRevisionOfDay 布尔 指示快照表示设置为 True的日期的最后一次修订。
是期间的最后一次修订 IsLastRevisionOfPeriod 布尔 指示快照表示设置为 True的时间段的最后一个修订。
问题 Issue 字符串 指示共享步骤与预期结果相关联。 允许的值为 “是”“否”。 Microsoft.VSTS.Common.Issue
提前期天数 LeadTimeDays 加倍 从工作项创建或输入 建议 的状态类别到输入 已完成 状态类别的潜在客户时间。 有关详细信息,请参阅 “潜在顾客时间和周期时间”小组件
原始估算 OriginalEstimate 加倍 测量完成任务所需的工作量。 Microsoft.VSTS.Scheduling.OriginalEstimate
父工作项 ID ParentWorkItemId Int32 标识链接到父项的工作项的唯一 ID。 可用于生成汇总报告。 字段对实体类型 WorkItemRevisionWorkItem 有效。 System.Parent
优先级 Priority Int32 与业务相关的 bug、问题、任务或测试用例的主观分级。 值包括 123 Microsoft.VSTS.Common.Priority
项目名称 ProjectName 导航 工作项所属的项目的名称。 有关详细信息,请参阅 Project 属性 System.TeamProject
ProjectSK GUID 分配给工作项所属的项目的 GUID。
评级 Reason 字符串 在基于星号的排名系统(反馈响应)中,项目从审阅者那里收到的星号数。 该数字存储在系统中,并写为 0 - 未评分1 - 差2 - 公平3 - 良好4 - 非常好,或 5 - 优秀。 对 WorkItemRevisionWorkItem 实体类型有效。 Microsoft.VSTS.Common.Rating
原因 Reason 字符串 工作项处于当前状态的原因。 从一个工作流状态到另一个工作流状态的每次转换都与相应的原因相关联。 System.Reason
剩余工作 RemainingWork 加倍 度量要完成任务的剩余工时量。 Microsoft.VSTS.Scheduling.RemainingWork
解决者 ResolvedByResolvedByUserSK UserSK 解决 bug 或用户情景的团队成员的名称。 Microsoft.VSTS.Common.ResolvedBy
解决日期 ResolvedDate 日期时间 Bug 或用户情景解决的日期和时间。 Microsoft.VSTS.Common.ResolvedDate
ResolvedDateSK Int32 解决工作项的日期,以 YYYYMMDD 组织定义的时区表示。 由外部工具用于联接相关实体。
ResolvedOn 导航 在为组织定义的时区中,工作项解析日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
解决原因 ResolvedReason 字符串 bug 已解决的原因,例如 已修复 Microsoft.VSTS.Common.ResolvedReason
修订 Revision Int32 分配给工作项的历史修订的编号。 System.Rev
修订日期 RevisedDate 日期时间 修改或更新工作项的日期和时间。
RevisedDateSK Int32 修改工作项的日期,以 YYYYMMDD 组织定义的时区表示。 由外部工具用于联接相关实体。
RevisedOn 导航 在为组织定义的时区中,修改工作项的日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
风险 Risk 加倍 有关工作项成功完成的相对不确定性的主观评级。 有效值包括 1 - 高2 - 中3 - 低 Microsoft.VSTS.Common.Risk
严重性 Severity 加倍 对 bug、问题或风险对项目的影响的主观分级。 有效值包括 1 - 严重2 - 高3 - 中4 - 低 Microsoft.VSTS.Common.Severity
大小 Size 加倍 估计要求实现所需的工作量。 (CMMI 进程) Microsoft.VSTS.Scheduling.Size
堆栈级别 StackRank 加倍 由系统后台进程分配的编号,用于对积压工作或板上的项目序列进行堆栈排名或跟踪。 (敏捷、Scrum 和基本流程) Microsoft.VSTS.Common.StackRank
开始日期 StartDate 日期时间 分配给工作项以便开始工作的日期和时间。 Microsoft.VSTS.Scheduling.StartDate
State 字符串 工作项的当前状态。 状态的有效值特定于每种类型的工作项和对其进行的自定义。 System.State
状态类别 StateCategory 字符串 Azure Boards 和选择仪表板小组件如何处理每个工作流状态。 状态类别包括“建议”、“正在进行”、“已解决”、“已删除”和“已完成”。 有关详细信息,请参阅 如何使用工作流状态和状态类别。 仅对 WorkItemRevision 实体类型有效。
状态更改日期 StateChangeDate 日期时间 “状态”字段值的日期和时间已更改。 Microsoft.VSTS.Common.StateChangeDate
StateChangeSK Int32 工作项状态已更改的日期,以 YYYYMMDD 组织定义的时区表示。 由外部工具用于联接相关实体。
StateChangeOn 导航 在为组织定义的时区中,工作项状态已更改的日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
故事点 StoryPoints 加倍 用户情景需要实现的工作量的估计值,通常聚合为总和。 (敏捷流程) Microsoft.VSTS.Scheduling.StoryPoints
标记 TagNames 字符串 分配给一个或多个工作项以分号分隔的标记列表,用于筛选或查询目的。 System.Tags
目标日期 TargetDate 日期时间 要解决或完成的问题或其他工作项的预测截止日期。 Microsoft.VSTS.Scheduling.TargetDate
测试套件类型 字符串 测试套件的类型。 有效值包括 “基于查询”、“ 基于要求”“静态”。 Microsoft_VSTS_TCM_TestSuiteType
测试套件类型 ID Int64 系统分配的数字对应于测试套件类别。 仅适用于测试套件。 分配的值为 1(静态)2(基于查询)3(基于要求)。 Microsoft_VSTS_TCM_TestSuiteTypeId
时间关键性 TimeCriticality 加倍 捕获业务价值随时间推移减少的主观度量单位。 较高的值表示史诗或特征本质上比值较低的项更关键时间。 Microsoft.VSTS.Common.TimeCriticality
标题 Title 字符串 汇总工作项的简短说明,帮助团队成员将其与列表中的其他工作项区分开来。 System.Title
值区域 ValueArea 字符串 由史诗、功能或积压工作项解决的客户价值区域。 值包括 体系结构业务 Microsoft.VSTS.Common.ValueArea
水印 Watermark 字符串 系统管理的字段,该字段随对工作项所做的更改而递增。 对 WorkItemRevisionWorkItem 实体类型有效。 System.Watermark
工作项 ID WorkItemId Int32 分配给工作项的唯一标识符。 工作项 ID 在组织或项目集合中的所有项目中都是唯一的。 System.Id
WorkItemRevisionSK Int32 外部工具用于联接相关实体的工作项修订的分析唯一键。
工作项类型 WorkItemType 字符串 工作项类型的名称。 可用的工作项类型基于项目使用的过程。 有关详细信息,请参阅 关于进程和进程模板 System.WorkItemType

OData 导航属性是指向另一个实体的实体的引用属性。 下表汇总了导航属性、其引用约束以及它们有效的实体类型。

显示名称 Name 引用约束 Referential 属性 有效的实体类型
ChangedOn ChangedDateSK DateSK WorkItemRevisionWorkItemSnapshotWorkItemBoardSnapshot
ClosedOn ClosedDateSK DateSK WorkItemRevisionWorkItemSnapshotWorkItemBoardSnapshot
CreatedOn CreatedDateSK DateSK WorkItemRevisionWorkItemSnapshotWorkItemBoardSnapshot
ResolvedOn ResolvedDateSK DateSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
StateChangeOn StateChangeDateSK DateSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
InProgressOn InProgressDateSK DateSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
CompletedOn CompletedDateSK DateSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
ChangedOn ChangedDateSK DateSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
RevisedOn RevisedDateSK DateSK WorkItemRevisionWorkItemSnapshot
Date DateSK DateSK WorkItemRevisionWorkItemSnapshotWorkItemBoardSnapshot
地区 Area AreaSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
BoardLocation WorkItemRevisionWorkItemWorkItemBoardSnapshot
迭代次数 Iteration IterationSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
分配到 AssignedTo AssignedToUserSK UserSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
更改者 ChangedBy ChangedByUserSK UserSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
创建者 CreatedBy CreatedByUserSK UserSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
激活者 ActivatedBy ActivatedByUserSK UserSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
关闭者 ClosedBy ClosedBySK UserSK WorkItemRevisionWorkItemWorkItemSnapshotWorkItemBoardSnapshot
ResolvedBy ResolvedBy ResolvedByUserSK UserSK WorkItemRevisionWorkItemSnapshotWorkItemBoardSnapshot
团队 AreaBoardLocationIterationWorkItemRevisionWorkItemSnapshotWorkItemBoardSnapshot
标记 WorkItemWorkItemRevisionWorkItemBoardSnapshot
项目 Project ProjectSK ProjectSK TagWorkItemBoardSnapshotWorkItemLink、WorkItemRevisionWorkItemSnapshotWorkItemTypeField
进程 WorkItemRevisionWorkItemWorkItemSnapshot
修订 WorkItem
链接 WorkItem
儿童 WorkItem
父母 WorkItem
后代 WorkItem
WorkItem* WorkItemId WorkItemRevision

* WorkItem 实体还支持 PredictTagsPredict 函数,它们支持对选择的内置分析报表和小组件进行预测趋势。

BoardLocation 和 WorkItemBoardSnapshot

下表列出了并描述了为 BoardLocationWorkItemBoardSnapshot 实体类型定义的属性,除非另有说明。 可以使用这些字段根据团队板列、泳道或积压工作级别中工作项的状态筛选工作项数据。 有关查询 WorkItemBoardSnapshot 实体集的示例,请参阅 累积流图 (XP) 示例报表

显示名称 属性名称 数据类型 说明
板 ID BoardId Guid 分配给开发板的唯一 GUID。 每个团队都与一个或多个董事会相关联。
板类别引用名称 BoardCategoryReferenceName 字符串 分配给用于填充开发板的工作项类型类别的名称。 例如,产品积压工作板与“要求”类别相关联。 有关详细信息,请参阅自定义积压工作或面板(继承的流程)
电路板名称 BoardName 字符串 分配给开发板的名称,例如 故事积压工作项功能史诗
板级别 BoardLevel Int32 根据它位于板层次结构中的位置分配给开发板的数字。
积压工作类型 BacklogType 字符串 积压工作类型的名称,例如迭代、要求或项目组合。
列名称 ColumnName 字符串 工作项当前分配给的板列的名称,例如 活动已关闭提交完成或自定义列标签。 引用名称:System.BoardColumn
列顺序 ColumnOrder Int32 根据板中的序列分配给板列的数字。
已完成 Done 枚举 拆分列位置的指示器。*
列项限制 ColumnItemLimit Int32 按顺序分配给板列的数字。
板是否可见 IsBoardVisible 布尔 指示团队是否选择使董事会可见。
是否拆分列 IsColumnSplit 布尔 指示是否将列拆分为 “正在执行 ”和 “完成 ”列,如 开发板上的“拆分”列中所述,以显示正在进行的工作
是否为最新 IsCurrent 布尔 支持筛选数据以在设置为 True时查看筛选工作项的最新快照的属性。
是默认通道 IsDefaultLane 布尔 指示在设置为 True默认泳道时将工作项分配给默认泳道。
已完成 IsDone 布尔 列内工作项的当前工作分配,以何时True执行False完成。 仅当为板列启用 拆分列 时才有效。 引用名称:System.BoardColumnDone
通道 ID LaneId Guid 分配给板泳道的唯一 GUID。 每个团队都可以向板中添加一个或多个泳道。 有关泳道的详细信息,请参阅 在棋盘中使用泳道加快团队的工作速度。
通道名称 LaneName 字符串 分配给板泳道的名称。 引用名称:System.BoardLane
通道顺序 LaneOrder Int32 按顺序分配给板泳道的数字。

*下表列出了枚举类型的成员名称 BoardColumnSplit ,可用于筛选 “执行 ”或 “完成 ”板列中的工作项。

成员名称 显示名称
Doing 0 正在执行
Done 1 完成
Unknown 2 未知 (未拆分)

有关团队的板列的详细信息,请参阅以下文章:

地区

以下属性对与“区域路径”字段关联的“区域”实体集有效。 与 Area 关联的代理键包括 AreaSKProjectSK。 可以使用这些属性根据区域路径分配筛选或报告工作跟踪数据。

显示名称 Name 数据类型 说明
AnalyticsUpdatedDate 日期时间 指示上次更新 Analytics 数据的水印。
Number Int32 创建时分配给区域路径节点的整数值。
深度 Depth Int32 区域路径的级别,基于其根级别的深度。
区域 ID AreaId GUID 创建时分配给区域路径的唯一标识符。
区域级别 1区域级别 14 AreaLevel1AreaLevel14 字符串 最大 14 个嵌套级别的区域路径的节点级别。 区域级别 1 始终对应于根节点和项目名称。
区域名称 AreaName 字符串 为创建时的区域路径定义的名称。
区域路径 AreaPath 字符串 从根节点开始的区域路径的完整路径。

重要

删除 区域路径 值或重新配置 迭代路径 值会导致以下图表中不可逆的数据丢失:

  • 烧毁和烧毁小组件图表
  • 冲刺燃尽图表
  • 具有已更改区域路径的团队的速度图
  • 引用每个工作项时定义的 区域路径迭代路径 值的历史趋势图

仅当任何工作项不再使用区域和迭代路径时,才能删除它们。 删除这些路径时,无法再检索其历史数据。

区域实体类型和 Areas 实体集的导航属性包括 ProjectTeams

有关 区域路径的详细信息,请参阅以下文章:

迭代

以下属性对 迭代 实体集有效,该集与 “迭代路径 ”字段相关联。 与 迭代 关联的代理键包括 IterationSKProjectSK。 可以使用这些属性根据迭代路径分配筛选或报告工作跟踪数据。

显示名称 Name 数据类型 说明
AnalyticsUpdatedDate 日期时间 指示上次更新 Analytics 数据的水印。
Number Int32 在创建时分配给迭代路径节点的整数值。
深度 Depth Int32 基于其根级别的深度的迭代路径级别。
结束日期 EndDate 日期时间 为迭代路径定义的结束日期。
是否结束 IsEnded 布尔 指示在设置为 True 时,迭代路径结束日期在过去 。
迭代 ID IterationId GUID 创建时分配给迭代路径的唯一标识符。
迭代级别 1迭代级别 14 IterationLevel1IterationLevel14 字符串 迭代路径的节点级别最多为 14 个嵌套级别。 迭代级别 1 始终对应于根节点和项目名称。
迭代名称 IterationName 字符串 为创建时迭代路径定义的名称。
迭代路径 IterationPath 字符串 从根节点开始的完整迭代路径。 迭代必须是项目层次结构中的有效节点。 引用名称:System.IterationPath
开始日期 StartDate 日期时间 为迭代路径定义的开始日期。

重要

删除 区域路径 值或重新配置 迭代路径 值会导致以下图表中不可逆的数据丢失:

  • 烧毁和烧毁小组件图表
  • 冲刺燃尽图表
  • 具有已更改区域路径的团队的速度图
  • 引用每个工作项时定义的 区域路径迭代路径 值的历史趋势图

仅当任何工作项不再使用区域和迭代路径时,才能删除它们。 删除这些路径时,无法再检索其历史数据。

迭代实体类型和迭代实体集的导航属性包括 ProjectTeams

有关迭代路径的详细信息,请参阅以下文章:

进程

以下属性对 Process 实体类型和 Process 实体集有效。 与 Process 关联的代理键包括 ProcessSKProjectSKTeamSK。 使用这些属性可以筛选或报告项目或团队的工作项类型的工作跟踪数据。

注意

v-2.0v3.0-previewv4.0-preview Analytics 版本支持 Process 实体类型和 Process 实体集。

可以使用这些属性根据积压工作级别筛选工作跟踪数据。

显示名称 Name 数据类型 说明
AnalyticsUpdatedDate 日期时间 指示上次更新 Analytics 数据的水印。
ProjectSK GUID 与流程关联的项目密钥。
TeamSK GUID 与流程关联的团队密钥。
积压工作类别引用名称 BacklogCategoryReferenceName 字符串 分配给与工作项类型关联的积压工作的类别引用名称。 示例包括 Microsoft.EpicCategoryMicrosoft.FeatureCategoryMicrosoft.RequirementCategoryMicrosoft.TaskCategory
积压工作名称 BacklogName 布尔 分配给与工作项类型关联的积压工作的引用名称
积压工作类型 BacklogType GUID 创建时分配给积压工作的唯一标识符。
积压工作级别 BacklogLevel 字符串 与工作项类型关联的积压工作级别。 如果工作项类型未与积压工作级别关联,则 null 该值返回。
工作项类型 WorkItemType 字符串 为工作项类型定义的名称。
有积压工作 HasBacklog 字符串 指示工作项类型是否属于积压工作。
是隐藏类型 IsHiddenType 布尔 指示是否禁用工作项类型。
Bug 类型 IsBugType 布尔 指示工作项类型是否属于 Bug 类别。
已删除 IsDeleted 布尔 指示是否删除工作项类型。

有关进程积压工作项类型的详细信息,请参阅以下文章:

标记

以下属性对 Tags 实体集有效。 与 标记 关联的代理键包括 TagSKProjectSK。 导航属性包括 Project 及其引用约束 ProjectSK。 有关使用标记的详细信息,请参阅 添加工作项标记以对列表和板进行分类和筛选。

可以使用这些属性筛选或报告工作跟踪数据。

显示名称 Name 数据类型 说明
标记 ID TagId GUID 创建时分配给标记的唯一 ID。
标记名称 TagName 字符串 标记名称。

团队

以下属性对 Team 实体类型和 Teams 实体集有效。 与 Team 关联的代理键包括 TeamSKProjectSK。 可以使用这些属性根据团队分配筛选或报告工作跟踪数据。 有关使用和添加团队的信息,请参阅关于团队和敏捷工具和创建或添加团队

显示名称 Name 数据类型 说明
AnalyticsUpdatedDate 日期时间 水印指示上次更新分析数据的时间。
团队 ID TeamId GUID 创建时分配给团队的唯一 ID。
团队名称 TeamName 字符串 团队名称。

Teams 实体集的导航属性包括项目区域迭代

以下属性对 WorkItemLinks 实体集有效。 属性引用代理项键为 WorkItemLinkSK。 查询 WorkItemLinks ,以报告父/子、相关、前置/继任者或其他链接类型。

显示名称 Name 数据类型 说明
AnalyticsUpdatedDate 日期时间 水印指示上次更新分析数据的时间。
WorkItemLinkSK Int32 分配给 WorkItemLink 实体的代理键。
创建日期 CreatedDate GUID 创建链接的日期。
注释 Comment 字符串 创建链接时添加的注释。
删除日期 DeletedDate 字符串 删除链接的日期。
链接类型 ID LinkTypeId Int32 分配给目标链接工作项的 ID。
链接类型名称 LinkTypeName 字符串 分配给链接类型的友好名称。
链接类型引用名称 LinkTypeReferenceName 字符串 分配给链接类型的引用名称。
链接类型是无环的 LinkTypeIsAcyclic 布尔 指示链接类型在设置为 True时允许循环关系。 例如,树类型链接限制循环关系。
链接类型为方向 LinkTypeIsDirectional 布尔 指示链接类型是否为方向。 方向链接类型与正向和反向组件成对定义。
源工作项 ID SourceWorkItemId Int32 分配给链接源工作项的 ID。
目标工作项 ID TargetWorkItemId Int32 分配给链接目标工作项的 ID。

WorkItemLink 实体类型的导航属性包括 ProjectsSourceWorkItemTargetWorkItem

有关链接和链接类型的详细信息,请参阅以下文章:

工作项类型字段

以下属性对 WorkItemTypeFields 实体集有效。 属性引用键为 FieldNameProjectSKWorkItemType

显示名称 Name 数据类型 说明
字段名称 FieldName 字符串 系统或创建时分配给字段的友好名称。
字段引用名称 FieldReferenceName 字符串 由系统或在创建自定义字段时分配给字段的引用名称。
字段类型 FieldType 字符串 分配给字段的数据类型。
工作项类型 WorkItemType 字符串 为字段定义的工作项类型。

导航属性包括 Project。 有关为项目定义的所有字段的索引,请参阅 工作项字段的字段说明。 如需了解更多信息,请参阅以下文章:

自定义属性

自定义字段作为自定义属性自动添加到 Analytics 服务。 Custom_Custom. 在属性名称前面追加。 检查集合的元数据,如 查询元数据中所述。 以下示例显示了自定义字段 Risk Opportunity 的元数据语法。

<Property Name="Custom_RiskOpportunity" Type="Edm.Double">
<Annotation Term="Display.DisplayName" String="Risk Opportunity"/>
<Annotation Term="Ref.ReferenceName" String="Custom.RiskOpportunity"/>
<Annotation Term="Display.Description" String="Risk Reduction | Opportunity Enablement Value. Enter a value from 1 to 5. 5 represents high risk reduction or high opportunity enablement."/>
</Property>

自定义工作项类型和积压工作类别

自定义工作项类型的数据会自动添加到 Analytics 服务。 定义自定义工作项类型和积压工作项级别时,会创建一个自定义类别,并 Custom_ 追加到类别 GUID 或 Custom. 前面。 例如,自定义类别(例如 Custom.49b81c4e-9c4f-4c04-94fd-d660cbf3a000 ,可以分配给项目组合积压工作项中的 项目组合 自定义工作项类型)。