Compartir a través de


Enumerar campos y atributos de elementos de trabajo

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

Los campos de elemento de trabajo se usan para realizar un seguimiento de la información dentro de Azure DevOps. Estos campos se definen en el nivel de organización y se comparten entre todos los proyectos de la organización. Para revisar los campos definidos para su organización, puede usar una de las dos herramientas siguientes, disponibles para los modelos de proceso heredados y XML hospedados:

Los campos de elemento de trabajo se usan para realizar un seguimiento de la información dentro de Azure DevOps. Estos campos se definen en el nivel de colección y se comparten entre todos los proyectos de esa colección. Para revisar los campos definidos para la colección, use una de las siguientes herramientas:

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

Requisitos previos

Permisos: para ver los campos definidos para una organización o colección, sea miembro del grupo de aplicaciones Usuarios válidos de la colección de proyectos o tenga el permiso Ver información de nivel de instancia establecido en Permitir para la organización o la colección.

Enumeración o revisión de campos

Para enumerar o revisar campos, use una de las siguientes herramientas basadas en el modelo de proceso: Heredado, XML hospedado o XML local. Para ver un índice de campos definidos dentro de los procesos predeterminados, consulte Índice de campos de elementos de trabajo.

Herramienta Herencia XML hospedado XML local
Portal web: Enumeración de campos heredados y definidos por el usuario ✔️ ✔️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 incluidos en los elementos de trabajo de ese tipo. Cada campo tiene varios atributos, muchos de los cuales están definidos por el sistema e inmutables.

Los campos se definen mediante los tres atributos siguientes:

  • Tipo de datos: indica el tipo de datos que se pueden escribir en el campo, como Boolean, Double, Integer, HTML o String. Para obtener descripciones detalladas de cada tipo de datos, consulte Campos de consulta, operadores y macros.
  • Nombre descriptivo: el nombre descriptivo asignado al campo, que se usa al seleccionar un campo en una cláusula de consulta. Este nombre puede diferir del nombre que se muestra en el formulario del elemento de trabajo.
  • Nombre de referencia: identificador que se usa al crear consultas WIQL, plantillas de elementos de trabajo improvisadas, ejecutar comandos de LA API REST o definir definiciones de tipo de elemento de trabajo XML. El nombre de referencia es permanente y no se puede cambiar una vez establecido.

