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

Статья
06/09/2015

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

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

Создание командного проекта. Создаются все поля, определяемые в определениях глобального рабочего процесса или типов рабочих элементов, а также определяемые для выбранного шаблона процесса. Основные системные поля для каждого типа рабочих элементов, определенного для проекта, определяются автоматически. Список этих полей см. в разделе Справочник по полям рабочих элементов для Visual Studio ALM;
Импорт определения типа рабочего элемента. В коллекцию добавляются все новые поля, задаваемые в определении типа рабочего элемента. Для получения дополнительной информации см. Справочник по всем XML-элементам WITD.
Импорт определения глобального рабочего процесса. В коллекцию добавляются все новые поля, задаваемые в глобальном рабочем процессе. Глобальный рабочий процесс определяется, если требуется обслуживать набор полей рабочих элементов, которые используются несколькими типами рабочих элементов. Для получения дополнительной информации см. Настройка глобального рабочего процесса.
Сопоставьте коллекцию проектов с экземпляром Project Web App (PWA). После установки расширений Team Foundation Server для Project Server настройте интеграцию, сопоставив различные компоненты Team Foundation. При сопоставлении коллекции импортируется определение глобального рабочего процесса, поддерживающее несколько полей Project Server. Для получения дополнительной информации см. Поля Project Server, добавляемые в TFS для поддержки синхронизации данных.

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

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

Синтаксическая структура 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="sum" >
   <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 (определение).

Типы данных

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

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

Тип данных	Описание
DateTime	Указывает данные в соответствии с моментом времени в формате UTC. Добавьте поле DateTime в форму рабочего элемента можно с помощью атрибута FieldControl или DateTimeControl type.
Double	Указывает значение с плавающей запятой. Поля Double часто используются в фильтрах запросов и списках результатов. Добавить поле Double в форму рабочего элемента можно с помощью атрибута FieldControl или type .
GUID	Указывает поле, которое будет содержать уникальный идентификатор. В форму рабочего элемента нельзя добавить поле GUID.
History	Поддерживает просмотр цепочек обсуждений и отслеживание прочих сведений журнала. Примечание Этот тип данных используется только полем System.History.С помощью этого типа данных можно определить настраиваемое поле. Для добавления в форму рабочего элемента поля System.History можно воспользоваться атрибутом WorkItemLogControl type, поддерживающим элементы управления форматированным текстом.
HTML	Поддерживает возможность сохранения данных в формате RTF с использованием длинных текстовых описаний, таких как описания рабочих элементов. Поле HTML отличается от поля PlainText тем, что HTML имеет строгий тип HTML для форматированного отображения информации. Для добавления в форму рабочего элемента поля HTML можно воспользоваться атрибутом HTMLControl type, поддерживающим элементы управления форматированным текстом.
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, String или DateTime. Данные в этом поле попадают в реляционную базу данных хранилища и в куб служб аналитики в качестве атрибута измерения рабочего элемента, так что эти данные могут использоваться для фильтрации отчетов. Этот тип используется для полей списков или допустимых значений. Хорошими примерами измерений могут быть Work Item Type (тип рабочего элемента) и State (состояние рабочего элемента).
Measure	Тип Measure используется только для полей Integer и Double. Меры – это числовые значения в ваших отчетах. При обработке куба служб аналитики данные предварительно вычисляются в полях со значением Measure. Например, группы мер рабочего элемента и текущего рабочего элемента содержат совокупные данные для следующих полей: «Исходная оценка», «Оставшиеся часы» и «Затраченные часы». Дополнительные сведения о группах мер см. в разделе Перспективы и группы мер, предоставляемые в кубе служб Analysis Services для Visual Studio. При указании типа Measure следует указать sum для атрибута formula, который возвращает сумму каждой упомянутой в запросе меры (measure).
None	Задайте значение None, если поле необходимо исключить из отчетов. Это значение используется по умолчанию.

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

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

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

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

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

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

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

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

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

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

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

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

Примечание

Средство "Редактор процессов" предоставляет графический пользовательский интерфейс для настройки шаблонов процессов Team Foundation Server.Это средство позволяет импортировать и экспортировать типы рабочих элементов, изменять содержимое шаблонов процессов и анализировать наборы полей, определенные для коллекции командных проектов.Дополнительные сведения см. на следующих страницах веб-сайта Майкрософт: Team Foundation Server Power Tools.

См. также

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