Todas as referências de elementos do campo XML

Artigo
03/12/2013

Você pode usar as informações contidas neste tópico como uma referência rápida para todos os elementos e atributos principais que definem um campo de dados para um tipo de item de trabalho.Você especifica esses elementos no contêiner do elemento de definição FIELD ().Você adiciona um campo para um tipo de item de trabalho especificando um elemento de definição FIELD () no elemento de definição FIELDS ().Você pode especificar esses elementos dentro da definição de um tipo de item de trabalho ou como parte de um fluxo de trabalho global.Você pode criar elementos filho que este tópico descreve para especificar o comportamento de um campo, para definir valores padrão, ou para definir uma lista de opções de valores.Você pode usar os elementos da regra de campo em combinação com se.Você pode definir o escopo a maioria das regras para aplicar a um ou vários usuários ou grupos ou ser ignorada para um ou vários usuários ou grupos.

Todos os elementos filho do elemento de FIELD são opcionais.Exceto para o elemento de HELPTEXT , você pode especificar todos os elementos como elementos filhos dos elementos de FIELD (), FIELD definição de trabalho (), e FIELD de trabalho globais ().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.Você especificar regras para um elemento de FIELD fluxo de trabalho () para definir o valor ou para aplicar regras a um campo como um item de trabalho faz a transição de um estado para outro.Você pode especificar regras do campo com base em STATE, em TRANSITION, em DEFAULTREASON, ou elemento de REASON de que o elemento de CAMPOS do pai é um filho.Para obter mais informações, consulte Trabalhando com campos de Item de trabalho e Criar o fluxo de trabalho.

Neste tópico

Elemento contêiner de CAMPO (definição)
Elementos filho de CAMPO
Elementos filho de GLOBALLIST e de LISTITEM
Atributos especificados por elementos filho de CAMPO

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

Você usa a seguinte sintaxe para definir os campos de dados para um tipo de item de trabalho.Este exemplo mostra o formato de elemento de FIELD (definição) e de quaisquer elementos-filho opcionais.Para obter mais informações, consulte 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

A tabela a seguir descreve os elementos filhos que você pode especificar para aplicar regras para atribuir um valor a um campo.Todos os elementos filho são opcionais.Você pode definir o escopo a maioria dos elementos filho para aplicar apenas a um único grupo ou para todos exceto para usuários em um único grupo.

