Поля и атрибуты рабочих элементов в Azure Boards

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019 | TFS 2018

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

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

Поля рабочих элементов используются для отслеживания информации. Поля определяются для коллекции и совместно используются во всех проектах, определенных для этой коллекции. Чтобы просмотреть все поля, определенные для коллекции, можно использовать проводник полей рабочих элементов , подключаемый модуль Visual Studio.

Описание каждого поля, определенного с помощью системного процесса, см. в разделе Индекс поля рабочего элемента.

Предварительные требования

  • Чтобы просмотреть поля, определенные для организации или коллекции, необходимо быть членом группы приложений "Допустимые пользователи коллекции проектов" или иметь разрешение Просмотр сведений на уровне экземпляра значение Разрешить для организации или коллекции.

Список или проверка полей

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

Средство Наследование Размещенный XML-код Локальный XML-процесс
Веб-портал: перечисление наследуемых и настраиваемых полей ✔️ ✔️1
Обозреватель полей рабочих элементов ✔️ ✔️ ✔️
Программа командной строки witadmin listfields ✔️ ✔️ ✔️

Примечание

  1. Поддерживается только для процессов по умолчанию (Agile, CMMI, Scrum).

Типы данных и имена полей

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

Каждое поле определяется следующими тремя атрибутами.

Описание каждого атрибута поля и способ их перечисления см. в разделах Атрибуты полей и Список атрибутов полей далее в этой статье. Общие сведения о WIT и рабочих элементах см. в разделе Отслеживание работы с пользовательскими историями, проблемами, ошибками, функциями и эпиками.

Что такое поле? Как используются имена полей?

Каждый тип рабочего элемента связан с 31 системным полем и еще несколькими полями, зависящими от типа. Рабочие элементы используются для планирования и отслеживания проекта.

Каждое поле поддерживает отслеживание части сведений о выполняемой работе. Значения, присваиваемые полю, хранятся в хранилище данных отслеживания работы, в котором можно создавать запросы для определения состояния и тенденций.

Описание и использование каждого поля, определенного для основных системных процессов, процессов Agile, Basic, Scrum и CMMI, см. в разделе Индекс поля рабочего элемента.

Имена полей

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

  • Имена полей должны быть уникальными в коллекции учетных записей или проектов
  • Имена полей должны содержать не более 128 символов Юникода
  • Имена полей не могут содержать начальные или конечные пробелы, а также два или более последовательных пробелов.
  • Имена полей должны содержать по крайней мере один алфавитный символ.
  • Имена полей не могут содержать следующие символы: .,;'`:~\/\*|?"&%$!+=()[]{}<>.

Так как настраиваемые поля определены для организации или коллекции, вы не можете добавить настраиваемое поле в процесс с тем же именем поля, которое вы добавляете в другой процесс.

Дополнительные сведения см. в разделе Ограничения и соглашения об именовании.

Системные и предварительно определенные поля

Все системные поля имеют имена ссылок, которые начинаются с System, например System.AreaPath, System.AssignedTo, и продолжаются в этом шаблоне.

Предопределенные поля, определенные процессом по умолчанию, начинаются с Microsoft.VSTS, а затем отличаются в зависимости от их использования. Ниже приведены примеры стандартных полей, которые используются для планирования и интеграции с Office Project, для интеграции со сборкой Team Foundation и управления тестовыми случаями (TCM).

  • Microsoft.VSTS.Common.Priority
  • Microsoft.VSTS.Scheduling.DueDate
  • Microsoft.VSTS.Build.FoundIn
  • Microsoft.VSTS.TCM.Steps

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

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

Так как настраиваемые поля определены для организации или коллекции проектов, вы не можете добавить настраиваемое поле в процесс с тем же именем поля, которое вы добавляете в другой процесс.

При добавлении настраиваемых полей обратите внимание на следующие ограничения.

  • Для каждого WIT можно определить не более 64 полей.
  • Для каждого процесса можно определить не более 512 полей.

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

