Modificar ou adicionar um WIT (tipo de item de trabalho) personalizado

Como administrador do projeto, você pode modificar um tipo de item de trabalho (WIT) existente para oferecer suporte aos requisitos de acompanhamento ou processos de fluxo de trabalho adicionais. Os motivos mais comuns para modificar um WIT são para adicionar ou modificar o conjunto de campos ou de regras de campo, alterar o fluxo de trabalho ou personalizar o formulário de item de trabalho. Esses três motivos correspondem às três seções principais do arquivo de definição XML de WIT: FIELDS, WORKFLOW e FORM.

Todas essas modificações exigem a edição da definição de WIT, que você só pode fazer para implantações locais do TFS. Este tópico fornece uma visão geral do que você pode personalizar e indica o conteúdo que mostra como fazer isso.

Adicionar ou modificar um campo, uma regra de campo, um rótulo ou um texto vazio

Você adiciona campos e regras de campo na seção FIELDS. Para que o campo apareça no formulário de item de trabalho, você também deve adicioná-lo à seção FORM da definição de WIT.

Por exemplo, para adicionar a ID do item de trabalho a um formulário, especifique a seguinte sintaxe XML na seção FORM.

<Control FieldName="System.ID" Type="FieldControl" Label="ID" LabelPosition="Left" />

Para obter mais informações sobre a definição de campos, consulte Adicionar ou modificar um campo para oferecer suporte a consultas, relatórios e fluxo de trabalho.

Alterar os estados de fluxo de trabalho, motivos, transições, ou adicionar regras de campo de fluxo de trabalho

As seções STATES e REASONS do WORKFLOW especificam os valores da lista de opções nos campos Estado e Motivo. Elas acompanham o status de itens de trabalho. A seção TRANSITIONS especifica as transições válidas entre estados, como mostra a ilustração a seguir. Você especifica transições avançadas e regressivas.

Exemplo de diagrama de estado do fluxo de trabalho

Você altera o fluxo de trabalho para alcançar os seguintes objetivos:

• Adicionar ou remover estados, motivos ou transições.

• Especificar um valor para o campo a ser aplicado durante uma alteração de estado, motivo ou transição.

• Especificar uma ACTION personalizada para automatizar as atribuições de campos com base em uma alteração de estado, motivo ou transição.

Quando você for personalizar o fluxo de trabalho, siga estas duas etapas:

1. Modifique o FLUXO DE TRABALHO da definição de WIT.

2. Modifique a configuração do processo para mapear novos estados do fluxo de trabalho para metaestados.

   Essa segunda etapa é necessária nas seguintes circunstâncias:

   • Quando você altera o fluxo de trabalho para um WIT que aparece em uma página da ferramenta de planejamento do Agile. Esses WITs pertencem às categorias de requisito ou tarefa. Para saber mais sobre como configurar essas ferramentas, consulte Configurar e personalizar ferramentas de planejamento do Agile para um projeto de equipe.

   • Ao alterar o fluxo de trabalho do plano de teste ou do conjunto de testes e trabalhar em um cliente do Test Manager fornecido com Visual Studio 2013.2 ou versões anteriores. Esses WITs tornaram-se disponíveis quando você atualizou seu servidor de camada de aplicativo para TFS 2013.3. que aparece em uma página da ferramenta de planejamento do Agile.

     Se você encontrar um erro de O aplicativo detectou um erro inesperado quando você se conecta ao seu projeto de equipe depois de alterar o fluxo de trabalho, você pode resolvê-lo, mapeando o novo estado de fluxo de trabalho para metaestados. Para resolver esse erro, veja Importar e exportar configuração do processo [witadmin].

Regras de campo de fluxo de trabalho

Você pode aplicar regras de campo quando altera o estado, especifica um motivo ou durante uma transição de fluxo de trabalho.

Por exemplo, adicionar a regra EMPTY quando o estado estiver definido como Ativo pode anular automaticamente os campos "Data de Fechamento" e "Fechado por" e torná-los somente leitura. Isso é útil para reativar um item de trabalho de estado fechado.

<STATE value="Active">
   <FIELDS>
