Campos y atributos de elementos de trabajo en Azure Boards

Azure DevOps Services | Azure DevOps Server 2022: Azure DevOps Server 2019 | TFS 2018

Los campos de elemento de trabajo se usan para realizar un seguimiento de la información. Los campos se definen para una organización y se comparten en todos los proyectos definidos para esa organización. Puede usar una de las dos herramientas para revisar los campos definidos para la organización. Estas herramientas están disponibles para los modelos de proceso XML heredados y hospedados.

Los campos de elemento de trabajo se usan para realizar un seguimiento de la información. Los campos se definen para una colección y se comparten en todos los proyectos definidos para esa colección. Puede usar una de las dos herramientas para revisar los campos definidos para la colección.

Los campos de elemento de trabajo se usan para realizar un seguimiento de la información. Los campos se definen para una colección y se comparten en todos los proyectos definidos para esa colección. Para ver todos los campos definidos para una colección, puede usar la herramienta Explorador de campos de elementos de trabajo, un complemento a Visual Studio.

Para obtener una descripción de cada campo definido con un proceso del sistema, consulte Índice de campo de elemento de trabajo.

Requisitos previos

  • Para ver los campos definidos para una organización o colección, debe ser miembro del grupo de aplicaciones Usuarios válidos de la colección de proyectos o tener el permiso Ver información de nivel de instancia establecido en Permitir para la organización o la colección.

Enumerar o revisar campos

Para enumerar o revisar campos, puede usar una de las siguientes herramientas, en función del modelo de proceso (Herencia, XML hospedado o XML local). Para obtener un índice de campos definidos dentro de los procesos predeterminados, consulte Índice de campo de elemento de trabajo.

Herramienta Herencia XML hospedado XML local
Portal web: Enumeración de campos heredados y definidos por el personalizado ✔️ ✔️1
Explorador de campos de los elementos de trabajo ✔️ ✔️ ✔️
herramienta de línea de comandos witadmin listfields ✔️ ✔️ ✔️

Nota

  1. Solo se admite para procesos predeterminados (Agile, CMMI, Scrum).

Nombres y tipos de datos de campo

Cada tipo de elemento de trabajo especifica los campos definidos para los elementos de trabajo que hacen referencia a ese tipo. Cada campo está asociado a una serie de atributos, muchos de los cuales se establecen por el sistema y no se pueden cambiar.

Cada campo se define mediante los tres atributos siguientes.

  • Tipo de datos: especifica el tipo de datos que se pueden escribir en el campo, como Boolean, Double, Integer, HTML y String. Para obtener descripciones de cada tipo de datos, vea Campos de consulta, operadores y macros.
  • Nombre descriptivo: especifica el nombre asignado al campo y que se selecciona para un campo en una cláusula de consulta. Este nombre puede diferir del nombre que se muestra en el formulario de elemento de trabajo.
  • Nombre de referencia: especifica el nombre que se usa al crear una consulta WIQL o una plantilla de elemento de trabajo improvisado, mediante comandos de LA API REST o definiendo definiciones de tipo de elemento de trabajo XML. Una vez definido, no se puede cambiar el nombre de referencia.

Para obtener una descripción de cada atributo de campo y cómo puede enumerarlos, consulte Atributos decampo y Atributos de campo de lista más adelante en este artículo. Para obtener información general sobre las WIT y los elementos de trabajo, consulte Seguimiento del trabajo con casos de usuario, problemas, errores, características y epopeyas.

¿Qué es un campo? ¿Cómo se usan los nombres de campo?

Cada tipo de elemento de trabajo está asociado a 31 campos del sistema y a varios campos más específicos del tipo. Los elementos de trabajo se usan para planear y realizar un seguimiento del proyecto.

Cada campo admite el seguimiento de un fragmento de información sobre el trabajo que se va a realizar. Los valores que se asignan a un campo se almacenan en el almacén de datos de seguimiento de trabajo que puede crear consultas para determinar el estado y las tendencias.

