Compartir a través de

Referencias de todos los elementos FIELD de XML

  • Artículo

Use este tema para buscar la sintaxis del elemento FIELD o uno de sus elementos secundarios

Estos elementos se especifican en el contenedor del elemento FIELD (definición). Se añade un campo para un tipo de elemento de trabajo (WIT) especificando un elemento FIELD (definición) dentro del elemento FIELDS (definición). Puede especificar estos elementos dentro de la definición de un WIT o como parte de un flujo de trabajo global.

Puede agregar elementos segundarios para especificar el comportamiento de un campo, definir valores predeterminados o definir una lista de selección de valores. Puede usar elementos de reglas de campo combinados entre sí. Puede definir el ámbito de la mayoría de las reglas para que se apliquen a uno o varios usuarios o grupos o para que uno o varios usuarios o grupos las ignoren.

Elemento contenedor de FIELD (definición)

La siguiente sintaxis se usa para definir los campos de datos de un tipo de elemento de trabajo. En este ejemplo se muestra el formato del elemento FIELD (definición) y todos los elementos secundarios opcionales. Para obtener más información, vea Referencia de elemento FIELD (Definición).

<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 secundarios FIELD

Use elementos secundarios para establecer diversas restricciones sobre qué datos pueden introducirse en un campo. Puede establecer los valores de una lista de selección (menú desplegable), establecer los valores predeterminados, borrar entradas o restringir los cambios. La siguiente tabla proporciona la estructura de sintaxis para cada elemento secundario.

Para obtener información sobre cómo usar estos elementos, vea Aplicar una regla a un campo de elemento de trabajo. Existen restricciones sobre la aplicación de la mayoría de las reglas a los campos del sistema. Todos los elementos secundarios son opcionales.

Elemento

Descripción y sintaxis

ALLOWEDVALUES

Define una lista de valores que pueden especificar los usuarios en una lista de campos en los formularios de elementos de trabajo y en el editor de consultas. Los usuarios deben especificar uno de los valores que usted haya incluido en la lista.

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

Para obtener más información, vea el tema sobre Definir listas de selección.

ALLOWEXISTINGVALUE

Especifica que un campo puede retener un valor existente, incluso si ya no está en una lista de selección. Todos los valores de campo nuevos deben estar en la lista.

<ALLOWEXISTINGVALUE />

Para obtener más información, vea el tema sobre Definir listas de selección.

CANNOTLOSEVALUE

Especifica que los usuarios no pueden borrar un campo de todos los valores después de que se haya especificado un valor. Desde el momento en el que el campo contenga un valor, ese campo deberá contener siempre un valor que no sea NULL.

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

Para obtener más información, consulte Aplicar una regla de campo.

COPY

Copia un valor especificado a un campo cuando un usuario crea o modifica un elemento de trabajo.

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

Para obtener más información, vea el tema sobre Definir valores predeterminados o copiar valores en un campo.

DEFAULT

Especifica un valor para un campo que está vacío cuando un usuario crea o modifica un elemento de trabajo. Si un campo ya tiene un valor, se ignora la regla predeterminada.

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

Para obtener más información, vea el tema sobre Definir valores predeterminados o copiar valores en un campo.

EMPTY

Borra el campo de cualquier valor que contenga. La regla EMPTY también hace un campo de solo lectura. No debería usarse con la regla READONLY.

El valor del campo se borra cuando un usuario guarda el elemento de trabajo. Además, usted no podrá especificar ningún valor. Esta regla se usa principalmente durante la transición de estado para borrar los campos que se aplican al estado al que está pasando el elemento.

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

Para obtener más información, consulte Aplicar una regla de campo.

FROZEN

Especifica que no se puede cambiar el campo a un valor no vacío después de confirmar los cambios. En cuanto un usuario guarda el elemento de trabajo con un valor en ese campo, el valor ya no se puede modificar.

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

Para obtener más información, consulte Aplicar una regla de campo.

HELPTEXT

Define el texto que se muestra cuando un usuario coloca el puntero sobre el campo en el formulario de elemento de trabajo.

tooltipText: cadena de texto que contiene entre 1 y 255 caracteres.

<HELPTEXT>tooltipText </HELPTEXT>