. . .
      <FIELD refname="Microsoft.VSTS.Common.ClosedDate"><EMPTY/></FIELD>
      <FIELD refname="Microsoft.VSTS.Common.ClosedBy"><EMPTY/></FIELD>
   </FIELDS>
</STATE>

Aplique as regras de fluxo de trabalho para executar as seguintes ações:

• Qualifique o valor que um campo pode ter especificando CANNOTLOSEVALUE, EMPTY, FROZEN, NOTSAMEAS, READONLY e REQUIRED.

• Copie um valor em um campo usando COPY, DEFAULT e SERVERDEFAULT.

• Restrinja quem pode modificar um campo.

• Aplique a correspondência de padrões em um campo de cadeia de caracteres usando MATCH.

• Aplique, condicionalmente, as regras baseadas em valores em outros campos usando WHEN, WHENNOT, WHENCHANGED e WHENNOTCHANGED.

• Limite as regras a serem aplicadas a usuários ou grupos específicos. A maioria das regras oferecem suporte aos atributos for ou not para focar em quem a regra se aplica ou não se aplica.

Para obter mais informações sobre a aplicação de regras de campo de fluxo de trabalho, consulte Referência de elemento FIELD (fluxo de trabalho).

Personalizar o formulário de item de trabalho

A ilustração a seguir realça os elementos mais comuns em formulários de item de trabalho. Você pode personalizar todos, exceto os controles da área do título e do formulário.

Você pode personalizar um formulário de WIT para alcançar os objetivos a seguir:

• Adicionar ou remover um campo, alterar um rótulo de campo ou alterar a posição de um campo no formulário. Para obter mais informações, consulte Especificar controles de formulários de itens de trabalho.

• Adicionar novas guias ou colunas, ou mover grupos de campos de uma guia para outra. Consulte Criar o formulário de item de trabalho.

• Adicionar texto informativo para oferecer suporte ao preenchimento do formulário, hiperlinks para diretrizes detalhadas do processo, inserir texto HTML ou exibir relatórios dinâmicos no formulário. Consulte Fornecer texto da ajuda, hiperlinks ou conteúdo da Web em um formulário de item de trabalho.

• Especificar guias que restrinjam os tipos de link ou os WITs que podem ser vinculados a um item de trabalho. Consulte Definir controles de link para restringir as relações de link.

• Adicionar um controle de anexação para oferecer suporte ao anexo de arquivos. Consulte Adicionar o controle Anexos.

Editar a definição do WIT

Para editar a definição de WIT, exporte, modifique e depois importe o arquivo de definição de WIT.

Com o witadmin, você pode importar e exportar arquivos de definição. Outras ferramentas que você pode usar para modificar a sintaxe XML para um objeto incluem o Editor de Processos, disponível com o download do TFS Power Tools ou do TFS Team Project Manager, um projeto de recursos da comunidade disponível no CodePlex.

1. Se você não tiver permissões de administração para seu projeto de equipe, obtenha-as.

2. Abra uma janela do Prompt de Comando onde o Visual Studio ou o Team Explorer esteja instalado e digite:

   cd %programfiles%\Microsoft Visual Studio 12.0\Common7\IDE
   

   Em uma edição de 64 bits do Windows, substitua %programfiles% por %programfiles(x86)%. Acesse aqui para baixar o Team Explorer gratuitamente.

3. Exporte o arquivo de definição de WIT onde você deseja alterar ou adicionar um campo. Especifique o nome do WIT e um nome para o arquivo.

   witadmin exportwitd /collection:CollectionURL /p:ProjectName /n:TypeName /f:"DirectoryPath/FileName.xml"
   

   Um exemplo de CollectionURL é http://MyServer:8080/tfs/TeamProjectCollectionName.

4. Edite o arquivo. Para obter detalhes, consulte Acompanhamento do item de trabalho: indexar em definições de elementos XML.

5. Importe o arquivo de definição de WIT.

   witadmin importwitd /collection:CollectionURL /p:ProjectName /f:"DirectoryPath/FileName.xml"
   

