Справочник по метаданным для Аналитики Azure Boards

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

Служба аналитики собирает все определения отслеживания работы и обновления Azure Boards. Вы можете выполнять запросы Аналитики непосредственно в браузере и использовать сочетание свойств для фильтрации запросов, агрегированных данных или создания отчета. Дополнительные сведения см. в разделе "Определение базовых запросов с помощью OData Analytics".

В этой статье описывается большинство свойств, которые можно использовать для создания отчета аналитики отслеживания работы. Аналитика сохраняет все поля отслеживания работы в качестве свойств, за исключением полей HTML/rich-text и журнала. Пользовательские поля автоматически добавляются в Аналитику в качестве настраиваемых свойств.

Общие сведения о наборах сущностей

При запросе аналитики для данных отслеживания работы запросите сущность WorkItems , чтобы создать отчеты о состоянии и свертки. Используйте сущность WorkItemSnapshot , чтобы создать тенденции, сгореть и сжечь отчеты.

Используйте другие типы сущностей, такие как область, итерация, проект или команда , чтобы отфильтровать данные или выбрать свойства для отчета. Примеры отчетов см. в примерах отчетов и кратких справочных индексах.

Снимки

Наборы сущностей моментального снимка отслеживания работы — WorkItemSnapshot и WorkItemBoardSnapshot. Моментальный снимок записывается в Аналитику одновременно каждый день и предоставляет запись значений, определенных для рабочего элемента в течение этого дня. С помощью моментальных снимков можно создавать отчеты о тенденциях.

По умолчанию все таблицы моментальных снимков моделиируются как ежедневные таблицы фактов моментальных снимков. Запрос диапазона времени получает значение для каждого дня, а длительные диапазоны времени приводят к большому количеству записей. Если вам не нужна такая высокая точность, можно использовать еженедельные или ежемесячные моментальные снимки. Дополнительные сведения см. в разделе "Использование еженедельных или ежемесячных моментальных снимков" для запросов трендов, охватывающих длительный период времени.

Редакции рабочих элементов

При каждом обновлении рабочего элемента система создает новую редакцию и записывает ее в System.RevisedDate поле, что полезно для указания фильтра журнала. Можно представить измененную дату по свойствам и RevisedDate (DateTime) свойствамRevisedDateSK (Int32).

Используйте последнее свойство ключа суррогатной даты для оптимальной производительности. Этот ключ показывает дату создания редакции или отображает значение "9999-01-01T00:00:00Z" null даты и времени OData для активных или неполных редакций. Если вы хотите, чтобы все даты с момента {startDate}инклюзивного инклюзивного, добавьте следующий фильтр в запрос: RevisedDateSK eq null or RevisedDateSK gt {startDateSK}

Сущность WorkItemRevisions используется для загрузки всех исправлений для заданного рабочего элемента. Запрос возвращает все исторические редакции рабочих элементов, включая текущую редакцию, для рабочих элементов, которые вы фильтруете, не включая удаленные рабочие элементы.

Общие свойства для типов сущностей

Свойства, которые можно выбрать в представлении Аналитики, соответствуют обычным полям отслеживания работы и выбранным свойствам аналитики, таким как " Время цикла " и "Дни времени свинца". Эти свойства определяются для следующих типов сущностей, если не указано иное:

• WorkItem
• WorkItemRevision
• WorkItemSnapshot
• WorkItemBoardSnapshot

В следующей таблице перечислены и описываются большинство свойств, которые можно выбрать в представлении Аналитики, включая обычные поля отслеживания работы и другие свойства Аналитики.

Свойства навигации

Свойства навигации OData — это ссылочные атрибуты сущности, которая указывает на другую сущность. В следующей таблице приведена сводка свойств навигации, их ссылочных ограничений и допустимых типов сущностей.

*Сущность WorkItem также поддерживает PredictTags функции и Predict функции, поддерживающие прогнозные тенденции для выбора встроенных отчетов и мини-приложений Аналитики.

BoardLocation и WorkItemBoardSnapshot

В следующей таблице перечислены и описываются свойства, определенные для типов сущностей BoardLocation и WorkItemBoardSnapshot , если не указано. Эти поля можно использовать для фильтрации данных рабочих элементов на основе состояния рабочего элемента в столбце доски команды, плавании или уровне невыполненной работы. Пример запроса набора сущностей WorkItemBoardSnapshot см. в примере отчета о схеме потоков (CF).

*В следующей таблице перечислены имена элементов перечисленного типа, которые можно использовать для BoardColumnSplit фильтрации рабочих элементов в столбцах "Выполнение " или "Готово ".

Дополнительные сведения о столбцах доски для команды см. в следующих статьях:

• Добавьте столбцы в вашу доску
• Разделение столбцов на доске для отображения работы

Области

