Compartilhar via

Todas as referências de elementos XML FIELD

  • Artigo

Use este tópico para procurar a sintaxe de FIELD elemento ou um de seus elementos filho.

Você especifica esses elementos no FIELD recipiente do elemento (definição). Adicionar um campo de um tipo de item de trabalho (WIT), especificando uma FIELD elemento (definição) dentro do FIELDS elemento (definição). Você pode especificar esses elementos dentro da definição de um WIT ou como parte de um fluxo de trabalho global.

Você pode adicionar elementos filho para especificar o comportamento de um campo, definir valores padrão ou definir uma lista de opções de valores. Você pode usar elementos de regra de campo em combinação com o outro. Você pode definir o escopo a maioria das regras para aplicar a um ou mais usuários ou grupos ou a serem ignorados para um ou mais usuários ou grupos.

Elemento de contêiner FIELD (definição)

Use a seguinte sintaxe para definir os campos de dados para um tipo de item de trabalho. Este exemplo mostra o formato do FIELD elemento (definição) e todos os elementos filho opcionais. Para obter mais informações, consulte Referência de elemento FIELD (definição).

<FIELD name="fieldDisplayName" refname="fieldReferenceName" type="String | Integer | Double | DateTime | PlainText | HTML | History | TreePath | GUID "
syncnamechanges="true | false" reportingname="reportingDisplayName" reportingrefname="reportingReferenceName"
reportable="Dimension | Detail | Measure" formula="avg" >
   <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>

Elementos filho de campo

Use elementos filho para definir várias restrições sobre quais dados podem ser inseridos em um campo. Você pode especificar valores para uma lista de opções (menu suspenso), definir valores padrão, limpar entradas ou restringir as alterações. A tabela a seguir fornece a estrutura de sintaxe para cada elemento filho.

Para saber como usar esses elementos, consulte Aplicar uma regra a um campo do item de trabalho. Existem restrições sobre como aplicar a maioria das regras a campos do sistema. Todos os elementos filho são opcionais.

Elemento

Descrição e sintaxe

ALLOWEDVALUES

Define uma lista de valores que os usuários podem especificar em uma lista de campos nos formulários de itens de trabalho e no editor de consultas. Os usuários devem especificar um dos valores listado.

<ALLOWEDVALUES for="userGroupName" not="userGroupName" 
expanditems="true | false" filteritems="excludegroups">
   <GLOBALLIST name="globalListName">
      <LISTITEM value="Name" />
. . . 
   </GLOBALLIST>
</ALLOWEDVALUES>

Para obter mais informações, consulte Definir listas de opções.

ALLOWEXISTINGVALUE

Especifica que um campo pode reter um valor existente, mesmo que ele não tem uma lista de opções. Todos os novos valores de campo devem estar na lista.

<ALLOWEXISTINGVALUE />

Para obter mais informações, consulte Definir listas de opções.

CANNOTLOSEVALUE

Especifica que os usuários não é possível limpar um campo de todos os valores depois que um valor foi especificado. Depois que o campo contiver um valor, esse campo sempre deve conter um valor não nulo.

<CANNOTLOSEVALUE for="userGroupName" not="userGroupName" />

Para obter mais informações, consulte aplicar uma regra de campo.

COPY

Copia um valor especificado para um campo quando um usuário cria ou modifica um item de trabalho.

<COPY for="userGroupName" not="userGroupName"  
from="value | field | clock | currentuser" 
value="valueToCopy" field="fieldReferenceName" />

Para obter mais informações, consulte Definir um valor padrão ou copiar um valor para um campo.

DEFAULT

Especifica um valor para um campo está vazio quando um usuário cria ou modifica um item de trabalho. Se um campo já tiver um valor, a regra padrão será ignorada.

<DEFAULT for="userGroupName" not="userGroupName" 
from="value | field | clock | currentuser" 
value="value to copy" field="field reference name" />

Para obter mais informações, consulte Definir um valor padrão ou copiar um valor para um campo.

EMPTY

Limpa o campo de qualquer valor que ele contém. O EMPTY regra também faz um campo somente leitura e você não deve ser usar com o READONLY regra.

O valor do campo é limpo quando um usuário salva o item de trabalho, e você não pode especificar qualquer valor. Essa regra é usada principalmente durante a transição de estado para limpar os campos que se aplicam ao estado no qual o item está em transição.

<EMPTY for="userGroupName" not=" userGroupName" />

Para obter mais informações, consulte aplicar uma regra de campo.

FROZEN

Especifica que você não pode alterar o campo para um valor não vazio depois que as alterações são confirmadas. Assim que um usuário salva o item de trabalho com um valor nesse campo, o valor não pode ser modificado.

<FROZEN for="userGroupName" not="userGroupName" />

Para obter mais informações, consulte aplicar uma regra de campo.

HELPTEXT

Define o texto a ser exibido quando um usuário aponta para o campo no formulário de item de trabalho.

tooltipText: uma cadeia de caracteres de texto que contenha entre 1 e 255 caracteres.

