Поделиться через

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

  • Статья

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

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

  • создание командного проекта. Создаются все поля, определяемые в определениях глобального рабочего процесса или типов рабочих элементов, а также определяемые для выбранного шаблона процесса. Дополнительные сведения см. в разделе Поля рабочего элемента (гибкая разработка) или Поля рабочих элементов (CMMI). Основные системные поля для каждого типа рабочих элементов, определенного для проекта, определяются автоматически. Список этих полей см. в разделе Использование системных полей и полей, определенных шаблонами процессов MSF;

  • импорт определения типа рабочего элемента. В коллекцию добавляются все новые поля, задаваемые в определении типа рабочего элемента. Дополнительные сведения см. в разделе Справка по всем XML-элементам WITD;

  • импорт определения глобального рабочего процесса. В коллекцию добавляются все новые поля, задаваемые в глобальном рабочем процессе. Глобальный рабочий процесс определяется, если требуется обслуживать набор полей рабочих элементов, которые используются несколькими типами рабочих элементов. Дополнительные сведения см. в разделе Настройка глобального рабочего процесса;

  • сопоставление коллекции проектов экземпляру Project Web App (PWA). После установки Visual Studio Team Foundation Server 2010 и пакета дополнительных компонентов для интеграции Project Server интеграция настраивается путем сопоставления различных компонентов Team Foundation. При сопоставлении коллекции импортируется определение глобального рабочего процесса, поддерживающее несколько полей Project Server. Дополнительные сведения см. в разделе Поля Project Server, добавляемые для поддержки синхронизации данных.

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

Чтобы добавить или настроить поле для коллекции, необходимо изменить XML-содержимое определения типа рабочих элементов или глобального рабочего процесса. Каждое поле определяется элементом FIELD в разделе FIELDS определения типа рабочих элементов или глобального рабочего процесса. Сведения о структуре и расположении этих файлов см. в разделах Справка по всем XML-элементам WITD и Настройка глобального рабочего процесса.

Содержание раздела

  • Синтаксическая структура FIELD (определение)

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

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

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

  • Дочерние элементы FIELD (определение)

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

Синтаксическая структура FIELD (определение)

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

Важно!

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

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

<FIELD name="fieldDisplayName" refname="fieldReferenceName" type="String | Integer | Double | 
DateTime | PlainText | HTML | History | TreePath | GUID " syncnamechanges="true | false" reportingname="reportingDisplayName" reportingrefname="reportingReferenceName"
reportable="Dimension | Detail | Measure" formula="avg" >
   <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>

Дополнительные сведения см. в разделе Элемент FIELD (определение).

К началу

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

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

Ниже приведен список поддерживаемых типов полей.

Тип данных

Описание

DateTime

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

Для добавления поля DateTime в форму рабочего элемента можно использовать атрибут FieldControl или DateTimeControl type.

Double

Указывает значение с плавающей запятой. Поля Double часто используются в фильтрах запросов и списках результатов.

Для добавления поля Double в форму рабочего элемента можно использовать атрибут FieldControl или type .

GUID

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

В форму рабочего элемента нельзя добавить поле GUID.

History

Поддерживает просмотр цепочек обсуждений и отслеживание прочих сведений журнала.

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

Для добавления в форму рабочего элемента поля System.History можно воспользоваться атрибутом WorkItemLogControltype, поддерживающим элементы управления форматированным текстом (текст RTF).

HTML

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

Для добавления в форму рабочего элемента поля HTML можно воспользоваться атрибутом HTMLControltype, поддерживающим элементы управления форматированным текстом (текст RTF).

Integer

Указывает 32-разрядное знаковое целочисленное значение. Поля Integer часто используются в фильтрах запросов и списках результатов.

Для добавления поля Integer в форму рабочего элемента можно использовать атрибут FieldControl или type .

PlainText

Поддерживается запись текстовой строки длиной не более 255 символов Юникода.

Добавить поле PlainText в форму рабочего элемента можно либо с помощью атрибута FieldControl, поддерживающего не форматированный текст, либо с помощью атрибута HTMLControl type, поддерживающего элементы управления форматированным текстом.

String

Поддерживается запись текстовой строки длиной не более 255 символов Юникода. Поле String используется для метки или другого текста длиной не более одной строки. Поля String часто используются в фильтрах запросов и списках результатов.

Для добавления поля String в форму рабочего элемента можно использовать атрибут FieldControl или type .

TreePath

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

