Partilhar via


Elemento FIELD (definição)

Você usa o elemento de definição FIELD () para definir um campo de item de trabalho e para especificar regras e as condições que se aplicam a ele.Os atributos que você atribuir a um campo determinam como aparece em um formulário de item de trabalho e está disponível para a inclusão nos relatórios.Você gerencia o conjunto de atribuições de campo para uma coleção de projeto de equipe.Como consequência, os atributos que você atribui a campos que são definidos em um tipo de item de trabalho devem corresponder por todos os tipos de itens de trabalho para todos os projetos de equipe de uma coleção.Além disso, todos os campos reportáveis de todas as coleções são exportados a bancos de dados de data warehouse.

ObservaçãoObservação

Para obter informações sobre o elemento de FIELD (fluxo de trabalho), que você usa para especificar regras e circunstâncias a campos durante uma transição de alteração ou de fluxo de trabalho de estado, consulte Elemento FIELD (fluxo de trabalho).

Você pode alterar as atribuições do atributo que você fizer nos campos existentes para uma coleção usando a ferramenta de linha de comando witadmin .Para obter mais informações, consulte Gerenciar campos de item de trabalho [witadmin].

Hierarquia de esquema

WITD

   WORKITEMTYPE

      CAMPOS

            FIELD

<xs:element name="FIELD" type="FieldDefinition" maxOccurs="unbounded"/>

<FIELD name="fieldDisplayName" refname="fieldReferenceName" type="String | Integer | Double | DateTime | PlainText | HTML | History | TreePath | GUID" syncnamechanges ="true | false" reportable="Dimension | Detail | Measure" formula="sum" reportingname="ReportingDisplayName" reportingrefname="ReportingReferenceName" > <ALLOWEDVALUES> . . . </ALLOWEDVALUES> <ALLOWEXISTINGVALUE /> <CANNOTLOSEVALUE /> <COPY /> <DEFAULT /> <EMPTY /> <FROZEN /> <HELPTEXT> . . . </HELPTEXT> <MATCH /> <NOTSAMEAS /> <PROHIBITEDVALUES /> . . . </PROHIBITEDVALUES> <READONLY /> <REQUIRED /> <SERVERDEFAULT /> <SUGGESTEDVALUES /> . . . </SUGGESTEDVALUES> <VALIDUSER /> <WHEN>> . . . </WHEN> <WHENNOT> . . . </WHENNOT> <WHENCHANGED> . . . </WHENCHANGED> <WHENNOTCHANGED> . . . </WHENNOTCHANGED> </FIELD>

Atributos e elementos

As seções a seguir descrevem elementos filho, atributos, e elementos pai.

Atributos

Atributo

Descrição

name

Obrigatório.O nome amigável de campo que aparece nos menus suspensos de item de trabalho consulta.O nome amigável deve ser exclusivo por todos os campos que são definidos em um projeto de equipe.Além disso, o nome amigável pode diferir do rótulo que aparece ao lado do campo no formulário de item de trabalho.Para obter mais informações, consulte Referência de elemento do controle XML.

O tipo do atributo é typelib:FieldName.Comprimento mínimo: 1; comprimento máximo: 128.

O valor padrão: ^ ^ [\.\[\]]+$

Exemplo do valor de padrão: Atribuído a

refname

Obrigatório.O rótulo exclusivo que distingue um campo de todos os campos restantes que são definidos na coleção de projeto de equipe.

Requisitos para e restrições adicionais em nomes amigáveis e nomes de referência, consulte As convenções de nomenclatura para objetos de rastreamento de Item de trabalho.

O tipo do atributo é typelib:ReferenceFieldName.Comprimento mínimo: 1; comprimento máximo: 70.

O valor padrão: a-zA-Z_ ^ [] [] a-zA-Z0-9_ * (\. [] a-zA-Z0-9_ +) +$

Exemplo do valor de padrão: Company.IssueType

type

Obrigatório.Especifica o tipo de dados que aceita o campo.