При добавлении настраиваемого поля в наследуемый процесс Azure DevOps назначает имя ссылки с префиксом Custom , а затем имя поля с удаленными пробелами. Например, вы добавляете поле с именем DevOps Triage, а ссылка — Custom.DevOpsTriage. Пробелы в имени ссылки не допускаются.

Как определить тип данных поля?

Вы можете просмотреть тип данных полей, определенных для вашей организации, открыв страницу Поля обработки>.

Снимок экрана: страница

Если в коллекции проектов для настройки отслеживания работы используется модель процесса наследования, вы можете просмотреть тип данных полей, открыв страницу Обработка>полей.

Снимок экрана: страница

Если используется локальная модель процессов XML, можно найти тип данных с помощью индекса поля Рабочий элемент. Вы также можете открыть обозреватель полей рабочих элементов, чтобы просмотреть определенные поля и их назначения атрибутов, или использовать команду witadmin listfields для перечисления атрибутов полей. Дополнительные сведения см. в разделах Обозреватель полей рабочих элементов и Список атрибутов полей далее в этой статье.

Тип данных можно найти с помощью индекса поля Рабочий элемент. Вы также можете открыть обозреватель полей рабочих элементов, чтобы просмотреть определенные поля и их назначения атрибутов, или использовать команду witadmin listfields для перечисления атрибутов полей. Дополнительные сведения см. в разделах Обозреватель полей рабочих элементов и Список атрибутов полей далее в этой статье.

Веб-страница "Поля обработки">

Чтобы просмотреть список полей, определенных для организации или коллекции, откройте раздел Параметры>организации Поля процесса>.

  1. Выберите логотип Azure DevOps, чтобы открыть проекты. Затем выберите Параметры организации.

    Снимок экрана: выбор параметров организации.

  2. Затем нажмите кнопку Обработать.

    Снимок экрана: выбор процесса.

    Примечание

    Если вы не видите элемент Процесс, значит, вы работаете с TFS-2018 или более ранней версии. Страница "Процесс " не поддерживается. Необходимо использовать функции, поддерживаемые для локальной модели процессов XML.

  3. Затем выберите Поля.

    Перечисленные поля соответствуют всем полям, определенным для организации или коллекции. Сюда входят все настраиваемые поля и поля, определенные для системных процессов.

    Снимок экрана: создание копии выбранного наследуемого процесса.

    Примечание

    Если вы не видите поля, то в коллекции используется локальный ПРОЦЕСС XML. Страница Поля не поддерживается для этого процесса.

    Описание и использование каждого поля, а также имя ссылки для каждого поля можно найти в индексе поля Рабочий элемент. Вы также можете получить имя ссылки на поля из REST API типов рабочих элементов — список.

Обозреватель полей рабочего элемента

Вы можете искать назначения атрибутов полей с помощью средства "Обозреватель полей рабочих элементов".

Снимок экрана: обозреватель полей рабочих элементов.

Чтобы получить доступ к обозревателю полей рабочих элементов, необходимо установить средство редактора процессов. В зависимости от установленной версии Visual Studio получите средство редактора процессов из одного из следующих расширений.

Атрибуты полей

Существует множество неизменяемых и скрытых атрибутов для каждого поля рабочего элемента. В следующей таблице описывается каждый атрибут. Атрибуты имеют разные имена в зависимости от того, получаете ли вы их с помощью REST API "Поля — получение" или с помощью средства "Обозреватель полей рабочих элементов" (WIFE).

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

Attribute

Тип атрибута

Описание


REST:
WIFE: AllowedValues

коллекция

Возвращает коллекцию допустимых значений для поля, содержащего значения списка выбора. Это можно изменить, указав список выбора или глобальный список (локальный).
Может измениться?=Да

REST: canSortBy
ЖЕНА: CanSortBy

Логическое

