Listar campos e atributos de item de trabalho

Serviços de DevOps do Azure | Azure DevOps Server | Azure DevOps Server 2022

Para obter uma descrição de cada campo definido com um processo do sistema, consulte Índice de campo de item de trabalho.

Por que os campos de item de trabalho são importantes

Os campos de item de trabalho têm várias funções críticas no Azure DevOps:

• Rastreamento de dados: capture e armazene informações essenciais sobre itens de trabalho
• Funcionalidade de consulta: habilite recursos avançados de pesquisa e filtragem
• Relatórios: suporte a análises e criação de painéis
• Gerenciamento de fluxo de trabalho: impulsione transições de estado e regras de negócios
• Integração: Conecte-se com ferramentas e sistemas externos

Compreender os atributos de campo ajuda-o a:

• Otimizar consultas: escolha os campos certos para pesquisas eficientes
• Planejar personalizações: entenda as limitações e possibilidades
• Solucionar problemas: diagnosticar problemas com o comportamento de campo
• Processos de design: crie tipos de itens de trabalho e fluxos de trabalho eficazes

Prerequisites

Listar ou rever campos

Para listar ou revisar campos, use uma das seguintes ferramentas com base em seu modelo de processo: XML herdado, hospedado ou XML local. Para obter um índice de campos definidos dentro dos processos padrão, consulte Índice de campo de item de trabalho.

Tipos e nomes de dados de campo

Cada tipo de item de trabalho especifica os campos incluídos nos itens de trabalho desse tipo. Cada campo tem vários atributos, muitos dos quais são definidos pelo sistema e imutáveis.

Três atributos principais definem campos:

• Tipo de dados: indica o tipo de dados que você pode inserir no campo, como Booleano, Duplo, Inteiro, HTML ou String. Para obter descrições detalhadas de cada tipo de dados, consulte Campos de consulta, operadores e macros.
• Nome amigável: o nome amigável atribuído ao campo, usado ao selecionar um Campo em uma cláusula de consulta. Esse nome pode ser diferente do nome exibido no formulário de item de trabalho.
• Nome de referência: o identificador usado ao criar consultas WIQL, modelos de item de trabalho, executar comandos da API REST ou definir definições de tipo de item de trabalho XML. O nome de referência é permanente e não pode ser alterado uma vez definido.

Para obter uma descrição detalhada de cada atributo de campo e instruções sobre como listá-los, consulte Atributos de campo e Atributos de campo de lista mais adiante neste artigo. Para obter uma visão geral dos tipos de item de trabalho (WITs) e itens de trabalho, consulte Controlar o trabalho com histórias de usuários, problemas, bugs, recursos e épicos.

O que é um campo? Como funcionam os nomes dos campos?

Cada tipo de item de trabalho inclui 31 campos do sistema e vários campos específicos do tipo. Os itens de trabalho ajudam-no a planear e controlar o seu projeto.

Cada campo capta informações específicas sobre o trabalho a ser realizado. Os valores atribuídos a esses campos são armazenados no armazenamento de dados de controle de trabalho, permitindo que você crie consultas que determinam o status e as tendências.

Para obter descrições e o uso de cada campo definido para os principais processos do sistema — Agile, Basic, Scrum e CMMI — consulte o Índice de campo do item de trabalho.

Requisitos de nomenclatura de campo

Um nome de campo de item de trabalho identifica exclusivamente cada campo de item de trabalho. Certifique-se de que seus nomes de campo estejam de acordo com as seguintes diretrizes:

• Exclusividade: os nomes de campo devem ser exclusivos dentro da conta ou da coleção de projetos.
• Comprimento: Os nomes dos campos devem conter 128 caracteres Unicode ou menos.
• Espaçamento: os nomes de campo não podem ter espaços à esquerda ou à direita ou conter dois ou mais espaços consecutivos.
• Composição: Os nomes dos campos devem incluir pelo menos um caractere alfabético.
• Caracteres proibidos: os nomes dos campos não podem incluir os seguintes caracteres: .,;':~/*|?" &%$!+=()[]{}<>'.