6. Abra o TWA ou o Team Explorer para ver as alterações. Se o cliente já estiver aberto, atualize a página.

   No Team Explorer, escolha o botão Atualizar.

   As atualizações mais recentes são baixadas do servidor, incluindo as alterações que você acabou de importar. Aguarde alguns segundos para a conclusão da atualização.

   Para obter mais informações sobre o uso de witadmin, consulte Importar, exportar e gerenciar tipos de item de trabalho [witadmin].

Perguntas e respostas

P: Como trabalhar com marcas?

R: Para aprender a adicionar marcas e filtrar listas, clique aqui.

P: Quais personalizações posso fazer e ainda assim usar o assistente Configurar Recursos para atualizar meu projeto de equipe após uma atualização do TFS?

R: Você pode adicionar WITs personalizados e alterar o layout do formulário. O assistente Configurar Recursos atualizará seus projetos de equipe e você terá acesso aos recursos mais recentes.

Alterar o fluxo de trabalho ou renomear um WIT pode exigir que você realize algumas operações manuais ao atualizar seu projeto de equipe. Para saber mais sobre outras personalizações que você pode realizar com segurança e quais deve evitar, consulte Personalizar a experiência de acompanhamento de trabalho: antes de personalizar, entenda as implicações de manutenção e atualização.

P: Como eu adiciono um novo WIT?

R: A maneira mais fácil de adicionar um novo WIT é copiar um WIT existente e depois modificar o arquivo de definição. Para ver um exemplo, consulte Criar um tipo de item de trabalho.

P: Posso renomear um WIT?

R: Sim. Para renomear um WIT existente, use witadmin renamewitd. Por exemplo, você pode renomear um WIT chamado "Item de QoS" como "Contrato de Serviço".

witadmin renamewitd /collection:"http://FabrikamPrime:8080/tfs/DefaultCollection" /p:"Fabrikam Web Site" /n:"QoS Item" /new:"Service Agreement"

Quando você renomeia um WIT que pertence a uma categoria, você precisa atualizar a definição de categorias do projeto de equipe para refletir o novo nome. Em particular, as ferramentas de planejamento do Agile não funcionarão até você atualizar a definição de categorias.

Para obter mais informações, consulte Importar, exportar e gerenciar tipos de item de trabalho [witadmin] e Importar e exportar categorias [witadmin].

P: Como eu desativo ou desabilito um WIT?Como impedir usuários de criar itens de trabalho de um determinado tipo?

R: Se você tiver um WIT que deseja desativar, mas manter os itens de trabalho que foram criados com base nesse tipo, você pode adicionar uma regra que impeça todos os usuários válidos de salvarem o tipo de item de trabalho.

<TRANSITION from=" " to="New">
   <FIELDS>
     <FIELD refname="System.CreatedBy">
         <VALIDUSER not="[Team Project Name]Project Valid Users" />
     </FIELD>
   </FIELDS>
</TRANSITION> 

Se você quiser restringir a criação de um WIT específico a um grupo de usuários, há duas maneiras de restringir o acesso:

• Adicione o WIT ao grupo de categorias ocultas para impedir que a maioria dos colaboradores do projeto os crie. Se quiser permitir acesso para um grupo de usuários, você pode criar um hiperlink para um modelo que abra o formulário de item de trabalho e compartilhar esse link com os membros da equipe que deseja que os criem.

• Adicione uma regra de campo ao fluxo de trabalho para o campo System.CreatedBy para impedir efetivamente um grupo de usuários de criar um item de trabalho de um tipo específico. Conforme mostra o exemplo a seguir, o usuário que cria o item de trabalho deve pertencer ao Allowed Group para salvá-lo.

  <TRANSITION from=" " to="New">
     <FIELDS>
       <FIELD refname="System.CreatedBy">
           <VALIDUSER for="Allowed Group" not="Disallowed Group" />
       </FIELD>
     </FIELDS>
  </TRANSITION> 
  

P: Como posso excluir um WIT?

R: Para impedir que os membros da equipe usem um WIT específico para criar um item de trabalho, você pode removê-lo do projeto de equipe. Ao usar witadmin destroywitd, você remove permanentemente todos os itens de trabalho que foram criados usando esse WIT, bem como o WIT em si. Por exemplo, se sua equipe não usa o item “Impediment”, você poderá excluir o WIT denominado “Impediment” do projeto de site da Fabrikam.