<HELPTEXT>tooltipText </HELPTEXT>

Para obter mais informações, consulte aplicar uma regra de campo.

MATCH

Define um padrão de valores dos campos de tipo de cadeia de caracteres devem corresponder.

<MATCH pattern="patternValue" for="userGroupName" not="userGroupName" />

Para obter mais informações, consulte Aplicar correspondência de padrões a um campo de cadeia de caracteres.

NOTSAMEAS

Especifica que um campo não recebe o mesmo valor atribuído ao qual outro campo especificado. O valor de field atributo deve ser um nome de um campo de referência válido.

<NOTSAMEAS field="fieldReferenceName" for="userGroupName" not="userGroupName" />

Para obter mais informações, consulte aplicar uma regra de campo.

PROHIBITEDVALUES

Define uma lista de valores que não pode conter um campo. Os usuários não é possível salvar um item de trabalho se o campo contiver um valor proibido.

<PROHIBITEDVALUES for="userGroupName" not="userGroupName" 
expanditems="true | false" filteritems="excludegroups">
   <GLOBALLIST name="globalListName">
      <LISTITEM value="Name" />
. . . 
   </GLOBALLIST>
</PROHIBITEDVALUES>

Para obter mais informações, consulte Definir listas de opções.

READONLY

Especifica que você não pode modificar o valor para o qual o campo é atribuído.

<READONLY for="userGroupName" not="userGroupName" />

Dica

Não use esse elemento junto com o EMPTY elemento porque EMPTY também faz um campo somente leitura.Se você combinar esses elementos, os resultados serão inconsistentes.

Para obter mais informações, consulte aplicar uma regra de campo.

REQUIRED

Especifica que os usuários devem especificar um valor para o campo. Campos obrigatórios não podem estar vazios. Os usuários não é possível salvar um item de trabalho até terem sido atribuídos valores para todos os campos obrigatórios.

<REQUIRED for="userGroupName" not="userGroupName" />

Para obter mais informações, consulte aplicar uma regra de campo.

SERVERDEFAULT

Copia um valor de servidor especificado para um campo quando um usuário salva um item de trabalho. Normalmente, esses campos aparecem como somente leitura no formulário.

<SERVERDEFAULT for="userGroupName" not="userGroupName" 
from="clock | currentuser" />

Para obter mais informações, consulte Definir um valor padrão ou copiar um valor para um campo.

SUGGESTEDVALUES

Define uma lista de sugestões de valores que os usuários podem especificar em uma lista de campos nos formulários de itens de trabalho e no editor de consultas. Os usuários podem especificar valores diferentes daqueles que você sugerir.

<SUGGESTEDVALUES for="userGroupName" not="userGroupName" 
expanditems="true | false" filteritems="excludegroups">
   <GLOBALLIST name="globalListName">
      <LISTITEM value="Name" />
. . . 
   </GLOBALLIST>    
</SUGGESTEDVALUES>

Para obter mais informações, consulte Definir listas de opções.

VALIDUSER

Impede que os itens de trabalho está sendo modificado por usuários que pertencem ao grupo especificado. O grupo padrão é o Team Foundation grupo de usuários válidos.

Todos os atributos são opcionais. Todos os atributos devem ter uma cadeia de caracteres de texto que contenha entre 1 e 255 caracteres. Você pode usar tokens para especificar grupos.

< VALIDUSER group="groupName" for="userName" not="userName" />

Para obter mais informações, consulte aplicar uma regra de campo.

WHEN

Especifica uma ou mais regras para aplicar ao campo atual quando outro campo tem um valor específico. O pai FIELD elemento define o campo atual.

<WHEN field="fieldReferenceName" value="value">
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>
</WHEN>

Para obter mais informações, consulte Atribuir regras e valores baseados em condicionais

WHENNOT

Especifica uma ou mais regras para aplicar ao campo atual quando outro campo não tem um valor específico. O pai FIELD elemento define o campo atual.

<WHENNOT field="fieldReferenceName" value="value">
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>
</WHENNOT>

Para obter mais informações, consulte Atribuir regras e valores baseados em condicionais.

WHENCHANGED

Especifica uma ou mais regras para aplicar ao campo atual quando outro campo é alterado durante a revisão do item de trabalho. O pai FIELD elemento define o campo atual.

<WHENCHANGED field="fieldReferenceName" >
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>      
</WHENCHANGED>

Para obter mais informações, consulte Atribuir regras e valores baseados em condicionais.

WHENNOTCHANGED

Especifica uma ou mais regras para aplicar ao campo atual quando outro campo não é alterado durante a revisão do item de trabalho. O elemento pai define o campo atual.

<WHENNOTCHANGED field="fieldReferenceName">
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>
</WHENNOTCHANGED>

Para obter mais informações, consulte Atribuir regras e valores baseados em condicionais.

Elementos filho GLOBALLIST e LISTITEM