Como o sistema define campos personalizados no nível da organização ou da coleção, não é possível adicionar um campo personalizado com o mesmo nome a vários processos.

Para obter mais informações, consulte Restrições e convenções de nomenclatura.

Sistema e campos predefinidos

O sistema define campos de item de trabalho com requisitos estruturais e de nomenclatura específicos para garantir consistência e funcionalidade:

• Exclusividade: os nomes de campo devem ser exclusivos dentro de uma conta ou coleção de projetos.
• Comprimento: Os nomes dos campos devem ter 128 caracteres Unicode ou menos.
• Espaçamento: os nomes de campo não podem ter espaços à esquerda ou à direita ou conter vários espaços consecutivos.
• Composição: Os nomes dos campos devem incluir pelo menos um caractere alfabético.
• Caracteres proibidos: os nomes dos campos não podem incluir os seguintes caracteres: .,;':~/*|?" &%$!+=()[]{}<>'.

Como o sistema define campos personalizados no nível da organização ou da coleção, não é possível adicionar um campo personalizado com o mesmo nome a vários processos.

Para obter mais informações, consulte Restrições e convenções de nomenclatura.

Campos personalizados

Como o sistema define campos personalizados no nível da organização ou da coleção de projetos, não é possível adicionar um campo personalizado com o mesmo nome a vários processos.

Ao adicionar campos personalizados, observe os seguintes limites:

• Máximo de campos por tipo de item de trabalho (WIT): 64
• Máximo de campos por processo: 512

O tipo de dados de campo determina o tipo e o tamanho dos dados que você pode armazenar no campo. Cada campo pode ter apenas um tipo definido dentro de uma coleção de projetos, incentivando o uso de campos comuns em diferentes projetos e tipos de itens de trabalho.

Quando você adiciona um campo personalizado a um processo herdado, o Azure DevOps atribui um nome de referência prefixado com Personalizado seguido pelo nome do campo sem espaços. Por exemplo, adicionar um campo chamado DevOps Triage resulta no nome de referência Custom.DevOpsTriage. Não são permitidos espaços em nomes de referência.

Para obter mais informações, consulte Restrições e convenções de nomenclatura.

Como posso determinar o tipo de dados do campo?

Lista de campos de revisão

Para rever a lista de campos definidos para uma organização ou coleção, siga estes passos:

1. Selecione o logotipo do Azure DevOps para abrir Projetos. Em seguida, selecione Configurações da organização.

   

2. Selecione Processo.

   

3. Selecione Campos.

   Os campos listados correspondem a todos os campos definidos para a organização ou coleção, o que inclui todos os campos personalizados e os campos definidos para os processos do sistema.

   

   Note

   Se você não vir Campos, sua coleção usará o processo XML local. A página Campos não é suportada para esse processo.

   Para obter descrições, uso e nomes de referência de cada campo, consulte o índice do campo Item de trabalho. Além disso, você pode recuperar nomes de referência de campo usando o campo de tipos de item de trabalho - API REST de lista.

Explorador de Campo de Item de Trabalho

Você pode procurar as atribuições de atributos de campo usando a ferramenta Explorador de Campo de Item de Trabalho.

Para acessar o Explorador de Campo de Item de Trabalho, instale a Ferramenta Editor de Processos. Com base na sua versão instalada do Visual Studio, obtenha a ferramenta Editor de processos de uma das seguintes extensões.

• Visual Studio 2019 & 2022: A partir de agora, não há nenhuma extensão específica do Editor de Modelo de Processo disponível. Mas, você ainda pode personalizar modelos de processo usando outras ferramentas, como qualquer editor de texto ou editor XML. Você também pode usar o portal da Web do Azure DevOps para determinadas personalizações, especialmente para processos herdados.
• Visual Studio 2017: Editor de modelo de processo do TFS. Você também pode usar esta versão do Editor de processos para modificar os formulários de item de trabalho antigos. Não é possível usá-lo para editar formulários associados aos novos formulários da Web.
• Visual Studio 2015: Ferramentas Elétricas do TFS.

