Referencia de elemento FIELD (Definición)

Puede usar el elemento FIELD (Definition) para definir un campo de elemento de trabajo y especificar las reglas y condiciones que se aplican a él. Los atributos que asigna a un campo determinan su tipo de datos y si está disponible o no para incluirse en informes.

Nota

Para obtener información acerca del elemento FIELD (Workflow), que usa para especificar reglas y condiciones para los campos durante un cambio de estado o transición de flujo de trabajo, consulte FIELD (Workflow) (Elemento).

Jerarquía del esquema

WITD

   WORKITEMTYPE

      FIELDS

            FIELD

<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 y elementos

En las siguientes secciones se describen los atributos, los elementos secundarios y los elementos primarios.

Atributos

Atributo	Descripción
name	Requerido. Nombre descriptivo del campo que aparece en los menús desplegables de las consultas de elementos de trabajo. El nombre descriptivo debe ser único en todos los campos definidos en un proyecto de equipo. Además, dicho nombre puede ser distinto de la etiqueta que aparece junto al campo en el formulario de elemento de trabajo. Para obtener más información, consulta Referencia del elemento Control de XML. El tipo de atributo es typelib:FieldName. Longitud mínima: 1; longitud máxima: 128. Valor de patrón: ^[^\. \[\]]+$ Ejemplo de un valor de patrón: Asignado a
refname	Requerido. La etiqueta única que distingue un campo de todos los demás campos definidos en la colección de proyectos de equipo. Para conocer los requisitos y restricciones adicionales de los nombres descriptivos y los nombres de referencia, consulte Convenciones de nomenclatura para objetos de seguimiento de elementos de trabajo. El tipo de atributo es typelib:ReferenceFieldName. Longitud mínima: 1; longitud máxima: 70. Valor de modelo: ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$ Ejemplo de un valor de patrón: Company.IssueType
type	Requerido. Especifica el tipo de datos que acepta el campo. Nota Los campos de colecciones de proyectos diferentes que tienen el mismo reportingrefname deben tener asignado el mismo valor para type.Si los valores son distintos, se pueden producir conflictos de datos al procesar el almacén de datos.Para obtener más información, consulta Resolver los conflictos del esquema que se producen en el almacén de datos. En la tabla siguiente se enumeran los valores válidos de este atributo: Valor Uso DateTime Especifica una fecha según la Hora universal coordinada (Hora UTC). Double Especifica un valor de coma flotante. GUID Especifica un campo que contendrá un identificador único. History Admite hilos de discusión y realiza un seguimiento de otra información histórica. Nota El campo System.History es el único campo que utiliza este tipo de datos.No puede definir ningún campo personalizado utilizando este tipo de datos. HTML Admite la captura de datos de texto enriquecido y se usa para descripciones de texto más largas, tales como una descripción de elemento de trabajo. Integer Especifica un valor entero de 32 bits con signo. PlainText Admite la entrada de una cadena de texto con más de 255 caracteres Unicode. String Admite la entrada de una cadena de texto hasta 255 caracteres Unicode. Utilice un campo String para una etiqueta u otra cadena de texto corta hasta una línea de longitud. TreePath Especifica un campo que muestra las entradas con una estructura jerárquica o de árbol, tales como los requisitos para mostrar rutas de acceso de área e iteración para un producto. Para definir nodos secundarios, consulte Agregar y modificar rutas de acceso de área e iteración. Nota Los campos System.AreaPath y System.IterationPath son los únicos campos que utilizan este tipo de datos.No puede definir ningún campo personalizado utilizando este tipo de datos.
syncnamechanges	Opcional. Especifica si el campo de elemento de trabajo se usa para almacenar nombres que desea que se actualicen al realizarse modificaciones en Active Directory o en un grupo de trabajo. Esta opción solo es válida cuando type="String". El tipo de atributo es xs:boolean. Especifique true para habilitar la sincronización para el campo de datos o false para deshabilitarla.
reportable	Opcional. Especifica si los datos del campo están disponibles para incluirse en los informes. Los campos cuyo valor predeterminado es None no se exportan al almacén de datos relacional ni se procesan para el cubo de SQL Server Analysis Services. Para obtener más información sobre los campos susceptibles de incluirse en informes, consulte Agregar o modificar campos de elementos de trabajo para admitir la creación de informes. Nota Los campos de colecciones de proyectos diferentes que tienen el mismo valor para reportingrefname deben tener asignado el mismo valor para reportable.Si los valores son distintos, se pueden producir conflictos de datos al procesar el almacén de datos.Para obtener más información, consulta Resolver los conflictos del esquema que se producen en el almacén de datos. En la tabla siguiente se enumeran los valores válidos de este atributo: Value Uso Detail Puede especificarse para los campos de tipo DateTime, Double, Integer o String. Los datos de este campo se mueven a la base de datos relacional del almacén de datos en las tablas de elementos de trabajo y del elemento de trabajo actual, pero no en el cubo de Analysis Services. Este tipo es una buena opción para los campos de texto sin restricciones, ya que puede usarlos en los informes sin que el cubo aumente de tamaño de manera significativa. Dimension Puede especificarse para los campos de tipo DateTime, Integer, String o TreePath. Los datos de este campo se incorporan a la base de datos relacional del almacén de datos y al cubo de Analysis Services como un atributo de dimensión de elemento de trabajo, de modo que los datos se puedan utilizar para filtrar los informes. Utilice este tipo para campos que tengan listas de valores válidos. El tipo de elemento de trabajo y el estado son buenos ejemplos dimensiones. Measure Use el tipo de medida solo para los campos de tipo Integer y Double. Las medidas son los valores numéricos de los informes. Al procesar el cubo de Analysis Services, los datos se calculan previamente en los campos cuyos atributos reportable están establecidos en Measure. Por ejemplo, los grupos de medida de elementos de trabajo y del elemento de trabajo actual contienen datos acumulados para los siguientes campos: Estimación original, Horas restantes y Horas completadas. Cuando se especifique la medida, debe especificar el atributo formula. None Especifique None si no desea usar el campo para incluirlo en los informes. Esta es la asignación predeterminada.
formula	Opcional. El tipo de agregación para el tipo measure para informes. El único valor válido es sum, que devuelve la suma de todos los valores del conjunto.
reportingname	Opcional. Especifica el nombre que aparece en los informes. Si no especifica un valor, se usa el valor asignado al atributo name. Nota Los campos de colecciones de proyectos diferentes que tienen el mismo reportingrefname deben tener asignado el mismo valor para reportingname.Si los valores son distintos, se pueden producir conflictos de datos al procesar el almacén de datos.Para obtener más información, consulta Resolver los conflictos del esquema que se producen en el almacén de datos. El tipo de atributo es typelib:FieldName. Longitud mínima: 1; longitud máxima: 128. Valor de patrón: ^[^\. \[\]]+$ Ejemplo de un valor de patrón: Asignado a
reportingrefname	Opcional. Especifica el nombre de referencia que se usa al procesar un campo para informes. Si no especifica un valor, se usa el valor asignado al atributo refname. Puede usar este atributo para combinar o diferenciar los campos que se procesan para el almacén de datos. Para combinar dos campos que tienen nombres de referencia distintos y están definidos en colecciones de proyectos diferentes, asigne el mismo valor de reportingrefname a ambos. Para distinguir dos campos con el mismo nombre de referencia pero que están definidos en colecciones de proyectos diferentes, asigne un valor de reportingrefname diferente a cada campo. Siempre que sea posible, deberá combinar los campos para minimizar el número de campos del almacén de datos y para mantener los campos para informes dentro del límite máximo, que es de 1024. Puede generar informes entre grupos con campos combinados. El tipo de atributo es typelib:ReferenceFieldName. Longitud mínima: 1; longitud máxima: 70. Valor de modelo: ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$ Ejemplo de un valor de patrón: Company.IssueType