Elemento	Descrição e sintaxe
ALLOWEDVALUES	Define uma lista de valores que os usuários podem especificar em uma lista de campos em formulários de item de trabalho e no editor de consulta.Os usuários devem especificar um dos valores que você lista. `<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 manter um valor existente, mesmo se ele já não em 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 podem claro um campo de todos os valores depois que um valor foi especificado.Depois que o campo contém um valor, esse campo sempre deve conter um valor não-nulo. `<CANNOTLOSEVALUE for="userGroupName" not="userGroupName" />` Para obter mais informações, consulte Definir condições em um campo de item de trabalho.
COPY	Copia um valor especificado em um campo quando um usuário cria ou modificar 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 que seja vazio quando um usuário cria ou modificar um item de trabalho.Se um campo já tem 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.A regra de EMPTY também torna um campo somente leitura, e você não deve ser ele uso com a regra de READONLY . O valor do campo é desmarcado quando um usuário salvar o item de trabalho, e você não pode especificar qualquer valor.Essa regra é usada primariamente durante a transição de estado para limpar os campos que se aplicam ao estado em que o item é fazer a transição. `<EMPTY for="userGroupName" not=" userGroupName" />` Para obter mais informações, consulte Definir condições em um campo de item de trabalho.
FROZEN	Especifica que você não pode alterar o campo como um valor que não seja vazio após alterações são confirmadas.Assim que o usuário salvar o item de trabalho com um valor no campo, o valor não pode mais ser modificado. `<FROZEN for="userGroupName" not="userGroupName" />` Para obter mais informações, consulte Definir condições em um campo de item de trabalho.
HELPTEXT	Define o texto para aparecer quando os pontos de um usuário para o campo no item de trabalho windows. tooltipText: Uma cadeia de caracteres de texto que contém entre 1 e 255 caracteres. `<HELPTEXT>tooltipText </HELPTEXT>` Para obter mais informações, consulte Definir o texto da Ajuda para um campo de item de trabalho.
MATCH	Define um padrão que os valores de campos de tipo cadeia de caracteres devem corresponder. `<MATCH pattern="patternValue" for="userGroupName" not="userGroupName" />` Para obter mais informações, consulte Fazer a correspondência de um campo de cadeia de caracteres com um padrão.
NOTSAMEAS	Especifica que um campo não é atribuído o mesmo valor que a de outro campo especificado é atribuído.O valor do atributo de field deve ser um nome válido de referência de um campo. `<NOTSAMEAS field="fieldReferenceName" for="userGroupName" not="userGroupName" />` Para obter mais informações, consulte Definir condições em um campo de item de trabalho.
PROHIBITEDVALUES	Define uma lista de valores que um campo não pode conter.Os usuários não podem salvar um item de trabalho se o campo contém 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 alterar o valor que o campo é atribuído. `<READONLY for="userGroupName" not="userGroupName" />` Observação Não use esse elemento em conjunto com o elemento de EMPTY porque EMPTY também torna um campo somente leitura.Se você combina esses elementos, os resultados serão inconsistentes. Para obter mais informações, consulte Definir condições em um campo de item de trabalho.
REQUIRED	Especifica que os usuários devem especificar um valor para o campo.Os campos necessários não podem estar vazios.Os usuários não podem salvar um item de trabalho até que atribuam valores para todos os campos necessários. `<REQUIRED for="userGroupName" not="userGroupName" />` Para obter mais informações, consulte Definir condições em um campo de item de trabalho.
SERVERDEFAULT	Copia um valor especificado do servidor para um campo quando um usuário salva um item de trabalho.Esses campos geralmente 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 valores sugerida que os usuários podem especificar em uma lista de campos em formulários de item de trabalho e no editor de consulta.Os usuários podem especificar valores diferentes de aqueles que você sugere. `<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	Restringe itens de trabalho de alteração por usuários que pertencem ao grupo que você especificar.O grupo padrão é o grupo de usuários válidos de Team Foundation . Todos os atributos são opcionais.Todos os atributos devem consistir de uma cadeia de caracteres de texto que contém entre 1 e 255 caracteres.Você pode usar tokens para especificar grupos.Para obter mais informações, consulte Usar tokens para fazer referência a usuários e grupos. `< VALIDUSER group="groupName" for="userName" not="userName" />` Para obter mais informações, consulte Gerenciar permissão para criar ou modificar itens de trabalho.
WHEN	Especifica zero ou mais regras para aplicar ao campo atual quando outro campo tem um valor específico.O elemento de FIELD do pai 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 zero ou mais regras para aplicar ao campo atual quando outro campo não tem um valor específico.O elemento de FIELD do pai 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 zero ou mais regras para aplicar ao campo atual quando outro campo é alterado durante a revisão de item de trabalho.O elemento de FIELD do pai 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 zero ou mais regras para aplicar ao campo atual quando outro campo não é alterado durante a revisão de 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 de GLOBALLIST e de LISTITEM

A tabela a seguir descreve os elementos de GLOBALLIST e de LISTITEM .Você especifica esses elementos como elementos filhos de ALLOWEDVALUES, de SUGGESTEDVALUES, e elementos de PROHIBITEDVALUES .Você pode usar esses elementos para enumerar uma lista de valores que aparece como uma lista de opções ou um menu drop-down de itens que um usuário pode especificar.Para obter mais informações, consulte Definir listas de usuários, listas de opções e listas globais.

Elemento	Sintaxe	Descrição
GLOBALIST	`<GLOBALLIST name="globalListName "> <LISTITEM> . . . </LISTITEM> </GLOBALLIST>`	Define um conjunto de elementos de LISTITEM que sejam armazenados para uma coleção de projeto de equipe e que todos os projetos de equipe de uma coleção pode usar. globalListName: Uma cadeia de caracteres de texto que contém entre 1 e 255 caracteres. GLOBALLIST é necessário um elemento filho do elemento de GLOBALLISTS e um elemento filho opcional de ALLOWEDVALUES, de SUGGESTEDVALUES, e elementos de PROHIBITEDVALUES .Você pode definir uma lista global em uma definição de item de trabalho, de uma definição global da lista, ou fluxo de trabalho global.
LISTITEM	`<LISTITEM value="listName" />`	Define um valor válido da lista. LISTITEM é um filho de GLOBALLIST necessário e um elemento filho opcional de ALLOWEDVALUES, de SUGGESTEDVALUES, e elementos de PROHIBITEDVALUES .