ObservaçãoObservação
Os campos em coleções diferentes de projeto que têm o mesmo reportingrefname devem ser atribuídos o mesmo valor para type.Se os valores diferem de dados, conflitos podem ocorrer quando a data warehouse é processada.Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse.

A tabela a seguir lista os valores válidos para este atributo:

ValorUso
DateTime Especifica uma data de acordo com o ponto de (UTC) do Tempo Universal Coordenado (UTC) no tempo.
Double Especifica um valor de ponto flutuante.
GUID Especifica um campo que contém um identificador exclusivo.
History
Suporta segmentos de notícias e mantém registro de outras informações históricas.
ObservaçãoObservação
O campo de System.History é o único campo que usa esse tipo de dados.Você não pode definir um campo personalizado usando esse tipo de dados.
HTML A captura de suporte de dados de rico- texto e é usada para uma mais descrições longas de texto como uma descrição do artigo de trabalho.
Integer Especifica um valor de número inteiro de 32 bits com sinal.
PlainText Oferece suporte a entrada de uma cadeia de caracteres de texto que pode conter mais de 255 caracteres Unicode.
String Oferece suporte a entrada de uma cadeia de caracteres de texto que pode conter até 255 caracteres Unicode.Use uma propriedade de cadeia de caracteres para um rótulo ou outra cadeia de caracteres de texto até que uma linha de tempo.
TreePath
Especifica um campo que exibe entradas em um ou hierárquica a estrutura de árvore, como o que é necessário para exibir os caminhos da área e de iteração para um produto.Para definir nós filho, consulte Criar e modificar áreas e iterações.
ObservaçãoObservação
Os campos de System.AreaPath e de System.IterationPath são os únicos campos que usam esse tipo de dados.Você não pode definir um campo personalizado usando esse tipo de dados.

syncnamechanges

Opcional.Especifica se o campo de item de trabalho é usado para armazenar nomes que você deseja ser atualizado como as alterações são feitas no Active Directory ou em um grupo de trabalho.Essa opção é válido somente quando type="String".O tipo do atributo é xs:boolean.

Especificar true para habilitar a sincronização para o campo de dados, especifique false para desativar a sincronização para o campo de dados.

reportable

Opcional.Especifica se os dados do campo estão disponíveis para a inclusão nos relatórios.Os campos com o valor padrão de None não são exportados a data warehouse relacional ou processados para o cubo do analysis de SQL Server .Para obter mais informações sobre campos reportáveis, consulte Adicionar e modificar campos de item de trabalho para dar suporte a relatórios.

ObservaçãoObservação
Os campos em coleções diferentes de projeto que têm o mesmo valor para reportingrefname devem ser atribuídos o mesmo valor para reportable.Se os valores diferem de dados, conflitos podem ocorrer quando a data warehouse é processada.Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse.

A tabela a seguir lista os valores válidos para este atributo:

Value Uso
Detail Pode ser especificado para campos de DateTime, do tipo double, inteiro, ou de tipo cadeia de caracteres. Os dados neste campo são movidos no banco de dados relacional de depósito nas tabelas de item de trabalho e de item de trabalho atual mas não no cubo do analysis.Este tipo é uma boa opção para ilimitados campos de texto como você pode usá-los nos relatórios sem fazer o cubo significativamente maior.
Dimension Pode ser especificado para campos de DateTime, do tipo double, inteiro, ou de tipo cadeia de caracteres. Os dados neste campo no banco de dados relacional de armazenamento e o cubo do analysis como um atributo de dimensão de item de trabalho de forma que os dados podem ser usados para filtrar relatórios.Use esse tipo para os campos que possuem listas de valores válidos.Trabalhar o tipo de item e o estado é bons exemplos de uma dimensão.
Measure Use o tipo de medida somente para o inteiro e dobre campos.As medidas são os valores numéricos em seus relatórios.Quando o cubo do analysis é processado, os dados são precalculated nos campos cujos os atributos de reportable são definidos para abranger.Por exemplo, os grupos de medidas de item de trabalho e de item de trabalho atual contêm dados cumulativos para os campos seguintes: Avaliação horário original, outros, e hora concluídas.Quando você especifica a medida, você deve especificar o atributo de formula .
None Especificar None quando você não deseja usar o campo para a inclusão nos relatórios.Esta é a atribuição padrão.

