Элемент FIELD (определение)

  • Статья

Элемент FIELD (определение) служит для определения поля рабочего элемента и указания правил и условий, применяемых к этому полю.Атрибуты, которые можно назначить полю, определяют, как оно отображается в форме рабочего элемента и доступно ли оно для включения в отчеты.Управление набором назначений полей для коллекции командных проектов осуществляется пользователем.Таким образом атрибуты, назначаемые полям, определенным в одном типе рабочего элемента, должны совпадать во всех типах рабочих элементов во всех проектах рабочей группы в коллекции.Кроме того, все отчетные поля из всех коллекций экспортируются в базы данных хранилища данных.

ПримечаниеПримечание

Дополнительные сведения об элементе FIELD (Рабочий процесс), используемом для задания правил и условий для полей во время изменения состояния или перехода рабочего процесса, см. в разделе Элемент FIELD (рабочий процесс).

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

Схема иерархии

WITD

   WORKITEMTYPE

      FIELDS

            FIELD

<xs:element name="FIELD" type="FieldDefinition" maxOccurs="unbounded"/>

<FIELD name="fieldDisplayName" refname="fieldReferenceName" type="String | Integer | Double | DateTime | PlainText | HTML | History | TreePath | GUID" syncnamechanges ="true | false" reportable="Dimension | Detail | Measure" formula="sum" reportingname="ReportingDisplayName" reportingrefname="ReportingReferenceName" >
   <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
   <ALLOWEXISTINGVALUE />
   <CANNOTLOSEVALUE />
   <COPY />
   <DEFAULT />
   <EMPTY />
   <FROZEN />
   <HELPTEXT> . . . </HELPTEXT>
   <MATCH />
   <NOTSAMEAS />
   <PROHIBITEDVALUES /> . . . </PROHIBITEDVALUES>
   <READONLY />
   <REQUIRED />
   <SERVERDEFAULT />
   <SUGGESTEDVALUES /> . . . </SUGGESTEDVALUES>
   <VALIDUSER />
   <WHEN>> . . . </WHEN>
   <WHENNOT> . . . </WHENNOT>
   <WHENCHANGED> . . . </WHENCHANGED>
   <WHENNOTCHANGED> . . . </WHENNOTCHANGED>
</FIELD>

Атрибуты и элементы

В следующих разделах описаны атрибуты, дочерние элементы и родительские элементы.

Атрибуты

Атрибут

Описание

name

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

Типом атрибута является typelib:FieldName.Минимальная длина: 1; максимальная длина: 128.

Значение шаблона: ^[^\.\[\]]+$

Пример значения шаблона: Assigned To

refname

Обязательное.Уникальная метка, которая отличает поля из всех полей, которые определены в коллекции командного проекта.

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

Типом атрибута является typelib:ReferenceFieldName.Минимальная длина: 1; максимальная длина: 70.

Значение шаблона: ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

Пример значения шаблона: Company.IssueType

type

Обязательное.Указывает тип данных, который принимает поле.

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

В следующей таблице приведен список возможных значений для данного атрибута:

ЗначениеИспользование
DateTime Указывает данные в соответствии с моментом времени в формате UTC.
Double Указывает значение с плавающей запятой.
GUID Указывает поле, которое будет содержать уникальный идентификатор.
History
Поддерживает просмотр цепочек обсуждения и отслеживает прочие данные журналов.
ПримечаниеПримечание
Этот тип данных используется только полем System.History.С помощью этого типа данных можно определить настраиваемое поле.
HTML Поддерживает сохранение данных в формате RTF и используется для длинных текстовых описаний, таких как описания рабочих элементов.
Integer Указывает 32-разрядное знаковое целочисленное значение.
PlainText Поддерживается запись текстовой строки длиной не более 255 символов Юникода.
String Поддерживается запись текстовой строки длиной не более 255 символов Юникода.Поле String используется для метки или другого текста длиной не более одной строки.
TreePath
Указывает поле, отображающее записи в иерархической или древовидной структуре, например то, что должно отображать область и пути итерации продукта.Для определения дочерних узлов см. в разделе Создание и изменение областей и итераций.
ПримечаниеПримечание
Этот тип данных используется только полями System.AreaPath и System.IterationPath.С помощью этого типа данных можно определить настраиваемое поле.

syncnamechanges

Необязательный параметр.Указывает, используется ли поле рабочего элемента для хранения имен, которые нужно обновлять по мере внесения изменений в Active Directory или рабочую группу.Этот параметр действителен только в случае, если выполняется условие type="String".Типом атрибута является xs:boolean.

Укажите значение true для включения синхронизации поля данных, а для отключения укажите значение false.

reportable

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

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

В следующей таблице приведен список возможных значений для данного атрибута:

Value Использование
Detail Может быть указан для полей типа DateTime, Double, Integer или String. Данные из этого поля переносятся в реляционную базу данных хранилища в таблицу истории рабочих элементов и в таблицу текущих рабочих элементов, но не помещаются в куб служб аналитики.Этот тип подходит для неограниченных текстовых полей, поскольку позволяет использовать их в отчетах без существенного увеличения куба.
Dimension Может быть указан для полей типа DateTime, Double, Integer или String. Данные в этом поле попадают в реляционную базу данных хранилища и в куб служб аналитики в качестве атрибута измерения рабочего элемента, так что эти данные могут использоваться для фильтрации отчетов.Этот тип используется для полей списков или допустимых значений.Хорошими примерами измерений могут быть Work Item Type (тип рабочего элемента) и State (состояние рабочего элемента).
Measure Используйте тип measure (мера) только для полей Integer и Double.Меры – это числовые значения в ваших отчетах.При обработке куба служб аналитики данные предварительно вычисляются на полях, атрибуты reportable которых заданы для измерения.Например, группы мер рабочего элемента и текущего рабочего элемента содержат совокупные данные для следующих полей: "Исходная оценка", "Оставшиеся часы" и "Затраченные часы".При указании метрики следует задать атрибут formula.
None Укажите None, когда не требуется использовать поле для включения в отчеты.Это назначение по умолчанию.

formula

Необязательный параметр.Тип агрегата для отчетного типа measure.Единственным допустимым значением является sum, которое возвращает сумму всех значений в наборе.

reportingname

Необязательный параметр.Задает имя, отображаемое в отчетах.Если значение не задано, используется значение, присвоенное атрибуту name;

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

Типом атрибута является typelib:FieldName.Минимальная длина: 1; максимальная длина: 128.

Значение шаблона: ^[^\.\[\]]+$

Пример значения шаблона: Assigned To

reportingrefname

Необязательный параметр.Задает имя ссылки, которые используются при обработке отчетного поля.Если значение не задано, используется значение, присвоенное атрибуту refname.

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

Объединять поля следует всегда, когда этого возможно, в целях минимизации количества полей в хранилище и во избежание превышения предельного допустимого количества включаемых в отчеты полей (1024).Можно формировать межгрупповые отчеты с объединенными полями.

Типом атрибута является typelib:ReferenceFieldName.Минимальная длина: 1; максимальная длина: 70.

Значение шаблона: ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

Пример значения шаблона: Company.IssueType

Дочерние элементы

Элемент

Описание

ALLOWEDVALUES

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

ALLOWEXISTINGVALUE

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

CANNOTLOSEVALUE

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

COPY

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

DEFAULT

Необязательный параметр.Определяет значение поля по умолчанию.

EMPTY

Необязательный параметр.Определяет поле как пустое.

FROZEN

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

HELPTEXT

Необязательный параметр.Определяет текст, отображаемый во всплывающей подсказке поля.

MATCH

Необязательный параметр.Определяет для поля шаблон, которому должно соответствовать значение поля.

NOTSAMEAS

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

PROHIBITEDVALUES

Необязательный параметр.Определяет список запрещенных значений поля.

READONLY

Необязательный параметр.Определяет поле как доступное только для чтения.

REQUIRED

Необязательный параметр.Определяет поле как обязательное.

SERVERDEFAULT

Необязательный параметр.Указывает компонент сервера, которым будет предоставляться значение для поля.

SUGGESTEDVALUES

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

VALIDUSER

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

WHEN

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

WHENCHANGED

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

WHENNOT

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

WHENNOTCHANGED

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

Родительские элементы

Элемент

Описание

FIELDS

Обязательное.Содержит определения полей типа рабочего элемента.

Заметки

Элемент FIELD (Определение) является обязательным дочерним элементом элемента FIELDS (Определение).

minOccurs="1"

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

ПримечаниеПримечание

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

Дополнительные требования и ограничения для понятных имен полей и ссылочных имен см. в разделе Соглашения об именовании объектов отслеживания рабочих элементов.Сведения о пометке полей в целях составления отчетов см. в разделе Добавление и изменение полей рабочих элементов для поддержки отчетов.

Нельзя определить настраиваемое поле, начинающееся с префикса System..Можно определить поле с помощью префикса Microsoft., однако это не настоятельно не рекомендуется делать, так как это может помешать работе Team Foundation Server.

Обзор объекта отслеживания рабочего элемента поля см. в разделе Работа с полями рабочих элементов.

Обзор всех системных и предварительно определенных полей, заданных для Microsoft Solutions Framework (MSF) для шаблонов процессов гибкой разработки программного обеспечения версии 5.0, см. в разделе Справочник по полям рабочих элементов для Visual Studio ALM.

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

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

Пример

<FIELD name="Activity" refname="Microsoft.VSTS.Common.Activity" type="String" reportable="dimension">
   <HELPTEXT>Type of work involved</HELPTEXT>
   <SUGGESTEDVALUES>
      <LISTITEM value="Development"/>
      <LISTITEM value="Testing"/>
      <LISTITEM value="Requirements"/>
      <LISTITEM value="Design"/>
      <LISTITEM value="Deployment"/>
      <LISTITEM value="Documentation"/>
   </SUGGESTEDVALUES>
</FIELD>

См. также

Ссылки

Управление полями рабочих элементов [witadmin]

Основные понятия

Соглашения об именовании объектов отслеживания рабочих элементов

Справочник по полям рабочих элементов для Visual Studio ALM

Настройка данных отслеживания, форм, рабочего процесса и других объектов для проекта

Работа с полями рабочих элементов

Другие ресурсы

Указатель определений XML-элементов для типов рабочих элементов