Elemento

Sintaxe

Descrição

GLOBALIST

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

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

globalListName: Uma cadeia de caracteres de texto que contém entre 1 e 255 caracteres.

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

LISTITEM

<LISTITEM value="listName" />

Define um valor válido da lista.

LISTITEM é um filho de GLOBALLIST necessário e um elemento filho opcional de ALLOWEDVALUES, de SUGGESTEDVALUES, e elementos de PROHIBITEDVALUES .

De volta ao topo

Atributos especificados por elementos filho de CAMPO

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

Atributo	Sintaxe	Descrição
expanditems	o expanditems= " true \| false”	Opcional.Especifica se um grupo que o elemento de LISTITEM identifica deve ser expandido 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 não do 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 de um grupo na Team Foundation que as regras se aplicam.Os valores válidos consistem em uma cadeia de caracteres de texto que contém entre 1 e 255 caracteres.
not	not= "userGroupName”	Opcional.Especifica o nome de um usuário ou de um grupo na Team Foundation que a regra não se aplica.Os valores válidos consistem em uma cadeia de caracteres de texto que contém entre 1 e 255 caracteres.
from	valor de from= " \| campo \| relógio \| currentuser”	Obrigatório.Especifica a fonte do valor do qual deseja copiar um valor ou para especificar um valor padrão.Os seguintes valores são válidas: clock: Copia a data e a hora do relógio do sistema DateTime para posicionar. Nenhum atributo adicional é necessário.Para COPY e regras de DEFAULT , esse valor vem da hora do computador local.Para SERVERDEFAULT, o valor do relógio do servidor quando um usuário salvar o item de trabalho. currentuser: Copia o nome do usuário que está atualmente conectado.Use o nome de usuário curto do usuário atual como o valor.Nenhum atributo adicional é necessário.Usado para campos de cadeia de caracteres. field: Copia o valor do atributo de field que você especificar.Requer um atributo de field="abc" .Por padrão, se especificado “” do campo está vazia, nada é executado.O atributo de field é usado somente para <COPY> e regras de <DEFAULT> . value: Copia o valor do atributo de value que você especificar.Use o valor de uma constante de cadeia de caracteres que você especificar.Requer um atributo de value="abc" .value é usado somente para <COPY> e regras de <DEFAULT> . Se você especificar o “valor” ou “inserir”, você também deve incluir o valor ou o atributo de campo, respectivamente.
field	field= "fieldReferenceName”	Opcional.Especifica o nome do campo cujo valor deve ser copiado para o campo field quando é especificado para o atributo de from .
pattern	pattern= "patternValue”	Obrigatório.Aplica a correspondência de padrão básica para cadeias de caracteres somente.patternValue é uma cadeia de caracteres que consiste entre 1 e 255 caracteres, inclusive.Essa cadeia de caracteres não deve conter um caractere de barra invertida (\).Cada caractere na cadeia de caracteres é interpretado como um literal, a menos que seja um dos seguintes seis metacaracteres: “A” ou “a” representa um único caractere alfabético. “Em” ou “em” representa um único caractere numérico. “X” ou “x” representa um único caractere alfanumérico. Valor de padrão: ^ [\ de ^ \ *$] Por exemplo, corresponde pattern="xxxxx.nn.nn" todos os cinco caracteres alfanuméricos, em um período, em dois caracteres numéricos, em um período, então mais dois caracteres numéricos.
value	value= "valueToCopy”	Opcional.Especifica o valor a ser copiado para o campo value quando é especificado para o atributo de from .

De volta ao topo

Consulte também

Conceitos

Definir listas de usuários, listas de opções e listas globais

Trabalhando com campos de Item de trabalho

Criar o fluxo de trabalho

Share via