Atributos de campo

Existem muitos atributos inalteráveis e ocultos para cada campo de item de trabalho. A tabela seguinte descreve cada atributo. Os atributos têm nomes diferentes, dependendo se você os recupera por meio da API Fields - Get REST ou os visualiza por meio da ferramenta Work Item Field Explorer (WIFE).

Os atributos atribuídos a um campo dependem da plataforma e da versão que você usa. Por exemplo, alguns atributos não são suportados com o processo de herança. Para procurar o nome de referência de um campo, consulte o Índice do campo Item de trabalho.

Listar atributos de campo

https://dev.azure.com/OrganizationName/_apis/wit/fields/FieldReferenceName

https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://dev.azure.com/mseng/_apis/wit/fields/System.IterationPath"
}

https://{ServerName:Port}/tfs/{Collection}/_apis/wit/fields/FieldReferenceName?api-version={version}

https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1"
}

witadmin listfields /collection:http://fabrikam:8080/tfs/DefaultCollection /n:Microsoft.VSTS.Common.Issue  

Field: Microsoft.VSTS.Common.Issue  
Name: Issue  
Type: String  
Reportable As: dimension  
Use: Adventure Works (Shared Steps), AW Future (Shared Steps), AW Current (Shared Steps)  
Indexed: False  

Práticas recomendadas para trabalhar com campos

Considere estas recomendações ao trabalhar com campos de item de trabalho:

Seleção e design de campo

• Escolha nomes significativos: use nomes de campo descritivos que indiquem claramente sua finalidade
• Padronizar nomenclatura: estabeleça convenções de nomenclatura consistentes em toda a sua organização
• Limitar campos personalizados: adicione campos personalizados criteriosamente para evitar sobrecarregar os usuários
• Considerar tipos de dados: selecione os tipos de dados apropriados para as informações que você está armazenando

Otimização do desempenho

• Usar campos indexados: para implantações locais, considere a indexação de campos personalizados consultados com frequência
• Evite consultas pesadas: esteja atento ao desempenho da consulta ao usar muitos filtros de campo
• Otimizar listas de opções: mantenha os valores da lista de opções gerenciáveis em tamanho e bem organizados

Manutenção e governança

• Uso do campo do documento: mantenha a documentação explicando a finalidade e o uso dos campos personalizados
• Revise regularmente: revise periodicamente os campos personalizados para identificar campos não utilizados ou redundantes
• Planejar alterações: considere o impacto das alterações de campo em itens de trabalho e consultas existentes
• Modificações de teste: sempre teste as alterações de campo em um ambiente de desenvolvimento primeiro

Adicionar e modificar campos

Solução de problemas de campo

Problemas comuns e respetivas soluções ao trabalhar com campos de itens de trabalho:

Problemas de visibilidade de campo

• Campo que não aparece: Verifique se o campo foi adicionado ao layout do tipo de item de trabalho
• Problemas de permissão: verifique se você tem as permissões apropriadas para exibir ou editar campos
• Diferenças de processo: verifique se o campo existe no processo atual

Problemas de consulta e pesquisa

• Campo não consultável: Verifique o IsQueryable atributo do campo
• Problemas de desempenho: considere a indexação de campos personalizados consultados com frequência (no local)
• Limitações do operador: verifique quais operadores são suportados para o tipo de dados de campo

Introdução e validação de dados

• Valores inválidos: verifique se o campo restringiu valores permitidos ou regras de validação
• Campos somente leitura: verifique o atributo do IsEditable campo
• Requisitos de formato: verifique se os dados correspondem ao tipo de dados de campo esperado

Conteúdo relacionado