Definir e modificar campos do item de trabalho

Artigo
06/09/2015

Você usa campos de item de trabalho para acompanhar dados de um tipo de item de trabalho e para definir os critérios de filtro para consultas, bem como para gerar relatórios. Qualquer elemento de dados, exceto para campos de dados de sistema principal em Team Foundation Server (TFS), que você deseja controlar, use para definir o fluxo de trabalho ou aparecem no formulário para um tipo de item de trabalho deve ser definido como um campo de item de trabalho. Você pode definir os campos de item de trabalho dentro da definição de um tipo de item de trabalho ou fluxo de trabalho global.

Campos de item de trabalho são mantidos para uma coleção de projetos de equipe. Adicione campos quando você executa uma das seguintes tarefas:

Criar um projeto de equipe. Todos os campos que são definidos nas definições de tipos de item de trabalho ou fluxo de trabalho global e que são definidos para o modelo de processo selecionado são criados. Os campos de sistema de núcleo são definidos automaticamente para cada tipo de item de trabalho é definido para um projeto de equipe. Para obter uma lista desses campos, consulte Referência de campo de item de trabalho do Visual Studio ALM.
Importar uma definição de um tipo de item de trabalho. Todos os novos campos são definidos na definição de um tipo de item de trabalho são adicionados à coleção. Para obter mais informações, consulte Todas as referências de elementos XML WITD.
Importar uma definição de fluxo de trabalho global. Todos os novos campos são definidos dentro do fluxo de trabalho global são adicionados à coleção. Definir um fluxo de trabalho global para manter um conjunto de campos de item de trabalho que compartilham vários tipos de itens de trabalho. Para obter mais informações, consulte Personalizar o fluxo de trabalho global.
Mapear uma coleção de projetos para uma instância do Project Web App (PWA). Depois de instalar o Team Foundation Server extensões do Project Server, configurar a integração, mapeando os vários componentes do Team Foundation. Quando você mapeia uma coleção, uma definição de fluxo de trabalho global que oferece suporte a vários campos nos campos do Project Server é importada. Para obter mais informações, consulte Campos do Project Server adicionados ao TFS para dar suporte à sincronização de dados.

Todos os campos que são definidos em todos os tipos de item de trabalho e todos os fluxos de trabalho globais para todos os projetos de equipe compõem o conjunto completo de campos que são definidos para a coleção. Você pode alterar o atributo de, renomear e excluir campos existentes. No entanto, incorre em determinados custos ao fazer esses tipos de alterações. Para obter mais informações, consulte Personalizar objetos de acompanhamento de trabalho para dar suporte aos processos da sua equipe.

Para adicionar ou personalizar um campo para uma coleção, modifique o conteúdo XML para a definição de um tipo de item de trabalho ou fluxo de trabalho global. Definir cada campo por meio de um FIELD elemento dentro do FIELDS seção da definição de um tipo de item de trabalho ou fluxo de trabalho global. Para obter informações sobre a estrutura e o local desses arquivos, consulte Todas as referências de elementos XML WITD e Personalizar o fluxo de trabalho global.

Estrutura de sintaxe FIELD (definição)

Cada FIELD elemento (definição) tem um nome amigável, que é opcional, e um nome de referência, que é necessário. O nome de referência deve ser exclusivo dentro da coleção. Para obter mais informações, consulte Convenções de nomenclatura para objetos de acompanhamento de itens de trabalho.

Importante

Você pode alterar o nome amigável para um campo usando o witadmin changefield ferramenta de linha de comando.No entanto, se você renomear um campo, ela afeta todos os tipos de item de trabalho em todos os projetos de equipe dentro da coleção.

Defina um campo, a seguinte sintaxe XML no arquivo de definição do tipo de item de trabalho.

<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>

Para obter mais informações, consulte Referência de elemento FIELD (definição).

Tipos de dados

O tipo de um campo define o tipo e o tamanho dos dados que você pode armazenar no campo. Um campo pode ter apenas um tipo definido em uma coleção de projeto de equipe. Essa restrição encoraja as organizações a usar campos comuns entre projetos e tipos de item de trabalho.

A lista a seguir mostra os tipos de campo com suporte:

Tipo de dados	Descrição
DateTime	Especifica uma data de acordo com pouco tempo Universal Coordenado (UTC) no momento. Add a DateTime field to a work item form by using either the FieldControl or DateTimeControl type attributes.
Double	Especifica um valor de ponto flutuante. Dois campos são frequentemente usados em filtros de consulta e listas de resultados. Add a Double field to a work item form by using the FieldControl type attribute.
GUID	Especifica um campo que contém um identificador exclusivo. Não é possível adicionar um GUID campo a um formulário de item de trabalho.
History	Oferece suporte à exibição segmentos de discussão e outras informações históricas de controle. Dica O System.History é o único campo que usa esse tipo de dados.Você não pode definir um campo personalizado usando esse tipo de dados. Add the System.History field to a work item form by using the WorkItemLogControl type attribute which supports rich text format controls.
HTML	Suporta a capacidade de capturar dados de rich text e usar mais descrições de texto como uma descrição do item de trabalho. Um campo HTML é diferente de um campo de texto sem formatação, um campo HTML é fortemente tipado para HTML para exibições mais ricas de informações. Add an HTML field to a work item form by using the HTMLControl type attribute, which supports rich text format controls.
Integer	Especifica um valor inteiro assinado de 32 bits. Campos de inteiro são frequentemente usados em filtros de consulta e listas de resultados. Add an Integer field to a work item form by using the FieldControl type attribute.
PlainText	Oferece suporte a entrada de uma cadeia de caracteres de texto que pode conter mais de 255 caracteres Unicode. Add a PlainText field to a work item form by using either the FieldControl type attribute and limited to plain text, or the HTMLControl type attribute which supports rich text format controls.
String	Oferece suporte a entrada de uma cadeia de caracteres de texto que pode conter até 255 caracteres Unicode. Use um campo de cadeia de caracteres para um rótulo ou outra cadeia de caracteres de texto curto até uma linha de tempo. Campos de cadeia de caracteres são frequentemente usados em filtros de consulta e listas de resultados. Add a String field to a work item form by using the FieldControl type attribute.
TreePath	Especifica um campo que exibe entradas de modo hierárquico ou estrutura de árvore, como os requisitos para exibir os caminhos de iteração e área de um produto. Dica O System.AreaPath e System.IterationPath campos são os únicos campos que usam esse tipo de dados.Você não pode definir um campo personalizado usando esse tipo de dados. Adicionar o System.AreaPath e System.IterationPath formulário de item de campos para um trabalho usando o WorkItemClassificationControl type atributo.

Atributos Reportable

Alguns valores de campo são especialmente úteis para relatórios. Usando a linguagem de definição de tipo de item de trabalho, você pode especificar os seguintes atributos opcionais:

reportable. Defina o atributo reportable None, Detail, Dimension, ou Measure, dependendo se e como você deseja que o campo a ser incluído nos relatórios. Dados de campos que têm um valor diferente de None para este atributo são exportados para o data warehouse e podem ser incluídos em relatórios.

Quando você adicionar um campo existente para um item de trabalho tipo, o valor atual para o reportable atributo será usado. Quando você adiciona um campo a um tipo de item de trabalho, relatórios está desabilitada a menos que explicitamente especificado usando o reportable atributo.
reportingname. Atribua um rótulo diferente para um campo que é usado quando os dados são exibidos em relatórios. Se você não especificar um valor, o nome amigável que é atribuído a name atributo será usado.
reportingrefname. Atribua um nome de referência diferente para um campo que é usado quando os dados são exportados para o data warehouse relacional. Se você não especificar um valor, o valor atribuído para a refname atributo será usado.

Use esse atributo para mesclar ou divergem campos são incluídos nos relatórios. Para mesclar dois campos que tenham nomes distintos de referência e que são definidos em coleções de projetos diferentes, atribua o mesmo reportingrefname para ambos os campos. Para uma diferenciação dois campos que tenham o mesmo nome de referência e que são definidos em coleções de projetos diferentes, você atribuir outro reportingrefname a cada campo.

Depois de definir um campo, você pode usar o witadmin changefield comando no prompt de comando para alterar o valor de todos os atributos, exceto para o refname atributo.

Para obter informações sobre as práticas recomendadas em rótulos de campos para fins de relatório, consulte Adicionar ou modificar campos de itens de trabalho para oferecer suporte a relatórios.

Valores de atributo Reportable

Conforme descrito na tabela a seguir, você pode atribuir um dos seguintes valores para o reportable atributo: none, dimensão, detalhes e medir.

Dica

Você pode tornar um campo reportable após ele ter sido usado para um item de trabalho.Depois de definir o valor reportable, novas revisões do item de trabalho que são copiadas para o warehouse conterá o valor do campo.No entanto, as revisões que já estão no depósito não será backfilled com os valores existentes.

