Importar, exportar e gerenciar tipos de item de trabalho [witadmin]

Artigo
06/09/2015

Você pode gerenciar os tipos de itens de trabalho de um projeto de equipe usando os seguintes comandos witadmin:

destroywitd: Destrói um tipo de item de trabalho e destrói cada item de trabalho desse tipo permanentemente, sem recuperação.
exportwitd: Exporta a definição de um tipo de item de trabalho para um arquivo XML ou para a janela do Prompt de Comando.
importwitd: Importa tipos de itens de trabalho de um arquivo de definição XML para um projeto de equipe em um servidor que executa Team Foundation Server. Se um tipo de item de trabalho com o mesmo nome já existir, a nova definição de tipo de item de trabalho substituirá a existente. Se um tipo de item de trabalho ainda não existir, esse comando criará um novo tipo de item de trabalho. Para validar o XML que define um tipo de item de trabalho, mas não importa o arquivo, você usa a opção /v.
listwitd: Exibe os nomes de tipos de itens de trabalho no projeto especificado na janela do Prompt de Comando.
renamewitd: Altera o nome de exibição de um tipo de item de trabalho dentro de um projeto específico. Depois de executar esse comando, os itens de trabalho desse tipo mostram o novo nome.

Para executar a ferramenta da linha de comandos witadmin, abra uma janela do Prompt de Comando em que Visual Studio ou Team Explorer esteja instalado e insira:

cd %programfiles(x86)%\Microsoft Visual Studio 12.0\Common7\IDE

Em uma edição de 32 bits do Windows, substitua %programfiles(x86)% por %programfiles%.

Para obter mais informações sobre tipos de itens de trabalho, veja Adicionar definições de tipo para itens de trabalho a um modelo de processo.

Dica

Você pode criar e modificar tipos de itens de trabalho usando o Editor de Processo, uma poderosa ferramenta para Visual Studio.Essa ferramenta não é compatível.Para obter mais informações, consulte a página a seguir no site da Microsoft: Ferramentas Poderosas do Team Foundation Server.

Requisitos

Para o projeto de equipe em que os tipos de itens de trabalho são definidos, você deve ter o seguinte conjunto de permissões:

Para exportar ou relacionar tipos de itens de trabalho, você tem que ser um membro do grupo de Administradores do Projeto ou ter a permissão Exibir informações em nível de projeto definida como Permitir.
Para destruir, importar ou renomear tipos de itens de trabalho, você tem que ser um membro do grupo de segurança Administradores do Team Foundation ou do grupo de segurança Administradores do Projeto.

Para obter mais informações, consulte Referência de permissões para o Team Foundation Server.

Dica

Mesmo que faça logon com permissões administrativas, você deve abrir uma janela elevada do Prompt de Comando para executar essa função em um servidor que esteja executando Windows Server 2008.Para abrir uma janela do Prompt de Comando elevado, escolha Iniciar, abra o menu de atalho do Prompt de Comando e, em seguida, escolha Executar como Administrador.Para obter mais informações, consulte o site da Microsoft: Controle de Acesso do Usuário.

witadmin destroywitd /collection:CollectionURL /p:Project /n:TypeName [/noprompt]

witadmin exportwitd /collection:CollectionURL /p:Project /n:TypeName [/f:FileName] [/e:Encoding] [/exportglobalists]

witadmin importwitd /collection:CollectionURL [/p:Project] /f:FileName [/e:Encoding] [/v]

witadmin listwitd /collection:CollectionURL /p:Project

witadmin renamewitd /collection:CollectionURL /p:Project /n:TypeName /new:NewName [/noprompt]

Parâmetros