Para obtener más información, consulte Aplicar una regla de campo.

MATCH

Define un patrón con el que deben coincidir los valores de los campos de tipo cadena.

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

Para obtener más información, vea Aplicar la coincidencia de patrones a un campo de cadena.

NOTSAMEAS

Especifica que no se le asigne a un campo el mismo valor que se le ha asignado a otro campo especificado. El valor del atributo field debe ser un nombre de referencia válido de un campo.

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

Para obtener más información, consulte Aplicar una regla de campo.

PROHIBITEDVALUES

Define una lista de valores que no puede contener un campo. Los usuarios no pueden guardar un elemento de trabajo si el campo contiene un valor prohibido.

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

Para obtener más información, vea el tema sobre Definir listas de selección.

READONLY

Especifica que no se puede modificar el valor al que se asigna el campo.

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

Nota

No use este elemento junto con el elemento EMPTY, ya que EMPTY también hace que un campo sea de solo lectura.Si combina estos elementos, los resultados serán incoherentes.

Para obtener más información, consulte Aplicar una regla de campo.

REQUIRED

Especifica que los usuarios deben especificar un valor para el campo. Los campos obligatorios no pueden estar vacíos. Los usuarios no pueden guardar un elemento de trabajo hasta que tengan valores asignados en todos los campos requeridos.

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

Para obtener más información, consulte Aplicar una regla de campo.

SERVERDEFAULT

Copia un valor de servidor especificado en un campo cuando un usuario guarda un elemento de trabajo. Estos campos suelen aparecer como de solo lectura en el formulario.

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

Para obtener más información, vea el tema sobre Definir valores predeterminados o copiar valores en un campo.

SUGGESTEDVALUES

Define una lista de valores sugeridos que pueden especificar los usuarios en una lista de campos en los formularios de elementos de trabajo y en el editor de consultas. Los usuarios pueden especificar valores distintos a los que usted sugiera.

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

Para obtener más información, vea el tema sobre Definir listas de selección.

VALIDUSER

Impide que los usuarios que pertenezcan al grupo que usted especifique modifiquen elementos de trabajo. El grupo predeterminado es el grupo de Usuarios válidos de Team Foundation.

Todos los atributos son opcionales. Todos los atributos deben constar de una cadena de texto que contenga entre 1 y 255 caracteres. Puede usar tokens para especificar grupos.

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

Para obtener más información, consulte Aplicar una regla de campo.

WHEN

Especifica una o más reglas que se aplicarán al campo actual cuando otro campo tenga un valor concreto. El elemento primario FIELD define el campo actual.

<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 obtener más información, vea Asignar reglas y valores basados en condiciones.

WHENNOT

Especifica una o más reglas que se aplicarán al campo actual cuando otro campo no tenga un valor concreto. El elemento primario FIELD define el campo actual.

<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 obtener más información, vea Asignar reglas y valores basados en condiciones.

WHENCHANGED

Especifica una o varias reglas que se aplicarán al campo actual cuando se modifique otro campo durante la revisión del elemento de trabajo. El elemento primario FIELD define el campo actual.

<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 obtener más información, vea Asignar reglas y valores basados en condiciones.

WHENNOTCHANGED

Especifica una o varias reglas que se aplicarán al campo actual cuando no se modifique otro campo durante la revisión del elemento de trabajo. El elemento primario define el campo actual.

<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 obtener más información, vea Asignar reglas y valores basados en condiciones.

Elementos secundarios GLOBALLIST y LISTITEM

Usted especifica los elementos GLOBALLIST y LISTITEM como elementos secundarios de los elementos ALLOWEDVALUES, SUGGESTEDVALUES y PROHIBITEDVALUES. Puede usar estos elementos para enumerar una lista de valores que aparezca. Los usuarios seleccionan los valores de una lista de selección o un menú desplegable. Para obtener más información, vea Definir listas globales.

Elemento

Descripción

GLOBALIST

Define un conjunto de elementos LISTITEM que se almacena para una colección de proyectos de equipo y que pueden usar todos los proyectos de equipo de una colección.

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

globalListName: cadena de texto que contiene entre 1 y 255 caracteres.