Valor do atributo	Descrição
Detail	Use o Detail tipo apenas para campos de inteiro, duplo, cadeia de caracteres ou uma data e hora. Os dados nesse campo são movidos para o banco de dados do data warehouse relacional nas tabelas de Item de trabalho atual e Item de trabalho, mas não para o SQL Server cubo do Analysis Services. Usando esse tipo para campos de texto irrestrito, você pode usá-los em relatórios sem aumentar significativamente o cubo.
Dimension	Use o Dimension tipo somente para os campos DateTime, String ou Integer. Os dados nesse campo insere o banco de dados do data warehouse relacional e o cubo do Analysis Services como um atributo da dimensão do Item de trabalho para que os dados podem ser usados para filtrar relatórios. Use esse tipo para os campos que contêm listas de valores válidos. Tipo de Item de trabalho e o estado são bons exemplos de uma dimensão.
Measure	Use o Measure tipo apenas para campos de número inteiro e duplo. Medidas são valores numéricos em seus relatórios. Durante o processamento do cubo do Analysis Services, dados são pré-calculados em campos que são definidos como Measure. Por exemplo, os grupos de medidas de Item de trabalho e Item de trabalho atual contêm dados cumulativos para os seguintes campos: estimativa Original, restante de horas e horas concluídas. Para obter mais informações sobre grupos de medidas, consulte Perspectivas e grupos de medição fornecidos no cubo do Analysis Services para o Visual Studio. Quando você especifica Measure, você deve especificar sum para o formula atributo, que retorna a soma de cada medida referenciada na consulta.
None	Especifique None quando você não deseja incluir o campo em relatórios. Esse valor é a atribuição padrão.

Exemplos que mostram como especificar a emissão de relatórios

Exemplo de detalhe

Exemplo de dimensão

Exemplo de medida

Campos indexados

Você pode habilitar ou desabilitar a indexação de um campo de item de trabalho usando o witadmin indexfield comando. Quando você habilita a indexação de um campo, pode aumentar o desempenho de localização de itens de trabalho cujas consultas especificam esse campo. Se adicionar um campo personalizado usado em várias das consultas de itens de trabalho, talvez queira habilitar a indexação para esse campo. Para obter mais informações, consulte Gerenciar campos de item de trabalho [witadmin].

Elementos filho de FIELD (definição)

Há um número de elementos filho opcionais que você pode especificar para um campo de item de trabalho, por exemplo:

Texto de ajuda. Define as informações de Ajuda ou dica de ferramenta exibe para um campo no trabalho de formulário de item (HELPTEXT).
Restrições de campo. Especifica um campo como obrigatório, somente leitura, vazio, congelada ou corresponda a um padrão específico (REQUIRED, READONLY, EMPTY, FROZEN, MATCH).
Campo valor Autopreenchimento. Especifica um valor para o campo (DEFAULT, COPY, SERVERDEFAULT).
Listas de campo. Especifica os valores permitidos, sugeridos ou proibidos. (ALLOWEDVALUES, SUGGESTEDVALUES, PROHIBITEDVALUES)
Campo condições. Aplica-se uma ou mais regras para um campo quando outro campo for alterado ou não alterado ou outro campo tem ou não tem um valor específico ou outra condição (WHEN, WHENNOT, WHENCHANGED, WHENNOTCHANGED, CANNOTLOSEVALUE, NOTSAMEAS).

Para obter mais informações, consulte Todas as referências de elementos XML FIELD.

Campos predefinidos e sistema

Todos os campos definidos pelo sistema têm nomes de referência que começam com o sistema, por exemplo, areapath, AssignedTo e continuam a esse padrão.

Campos predefinidos definidos pelos modelos de processo padrão que o TFS fornece começam com Microsoft.VSTS e, em seguida, ainda mais variam com base no seu uso. Exemplos de campos predefinidos que são usados em comum, para agendar finalidades e integração com Microsoft Project, integração com Team Foundation Builde a integração com Team Foundation são os seguintes:

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

Para uma visão geral de todo o sistema e campos predefinidos que são definidos para modelos de processo padrão que o TFS fornece, consulte Referência de campo de item de trabalho do Visual Studio ALM. Para obter mais informações sobre como especificar nomes de campos, consulte Convenções de nomenclatura para objetos de acompanhamento de itens de trabalho.

Atributos ocultos e imutável e o Gerenciador de campo de Item de trabalho

Além dos atributos que você pode alterar para um campo de item de trabalho, há uma série de atributos não variáveis e virtualmente ocultos para cada campo. É possível pesquisar as atribuições desses campos usando a ferramenta Work Item Field Explorer. Acesse a ferramenta Gerenciador de campos de Item de trabalho do Process Editor power tool.

Work Item Field Explorer

Gerenciador de campos de item de trabalho

Dica

O Process Editor power tool fornece uma interface gráfica do usuário para personalizar modelos de processo do Team Foundation Server.Você pode usar essa ferramenta para importar e exportar tipos de item de trabalho, modificar o conteúdo do modelo de processo e explorar o conjunto de campos definido para uma coleção de projetos de equipe.Para saber mais, veja a seguinte página no site da Microsoft: Team Foundation Server Power Tools.

Consulte também

Compartilhar via