Campos e atributos de item de trabalho no Azure Boards

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

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

Pré-requisitos

• Para exibir os campos definidos para a organização ou coleção, você deve ser membro do grupo de aplicativos Usuários Válidos da Coleção de Projetos ou ter a permissão Exibir informações no nível da instância definida como Permitir para a organização ou coleção.

Listar ou revisar campos

Para listar ou examinar campos, você pode usar uma das ferramentas a seguir, dependendo do modelo de processo – Herdado, XML hospedado ou XML local – que você usa. 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 definidos para os itens de trabalho que fazem referência a esse tipo. Cada campo é associado a vários atributos, muitos dos quais são definidos pelo sistema e não podem ser alterados.

Cada campo é definido pelos três atributos a seguir.

• Tipo de dados: especifica o tipo de dados que podem ser inseridos no campo, como Booleano, Duplo, Inteiro, HTML e Cadeia de caracteres. Para obter descrições de cada tipo de dados, confira Campos de consulta, operadores e macros.
• Nome amigável: especifica o nome atribuído ao campo e que você seleciona para um Campo em uma cláusula de consulta. Esse nome pode diferir daquele exibido no formulário de item de trabalho.
• Nome da referência: especifica o nome que você usa ao criar uma consulta WIQL ou um modelo de item de trabalho improvisado, usando os comandos da API REST ou configurando as definições de tipo de item de trabalho XML. Depois de definido, o nome de referência não pode ser alterado.

Para obter uma descrição de cada atributo de campo e 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 de WITs e itens de trabalho, confira Acompanhar o trabalho com histórias de usuários, problemas, bugs, recursos e épicos.

O que é um campo? Como os nomes de campo são usados?

Cada tipo de item de trabalho está associado a 31 campos do sistema e vários outros campos específicos do tipo. Você usa itens de trabalho para planejar e acompanhar seu projeto.

Cada campo dá suporte ao acompanhamento de uma informação sobre o trabalho a ser executado. Os valores atribuídos a um campo são guardados no armazenamento de dados de acompanhamento de trabalho que você pode criar consultas para determinar status e tendências.

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

Nomes de campo

Um nome de campo de item de trabalho identifica com exclusividade cada campo de item de trabalho. Verifique se os nomes de campo estão dentro destas diretrizes:

• Os nomes de campo devem ser exclusivos na coleção de conta/projeto
• Os nomes de campo devem ter 128 ou menos caracteres Unicode
• Os nomes de campo não podem conter espaços à esquerda ou à direita, nem dois ou mais espaços consecutivos
• Os nomes de campo devem conter pelo menos um caractere alfabético
• Os nomes de campo não podem conter os seguintes caracteres: .,;'`:~\/\*|?"&%$!+=()[]{}<>.

Como os campos personalizados são definidos para a organização ou coleção, você não pode adicionar um campo personalizado a um processo com o mesmo nome de campo adicionado a outro processo.

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

Sistema e campos predefinidos

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

Os campos predefinidos definidos pelo processo padrão começam com Microsoft.VSTS e diferem ainda mais com base em seu uso. Exemplos de campos predefinidos que são usados em comum, para fins de agendamento e integração com o Office Project, para integração com o Team Foundation Build e integração com o TCM (gerenciamento de casos de teste) são os seguintes:

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

Para obter uma visão geral de todos os campos predefinidos e do sistema definidos para os modelos de processo/processos padrão, confira Índice de campo de item de trabalho. Para obter mais informações sobre como especificar nomes de campo, confira Restrições de nomenclatura.

Campos Personalizados

Como os campos personalizados são definidos para a organização ou coleção de projetos, você não pode adicionar um campo personalizado a um processo com o mesmo nome de campo adicionado a outro processo.

Ao adicionar campos personalizados, observe os seguintes limites:

• Um máximo de 64 campos pode ser definido para cada WIT
• Um máximo de 512 campos pode ser definido por processo

O tipo de dados de campo determina 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 projetos. Essa restrição incentiva as organizações a usar campos comuns entre projetos e tipos de item de trabalho.

Como posso determinar o tipo de dados de campo?

Work Item Field Explorer

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

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

• Visual Studio 2019 e 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 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 do campo

Há 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 com base em se você obtê-los por meio da Campos – ObterAPI REST ou exibir por meio da ferramenta WIFE (Gerenciador de Campo 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, confira Í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  

Adicionar e modificar campos

Artigos relacionados