Para obtener descripciones y uso de cada campo definido para los procesos principales del sistema (procesos de Agile, Basic, Scrum y CMMI), consulte Índice de campos de elemento de trabajo.

Nombres de campo

Un nombre de campo de elemento de trabajo identifica exclusivamente un campo de elemento de trabajo. Asegúrese de que los nombres de campo se encuentran dentro de estas directrices:

  • Los nombres de campo deben ser únicos dentro de la colección de cuentas o proyectos.
  • Los nombres de campo deben tener 128 caracteres Unicode o menos.
  • Los nombres de campo no pueden contener espacios iniciales o finales, ni dos o más espacios consecutivos
  • Los nombres de campo deben contener al menos un carácter alfabético
  • Los nombres de campo no pueden contener los caracteres siguientes: .,;'`:~\/\*|?"&%$!+=()[]{}<>.

Dado que los campos personalizados se definen para una organización o colección, no puede agregar un campo personalizado a un proceso con el mismo nombre de campo que agregue a otro proceso.

Para obtener más información, consulte Restricciones y convenciones de nomenclatura.

Campos del sistema y predefinidos

Todos los campos definidos por el sistema tienen nombres de referencia que comienzan por System, por ejemplo, System.AreaPath, System.AssignedTo y continúan en ese patrón.

Los campos predefinidos definidos por el proceso predeterminado comienzan con Microsoft.VSTS y, a continuación, difieren en función de su uso. Los ejemplos de campos predefinidos que se usan en común, con fines de programación e integración con Office Project, para la integración con Team Foundation Build y la integración con la administración de casos de prueba (TCM) son los siguientes:

  • Microsoft.VSTS.Common.Priority
  • Microsoft.VSTS.Scheduling.DueDate
  • Microsoft.VSTS.Build.FoundIn
  • Microsoft.VSTS.TCM.Steps

Para obtener información general sobre todos los campos predefinidos y del sistema definidos para las plantillas de procesos o procesos predeterminados, consulte Índice de campo de elemento de trabajo. Para obtener más información sobre cómo especificar nombres de campo, vea Restricciones de nomenclatura.

Custom Fields

Dado que los campos personalizados se definen para una organización o colección de proyectos, no puede agregar un campo personalizado a un proceso con el mismo nombre de campo que agregue a otro proceso.

Al agregar campos personalizados, tenga en cuenta los límites siguientes:

  • Se puede definir un máximo de 64 campos para cada WIT.
  • Se puede definir un máximo de 512 campos por proceso.

El tipo de datos de campo determina el tipo y el tamaño de los datos que puede almacenar en el campo. Un campo solo puede tener un tipo definido dentro de una colección de proyectos. Ésta es una restricción que anima a las organizaciones a utilizar campos comunes para distintos proyectos y tipos de elemento de trabajo.

Al agregar un campo personalizado a un proceso heredado, Azure DevOps asigna un nombre de referencia con el prefijo Personalizado y, a continuación, el nombre del campo con espacios quitados. Por ejemplo, agrega un campo denominado DevOps Triage, el nombre de referencia es Custom.DevOpsTriage. No se permiten espacios dentro del nombre de referencia.

¿Cómo puedo determinar el tipo de datos de campo?

Para ver el tipo de datos de los campos definidos para su organización, abra la página Campos de proceso>.

Página Campos de proceso>

Cuando la colección de proyectos usa el modelo de proceso de herencia para personalizar el seguimiento del trabajo, puede ver el tipo de datos de los campos abriendo la página Campos de proceso>.

Página Campos de proceso>

Si se usa el modelo de proceso XML local, puede buscar el tipo de datos a través del índice de campo Elemento de trabajo. O bien, puede abrir el Explorador de campos de elemento de trabajo para revisar los campos definidos y sus asignaciones de atributos, o usar el comando listfields witadmin para enumerar los atributos del campo. Para obtener más información, consulte Explorador de campos de elemento de trabajo y Atributos de campo de lista más adelante en este artículo.