Para obtener una descripción detallada de cada atributo de campo e instrucciones sobre cómo enumerarlos, consulte Atributos de campo y Atributos de campo de lista más adelante en este artículo. Para obtener información general sobre los tipos de elementos de trabajo (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 campos?

Cada tipo de elemento de trabajo incluye 31 campos del sistema y varios campos específicos del tipo. Los elementos de trabajo se usan para planear y realizar un seguimiento del proyecto.

Cada campo captura información específica sobre el trabajo que se va a realizar. Los valores que asigna a estos campos se almacenan en el almacén de datos de seguimiento de trabajo, lo que le permite crear consultas que determinan el estado y las tendencias.

Para obtener descripciones y uso de cada campo definido para los procesos principales del sistema (Agile, Basic, Scrum y CMMI), consulte el índice del campo 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 adhieren a las siguientes directrices:

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

Dado que los campos personalizados se definen en el nivel de organización o colección, no se puede agregar un campo personalizado con el mismo nombre a varios procesos.

Para más información, consulte Convenciones y restricciones de nomenclatura.

Campos del sistema y predefinidos

Un nombre de campo de elemento de trabajo identifica de forma única cada campo dentro de Azure DevOps. Asegúrese de que los nombres de campo cumplen las siguientes directrices:

  • Unicidad: los nombres de campo deben ser únicos dentro de una cuenta o colección de proyectos.
  • Longitud: los nombres de campo deben tener 128 caracteres Unicode o menos.
  • Espaciado: los nombres de campo no pueden tener espacios iniciales o finales ni contener varios espacios consecutivos.
  • Composición: los nombres de campo deben incluir al menos un carácter alfabético.
  • Caracteres prohibidos: los nombres de campo no pueden incluir los siguientes caracteres: .,;':~/*|?" &%$!+=()[]{}<>'.

Dado que los campos personalizados se definen en el nivel de organización o colección, no se puede agregar un campo personalizado con el mismo nombre a varios procesos.

Para más información, consulte Convenciones y restricciones de nomenclatura.

Campos personalizados

Dado que los campos personalizados se definen en el nivel de organización o colección de proyectos, no se puede agregar un campo personalizado con el mismo nombre a varios procesos.

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

  • Número máximo de campos por tipo de elemento de trabajo (WIT): 64
  • Campos máximos por proceso: 512

El tipo de datos de campo determina el tipo y el tamaño de los datos que se pueden almacenar en el campo. Cada campo solo puede tener un tipo definido dentro de una colección de proyectos, lo que fomenta el uso de campos comunes en diferentes proyectos y tipos de elementos de trabajo.

Al agregar un campo personalizado a un proceso heredado, Azure DevOps asigna un nombre de referencia prefijo con custom seguido del nombre de campo sin espacios. Por ejemplo, agregar un campo denominado DevOps Triage da como resultado el nombre de referencia Custom.DevOpsTriage. No se permiten espacios en nombres de referencia.

Para más información, consulte Convenciones y restricciones de nomenclatura.

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

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

Captura de pantalla de configuración de la organización, página Proceso, Campos.

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.

Captura de pantalla de configuración de la colección, página Proceso, Campos.

Si la colección de proyectos usa el modelo de proceso XML local, puede determinar el tipo de datos a través del índice de campo Elemento de trabajo. También puede:

  • Abra el Explorador de campos de elemento de trabajo para revisar los campos definidos y sus atributos.
  • Use el comando witadmin listfields para enumerar los atributos de campo.

Para obtener más información, consulte Explorador de campos de elementos de trabajo y Enumeración de atributos de campo más adelante en este artículo.

Lista de campos de revisión

Para revisar la lista de campos definidos para una organización o colección, siga estos pasos:

  1. Seleccione el logotipo de Azure DevOps para abrir Proyectos. Luego, elija Configuración de la organización.

    Captura de pantalla de selección de Configuración de la organización.

  2. Seleccione Procesar.

    Captura de pantalla de selección del proceso.

  3. Seleccione Campos.

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

    Captura de pantalla de la realización de una copia de un proceso heredado seleccionado.

    Nota:

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

    Para obtener descripciones, uso y nombres de referencia de cada campo, consulte el índice del campo Elemento de trabajo. Además, puede recuperar nombres de referencia de campo mediante la API REST Tipos de elemento de trabajo : lista.

Explorador de campos de elemento de trabajo

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

Captura de pantalla del Explorador de campos de elementos de trabajo.

Para acceder al Explorador de campos de elemento de trabajo, instale la herramienta Editor de procesos. En función de la versión instalada de Visual Studio, obtenga la herramienta Editor de procesos de una de las siguientes extensiones.

  • Visual Studio 2019 y 2022: a partir de ahora, no hay ninguna extensión específica del Editor de plantillas de proceso disponible. Sin embargo, todavía puede personalizar plantillas de proceso mediante otras herramientas, como cualquier editor de texto o editor XML. También puede usar el portal web de Azure DevOps para determinadas personalizaciones, especialmente para los procesos heredados.
  • Visual Studio 2017: Editor de plantillas de proceso de TFS. También puede usar esta versión del Editor de procesos para modificar los formularios de elementos de trabajo de estilo antiguo. No se puede usar para editar formularios asociados a los nuevos formularios web.
  • Visual Studio 2015: Herramientas avanzadas de TFS.

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 recupera a través de la API REST Fields - Get o los ven a través de la herramienta Explorador de campos de elemento de trabajo (WIFE).

Los atributos asignados a un campo dependen de la plataforma y la versión que usa. Por ejemplo, algunos atributos no se admiten con el proceso de herencia. Para buscar el nombre de referencia de un campo, vea el índice del campo Elemento de trabajo.

Atributo

Tipo de atributo

Descripción


REST:
WIFE: 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).
¿Se puede cambiar?= Sí

REST: canSortBy
WIFE: CanSortBy

boolean

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

REST: description
WIFE: 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.
¿Se puede cambiar?= Sí

REST:
WIFE: ID

Entero

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

REST:
WIFE: 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.
¿Se puede cambiar?= No

REST:
WIFE: 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 Id., Fecha de revisión, Fecha de cambio y Recuento de vínculos externos.
¿Se puede cambiar?= No

REST:
WIFE: IsCoreField

boolean

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

REST:
WIFE: IsEditable

boolean

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

REST: isIdentity
WIFE: 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.
¿Se puede cambiar?= No

REST:
WIFE: IsIndexed1

boolean

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

REST:
WIFE: IsLongText

boolean

Indica que el campo puede contener más de 255 caracteres, como campos a los que se ha asignado un tipo de datos de PlainText, HTML o Historial.
¿Se puede cambiar?= No

REST: isPicklist2 WIFE:

Booleano

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

REST: isPicklistSuggested2 WIFE:

Booleano

Indica si el campo permite a los usuarios especificar sus propios valores para una lista desplegable. El valor se establece en True cuando se define un campo personalizado para Azure DevOps o se selecciona un tipo Picklist (String) o Picklist (Integer) y la casilla Permitir a los usuarios establecer sus propios valores está activada.
¿Se puede cambiar?= Sí

REST: isQueryable
WIFE: IsQueryable

boolean

