Campos e atributos de item de trabalho nos Painéis do Azure

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

Os campos de item de trabalho são usados para controlar informações. Os campos são definidos para uma organização e compartilhados em todos os projetos definidos para essa organização. Você pode usar uma das duas ferramentas para revisar os campos definidos para a organização. Essas ferramentas estão disponíveis para modelos de processo XML herdados e hospedados.

• Página Web Campos de Processo>
• Explorador de Campo de Item de Trabalho

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

Pré-requisitos

• Para exibir os campos definidos para uma 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 rever campos

Para listar ou revisar campos, você pode usar uma das seguintes ferramentas, dependendo do modelo de processo — Herança, XML hospedado ou XML local — usado. Para obter um índice de campos definidos dentro dos processos padrão, consulte Índice de campo de item de trabalho.

Ferramenta	Herança	XML hospedado	XML local
Portal da Web: Listar campos herdados e personalizados	✔️	✔️1º
Explorador de campos de item de trabalho	✔️	✔️	✔️
Ferramenta de linha de comando WITADMIN ListFields	✔️	✔️	✔️

Nota

1. Suporte apenas para processos padrão (Agile, CMMI, Scrum).

Tipos e nomes de dados de campo

Cada tipo de item de trabalho especifica os campos definidos para os itens de trabalho que fazem referência a esse tipo. Cada campo está associado a um número de 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 String. Para obter descrições de cada tipo de dados, consulte 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 ser diferente do nome exibido no formulário de item de trabalho.
• Nome de referência: especifica o nome que você usa ao criar uma consulta WIQL ou um modelo de item de trabalho improvisado, usando comandos da API REST ou definindo definições de tipo de item de trabalho XML. Uma vez definido, o nome de referência não pode ser alterado.

Para obter uma descrição de cada atributo de campo e como listá-los, consulte Atributos de campo e Listar atributos de campo mais adiante neste artigo. Para obter uma visão geral de WITs e itens de trabalho, consulte Acompanhar o trabalho com histórias de usuários, problemas, bugs, recursos e épicos.

O que é um campo? Como são utilizados os nomes dos campos?

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 suporta o rastreamento de uma informação sobre o trabalho a ser executado. Os valores atribuídos a um campo são armazenados no armazenamento de dados de acompanhamento de trabalho, que pode ser criado consultas para determinar o status e as tendências.

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

Nomes de campo

Um nome de campo de item de trabalho identifica exclusivamente cada campo de item de trabalho. Certifique-se de que os nomes dos campos se enquadram nestas diretrizes:

• Os nomes de campo devem ser exclusivos dentro da coleção de contas/projetos
• 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 dos campos 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 uma organização ou coleção, não é possível adicionar um campo personalizado a um processo com o mesmo nome de campo que você adiciona a outro processo.

Para obter mais informações, consulte Restrições e convençõ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, em seguida, 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 Team Foundation Build e integração com gerenciamento de casos de teste (TCM) são os seguintes:

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

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

Campos personalizados

Como os campos personalizados são definidos para uma organização ou coleção de projetos, não é possível adicionar um campo personalizado a um processo com o mesmo nome de campo que você adiciona a outro processo.

Ao adicionar campos personalizados, observe os seguintes limites:

• Um máximo de 64 campos pode ser definido para cada WIT
• É possível definir um máximo de 512 campos 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 dentro de uma coleção de projetos. Essa restrição incentiva as organizações a usar campos comuns entre 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 prefixado com Personalizado e, em seguida, o nome do campo com espaços removidos. Por exemplo, você adiciona um campo chamado DevOps Triage, o nome de referência é Custom.DevOpsTriage. Não são permitidos espaços no nome de referência.

Como posso determinar o tipo de dados do campo?

Você pode exibir o tipo de dados de campos definidos para sua organização abrindo a página Campos de processo>.

Página Web Campos de Processo>

Para revisar a lista de campos definidos para uma organização ou coleção, abra Campos de processo de configurações>>da organização.

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

   

2. Em seguida, escolha Processar.

   

   Nota

   Se você não vir Processo, então você está trabalhando a partir do TFS-2018 ou versão anterior. A página Processo não é suportada. Você deve usar os recursos suportados para o modelo de processo XML local.

3. Em seguida, escolha Campos.

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

   

   Nota

   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 descrições e uso de cada campo, bem como o nome de referência para cada campo, você pode procurá-lo a partir do índice de campo Item de trabalho. Você também pode obter o nome de referência dos campos do campo 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 Gerenciador de Campo de Item de Trabalho, você deve instalar a Ferramenta Editor de Processos. Com base na versão do Visual Studio que você instalou, 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 do campo

