Listar atributos e campos de item de trabalho.

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

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

Por que os campos de item de trabalho importam

Os campos de item de trabalho atendem a várias funções críticas no Azure DevOps:

• Acompanhamento de dados: capturar e armazenar informações essenciais sobre itens de trabalho
• Funcionalidade de consulta: habilitar recursos avançados de pesquisa e filtragem
• Relatórios: Suporte à análise e à criação de dashboards
• Gerenciamento de fluxo de trabalho: conduzir transições de estado e regras de negócios
• Integração: conectar-se com ferramentas e sistemas externos

Entender atributos de campo ajuda você a:

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

Prerequisites

Listar ou revisar campos

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

Campo de nomes e tipos de dados

Cada tipo de item de trabalho especifica os campos incluídos em 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 Boolean, Double, Integer, HTML ou String. Para obter descrições detalhadas de cada tipo de dados, confira 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 daquele exibido no formulário de item de trabalho.
• Nome da 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 depois de definido.

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

O que é um campo? Como funcionam os nomes de campo?

Cada tipo de item de trabalho inclui 31 campos do sistema e vários campos específicos do tipo. Os itens de trabalho ajudam você a planejar e acompanhar seu projeto.

Cada campo captura informações específicas sobre o trabalho a ser executado. Os valores atribuídos a esses campos são armazenados no armazenamento de dados de acompanhamento de trabalho, possibilitando a criação de consultas que determinam o status e as tendências.

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

Requisitos de nomenclatura de campo

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

• Exclusividade: os nomes de campo devem ser exclusivos na conta ou na coleção de projetos.
• Comprimento: os nomes de campo 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, você não pode adicionar um campo personalizado com o mesmo nome a vários processos.

Para saber mais, confira Convenções e restriçõ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 a consistência e a funcionalidade:

• Exclusividade: os nomes de campo precisam ser exclusivos na conta ou na coleção de projetos.
• Tamanho: Os nomes de campo devem ter 128 ou menos caracteres Unicode
• 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, você não pode adicionar um campo personalizado com o mesmo nome a vários processos.

Para saber mais, confira Convenções e restrições de nomenclatura.

Campos personalizados

Como o sistema define campos personalizados no nível da organização ou da coleção de projetos, você não pode 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 em uma coleção de projetos, incentivando o uso de campos comuns em diferentes projetos e tipos de item de trabalho.

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

Para saber mais, confira Convenções e restrições de nomenclatura.

Como posso determinar o tipo de dados de campo?

Revisar lista de campos

Para examinar a lista de campos definidos para uma organização ou coleção, siga estas etapas:

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

   

2. Selecione Processar.

   

3. Selecione Campos.

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

   

   Note

   Se você não vir Campos, sua coleção usará o processo XML local. Não há suporte para a página Campos nesse processo.

   Para obter descrições, uso e nomes de referência de cada campo, consulte o Índice de campos de item de trabalho. Além disso, você pode recuperar nomes de referência de campo usando o Campo de Tipos de Item de Trabalho – Listar API REST.

Explorador de Campos do Item de Trabalho

É possível pesquisar as atribuições dos atributos de campo usando a ferramenta Gerenciador de Campos de Item de Trabalho.

Para acessar o Gerenciador de Campos de Item de Trabalho, você deve instalar a Ferramenta do Editor de Processos. Com base na versão instalada do Visual Studio, obtenha a Ferramenta de Editor de Processos de uma das extensões a seguir.

• 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 utilizando 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 TFS. Você também pode usar essa versão do Editor de Processos para modificar os formulários de item de trabalho de estilo antigo. Não é possível usá-lo para editar formulários associados aos novos formulários da Web.
• Visual Studio 2015: TFS Power Tools.

Atributos de campo

Existem muitos atributos não alteráveis e ocultos para cada campo de item de trabalho. A tabela a seguir descreve cada atributo. Os atributos têm nomes diferentes dependendo se você os obtiver por meio da Campos – Obter API REST ou os exibir por meio da ferramenta WIFE (Gerenciador de Campos de Item de Trabalho).

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 compatíveis com o processo de herança. Para pesquisar o nome de referência de um campo, consulte o Índice do campo de item de trabalho.

Listar atributos do 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 itens de trabalho:

Seleção e design de campo

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

Otimização de 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 seleção: garantir que os valores das listas de seleção sejam gerenciáveis em tamanho e bem organizados

Manutenção e governança

• Uso do campo do documento: manter a documentação explicando a finalidade e o uso de campos personalizados
• Examine regularmente: examine 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 e soluções frequentemente encontrados ao trabalhar com campos de itens de trabalho:

Problemas de visibilidade de campo

• Campo não aparecendo: verifique se o campo foi adicionado ao layout do tipo de item de trabalho
• Problemas de permissão: verifique se você tem 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 frequentemente consultados (localmente)
• Limitações do operador: verifique quais operadores têm suporte para o tipo de dados de campo

Entrada e validação de dados

• Valores inválidos: verifique se o campo tem valores permitidos restritos ou regras de validação
• Campos somente leitura: verificar o atributo do campo IsEditable
• Requisitos de formato: garantir que os dados correspondam ao tipo de dados de campo esperado

Conteúdo relacionado