Indica si el campo aparece dentro del conjunto de campos que puede agregar para filtrar una consulta de elementos de trabajo (True), o no (False). La mayoría de los campos se pueden consultar.
¿Se puede cambiar?= No

REST:
WIFE: IsReportable 3

boolean

Indica si el atributo reportable se define o se establece en cualquier otro valor distinto de None. Este atributo se puede cambiar en entornos locales.
¿Se puede cambiar?= Sí

REST:
WIFE: IsUsedInGlobalWorkflow

boolean

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

REST:
WIFE: IsUserNameField

boolean

Indica si el campo se usa para mostrar un campo Identidad.
¿Se puede cambiar?= No

REST: name
WIFE: Name

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.
¿Se puede cambiar?= Solo en el entorno local

REST: picklistId
WIFE: HelpText

GUID

Si el campo es una lista desplegable, el identificador de la lista desplegable 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.
¿Se puede cambiar?= No

REST:
WIFE: ProhibitedValues

collection

Obtiene la colección de valores prohibidos para un campo que especifica estos valores. Solo puede definir valores prohibidos para implementaciones locales.
¿Se puede cambiar?= Solo en el entorno local

REST: readOnly
WIFE:

Booleano

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

REST: referenceName
WIFE: ReferenceName

string

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

REST:
WIFE: ReportingAttributes3

Especifica Detail, Dimension o Measure, según si quiere que el campo se incluya en los informes y cómo quiere hacerlo. Los datos de campos que tienen un valor distinto de None para este atributo se exportan al almacén de datos y se pueden incluir en informes de SQL.
¿Se puede cambiar?= Solo en el entorno local

REST:
WIFE: ReportingName3

string

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

REST:
WIFE: ReportingReferenceName3

string

Especifica un nombre de referencia diferente para un campo que se usa cuando los datos se exporten al almacén de datos relacional. Si no especifica un valor, se usa el nombre de referencia de los campos.
¿Se puede cambiar?= Solo en el entorno local

REST: supportedOperations
WIFE:

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.
¿Se puede cambiar?= No

REST:
WIFE: SupportsTextQuery

boolean

Indica si el campo admite consultas de texto, como Contiene palabras, No contiene palabras.
¿Se puede cambiar?= No

REST:
WIFE: SystemType

string

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

REST: type
WIFE: FieldType

string

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

REST: usage
WIFE: Usage

string

Especifica si el campo está destinado a usarse con elementos de trabajo (WorkItem) u objetos 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, consulte Obtención de campos: FieldUsage.
¿Se puede cambiar?= No

Nota:

  1. En las implementaciones locales, puede habilitar la indexación de un campo para mejorar los tiempos de respuesta de las consultas al filtrar por dicho campo. Para más información, consulte 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 en Azure DevOps Server 2019 y versiones posteriores. Para obtener 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 hayan 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 en las que los proyectos están configurados para admitir SQL Server Reporting y SQL Server Analysis Services. Para obtener más información, consulte Adición de informes a un proyecto.

Para obtener descripciones de cada atributo que se puede notificar, consulte Agregar o modificar campos de elementos de trabajo para admitir informes.

Para ver una lista de campos con atributos notificables definidos de forma predeterminada, consulte Referencia de campos que se pueden notificar.

Campos indizados

Use el comando witadmin indexfield para habilitar o deshabilitar la indexación de un campo de elemento de trabajo. Habilitar la indexación para un campo puede mejorar el rendimiento de las consultas que especifican ese campo. De forma predeterminada, se indexan los siguientes campos:

  • Asignado a
  • Fecha de creación
  • Modificado por
  • Valor
  • Motivo
  • Id. de área
  • Id. de iteración
  • Tipo de elemento de trabajo

Si agrega un campo personalizado que se usa con frecuencia en las consultas de elementos de trabajo, considere la posibilidad de habilitar la indexación para ese campo. Para más información, consulte Administración de campos de elementos de trabajo [witadmin].

Enumeración de atributos de campo

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

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

Por ejemplo, para enumerar los atributos de la ruta de acceso de iteración, use el nombre System.IterationPath de referencia para la fabrikam organización:

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

**Returned data:**

> [!div class="tabbedCodeSnippets"]
> ```JSON
> {
> "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 en OrganizationName. Para empezar a usar REST, consulte Referencia de la API REST de Azure DevOps Services.

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 y se especifica el nombre de referencia, System.IterationPath, del servidor de 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 la herramienta de línea de comandos witadmin

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

Por ejemplo, puede especificar 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 en el que se usa el campo.

Adición y modificación de campos

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

Puede agregar o modificar los campos contenidos en un tipo de elemento de trabajo o agregar uno personalizado. Para más información, vea:

Además, puede cambiar el nombre del campo, el índice y los atributos de informe de cualquier campo, salvo los del sistema, con la herramienta de línea de comandos witadmin. Para más información, consulte Administración de campos de elementos de trabajo (witadmin).