Puede buscar el tipo de datos a través del índice del campo Elemento de trabajo. O bien, puede abrir el Explorador de campos de elementos de trabajo para revisar los campos definidos y sus asignaciones de atributos, o bien usar el comando witadmin listfields para enumerar los atributos de campo. Para obtener más información, vea Explorador de campos de elemento de trabajo y Atributos de campo de lista más adelante en este artículo.

Página web Campos de proceso>

Para revisar la lista de campos definidos para una organización o colección, abra Campos de proceso>de configuración> de la organización.

  1. Elija el logotipo de Azure DevOps para abrir Proyectos. A continuación, elija Configuración de la organización.

    Elija Configuración de la organización.

  2. A continuación, elija Procesar.

    Elija Proceso.

    Nota

    Si no ve Proceso, está trabajando desde TFS-2018 o una versión anterior. No se admite la página Proceso . Debe usar las características admitidas para el modelo de proceso XML local.

  3. A continuación, elija Campos.

    Los campos enumerados corresponden a todos los campos definidos para la organización o colección. Esto incluye todos los campos personalizados y los definidos para los procesos del sistema.

    Realizar una copia de un proceso heredado seleccionado

    Nota

    Si no ve Fields, la colección usa el proceso XML local. La página Campos no se admite para ese proceso.

    Para obtener descripciones y uso de cada campo, así como el nombre de referencia de cada campo, puede buscarlo en el índice del campo Elemento de trabajo. También puede obtener el nombre de referencia de los campos de la API DE REST De tipos de elementos de trabajo : lista.

Explorador de campos de elemento de trabajo

Puede buscar las asignaciones de atributos de campo mediante la herramienta Explorador de campos de elementos de trabajo.

Explorador de campos de los elementos de trabajo

Para acceder al Explorador de campos de elemento de trabajo, debe instalar la herramienta Editor de procesos. En función de la versión de Visual Studio que haya instalado, obtenga la herramienta Editor de procesos de una de las siguientes extensiones.

Atributos de campo

Hay muchos atributos no modificables y ocultos para cada campo de elemento de trabajo. En la tabla siguiente se describe cada atributo. Los atributos tienen nombres diferentes en función de si los obtiene a través de la API RESTFields - Get o la vista a través de la herramienta Explorador de campos de elementos de trabajo (WIFE) y las propiedades FieldDefinition.

Los atributos asignados a un campo dependen de la plataforma y la versión que use. Por ejemplo, algunos atributos no son compatibles con el proceso de herencia. Para buscar el nombre de referencia de un campo, vea Índice de campo de elemento de trabajo.

Atributo

Tipo de atributo

Descripción


REST:
ESPOSA: AllowedValues

collection

Obtiene la colección de valores válidos para un campo que contiene valores de lista desplegable. Para cambiarlo, especifique una lista desplegable o global (local).
¿Puede cambiar?=Sí

REST: canSortBy
ESPOSA: CanSortBy

boolean

Indica si puede ordenar los resultados de la consulta con este campo.
¿Puede cambiar?=No

REST: descripción
ESPOSA: HelpText

string

Especifica una descripción para el campo, que también define el texto de ayuda que aparece al mantener el puntero sobre el campo dentro del formulario del elemento de trabajo.
¿Puede cambiar?=Sí

REST:
ESPOSA: ID.

Entero

Especifica el identificador interno del campo.
¿Puede cambiar?=No

REST:
ESPOSA: IsCloneable

boolean

Indica si el valor definido para el campo se copia cuando un usuario elige copiar un elemento de trabajo. Por ejemplo, los campos Título, Etiquetas y Descripción se copian, pero los campos Id . e Historial no se copian.
¿Puede cambiar?=No

