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

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

Можно настроить существующий тип рабочего элемента (WIT) или создать новый WIT для соответствия требованиям отслеживания проекта. WIT определяет поля, правила и состояния рабочего процесса и переходы для элемента работы, который будет контролироваться для проекта, например ошибки, требования или риска. проект создается либо в Azure DevOps Services, либо в локальной Team Foundation Server (TFS).

Корневым элементом в каждом определении WIT является элемент, для WITD которого должен быть определен только один WORKITEMTYPE элемент. Имя каждого WIT должно быть уникальным в проекте, а длина имени каждого типа не должна превышать 128 символов Юникода.

Чтобы настроить или создать определение WIT, необходимо изменить XML-файл определений типов. WIT ограничивается проектом в коллекции проектов.

Структура синтаксиса WITD

В следующем примере показана высокоуровневая структура определения WIT.

<witd:WITD application="Work item type editor" version="1.0" xmlns:witd="http://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef">  
       <WORKITEMTYPE name="bug" refname="Microsoft.VSTS.WorkItemTypes.Bug">  
          <DESCRIPTION> Describes a divergence between required and actual behavior, and tracks the work done to correct the defect and verify the correction.</DESCRIPTION>  
          <GLOBALLISTS> . . . </GLOBALLISTS>  
          <FIELDS> . . . </FIELDS>  
          <WORKFLOW> . . . </WORKFLOW>  
          <FORM> . . . </FORM>  
       </WORKITEMTYPE>  
</witd:WITD>  

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

Ниже описаны структурные элементы, использованные в предыдущем примере.

Элемент

Описание

WITD

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

<witd:WITD application="Work item type editor" version="1.0" >  
<WORKITEMTYPE>   
. . .  
</WORKITEMTYPE>  
</witd:WITD>

WORKITEMTYPE

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

<WORKITEMTYPE name="WorkItemTypeName" refname="WITReferenceName" >  
<DESCRIPTION>Text</DESCRIPTION>  
<GLOBALLISTS> . . .</GLOBALLISTS>  
<FIELDS> . . . </FIELDS>  
<WORKFLOW> . . . </WORKFLOW>  
<FORM> . . .</FORM>  
</WORKITEMTYPE>

Понятное имя (имя): отображается в раскрывающихся меню запросов рабочих элементов. Понятное имя должно быть уникальным для всех имен WIT, определенных в проекте. Укажите имя не длиннее 128 символов Юникода, содержащее буквы, цифры, символы подчеркивания и дефисы.

Имя ссылки (refname): укажите имя, длина которого не превышает 70 символов Юникода, использующих буквы, цифры, символы подчеркивания и дефисы. Ссылочное имя должно содержать как минимум одну точку (.), но точка не может находиться в начале или в конце имени. Кроме того, ссылочное имя не может начинаться с цифры или символа подчеркивания, и в нем не может быть нескольких последовательных дефисов, например (--).

Не указывайте имя, пересекающееся с зарезервированными пространствами имен System. Xxx и Microsoft. Xxx пространства имен.

ОПИСАНИЕ

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

Примечание

Описание отображается только в XML-определении. Невозможно просмотреть описание в пользовательском интерфейсе и оно не имеет отношения к полю System. Definition.


<DESCRIPTION> DescriptionOfWorkItemType</DESCRIPTION>

Задается строка текста, описывающая тип определяемого рабочего элемента.

GLOBALLISTS

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

<GLOBALLIST name="globalListName">   
<LISTITEM> . . . </LISTITEM>  
</GLOBALLIST>  

ПОЛЯМ

Определяет поля, используемые для трассировки данных для WIT. В элементе Fields (поля ) определяются все поля , которые необходимо использовать для трассировки данных. Это включает поля, используемые для выполнения запросов и создания отчетов.

<FIELDS>   
<FIELD> . . . </FIELD>  
</FIELDS>

СООТВЕТСТВУЕТ

Определяет структуру формы рабочего элемента , определяя поля и элементы управления, отображаемые в форме и в каком порядке.

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

<FORM>   
<Layout> . . . </Layout>  
</FORM>  

Для внутрипроцессных и локальных XML-моделей процессов (TFS 2017 и более поздних версий)элемент Form содержит веб- Макет, элемент управления, SystemControls, раздел, страницуи другие элементы.

<WebLayout> 
<Page>  
<Section>  
<Group>  
<Control> . . . </Control>
<Control> . . . </Control>
</Group>
</Section>
</Page>
. . .
</WebLayout>

Важно!

Сведения о размещенных XML-и локальных моделях процессов XML (TFS 2017 и более поздних версий) см. в разделе элементы управления "структура".

ПРОЦЕССОВ

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

<WORKFLOW>  
<STATES> . . . </STATES>  
<TRANSITIONS> . . . </TRANSITIONS>  
</WORKFLOW>  

Типы рабочих элементов шаблона процесса

При установке или обновлении экземпляра локального сервера TFS шаблоны процессов по умолчанию загружаются в следующий каталог:

Для TFS 2017:

%programfiles%/TFS 15.0/Tools/Deploy/ProcessTemplateManagerFiles/1033

Для TFS 2015:

%programfiles%/TFS 14.0/Tools/Deploy/ProcessTemplateManagerFiles/1033

Файлы определения типов рабочих элементов хранятся в папке WorkItem Tracking\TypeDefinitions.

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