Следующие свойства допустимы для набора сущностей "Области ", связанного с полем "Путь к области". Суррогатные ключи, связанные с областью , включают AreaSK и ProjectSK. Эти свойства можно использовать для фильтрации или отчета о данных отслеживания работы на основе назначений пути к области.

Свойства навигации для типа сущности "Область " и набора сущностей "Области " включают Project и Teams.

Дополнительные сведения о пути к области см. в следующих статьях:

• Сведения о путях к области и путях итерации (спринт)
• Определение путей к областям и назначение их команде

Итерации

Следующие свойства допустимы для набора сущностей итерации , связанного с полем "Путь итерации". Суррогатные ключи, связанные с итерацией , включают IterationSK и ProjectSK. Эти свойства можно использовать для фильтрации или отчета по данным отслеживания работы на основе назначений пути итерации.

Свойства навигации для типа сущности Итерации и набор сущностей итерации включают Project и Teams.

Дополнительные сведения о путях итерации см. в следующих статьях:

• Сведения о путях к области и путях итерации (спринт)
• Определение путей итерации (спринтов) и настройка итераций для команды

Процессы

Следующие свойства допустимы для типа сущности Process и набора сущностей Process . Суррогатные ключи, связанные с процессом , включают ProcessSK, ProjectSKи TeamSK. Используйте эти свойства для фильтрации или отчета о данных отслеживания работы в типах рабочих элементов для проекта или команды.

Эти свойства можно использовать для фильтрации данных отслеживания работы на основе уровня невыполненной работы.

Дополнительные сведения о невыполненных работах и типах рабочих элементов см. в следующих статьях:

• Создание наследуемых процессов и управление ими
• Добавление типов рабочих элементов и управление ими
• Настройка невыполненных работ или досок (процесс наследования)

Теги

Следующие свойства допустимы для набора сущностей Tags . Суррогатные ключи, связанные с тегом , включают TagSK и ProjectSK. Свойства навигации включают Project и его ссылочное ограничение ProjectSK. Дополнительные сведения об использовании тегов см. в статье "Добавление тегов рабочих элементов для классификации и фильтрации списков и досок".

Эти свойства можно использовать для фильтрации или отчета по данным отслеживания работы.

Команды

Следующие свойства допустимы для типа сущности Team и набора сущностей Teams . Суррогатные ключи, связанные с командой , включают TeamSK и ProjectSK. Эти свойства можно использовать для фильтрации или отчета о данных отслеживания работы на основе назначений команд. Сведения об использовании и добавлении команд см. в разделе "О командах" и "Гибкие средства " и "Создание или добавление команды".

Свойства навигации для набора сущностей Teams включают проекты, области и итерации.

WorkItemLinks

Следующие свойства допустимы для набора сущностей WorkItemLinks . Ссылочный суррогатный ключ свойства имеет значение WorkItemLinkSK. Запрос WorkItemLinks для отчета о родительском или дочернем, связанном, предшественнике или преемнике или других типах ссылок.

Свойства навигации для типа сущности WorkItemLink включают Проекты, SourceWorkItem и TargetWorkItem.

Дополнительные сведения о ссылках и типах ссылок см. в следующих статьях:

• Использование ссылок для просмотра зависимостей и отслеживания связанных работ
• Справочник по типам ссылок, используемым в Azure DevOps

ПоляТипаРабочегоЭлемента

Следующие свойства допустимы для набора сущностей WorkItemTypeFields . Ключи ссылки на свойства: FieldNameи ProjectSKWorkItemType.

Свойства навигации включают Project. Индекс всех полей, определенных для проекта, см . в описаниях полей рабочего элемента. Дополнительные сведения см. в следующих статьях:

• Поля и атрибуты рабочих элементов
• Добавление полей и управление ими (процесс наследования)

Пользовательские свойства

Настраиваемые поля автоматически добавляются в службу Аналитики в качестве настраиваемых свойств. 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>

Пользовательские типы рабочих элементов и категории невыполненных работ

Данные для пользовательских типов рабочих элементов автоматически добавляются в службу Аналитики. Пользовательская категория создается при определении пользовательского типа рабочего элемента и уровня невыполненной работы с Custom_ идентификатором GUID категории или Custom. его предустановкой. Например, пользовательская категория, например Custom.49b81c4e-9c4f-4c04-94fd-d660cbf3a000 , может быть назначена типу пользовательского рабочего элемента портфеля в невыполненной работе портфеля.

Связанный контент

• Что такое Azure Boards?
• Отслеживание историй пользователей, проблем, ошибок и других рабочих элементов в Azure Boards
• Поля и атрибуты рабочих элементов
• Индекс полей рабочего элемента
• Ограничения для отслеживания хода выполнения работы, процесса и проекта
• Представление исторических данных в Аналитике
• Модель данных для аналитики
• Рекомендации по запросам OData Analytics