witadmin destroywitd /collection:"http://FabrikamPrime:8080/tfs/DefaultCollection" /p:"Fabrikam Web Site" /n:"Impediment" 

Quando você exclui um WIT que pertence a uma categoria, você precisa atualizar a definição de categorias do projeto de equipe para refletir o novo nome. Em particular, as ferramentas de planejamento do Agile não funcionarão até você atualizar a definição de categorias.

Para obter mais informações, consulte Importar, exportar e gerenciar tipos de item de trabalho [witadmin] e Importar e exportar categorias [witadmin].

P: Posso alterar a cor associada a um WIT?

R: Sim. No Team Web Access, os itens de trabalho aparecem nos resultados da consulta e nas páginas de lista de pendências e de painel das ferramentas de planejamento do Agile. Para alterar a cor associada a um WIT existente ou adicionar a cor a ser usada para um novo WIT, edite a configuração do processo.

P: Posso adicionar ou remover um WIT de uma lista de pendências ou de um painel de tarefas?

R: Sim. As ferramentas de planejamento do Agile — lista de pendências do produto, lista de pendências de sprint e páginas do painel de tarefas — exibem WITs específicos com base no modelo de processo usado para criar seu projeto de equipe. Você pode adicionar ou remover WITs nessas páginas. Por exemplo, se seu projeto de equipe usar WITs do Scrum, os itens da lista de pendências do produto e os bugs aparecerão nas páginas de lista de pendências. No entanto, se seu projeto de equipe for criado usando o Agile, CMMI ou outro modelo de processo, os bugs não aparecerão na lista de pendências ou no painel de tarefas.

Por exemplo, você pode adicionar bugs na página da lista de pendências do produto.

Para saber como adicionar ou remover WITs do painel de tarefas ou da lista de pendências, clique aqui. Para adicionar um novo WIT para oferecer suporte a uma lista de pendências de portfólio, clique aqui.

P: Quando modifico um WIT, como isso afeta os itens de trabalho existentes?

R: A tabela a seguir resume o efeito nos itens de trabalho existentes quando você modifica campos ou definições de WIT.

Ação	Efeito nos itens de trabalho existentes
Remover campos de um WIT	Os dados dos campos removidos permanecem no repositório de dados. No entanto, nenhum dado novo pode ser adicionado, porque você o removeu da definição de WIT.
Renomear um campo	Os dados dos campos renomeados permanecem no repositório de dados sob o novo nome amigável.
Excluir campos	Os dados dos campos excluídos são removidos do repositório de dados.
Renomear um WIT	Todos os dados permanecem intactos sob o novo nome.
Excluir um WIT	Todos os dados dos itens de trabalho criados como o WIT excluído são removidos permanentemente sem possibilidade de recuperação.

Se você quiser remover completamente os campos do repositório de dados, use a ferramenta de linha de comando witadmin deletefield. Consulte Gerenciar campos de item de trabalho [witadmin].

P: Como eu altero o tipo de um item de trabalho existente?

R: Você não pode alterar o tipo de um item de trabalho existente, mas pode copiar o item de trabalho e especificar um novo tipo. Por exemplo, você pode copiar um item existente da lista de pendências do produto e alterar o tipo para bug, conforme mostrado na ilustração a seguir.

Além disso, se houver vários itens de trabalho com as alterações de tipo que você deseja fazer, é melhor exportá-los usando o Excel e adicioná-los novamente como um novo tipo.

P: Posso excluir itens de trabalho do TFS?

R: Sim. Use witadmin destroywi para remover permanentemente itens de trabalho do banco de dados.

P: O que eu deveria saber a personalização de WITs e as atualizações do TFS?

R: Consulte Configurar recursos após uma atualização do TFS.

P: Para onde posso ir se tiver mais dúvidas?

R: Para encontrar respostas ou publicar uma pergunta, visite o fórum: Team Foundation Server - Project Management & Work Item.

Para obter mais informações, consulte Especificar controles de formulários de itens de trabalho.

Use o Editor de Processos, disponível com o download do TFS Power Tools, para modificar o fluxo de trabalho ou exibir um diagrama de estado do fluxo de trabalho.