Parâmetro	Descrição
/collection:CollectionURL	Especifica o URI da coleção de projeto de equipe. O formato do URI é o seguinte: http://ServerName:Port/VirtualDirectoryName/CollectionName Se nenhum diretório virtual for usado, então o formato do URI será o seguinte: http://ServerName:Port/CollectionName
/p:Projeto	O projeto de equipe para o qual os tipos de itens de trabalho devem ser gerenciados. Esse projeto de equipe deve ser definido na coleção de projeto que você especificou usando o parâmetro /collection. O parâmetro /p é obrigatório, a menos que você execute o comando importwitd com a opção /v.
/n:TypeName	O nome do tipo de item de trabalho para destruir, exportar, importar ou renomear.
/f:FileName	O caminho e o nome do arquivo de definição XML que contém os tipos de itens de trabalho a serem exportados ou importados. Se omitir este parâmetro ao usar o comando exportwitd, o XML aparece na janela do Prompt de Comando. Dica Se estiver usando Windows Vista, talvez você não tenha permissões para determinadas pastas.A tecnologia de virtualização de registro redireciona o arquivo exportado e o salva no repositório virtual, automaticamente, caso tente exportar o tipo de item de trabalho para um local para o qual você não tenha permissões.Para evitar esse redirecionamento, é possível exportar o arquivo para um local em que tenha permissões. Para obter mais informações sobre a virtualização do registro, consulte o site da Microsoft: Virtualização do Registro e Problemas comuns de virtualização de arquivo e registro no Windows Vista.
/e:Codificação	O nome de um formato de codificação .NET Framework 2,0. O comando usa a codificação especificada para exportar ou importar os dados XML. Por exemplo, /e:utf-7 especifica codificação Unicode (UTF-7). Se omitir esse parâmetro, witadmin tentará detectar a codificação e, se a detecção falhar, witadmin usará UTF-8.
/exportgloballists	Exporta as definições de listas globais referenciadas pelo tipo de item de trabalho. As definições de listas globais serão inseridas no XML de definição de tipo de item de trabalho. Quando não especificado, as definições para listas globais serão omitidas.
/v	Valida o XML que define o tipo de item de trabalho, mas não importa o arquivo de definição XML. Dica Você pode validar a definição de tipo sem especificar um projeto de equipe.As referências aos grupos com escopo no nível de projeto são ignoradas.
/new:NewName	O novo nome do tipo de item de trabalho.
/noprompt	Desabilita o prompt para confirmação.
/? ou help	Exibe ajuda sobre o comando na janela Prompt de comando.

Comentários

Quando você usa o comando destroywitd, ele destrói todos os seguintes objetos:

O tipo de item de trabalho
Todos os itens de trabalho desse tipo
As entradas correspondentes nas tabelas de itens de trabalho, nas tabelas de texto longo e nas tabelas de links
Objeto no cache de metadados do tipo de item de trabalho

Exemplos

A menos que especificado de outra forma, os seguintes valores se aplicam a cada exemplo:

URI da coleção do projeto de equipe: http://AdventureWorksServer:8080/tfs/DefaultCollection
Nome do projeto: AdventureWorks
Nome do arquivo de entrada ou de saída: myworkitems.xml
Nome do tipo de item de trabalho: myworkitem
Codificação padrão: UTF-8

Exportar a definição de um WIT

O comando a seguir exporta a definição de myworkitem para o arquivo, myworkitems.xml.

witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myworkitems.xml /n:myworkitem

O exemplo a seguir exporta o item de trabalho usando codificação Unicode (UTF-7).

witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myworkitems.xml /n:myworkitem /e:utf-7

Exportar a definição de um WIT e suas listas globais referenciadas

O exemplo a seguir exporta o tipo de item de trabalho e suas listas globais referenciadas.

witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myworkitems.xml /n:myworkitem /exportgloballists

Relacionar a definição de um WIT

O exemplo a seguir exibe a definição do tipo de item de trabalho da janela do Prompt de Comando.

witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /n:myworkitem

Importar a definição de WITs

O exemplo a seguir importa a definição do item de trabalho a partir do arquivo XML.

witadmin importwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /f:myworkitem.xml /p:AdventureWorks

Validar a definição XML de um WIT

O exemplo a seguir valida o XML que define o tipo de item de trabalho, mas não importa a definição.

witadmin importwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /f:myworkitem.xml /p:AdventureWorks /v

Perguntas e respostas

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 aprender sobre quais personalizações pode fazer com segurança e quais evitar, veja Personalizar a experiência de acompanhamento de trabalho: antes que você personalize, considere as implicações de manutenção e atualização.

P: Como posso alterar a cor associada a um WIT?

R: 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.

Atribuições de cor para tipos de item de trabalho diferentes

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 e exportar categorias [witadmin].

Consulte também

Compartilhar via