formula

Opcional.O tipo de agregação para o tipo reportável de measure .O único valor válido é sum, que retorna a soma de todos os valores no conjunto.

reportingname

Opcional.Especifica o nome que aparece nos relatórios.Se você não especificar um valor, o valor que é atribuído ao atributo de name é usado.

ObservaçãoObservação
Os campos em coleções diferentes de projeto que têm o mesmo reportingrefname devem ser atribuídos o mesmo valor para reportingname.Se os valores diferem de dados, conflitos podem ocorrer quando a data warehouse é processada.Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse.

O tipo do atributo é typelib:FieldName.Comprimento mínimo: 1; comprimento máximo: 128.

O valor padrão: ^ ^ [\.\[\]]+$

Exemplo do valor de padrão: Atribuído a

reportingrefname

Opcional.Especifica o nome da referência que é usado quando um campo reportável é processado.Se você não especificar um valor, o valor que é atribuído ao atributo de refname é usado.

Você pode usar esse atributo à mesclagem ou divergir os campos que são processados como a data warehouse.Para mesclar dois campos que têm nomes distintos de referência e que são definidos em coleções diferentes do projeto, você atribui mesmo reportingrefname a ambas.Para divergir dois campos que têm o mesmo nome de referência mas que é definido em coleções diferentes do projeto, você atribui reportingrefname diferente para cada campo.

Você deve mesclar campos sempre que possível minimizar o número de campos no depósito e manter no limite máximo de 1024 campos reportáveis.Você pode gerar relatórios de grupo cruzado com campos mesclados.

O tipo do atributo é typelib:ReferenceFieldName.Comprimento mínimo: 1; comprimento máximo: 70.

O valor padrão: a-zA-Z_ ^ [] [] a-zA-Z0-9_ * (\. [] a-zA-Z0-9_ +) +$

Exemplo do valor de padrão: Company.IssueType

Elementos filho

Elemento

Descrição

ALLOWEDVALUES

Opcional.Define uma lista de valores permitidos para o campo.Os valores permitidos são os valores que estão disponíveis para a seleção em uma lista de campos em formulários de item de trabalho e no construtor de consultas.Você deve selecionar um desses valores.

ALLOWEXISTINGVALUE

Opcional.Define o campo para permitir valores existentes.Este elemento permite os valores de campo que já existem para ser usados, mesmo se não são válidos.Todos os novos valores de campo deve ser válido.

CANNOTLOSEVALUE

Opcional.Define o campo como não pode perder o valor.Esse elemento mantém o valor do campo atual e não pode ser desmarcado ou feito vazia.

COPIAR

Opcional.Especifica outro campo que contém um valor a ser copiado para o campo atual.

PADRÃO

Opcional.Define um valor padrão para o campo.

VAZIO

Opcional.Define o campo como vazia.

CONGELADO

Opcional.Define o campo como congelado.Um campo congelado não pode ser alterado a nenhum valor não vazio após alterações são confirmadas.No entanto, você pode manualmente limpar o campo, para salvar o item de trabalho para, e então especifique um valor diferente.

HELPTEXT

Opcional.Define o texto exibido em dica de ferramenta para o campo.

CORRESPONDÊNCIA

Opcional.Define um padrão do campo que o valor do campo deve coincidir.

NOTSAMEAS

Opcional.Especifica outro campo, o valor que não pode ser idêntico ao valor do campo atual.

PROHIBITEDVALUES

Opcional.Define uma lista de valores proibidos para o campo.

DE LEITURA APENAS

Opcional.Define o campo como somente leitura.

EXIGIDO

Opcional.Define o campo conforme necessário.

SERVERDEFAULT

Opcional.Especifica um componente de servidor que fornece o valor para o campo.