REST:
ESPOSA: IsComputed

boolean

Indica si el sistema calcula el valor establecido por este campo (True) o no (False). Algunos ejemplos de campos calculados son aquellos establecidos por el sistema, como el identificador, la fecha revisada, la fecha modificada y el recuento de vínculos externos.
¿Puede cambiar?=No

REST:
ESPOSA: IsCoreField

boolean

Indica si este campo se especifica para todos los tipos de elementos de trabajo.
¿Puede cambiar?=No

REST:
ESPOSA: IsEditable

boolean

Indica si los usuarios pueden modificar este campo (True) o no (False). Algunos ejemplos de campos no editables son los que establece el sistema, como los campos ID, Revision, Created By y Changed By .
¿Puede cambiar?=No

REST: isIdentity
ESPOSA: IsIdentity

boolean

Indica si este campo es un campo identidad . Los campos de identidad son campos de cadena que se usan para almacenar identidades de usuario.
¿Puede cambiar?=No

REST:
ESPOSA: IsIndexed1

boolean

Indica si este campo está indexado para admitir la búsqueda.
¿Puede cambiar?=No

REST:
ESPOSA: IsLongText

boolean

Indica que el campo puede contener más de 255 caracteres, como campos asignados a un tipo de datos de Texto no cifrado, HTML o Historial.
¿Puede cambiar?=No

REST: isPicklist2 WIFE:

boolean

Indica si el campo está asociado a una lista de selección. El valor se establece en True cuando se define un campo personalizado para El tipo DevOps y Picklist (String) o Picklist (Integer) de Azure. El valor se establece en False para los campos heredados que definen listas de selección.
¿Puede cambiar?=No

REST: isPicklistSuggested2 ESPOSA:

boolean

Indica si el campo permite a los usuarios escribir sus propios valores para una lista de selección. El valor se establece en True cuando se define un campo personalizado para El tipo Azure DevOps, Picklist (String) o Picklist (Integer) está seleccionado y la casilla Permitir a los usuarios establecer sus propios valores está activada.
¿Puede cambiar?=Sí

REST: isQueryable
ESPOSA: IsQueryable

boolean

Indica si el campo se muestra dentro del conjunto de campos que puede agregar para filtrar una consulta de elemento de trabajo (True) o no (False). La mayoría de los campos son consultables.
¿Puede cambiar?=No

REST:
ESPOSA: IsReportable 3

boolean

Indica si el atributo notificable se define o se establece en algo distinto de None. Este atributo se puede cambiar para entornos locales.
¿Puede cambiar?=Sí

REST:
ESPOSA: IsUsedInGlobalWorkflow

boolean

Indica si el campo se define dentro de un flujo de trabajo global.
¿Puede cambiar?=No

REST:
ESPOSA: IsUserNameField

boolean

Indica si el campo se usa para mostrar un campo De identidad.
¿Puede cambiar?=No

REST: nombre
ESPOSA: Nombre

string

Nombre descriptivo asignado al campo. El nombre descriptivo no se puede cambiar para Azure DevOps, pero se puede cambiar para el entorno local mediante el comando changefield witadmin .
¿Solo se puede cambiar?=Local

REST: picklistId
ESPOSA: HelpText

GUID

Si el campo es una lista de selección, el identificador de la lista de selección asociada, en caso contrario, null. Se asigna un valor GUID único cuando se define un campo personalizado para Azure DevOps y el tipo Picklist (String) o Picklist (Integer) está seleccionado.
¿Puede cambiar?=No

REST:
ESPOSA: ProhibitedValues

collection

Obtiene la colección de valores prohibidos para un campo que especifica estos valores. Solo puede definir valores prohibidos para las implementaciones locales.
¿Solo se puede cambiar?=Local

REST: readOnly
ESPOSA:

boolean