Указывает, можно ли сортировать результаты запроса с помощью этого поля.
Может измениться?=Нет

REST: описание
ЖЕНА: HelpText

строка

Указывает описание поля, которое также определяет текст справки, который отображается при наведении указателя мыши на поле в форме рабочего элемента.
Может измениться?=Да

REST:
ЖЕНА: ИДЕНТИФИКАТОР

Целое число

Задает внутренний идентификатор поля.
Может измениться?=Нет

REST:
ЖЕНА: IsCloneable

Логическое

Указывает, копируется ли определенное для поля значение, когда пользователь решает скопировать рабочий элемент. Например, копируются поля "Заголовок", "Теги" и "Описание ", но поля "Идентификатор " и "Журнал " не копируются.
Может измениться?=Нет

REST:
ЖЕНА: IsComputed

Логическое

Указывает, вычисляется ли значение, заданное этим полем, системой (True) или нет (False). Примерами вычисляемых полей являются поля, которые задаются системой, такие как идентификатор, измененная дата, дата изменения и число внешних ссылок.
Может измениться?=Нет

REST:
ЖЕНА: IsCoreField

Логическое

Указывает, указано ли это поле для всех типов рабочих элементов.
Может измениться?=Нет

REST:
ЖЕНА: IsEditable

Логическое

Указывает, могут ли пользователи изменять это поле (True) или нет (False). Примерами нередактируемых полей являются поля, которые задаются системой, например поля ID, Revision, Created By и Changed By
Может измениться?=Нет

REST: isIdentity
ЖЕНА: IsIdentity

Логическое

Указывает, является ли это поле полем идентификатора . Поля удостоверений — это строковые поля, используемые для хранения удостоверений пользователей.
Может измениться?=Нет

REST:
ЖЕНА: IsIndexed1

Логическое

Указывает, индексируется ли это поле для поддержки поиска.
Может измениться?=Нет

REST:
ЖЕНА: IsLongText

Логическое

Указывает, что поле может содержать более 255 символов, например полям, которым назначен тип данных PlainText, HTML или History.
Может измениться?=Нет

REST: isPicklist2 ЖЕНА:

Логическое

Указывает, связано ли поле с списком выбора. Если для Azure DevOps определено настраиваемое поле, устанавливается значение True , а для типа Picklist (String) или Picklist (Integer) выбран тип. Для наследуемых полей, определяющих списки выбора, задано значение False .
Может измениться?=Нет

REST: isPicklistSuggested2 WIFE:

Логическое

Указывает, позволяет ли это поле вводить собственные значения для списка выбора. Если для Azure DevOps, типа Picklist (String) или Picklist (Integer) выбрано настраиваемое поле True и установлен флажок Разрешить пользователям задавать собственные значения.
Может измениться?=Да

REST: isQueryable
ЖЕНА: IsQueryable

Логическое

Указывает, отображается ли поле в наборе полей, которые можно добавить для фильтрации запроса рабочего элемента (True) или нет (False). Большинство полей можно запрашивать.
Может измениться?=Нет

REST:
ЖЕНА: Отчет 3

Логическое

Указывает, определен ли атрибут отчетов или задано ли значение, отличное от None. Этот атрибут можно изменить для локальных сред.
Может измениться?=Да

REST:
ЖЕНА: IsUsedInGlobalWorkflow

Логическое

Указывает, определено ли поле в глобальном рабочем процессе.
Может измениться?=Нет

REST:
WIFE: IsUserNameField

Логическое

Указывает, используется ли поле для отображения поля Identity.
Может измениться?=Нет

REST: имя
ЖЕНА: Имя

строка

Понятное имя, присвоенное полю. Понятное имя нельзя изменить для Azure DevOps, но можно изменить для локальной среды с помощью команды witadmin changefield .
Может измениться?=Только локально

REST: picklistId
ЖЕНА: HelpText

GUID