Especificar o GLOBALLIST e LISTITEM elementos como elementos filhos do ALLOWEDVALUES, SUGGESTEDVALUES, e PROHIBITEDVALUES elementos. Você pode usar esses elementos para enumerar uma lista de valores é exibida. Os usuários selecionar valores de uma lista de opções ou um menu suspenso. Para obter mais informações, consulte Definir listas globais.

Elemento

Descrição

GLOBALIST

Define um conjunto de LISTITEM coleção de elementos que são armazenados por uma equipe de projeto e que todos os projetos em uma coleção de equipe pode usar.

<GLOBALLIST name="globalListName">
    <LISTITEM> . . . </LISTITEM>
</GLOBALLIST>

globalListName: uma sequência de caracteres de texto que contém entre 1 e 255 caracteres.

GLOBALLIST é um elemento filho obrigatório do elemento GLOBALLISTS e um elemento filho opcional dos elementos ALLOWEDVALUES, SUGGESTEDVALUES e PROHIBITEDVALUES. Você pode definir uma lista global dentro de uma definição de item de trabalho, uma definição de lista global ou um fluxo de trabalho global.

LISTITEM

Define um valor de lista válido.

<LISTITEM value="listName" />

LISTITEM é um elemento filho obrigatório de GLOBALLIST e um elemento filho opcional dos elementos ALLOWEDVALUES, SUGGESTEDVALUES e PROHIBITEDVALUES.

Atributos especificados pelos elementos filho de campo

Você pode qualificar mais FIELD regras para aplicar ou não a um conjunto de grupos ou usuários, incluindo o for ou not atributos. Para obter mais informações, consulte aplicar uma regra de campo.

Atributo

Sintaxe

Descrição

expanditems

expanditems = "true | False"

Opcional. Especifica se um grupo que o LISTITEM elemento deve ser expandida para incluir grupos subordinados na lista. O valor padrão desse atributo é true.

filteritems

filteritems = "excludegroups"

Opcional. Especifica que somente os membros de grupos e nomes de grupo, estão incluídos na lista. O único valor permitido para este atributo é excludegroups.

for

for = "userGroupName"

Opcional. Especifica o nome de um usuário ou grupo no Team Foundation aos quais a regra se aplica. Os valores válidos consistem em uma cadeia de caracteres de texto que contenha entre 1 e 255 caracteres.

not

não = "userGroupName"

Opcional. Especifica o nome de um usuário ou grupo no Team Foundation para quem a regra não se aplica. Os valores válidos consistem em uma cadeia de caracteres de texto que contenha entre 1 e 255 caracteres.

from

From = "valor | campo | relógio | CurrentUser"

Obrigatório. Especifica a origem do valor do qual você deseja copiar um valor ou especificar um valor padrão. Os seguintes valores são válidos:

  • clock: Copia a data atual e a hora do relógio do sistema para campos de data e hora. Não há atributos adicionais são necessários. Para COPY e DEFAULT de regras, esse valor é proveniente de hora do computador local. Para SERVERDEFAULT, o valor vem do relógio do servidor quando um usuário salva o item de trabalho.

  • currentuser: Copia o nome do usuário que está conectado no momento. Use o nome curto do usuário do usuário atual como o valor. Não há atributos adicionais são necessários. Usado para campos de cadeia de caracteres.

  • field: Copia o valor do field atributo que você especificar. Requer um field="abc" atributo. Por padrão, se especificado "de" campo estiver vazio, nada é executado. O field atributo é usado somente para cópia de < > e < padrão > regras.

  • value: Copia o valor do value atributo que você especificar. Use o valor de uma constante de cadeia de caracteres que você especificar. Requer um value="abc" atributo. valueé usado somente para cópia de < > e < padrão > regras.

Se você especificar "valor" ou "campo", você também deve incluir o atributo de valor ou campo, respectivamente.

field

campo = "fieldReferenceName"

Opcional. Especifica o nome do campo cujo valor deve ser copiado para o campo quando field for especificado para o from atributo.

pattern

padrão = "patternValue"

Obrigatório. Impõe padrões básicos correspondentes apenas cadeias de caracteres. patternValue é uma cadeia de caracteres que consiste em entre 1 e 255 caracteres, inclusivas. Essa cadeia de caracteres não deve conter um caractere de barra invertida (\). Cada caractere na cadeia de caracteres é interpretada como um literal, a menos que é um dos seguintes seis metacaracteres:

  • "A" ou "a" representam um único caractere alfabético.

  • "N" ou "n" representa um único caractere numérico.

  • "X" ou "x" representa um único caractere alfanumérico.

Valor do padrão: ^ [^ \ \] * $

Por exemplo, pattern="xxxxx.nn.nn" corresponde a cinco caracteres alfanuméricos, depois de um período depois de dois caracteres numéricos, em seguida, um ponto e mais dois caracteres numéricos.

value

valor = "valueToCopy"

Opcional. Especifica o valor a ser copiado para o campo quando value for especificado para o from atributo.

Consulte também

Conceitos

Definir e modificar campos do item de trabalho

Alterar o fluxo de trabalho de um tipo de item de trabalho