Справочник по элементам FIELD (определение)

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

Примечание

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

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

WITD

   WORKITEMTYPE

      FIELDS

            FIELD

<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, Integer, String и TreePath. Данные в этом поле попадают в реляционную базу данных хранилища и в куб служб аналитики в качестве атрибута измерения рабочего элемента, так что эти данные могут использоваться для фильтрации отчетов. Этот тип используется для полей списков или допустимых значений. Хорошими примерами измерений могут быть Work Item Type (тип рабочего элемента) и State (состояние рабочего элемента). Measure Используйте значение Measure (мера) только для полей Integer и Double. Меры – это числовые значения в ваших отчетах. При обработке куба служб аналитики данные предварительно вычисляются в полях, атрибуты reportable которых заданы для измерения. Например, группы мер рабочего элемента и текущего рабочего элемента содержат совокупные данные для следующих полей: «Исходная оценка», «Оставшиеся часы» и «Затраченные часы». При задании значения Measure необходимо задать атрибут 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	Обязательный. Содержит определения полей типов рабочих элементов.

Заметки

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

2. Обзор всех системных и предопределенных полей, определенных для шаблонов процессов TFS, см. в разделе Справочник по полям рабочих элементов для Visual Studio ALM.

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

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

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

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

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

6. Сведения о пометке полей для создания отчетов см. в разделе Добавление и изменение полей рабочих элементов для поддержки отчетов.

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

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

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

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

Пример

<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-элементов