Если поле является списком выбора, идентификатор связанного списка выбора, в противном случае — null. Уникальное значение GUID присваивается при определении настраиваемого поля для Azure DevOps и выборе типа (String) или Picklist (Integer).
Может измениться?=Нет

REST:
WIFE: ProhibitedValues

коллекция

Возвращает коллекцию запрещенных значений для поля, указывающего такие значения. Вы можете определить только запрещенные значения для локальных развертываний.
Может измениться?=Только локально

REST: readOnly
ЖЕНА:

Логическое

Указывает, задано ли поле только для чтения. Для Azure DevOps Services можно изменить только настраиваемые поля, чтобы они были доступны только для чтения. Системные поля нельзя изменить.
Может измениться?=Да

REST: referenceName
WIFE: ReferenceName

строка

Указывает имя ссылки на поле.
Может измениться?=Нет

REST:
WIFE: ReportingAttributes3

Задает значение Detail, Dimension или Measure в зависимости от того, нужно ли включить поле в отчеты и как. Данные из полей, имеющих значение, отличное от None для этого атрибута, экспортируются в хранилище данных и могут быть включены в отчеты SQL.
Может измениться?=Только локально

REST:
ЖЕНА: ReportingName3

строка

Указывает метку поля при отображении данных в отчетах SQL. Если значение не указано, используется понятное имя поля.
Может ли измениться?=Только локальная среда

REST:
WIFE: ReportingReferenceName3

строка

Задает другое имя ссылки на поле, которое используется при экспорте данных в реляционное хранилище данных. Если значение не указано, используется имя ссылки на поля.
Может ли измениться?=Только локальная среда

REST: supportedOperations
ЖЕНА:

set

Набор операторов запроса, допустимых для использования при ссылке на это поле. Краткие сведения о поддерживаемых операциях на основе типа данных см. в статье Краткий справочник по запросам, Операторы и макросы, поддерживаемые для каждого типа данных.
Может измениться?=Нет

REST:
WIFE: SupportsTextQuery

Логическое

Указывает, поддерживает ли поле текстовые запросы, такие как Содержит слова, Не содержит слов.
Может измениться?=Нет

REST:
WIFE: SystemType

строка

Указывает тип данных поля, ссылающийся на системное имя, например System.DateTime или System.String.
Может измениться?=Нет

REST: тип
WIFE: FieldType

строка

Указывает тип данных поля, например Boolean, DateTime, Integer, String и т. д. Полный список и описания см. в разделе Поля запросов, операторы и макросы.
Может измениться?=Нет

REST: использование
ЖЕНА: Использование

строка

Указывает, предназначено ли поле для использования с рабочими элементами (WorkItem) или с объектами ссылки на рабочий элемент (WorkItemLink). Для большинства полей используется WorkItem. Полный список значений использования см. в разделе Получение полей, FieldUsage.
Может измениться?=Нет

Примечание

  1. Для локальных развертываний можно включить индексирование для поля, чтобы улучшить время отклика на запросы при фильтрации по полю. Дополнительные сведения см. в разделе Индексированные поля далее в этой статье.
  2. Атрибуты isPicklist и isPicklistSuggested назначаются только настраиваемым полям, определенным для наследуемого процесса. Модель наследуемого процесса поддерживается для Azure DevOps Server 2019 и более поздних версий. Дополнительные сведения см. в разделе Наследуемая модель процесса.
  3. Все атрибуты отчетов допустимы только для локальных развертываний, проекты которых настроены для поддержки SQL Server отчетов и SQL Server Analysis Services.

Включаемые в отчеты атрибуты

Все атрибуты отчетов допустимы только для локальных развертываний, проекты которых настроены для поддержки SQL Server отчетов и SQL Server Analysis Services. Дополнительные сведения см. в статье Добавление отчетов в проект.

Описание каждого атрибута, поддерживающего отчет, см. в статье Добавление или изменение полей рабочих элементов для поддержки отчетов.