Elementos secundarios

Elemento	Descripción
ALLOWEDVALUES	Opcional. Define una lista de valores permitidos para el campo. Los valores permitidos son valores disponibles para seleccionarlos en una lista de campos en los formularios de elementos de trabajo y en el generador de consultas. Debe seleccionar uno de estos valores.
ALLOWEXISTINGVALUE	Opcional. Define el campo de modo que permita los valores existentes. Este elemento permite usar los valores de campo que ya existen, incluso si no son válidos. Todos los valores de campo nuevos deben ser válidos.
CANNOTLOSEVALUE	Opcional. Define el campo de modo que no pueda perder su valor. Este elemento mantiene el valor de campo actual y no se puede borrar o dejar vacío.
COPY	Opcional. Especifica otro campo que contiene un valor que se va a copiar en el campo actual.
DEFAULT	Opcional. Define un valor predeterminado para el campo.
EMPTY	Opcional. Define el campo como vacío.
FROZEN	Opcional. Define el campo como inmovilizado. Un campo inmovilizado no puede cambiarse a un valor no vacío después de confirmar los cambios. Sin embargo, se puede borrar manualmente el campo, guardar el elemento de trabajo y, a continuación, especificar un valor diferente.
HELPTEXT	Opcional. Define el texto mostrado en la información sobre herramientas del campo.
MATCH	Opcional. Define un patrón para el campo con el que debe coincidir el valor del campo.
NOTSAMEAS	Opcional. Especifica otro campo cuyo valor no puede ser idéntico al valor del campo actual.
PROHIBITEDVALUES	Opcional. Define una lista de valores prohibidos para el campo.
READONLY	Opcional. Define el campo como de solo lectura.
REQUIRED	Opcional. Define el campo como obligatorio.
SERVERDEFAULT	Opcional. Especifica un componente del servidor que proporcionará el valor para el campo.
SUGGESTEDVALUES	Opcional. Define una lista de valores sugeridos para el campo. Los valores sugeridos son los valores que están disponibles para seleccionarlos en una lista de campos en los formularios de elementos de trabajo y en el generador de consultas. Además de los valores que figuran en la lista, puede agregar otros.
VALIDUSER	Opcional. Especifica que la lista de valores permitidos debe incluir solo los usuarios válidos del sistema.
WHEN	Opcional. Especifica una o más reglas que se aplicarán al campo actual cuando otro campo tenga un valor concreto.
WHENCHANGED	Opcional. Aplica una o más reglas al campo actual cuando se cambia el valor de un campo concreto.
WHENNOT	Opcional. Aplica una o más reglas al campo actual cuando otro campo no tiene un valor concreto.
WHENNOTCHANGED	Opcional. Aplica una o más reglas al campo actual cuando no se cambia el valor de un campo concreto.

