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

Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 — TFS 2013

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

Примечание

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

Синтаксис

Примечание

тип данных Boolean поддерживается для Azure DevOps Services и для локального сервера TFS 2017,2 и более поздних версий.

<FIELD name="fieldDisplayName" refname="fieldReferenceName" 
type="String | Integer | Double | DateTime | PlainText | HTML | History | TreePath | GUID | Boolean"   
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 Обязательный элемент. Понятное имя поля, которое отображается в раскрывающихся меню запросов рабочих элементов. Понятное имя должно быть уникальным для всех полей, определенных в проекте. Понятное имя может также отличаться от метки, появляющейся рядом с полем в форме рабочего элемента. Дополнительные сведения см. в статье Управление.

Тип атрибута — 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 . Если значения различаются, при обработке хранилища данных могут возникать конфликты данных. Дополнительные сведения см. в разделе разрешение конфликтов данных, происходящих в Data Warehouse.

В следующей таблице перечислены допустимые значения этого атрибута.

- Boolean: Добавляет поле true/false или да/нет. Примечание. для локального типа данных TFS требуется обновление до TFS 2017,2 или более поздней версии.

- DateTime: Указывает дату в соответствии с временем в формате UTC.

- Double: Задает значение с плавающей запятой.

- GUID: Указывает поле, которое будет содержать уникальный идентификатор.

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

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

- 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 Analysis Services куба. Дополнительные сведения об отчетных полях см. в разделе Добавление или изменение полей рабочих элементов для поддержки отчетов.

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

В следующей таблице перечислены допустимые значения этого атрибута.

- Detail: Может быть задано для полей типа DateTime, Double, Integer или String. Данные из этого поля переносятся в реляционную базу данных хранилища в таблицах рабочих элементов и текущих рабочих элементов, но не в куб служб аналитики. Этот тип подходит для неограниченных текстовых полей, поскольку позволяет использовать их в отчетах без существенного увеличения куба.

- Dimension: Может быть задано для полей типа DateTime, Integer, String или TreePath. Данные в этом поле попадают в реляционную базу данных хранилища и в куб служб аналитики в качестве атрибута измерения рабочего элемента, так что эти данные могут использоваться для фильтрации отчетов. Этот тип используется для полей списков или допустимых значений. Хорошими примерами измерений могут быть Work Item Type (тип рабочего элемента) и State (состояние рабочего элемента).

- Measure: Используйте тип меры только для полей типа Integer и Double. Меры – это числовые значения в ваших отчетах. При обработке куба Analysis Services данные предварительно вычисляются для полей, атрибуты которых reportable заданы как Measure. Например, группы мер рабочего элемента и текущего рабочего элемента содержат совокупные данные для следующих полей: «Исходная оценка», «Оставшиеся часы» и «Затраченные часы».

При указании меры необходимо указать formula атрибут.

- None: Укажите None , когда не нужно использовать поле для включения в отчеты. Это назначение по умолчанию.
числять Необязательный элемент. Тип агрегирования для measure отчетного типа. Единственное допустимое значение — sum , которое возвращает сумму всех значений в наборе.
репортингнаме Необязательный элемент. Задает имя, отображаемое в отчетах. Если значение не указано, используется значение, присвоенное name атрибуту.

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

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

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

Пример значения шаблона: Assigned To
репортингрефнаме Необязательный элемент. Задает ссылочное имя, используемое при обработке отчетного поля. Если значение не указано, используется значение, присвоенное refname атрибуту.

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

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

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

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

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

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

Элемент Описание
ALLOWEDVALUES Необязательный элемент. Определяет список допустимых значений поля. Допустимыми являются значения, которые можно выбрать в списке полей в формах рабочих элементов и в конструкторе запросов. Необходимо выбрать одно из этих значений.
ALLOWEXISTINGVALUE Необязательный элемент. Определяет разрешение полем существующих значений. Этот элемент позволяет полю принимать любое из уже существующих значений, даже если оно недопустимо. Все новые значения поля должны быть допустимы.
CANNOTLOSEVALUE Необязательный элемент. Определяет поле как поле, которое не может потерять значение. Этот элемент сохраняет текущее значение поля и оно не может быть очищено или сделано пустым.
КОПИРОВАТЬ Необязательный элемент. Указывает другое поле, которое содержит значение, копируемое в текущее поле.
DEFAULT Необязательный элемент. Определяет значение по умолчанию для поля.
УКАЗАНО Необязательный элемент. Определяет поле как пустое.
Крепление Необязательный элемент. Определяет поле как зафиксированное. После фиксации изменений значение зафиксированного поля не может быть изменено на какое-либо другое непустое значение. Однако пользователь может вручную очистить поле, сохранить рабочий элемент, а затем указать другое значение.
HELPTEXT Необязательный элемент. Определяет текст, отображаемый во всплывающей подсказке поля.
MATCH Необязательный элемент. Определяет для поля шаблон, которому должно соответствовать значение поля.
NOTSAMEAS Необязательный элемент. Указывает другое поле, значение которого не может совпадать со значением текущего поля.
PROHIBITEDVALUES Необязательный элемент. Определяет список запрещенных значений поля.
ДОСТУПНО Необязательный элемент. Определяет поле как доступное только для чтения.
ОБЯЗАТЕЛЬНО Необязательный элемент. Определяет поле как обязательное.
SERVERDEFAULT Необязательный элемент. Указывает компонент сервера, которым будет предоставляться значение для поля.
сугжестедвалуес Необязательный элемент. Определяет список предлагаемых значений поля. Предлагаемые значения — это значения, которые можно выбрать в списке полей в формах рабочих элементов и в конструкторе запросов. Помимо значений, представленных в списке, можно ввести другие значения.
VALIDUSER Необязательный элемент. Указывает, что список разрешенных значений должен включать только допустимых пользователей системы.
WHEN Необязательный элемент. Задает одно или несколько правил, применяемых к текущему полю, если другое поле имеет определенное значение.
WHENCHANGED Необязательный элемент. Применяет одно или несколько правил к текущему полю при изменении значения определенного поля.
WHENNOT Необязательный элемент. Применяет к текущему полю одно или несколько правил, если другое поле не имеет определенного значения.
WHENNOTCHANGED Необязательный элемент. Применяет одно или несколько правил к текущему полю, когда значение определенного поля не изменяется.

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

Элемент Описание
ПОЛЯМ Обязательный элемент. Содержит определения полей типов рабочих элементов.

Комментарии

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

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

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

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

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

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

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

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

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

    Конфликты схем могут возникать, если разные атрибуты отчетов назначены одному полю в разных WIT или в разных проектах. Чтобы устранить эти конфликты, см. раздел разрешение конфликтов данных, происходящих в Data Warehouse.

  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>