Há muitos atributos ocultos e inalteráveis para cada campo de item de trabalho. A tabela seguinte descreve cada atributo. Os atributos têm nomes diferentes com base em se você obtê-los através da API Fields - GetREST ou exibir através 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 Índice de campo de item de trabalho.

Atributo

Tipo de atributo

Descrição

---

REST:
ESPOSA: AllowedValues

Coleção

Obtém a coleção de valores válidos para um campo que contém valores de lista de opções. Você pode alterar isso especificando uma lista de opções ou uma lista global (local).
Pode mudar?=Sim

REST: canSortBy
ESPOSA: CanSortBy

boolean

Indica se é possível classificar os resultados da consulta com esse campo.
Pode mudar?=Não

REST: descrição
ESPOSA: HelpText

string

Especifica uma descrição para o campo, que também define o texto de ajuda que aparece quando você passa o mouse sobre o campo dentro do formulário de item de trabalho.
Pode mudar?=Sim

REST:
ESPOSA: ID

Número inteiro

Especifica a ID interna do campo.
Pode mudar?=Não

REST:
ESPOSA: IsCloneable

boolean

Indica se o valor definido para o campo é copiado quando um usuário opta por copiar um item de trabalho. Por exemplo, os campos Título, Tags e Descrição são copiados, mas os campos ID e Histórico não são copiados.
Pode mudar?=Não

REST:
ESPOSA: IsComputed

boolean

Indica se o valor definido por este campo é calculado pelo sistema (True) ou não (False). Exemplos de campos computados são aqueles que são definidos pelo sistema, como o ID, Data revisada, Data alterada e Contagem de links externos.
Pode mudar?=Não

REST:
ESPOSA: IsCoreField

boolean

Indica se esse campo é especificado para todos os tipos de item de trabalho.
Pode mudar?=Não

REST:
ESPOSA: IsEditable

boolean

Indica se os usuários podem modificar esse campo (True) ou não (False). Exemplos de campos não editáveis são aqueles que são definidos pelo sistema, como os campos ID, Revisão, Criado por e Alterado por
Pode mudar?=Não

REST: isIdentity
ESPOSA: IsIdentity

boolean

Indica se este campo é um campo Identidade . Os campos de identidade são campos de cadeia de caracteres usados para armazenar identidades de usuário.
Pode mudar?=Não

REST:
ESPOSA: IsIndexed¹

boolean

Indica se este campo está indexado para suportar a pesquisa.
Pode mudar?=Não

REST:
ESPOSA: IsLongText

boolean

Indica que o campo pode conter mais de 255 caracteres, como campos atribuídos a um tipo de dados de Texto sem formatação, HTML ou Histórico.
Pode mudar?=Não

REST: isPicklist² ESPOSA:

boolean

Indica se o campo está associado a uma lista de opções. O valor é definido como True quando um campo personalizado é definido para o Azure DevOps e o tipo Picklist (String) ou Picklist (Integer) é selecionado. O valor é definido como False para campos herdados que definem listas de opções.
Pode mudar?=Não

REST: isPicklistSugerido² ESPOSA:

boolean

Indica se o campo permite que os usuários insiram seus próprios valores para uma lista de opções. O valor é definido como True quando um campo personalizado é definido para o tipo Azure DevOps, Picklist (String) ou Picklist (Integer) e a caixa de seleção Permitir que os usuários definam seus próprios valores está marcada.
Pode mudar?=Sim

REST: isQueryable
ESPOSA: IsQueryable

boolean

Indica se o campo aparece dentro do conjunto de campos que você pode adicionar para filtrar uma consulta de item de trabalho (True) ou não (False). A maioria dos campos pode ser consultada.
Pode mudar?=Não

REST:
ESPOSA: IsReportable ³

boolean

Indica se o atributo relatável está definido ou definido como algo diferente de Nenhum. Esse atributo pode ser alterado para ambientes locais.
Pode mudar?=Sim

REST:
ESPOSA: IsUsedInGlobalWorkflow

boolean

Indica se o campo está definido dentro de um fluxo de trabalho global.
Pode mudar?=Não

REST:
ESPOSA: IsUserNameField

boolean

Indica se o campo é usado para exibir um campo Identidade.
Pode mudar?=Não

REST: nome
ESPOSA: Nome

string

Nome amigável atribuído ao campo. O nome amigável não pode ser alterado para o Azure DevOps, mas pode ser alterado para local usando o comando witadmin changefield .
Pode mudar?=Apenas no local