Elementos primarios

Elemento	Descripción
FIELDS	Requerido. Contiene las definiciones del campo de tipo de elemento de trabajo.

Comentarios

1. FIELD (Definition) es un elemento secundario necesario de FIELDS (Definition).

2. Para obtener información general de todo el sistema y de los campos predefinidos para las plantillas de proceso de TFS, consulte Referencia de campos de elementos de trabajo para Visual Studio ALM.

3. No se puede definir un campo personalizado que empiece por el prefijo System.. Puede definir un campo mediante el prefijo Microsoft.; sin embargo, esta práctica no es recomendable porque podría impedir la funcionalidad de Team Foundation Server.

   Para conocer los requisitos y restricciones adicionales de los nombres descriptivos de campos y los nombres de referencia, consulte Convenciones de nomenclatura para objetos de seguimiento de elementos de trabajo.

4. Aunque puede cambiar el nombre descriptivo de un campo, no puede cambiar los nombres de referencia del campo. Puede enumerar los campos y cambiar varios atributos de campo usando la herramienta de línea de comandos de witadmin. Consulte Administrar campos de elementos de trabajo [witadmin].

5. No se pueden definir más de 1024 campos de elemento de trabajo en la misma colección de proyectos de equipo y no se pueden establecer más de 1024 campos como susceptibles de informe en todas las colecciones de proyectos de equipo.

   Todos los campos definidos dentro de todos los tipos de elementos de trabajo (WIT) para todos los proyectos de equipo definidos para una colección de proyectos de equipo. Por lo tanto, los atributos que asigne a los campos definidos en un WIT deben coincidir en todos los WIT de todos los proyectos de equipo de una colección. Además, todos los campos susceptibles de informe de todas las colecciones se exportan a las bases de datos del almacén de datos.

6. Para obtener información sobre cómo etiquetar los campos para los informes, consulte Agregar o modificar campos de elementos de trabajo para admitir la creación de informes.

7. Cuando agregue un campo existente a otro WIT, establezca de forma explícita los atributos de informes para que sean iguales que la definición de campo actual o deje que se apliquen los valores predeterminados.

   Se pueden producir conflictos de esquema si se asignan diferentes atributos de informes al mismo campo en distintos WIT o en los mismos WIT de distintos proyectos de equipo. Para solucionar estos conflictos, consulte Resolver los conflictos del esquema que se producen en el almacén de datos.

8. Para comprender cómo se usan los campos para permitir las consultas, los informes y el seguimiento de elementos de trabajo, consulte Definir campos de elementos de trabajo.

9. Para ver una descripción general sobre cómo aplicar restricciones o condiciones a un FIELD mediante elementos secundarios, consulte Aplicar reglas a un campo de elemento de trabajo.

Ejemplo

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

Vea también

Referencia

Administrar campos de elementos de trabajo [witadmin]

Conceptos

Convenciones de nomenclatura para objetos de seguimiento de elementos de trabajo

Referencia de campos de elementos de trabajo para Visual Studio ALM

Personalizar los objetos de seguimiento del trabajo para admitir los procesos de su equipo

Definir y modificar campos de elementos de trabajo

Otros recursos

Seguimiento de elementos de trabajo: Índice de definiciones de elementos XML