SUGGESTEDVALUES

Opcional.Define uma lista de valores sugeridos para o campo.Os valores sugeridos são os valores que estão disponíveis para a seleção em uma lista de campos em formulários de item de trabalho e no construtor de consultas.Você pode incorporar outros valores além a esse na lista.

VALIDUSER

Opcional.Especifica que a lista de valores permitidos deve consistir somente nos usuários válidos do sistema.

QUANDO

Opcional.Especifica zero ou mais regras para aplicar ao campo atual quando outro campo tem um valor específico.

WHENCHANGED

Opcional.Aplica uma ou mais regras para o campo atual quando o valor de um campo específico é alterado.

WHENNOT

Opcional.Aplica uma ou mais regras para o campo atual quando outro campo não tem um valor específico.

WHENNOTCHANGED

Opcional.Aplica uma ou mais regras para o campo atual quando o valor de um campo particular não é alterado.

Elementos pai

Elemento

Descrição

CAMPOS

Obrigatório.Contém as definições de campo de tipo de item de trabalho.

Comentários

definiçãoFIELD () é um elemento filho necessário definição de FIELDS ().

minOccurs= " 1 "

Você não pode definir mais de 1.024 campos de item de trabalho na mesma coleção de projeto de equipe, e você não pode definir mais de 1.024 a reportável campos em todas as coleções de projeto de equipe.Para obter mais informações, consulte Adicionar e modificar campos de item de trabalho para dar suporte a relatórios.

ObservaçãoObservação

Quando você adiciona um campo existente a um tipo diferente de item de trabalho, os valores atuais para os atributos reportáveis são usados.

Requisitos para e restrições adicionais em campo nomes amigáveis e nomes de referência, consulte As convenções de nomenclatura para objetos de rastreamento de Item de trabalho.Para obter informações sobre como os campos de rótulo para relatar propósitos, consulte Adicionar e modificar campos de item de trabalho para dar suporte a relatórios.

Você não pode definir um campo personalizado que começa com o prefixo de System.Você pode definir um campo usando o prefixo de Microsoft. , no entanto, esta é altamente recomendável desanimada como pode impedir a funcionalidade de Team Foundation Server .

Para obter uma visão geral do objeto de acompanhamento de item de trabalho de campo, consulte Trabalhando com campos de Item de trabalho.

Para obter uma visão geral de todo o sistema e campos predefinidos que são definidos para soluções Framework (MSF) Microsoft para o modelo de programação processo de desenvolvimento de software agile v5.0, consulte Referência de campos de item de trabalho para o Visual Studio ALM.

Os nomes de referência de campo não podem ser renomeados.Você pode listar campos, para renomear o nome amigável de campo, e atributos de campo de alteração usando a ferramenta de linha de comando witadmin .Para obter mais informações, consulte Gerenciar campos de item de trabalho [witadmin].

Para obter informações sobre como os campos são usados por meio de coleções de projeto de equipe, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse e Adicionar e modificar campos de item de trabalho para dar suporte a relatórios.

Exemplo

<FIELD name="Activity" refname="Microsoft.VSTS.Common.Activity" type="String" reportable="dimension">
   <HELPTEXT>Type of work involved</HELPTEXT>
   <SUGGESTEDVALUES>
      <LISTITEM value="Development"/>
      <LISTITEM value="Testing"/>
      <LISTITEM value="Requirements"/>
      <LISTITEM value="Design"/>
      <LISTITEM value="Deployment"/>
      <LISTITEM value="Documentation"/>
   </SUGGESTEDVALUES>
</FIELD>

Consulte também

Referência

Gerenciar campos de item de trabalho [witadmin]

Conceitos

As convenções de nomenclatura para objetos de rastreamento de Item de trabalho

Referência de campos de item de trabalho para o Visual Studio ALM

Personalizar dados de acompanhamento de projeto, formulários, fluxo de trabalho e outros objetos

Trabalhando com campos de Item de trabalho

Outros recursos

Índice para definições de elementos XML para tipos de item de trabalho