REST: picklistId
ESPOSA: HelpText

GUID

Se o campo for uma lista de opções, o identificador da lista de opções associada, caso contrário, nulo. Um valor GUID exclusivo é atribuído quando um campo personalizado é definido para o Azure DevOps e o tipo Picklist (String) ou Picklist (Integer) é selecionado.
Pode mudar?=Não

REST:
ESPOSA: Valores Proibidos

Coleção

Obtém a coleção de valores proibidos para um campo que especifica esses valores. Você só pode definir valores proibidos para implantações locais.
Pode mudar?=Apenas no local

REST: somente leitura
ESPOSA:

boolean

Indica se o campo está definido como somente leitura. Para os Serviços de DevOps do Azure, apenas os campos personalizados podem ser alterados para serem somente leitura. Os campos do sistema não podem ser modificados.
Pode mudar?=Sim

REST: nome_referência
ESPOSA: ReferenceName

string

Especifica o nome de referência de um campo.
Pode mudar?=Não

REST:
ESPOSA: ReportingAttributes³

Especifica Detalhe, Dimensão ou Medida, dependendo se e como você deseja que o campo seja incluído nos relatórios. Os dados de campos que têm um valor diferente de Nenhum para este atributo são exportados para o data warehouse e podem ser incluídos em relatórios SQL.
Pode mudar?=Apenas no local

REST:
ESPOSA: ReportingName³

string

Especifica o rótulo de um campo quando os dados aparecem em relatórios SQL. Se você não especificar um valor, o nome amigável do campo será usado.
Pode alterar?=Apenas no local

REST:
ESPOSA: ReportingReferenceName³

string

Especifica um nome de referência diferente para um campo que é usado quando os dados são exportados para o data warehouse relacional. Se você não especificar um valor, o nome de referência dos campos será usado.
Pode alterar?=Apenas no local

REST: supportedOperations
ESPOSA:

conjunto

O conjunto de operadores de consulta que são válidos para uso ao fazer referência a este campo. Para obter uma referência rápida das operações suportadas com base no tipo de dados, consulte Referência rápida de consulta, Operadores e macros suportadas para cada tipo de dados.
Pode mudar?=Não

REST:
ESPOSA: SupportsTextQuery

boolean

Indica se o campo suporta consultas de texto, como Contém palavras, Não contém palavras.
Pode mudar?=Não

REST:
ESPOSA: SystemType

string

Especifica o tipo de dados do campo, fazendo referência ao nome do sistema, como System.DateTime ou System.String.
Pode mudar?=Não

REST: tipo
ESPOSA: FieldType

string

Especifica o tipo de dados do campo, como Boolean, DateTime, Integer, String e assim por diante. Para obter uma lista completa e descrições, consulte Campos de consulta, operadores e macros.
Pode mudar?=Não

REST: utilização
ESPOSA: Uso

string

Especifica se o campo se destina a ser usado com objetos de item de trabalho (WorkItem) ou link de item de trabalho (WorkItemLink). O uso para a maioria dos campos é WorkItem. Para obter uma lista completa de valores de uso, consulte Obter campos, FieldUsage.
Pode mudar?=Não

Nota

1. Para implantações locais, você pode habilitar a indexação de um campo para melhorar os tempos de resposta da consulta ao filtrar no campo. Para obter mais informações, consulte Campos indexados mais adiante neste artigo.
2. Os atributos isPicklist e isPicklistSuggested são atribuídos apenas a campos personalizados definidos para um processo herdado. O modelo de processo herdado tem suporte para o Azure DevOps Server 2019 e versões posteriores. Para obter mais informações, consulte Modelo de processo herdado.
3. Todos os atributos de relatório são válidos apenas para implantações locais cujos projetos foram configurados para dar suporte aos Relatórios do SQL Server e ao SQL Server Analysis Services.

Listar atributos de campo

Você pode listar os atributos atribuídos a um campo usando a API Fields - Get REST. Insira o nome da sua organização para OrganizationName.

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

Por exemplo, aqui listamos os atributos para o Caminho de Iteração, especificando o nome de referência, System.IterationPath, para a organização fabrikam.

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

Dados devolvidos:

{
"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"
}

Adicionar e modificar campos

Para adicionar campos a um processo, adicione-os a um ou mais tipos de item de trabalho. Para obter mais informações, consulte Personalizar um processo de herança.

Artigos relacionados

• Referência de consulta rápida
• Índice do campo dos itens de trabalho
• Adicionar e gerenciar campos para um processo herdado
• Referência de metadados para o Azure Boards Analytics