Indica si el campo está establecido en solo lectura. Para Azure DevOps Services, solo se pueden cambiar los campos personalizados para que sean de solo lectura. No se pueden modificar los campos del sistema.
¿Puede cambiar?=Sí

REST: referenceName
ESPOSA: ReferenceName

string

Especifica el nombre de referencia de un campo.
¿Puede cambiar?=No

REST:
ESPOSA: ReportingAttributes3

Especifica Detalle, Dimensión o Medida, en función de si desea que el campo se incluya en los informes y cómo quiere que se incluya el campo. Los datos de campos que tienen un valor distinto de None para este atributo se exportan al almacenamiento de datos y se pueden incluir en los informes de SQL.
¿Solo se puede cambiar?=Local

REST:
ESPOSA: ReportingName3

string

Especifica la etiqueta de un campo cuando los datos aparecen en los informes de SQL. Si no especifica un valor, se usa el nombre descriptivo del campo.
¿Solo se puede cambiar?=Local

REST:
ESPOSA: ReportingReferenceName3

string

Especifica un nombre de referencia diferente a un campo que se usa cuando los datos se exportan al almacenamiento de datos relacional. Si no especifica un valor, se usa el nombre de referencia de campos.
¿Solo se puede cambiar?=Local

REST: supportedOperations
ESPOSA:

set

Conjunto de operadores de consulta que son válidos para su uso al hacer referencia a este campo. Para obtener una referencia rápida de las operaciones admitidas en función del tipo de datos, consulte Referencia rápida de consultas, Operadores y macros compatibles con cada tipo de datos.
¿Puede cambiar?=No

REST:
ESPOSA: SupportsTextQuery

boolean

Indica si el campo admite consultas de texto como Contains Words, Does Not Contains Words.
¿Puede cambiar?=No

REST:
ESPOSA: SystemType

string

Especifica el tipo de datos del campo, haciendo referencia al nombre del sistema, como System.DateTime o System.String.
¿Puede cambiar?=No

REST: tipo
ESPOSA: FieldType

string

Especifica el tipo de datos del campo, como Boolean, DateTime, Integer, String, etc. Para obtener una lista completa y descripciones, vea Campos de consulta, operadores y macros.
¿Puede cambiar?=No

REST: uso
ESPOSA: Uso

string

Especifica si el campo está pensado para usarse con objetos de vínculo de elementos de trabajo (WorkItem) o de vínculo de elemento de trabajo (WorkItemLink). El uso de la mayoría de los campos es WorkItem. Para obtener una lista completa de los valores de uso, vea Obtener campos, FieldUsage.
¿Puede cambiar?=No

Nota

  1. En el caso de las implementaciones locales, puede habilitar la indexación de un campo para mejorar los tiempos de respuesta de consulta al filtrar en el campo. Para obtener más información, vea Campos indexados más adelante en este artículo.
  2. Los atributos isPicklist y isPicklistSuggested solo se asignan a campos personalizados definidos para un proceso heredado. El modelo de proceso heredado se admite para Azure DevOps Server 2019 y versiones posteriores. Para más información, consulte Modelo de proceso heredado.
  3. Todos los atributos de informes solo son válidos para implementaciones locales cuyos proyectos se han configurado para admitir SQL Server Reporting y SQL Server Analysis Services.

Atributos para informes

Todos los atributos de informes solo son válidos para implementaciones locales cuyos proyectos se han configurado para admitir SQL Server Reporting y SQL Server Analysis Services. Para obtener más información, vea Agregar informes a un proyecto.

Para obtener una descripción de cada atributo notificable, vea Agregar o modificar campos de elementos de trabajo para admitir informes.

Para obtener una lista de campos que tienen atributos notificables definidos de forma predeterminada, vea Referencia de campos notificables.

Campos indizados