GLOBALLIST es un elemento secundario necesario del elemento GLOBALLISTS y un elemento secundario opcional de los elementos ALLOWEDVALUES, SUGGESTEDVALUES y PROHIBITEDVALUES. Puede definir una lista global dentro de una definición de elemento de trabajo, una definición de lista global o un flujo de trabajo global.

LISTITEM

Define un valor de lista válido.

<LISTITEM value="listName" />

LISTITEM es un elemento secundario necesario de GLOBALLIST y un elemento secundario opcional de los elementos ALLOWEDVALUES, SUGGESTEDVALUES y PROHIBITEDVALUES.

Atributos especificados por elementos secundarios FIELD

Puede calificar la mayoría de las reglas FIELD de modo que se apliquen o no a un conjunto de grupos o usuarios. Para hacerlo, debe incluir los atributos for o not. Para obtener más información, consulte Aplicar una regla de campo.

Atributo

Sintaxis

Descripción

expanditems

expanditems="true | false"

Opcional. Especifica si un grupo identificado por el elemento LISTITEM debería expandirse para incluir grupos subordinados en la lista. El valor predeterminado de este atributo es true.

filteritems

filteritems="excludegroups"

Opcional. Especifica que solo se incluyan en la lista los miembros de grupos y no los nombres de grupos. El único valor permitido para este atributo es excludegroups.

for

for="userGroupName"

Opcional. Especifica el nombre de un usuario o grupo en Team Foundation al que se le aplica la regla. Los valores válidos constan de una cadena de texto que contenga entre 1 y 255 caracteres.

not

not="userGroupName"

Opcional. Especifica el nombre de un usuario o grupo en Team Foundation al que no se le aplica la regla. Los valores válidos constan de una cadena de texto que contenga entre 1 y 255 caracteres.

from

from="value | field | clock | currentuser"

Requerido. Especifica el origen del valor del que copiar un valor o especificar un valor predeterminado. Valores válidos son:

  • clock: copia la fecha y hora actuales del reloj del sistema en los campos DateTime. No son necesarios otros atributos. En el caso de las reglas COPY y DEFAULT este valor se obtiene a partir de la hora del reloj del equipo local. En el caso de SERVERDEFAULT el valor procede del reloj del servidor en el momento que un usuario guarda el elemento de trabajo.

  • currentuser:  copia el nombre del usuario que tiene iniciada una sesión actualmente. Use como valor el nombre de usuario corto del usuario actual. No son necesarios otros atributos. Se usa para campos de cadena.

  • field: copia el valor del atributo field que usted especifique Requiere un atributo field="abc". De manera predeterminada no se realiza nada si está vacío el campo "from" especificado. El atributo field solo se usa para las reglas <COPY> y <DEFAULT>.

  • value: copia el valor del atributo value que usted especifique Use el valor de una cadena constante que usted especifique. Requiere un atributo value="abc". value solo se usa para las reglas <COPY> y <DEFAULT>.

Si especifica "value" o "field," también debe incluir el atributo de valor o campo, respectivamente.

field

field="fieldReferenceName"

Opcional. Especifica el nombre del campo cuyo valor se copiará en el campo cuando field se especifique para el atributo from.

pattern

pattern="patternValue"

Requerido. Exige la coincidencia de patrón básico solo para cadenas. patternValue es una cadena que contiene entre 1 y 255 caracteres, ambos incluidos. Esa cadena no debe contener un carácter de barra diagonal inversa (\). Cada uno de los caracteres de la cadena se interpreta como literal, a menos que sea uno de los seis metacaracteres indicados a continuación:

  • "A" o "a" representa un carácter alfabético individual.

  • "N" o "n" representa un carácter numérico individual.

  • "X" o "x" representa un carácter alfanumérico individual.

Valor de patrón: ^[^\\]*$

Por ejemplo, pattern="xxxxx.nn.nn" concordaría con cualquier cadena formada por cinco caracteres alfanuméricos cualesquiera, seguidos por un punto, dos caracteres numéricos, otro punto y otros dos caracteres numéricos.

value

value="valueToCopy"

Opcional. Especifica el valor que se copiará en el campo cuando se especifique value para el atributo from.

Vea también

Conceptos

Definir y modificar campos de elementos de trabajo

Cambiar el flujo de trabajo de un tipo de elemento de trabajo