ПримечаниеПримечание
Этот тип данных используется только полями System.AreaPath и System.IterationPath.С помощью этого типа данных можно определить настраиваемое поле.

Для добавления полей System.AreaPath и System.IterationPath в форму рабочего элемента можно использовать атрибут WorkItemClassificationControl type.

К началу

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

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

  • reportable. Атрибуту reportable задается значение None, Detail, Dimension или Measure в зависимости от необходимости и способа включения поля в отчеты. Данные из полей, у которых значение данного атрибута не равно None, будут экспортированы в хранилище данных и могут быть включены в отчеты;

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

  • reportingname. Можно назначить другую метку полю, которое используется при отображении данных в отчетах. Если значение не задано, используется понятное имя, присвоенное атрибуту name;

  • reportingrefname. Можно назначить другое имя ссылки полю, которое используется при экспорте данных в хранилище реляционных данных. Если значение не задано, используется значение, присвоенное атрибуту refname.

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

После определения поля можно воспользоваться командой witadmin changefield в командной строке, чтобы изменить значение всех атрибутов, кроме атрибута refname.

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

К началу

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

Как показано в следующей таблице, атрибуту reportable можно назначить одно из следующих значений: none, dimension, detail и measure.

Примечание

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

Значение атрибута

Описание

Detail

Тип Detail используется только для полей Integer, Double, String или DateTime.

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

Dimension

Тип Dimension используется только для полей Integer, Double, String или DateTime.

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

Measure

Тип Measure используется только для полей Integer и Double. Меры – это числовые значения в ваших отчетах.

При обработке куба служб аналитики данные предварительно вычисляются в полях со значением Measure. Например, группы мер рабочего элемента и текущего рабочего элемента содержат совокупные данные для следующих полей: "Исходная оценка", "Оставшиеся часы" и "Затраченные часы". Дополнительные сведения о группах мер см. в разделе Группы и показатели мер, доступные в кубе служб аналитики для Team System.

При указании типа Measure следует указать sum для атрибута formula, который возвращает сумму каждой упомянутой в запросе меры (measure).

None

Задайте значение None, если поле необходимо исключить из отчетов. Это значение используется по умолчанию.

К началу

Примеры указания данных для отчетов

Пример использования типа Detail

<FIELD refname="MyCorp.Summary" name="Summary" type="String" reportable="detail">

Пример использования типа Dimension

<FIELD refname="MyCorp.Category" name="Category" type="String" reportable="dimension">

Пример использования типа Measure

<FIELD refname="MyCorp.Cost" name="Cost" type="Integer" reportable="measure" formula="sum">

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

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

К началу

Дочерние элементы FIELD (определение)

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

  • Текст справки. Определяет всплывающую подсказку или справку, отображаемую для поля в форме рабочего элемента (HELPTEXT).

  • Ограничения поля. Определяет поле как обязательное, только для чтения, пустое, зафиксированное или соответствующее конкретному шаблону (REQUIRED, READONLY, EMPTY, FROZEN, MATCH).

  • Автозаполнение значения поля. Указывает значение для поля (DEFAULT, COPY, SERVERDEFAULT).

  • Списки полей. Указывает допустимые, рекомендуемые или запрещенные значения. (ALLOWEDVALUES, SUGGESTEDVALUES, PROHIBITEDVALUES)

  • Условия полей. Применяет одно или несколько правил к полю, когда другое поле изменяется или не изменяется, содержит или не содержит конкретное значение, или в других условиях (WHEN, WHENNOT, WHENCHANGED, WHENNOTCHANGED, CANNOTLOSEVALUE, NOTSAMEAS).

Дополнительные сведения см. в разделе Справка по всем XML-элементам FIELD.

К началу

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

Все системные поля имеют ссылочные имена, начинающиеся словом "System", например, System.AreaPath, System.AssignedTo и т д.

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

  • Microsoft.VSTS.Common.Priority

  • Microsoft.VSTS.Scheduling.DueDate

  • Microsoft.VSTS.Build.FoundIn

  • Microsoft.VSTS.TCM.Steps

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

К началу

См. также

Задачи

Добавление поля в тип рабочего элемента или удаление поля из этого поля

Ссылки

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

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

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

Справка по всем XML-элементам WITD

Справка по всем XML-элементам FIELD

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

Разрешение конфликтов схемы, возникающих в хранилище данных

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

Определение полей рабочих элементов

Журнал изменений

Дата

Журнал

Причина

Январь 2011

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

Улучшение информации.