Puede habilitar o deshabilitar la indexación de un campo de elemento de trabajo mediante el comando witadmin indexfield . Al habilitar la indización para un campo, puede aumentar el rendimiento de la búsqueda de elementos de trabajo cuyas consultas especifiquen ese campo. De forma predeterminada, se indizan los campos siguientes: Asignado a, Fecha de creación, Modificado por, Estado, Motivo, Identificador de área, Id de iteración y Tipo de elemento de trabajo.

Si agrega un campo personalizado que utilice en muchas de sus consultas de elemento de trabajo, quizá desee habilitar la indización para ese campo. Para obtener más información, vea Administrar campos de elementos de trabajo (witadmin).

Atributos de campo de lista

Puede enumerar los atributos asignados a un campo mediante la API REST Fields - Get. Escriba el nombre de la organización para OrganizationName.

https://dev.azure.com/OrganizationName/_apis/wit/fields/FieldReferenceName

Por ejemplo, aquí se enumeran los atributos de la ruta de acceso de iteración, especificando el nombre de referencia, System.IterationPath, para la organización fabrikam.

https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath

Datos devueltos:

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://dev.azure.com/mseng/_apis/wit/fields/System.IterationPath"
}

Puede enumerar los atributos asignados a un campo mediante la API REST Fields - Get. Escriba el nombre de la organización para OrganizationName. Para empezar a usar REST, consulte Azure DevOps Services referencia de la API REST.

https://{ServerName:Port}/tfs/{Collection}/_apis/wit/fields/FieldReferenceName?api-version={version}

Por ejemplo, aquí se enumeran los atributos de la ruta de acceso de iteración, especificando el nombre de referencia, System.IterationPath, para el servidor fabrikam.

https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1

Datos devueltos:

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1"
}

Enumeración de atributos mediante witadmin la herramienta de línea de comandos

Puede enumerar los atributos de campo seleccionados (como el tipo de datos, los atributos que se pueden notificar y la indexación) mediante el comando witadmin listfields.

Por ejemplo, puede escribir el siguiente comando para enumerar los atributos definidos para un campo especificado, como Microsoft.VSTS.Common.Issue.

witadmin listfields /collection:http://fabrikam:8080/tfs/DefaultCollection /n:Microsoft.VSTS.Common.Issue  

Se muestra la información de campo y atributo del campo especificado, como se ve en este ejemplo.

Field: Microsoft.VSTS.Common.Issue  
Name: Issue  
Type: String  
Reportable As: dimension  
Use: Adventure Works (Shared Steps), AW Future (Shared Steps), AW Current (Shared Steps)  
Indexed: False  

El parámetro Use indica el nombre de cada proyecto y el tipo de elemento de trabajo donde se usa el campo.

Integración de proyectos y asignación de campos de proyecto

Puede cambiar cómo se asignan los campos de seguimiento de trabajo a los campos de Project y puede cambiar la forma en que se publican campos específicos. Consulte [Archivo de asignación de campos de Microsoft Project](/previous-versions/azure/devops/reference/xml/customize-project-field-mapping-file.

Agregar y modificar campos

Para agregar campos a un proceso, agréguelos a uno o varios tipos de elementos de trabajo. Para más información, consulte Personalización de un proceso de herencia.

Puede agregar o modificar los campos contenidos en un WIT o agregar un WIT personalizado. Para obtener más información, consulte:

Puede cambiar el nombre del campo, el índice y los atributos de informe de cualquier campo excepto los campos del sistema mediante la herramienta de línea de comandos witadmin . Para obtener más información, vea Administrar campos de elemento de trabajo-witadmin.

Para agregar campos a un proyecto, agréguelos a uno o varios tipos de elementos de trabajo. Consulte Agregar o modificar un campo para realizar un seguimiento del trabajo.

Puede cambiar el nombre del campo, el índice y los atributos de informe de cualquier campo excepto los campos del sistema mediante la herramienta de línea de comandos witadmin . Para obtener más información, vea Administrar campos de elemento de trabajo-witadmin.