Список полей, в которых атрибуты, доступные для отчета, определены по умолчанию, см. в статье Справочник по отчетным полям .

Индексированные поля

Вы можете включить или отключить индексирование для поля рабочего элемента с помощью команды witadmin indexfield . Когда индексирование для поля включено, повышается производительность поиска рабочих элементов, если такое поле присутствует в запросе. По умолчанию индексируются следующие поля: "Кому назначено", "Дата создания", "Кем изменено", "Состояние", "Причина", "Идентификатор области", "Идентификатор итерации" и "Тип рабочего элемента".

При добавлении настраиваемого поля, используемого во множестве запросов поиска рабочих элементов, для этого поля можно включить индексирование. Дополнительные сведения см. в разделе Управление полями рабочих элементов (witadmin).

Список атрибутов полей

Вы можете получить список атрибутов, назначенных полю, с помощью REST API Fields — Get. Введите название организации в поле OrganizationName.

https://dev.azure.com/OrganizationName/_apis/wit/fields/FieldReferenceName

Например, здесь мы перечислим атрибуты пути итерации, указав имя System.IterationPathссылки , для организации fabrikam.

https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath

Возвращенные данные:

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://dev.azure.com/mseng/_apis/wit/fields/System.IterationPath"
}

Вы можете получить список атрибутов, назначенных полю, с помощью REST API Fields — Get. Введите название организации в поле OrganizationName. Сведения о начале работы с REST см. в статье Справочник по REST API Azure DevOps Services.

https://{ServerName:Port}/tfs/{Collection}/_apis/wit/fields/FieldReferenceName?api-version={version}

Например, здесь мы перечислим атрибуты для пути итерации, указав имя System.IterationPathссылки , для сервера fabrikam.

https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1

Возвращенные данные:

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1"
}

Перечисление атрибутов с помощью witadmin программы командной строки

С помощью команды witadmin listfields можно вывести список атрибутов некоторых полей, таких как тип данных, атрибуты отчетов и индексирование.

Например, можно ввести следующую команду, чтобы получить список атрибутов, определенных для указанного поля, например Microsoft.VSTS.Common.Issue.

witadmin listfields /collection:http://fabrikam:8080/tfs/DefaultCollection /n:Microsoft.VSTS.Common.Issue  

Поля и атрибуты отображаются для названного поля, как показано в этом примере.

Field: Microsoft.VSTS.Common.Issue  
Name: Issue  
Type: String  
Reportable As: dimension  
Use: Adventure Works (Shared Steps), AW Future (Shared Steps), AW Current (Shared Steps)  
Indexed: False  

Параметр Use указывает имя каждого проекта и тип рабочего элемента, в котором используется поле.

Интеграция проекта и сопоставление полей проекта

Вы можете изменить сопоставление полей отслеживания работы с полями в Project, а также изменить способ публикации конкретных полей. См. [Файл сопоставления полей Microsoft Project](/previous-versions/azure/devops/reference/xml/customize-project-field-mapping-file.

Добавление и изменение полей

Чтобы добавить поля в процесс, добавьте их в один или несколько типов рабочих элементов. Дополнительные сведения см. в статье Настройка процесса наследования.

Вы можете добавить или изменить поля, содержащиеся в WIT, или добавить настраиваемый WIT. Дополнительные сведения см. на следующих ресурсах:

Вы можете изменить имя поля, индекс и атрибуты отчета для любого поля, кроме системных полей, с помощью программы командной строки witadmin . Дополнительные сведения см. в разделе Управление полями рабочих элементов witadmin.

Чтобы добавить поля в проект, добавьте их в один или несколько типов рабочих элементов. См . статью Добавление или изменение поля для отслеживания работы.

Вы можете изменить имя поля, индекс и атрибуты отчета для любого поля, кроме системных полей, с помощью программы командной строки witadmin . Дополнительные сведения см. в разделе Управление полями рабочих элементов witadmin.