Recensement des champs et attributs d’éléments de travail

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

Pour obtenir une description de chacun des champs définis avec un processus système, consultez Index des champs d’éléments de travail.

Pourquoi les champs d’élément de travail importent

Les champs d’élément de travail servent plusieurs fonctions critiques dans Azure DevOps :

• Suivi des données : capturer et stocker des informations essentielles sur les éléments de travail
• Fonctionnalité de requête : activer des fonctionnalités de recherche et de filtrage puissantes
• Création de rapports : Prise en charge de la création d’analyses et de tableaux de bord
• Gestion des flux de travail : Générer des transitions d’état et des règles d’entreprise
• Intégration : Se connecter à des outils et systèmes externes

Comprendre les attributs de champ vous aide à :

• Optimiser les requêtes : choisissez les champs appropriés pour les recherches efficaces
• Personnalisations de plan : Comprendre les limitations et les possibilités
• Résoudre les problèmes : Diagnostiquer les problèmes liés au comportement de champ
• Processus de conception : Créer des types d’éléments de travail efficaces et des flux de travail

Prerequisites

Recensement et passage en revue des champs

Pour répertorier ou examiner des champs, utilisez l’un des outils suivants en fonction de votre modèle de processus :Hérité, XML Hébergé ou XML Local. Pour obtenir un index des champs définis dans les processus par défaut, consultez Index des champs d’éléments de travail.

Types de données et noms des champs

Chaque type d’élément de travail spécifie les champs inclus dans les éléments de travail de ce type. Chaque champ comporte plusieurs attributs, dont la plupart sont définis par le système et sont immuables.

Trois attributs clés définissent des champs :

• Type de données : indique le type de données que vous pouvez entrer dans le champ, tel que Boolean, Double, Integer, HTML ou String. Pour obtenir une description détaillée de chaque type de données, consultez Champs, opérateurs et macros des requêtes.
• Nom convivial : Nom convivial attribué au champ, utilisé lors de la sélection d’un Champ dans une clause de requête. Il peut être différent de celui qui figure sur le formulaire d’élément de travail.
• Nom de référence : identificateur utilisé lors de la création de requêtes WIQL, de modèles d’éléments de travail, d’exécution de commandes d’API REST ou de définition de définitions de type d’élément de travail XML. Le nom de référence est permanent et ne peut pas être modifié une fois qu’il est défini.

Pour obtenir une description détaillée de chaque attribut de champ et obtenir des instructions sur leur recensement, consultez Attributs de champ et Recensement des attributs de champ plus loin dans cet article. Pour une vue d'ensemble des types d'éléments de travail (WIT) et des éléments de travail, reportez-vous à la section Suivre le travail avec les user stories, les problèmes, les bogues, les fonctionnalités et les épopées.

Définition Comment fonctionnent les noms de champs ?

Chaque type d’élément de travail inclut 31 champs système et plusieurs champs spécifiques au type. Les éléments de travail vous aident à planifier et à suivre votre projet.

Chaque champ contient des informations spécifiques sur le travail à effectuer. Les valeurs que vous attribuez à ces champs sont stockées dans le magasin de données de suivi du travail, ce qui vous permet de créer des requêtes qui déterminent le statut et les tendances.

Pour obtenir la description et connaître le contexte d’utilisation de chaque champ défini dans les grands processus système (Agile, Essentiel, Scrum et CMMI), consultez Index des champs d’éléments de travail.

Conditions d’affectation de noms de champ

Un nom de champ d'élément de travail identifie uniquement chaque champ d'élément de travail. Assurez-vous que les noms de vos champs respectent les directives suivantes :

• Unicité : Les noms des champs doivent être uniques au sein du compte ou de la collection de projets.
• Longueur : Les noms de champs doivent contenir 128 caractères Unicode maximum.
• Espacement : Les noms de champs ne peuvent pas comporter d’espaces au début ou à la fin, ni contenir deux espaces consécutifs ou plus.
• Composition : Les noms de champs doivent inclure au moins un caractère alphabétique.
• Caractères interdits : Les noms de champs ne peuvent pas inclure les caractères suivants : .,;':~/*|?"&%$!+=()[]{}<>`.

Étant donné que le système définit des champs personnalisés au niveau de l’organisation ou de la collection, vous ne pouvez pas ajouter un champ personnalisé portant le même nom à plusieurs processus.

Pour plus d’informations, consultez Restrictions de nommage et conventions d’affectation de noms.

Champs système et prédéfinis

Le système définit des champs d’élément de travail avec des exigences de nommage et de structure spécifiques pour garantir la cohérence et la fonctionnalité :

• Unicité : Les noms des champs doivent être uniques au sein d’un compte ou de la collection de projets.
• Longueur : les noms de champs doivent comporter 128 caractères Unicode maximum.
• Espacement : Les noms de champs ne peuvent pas comporter d’espaces au début ou à la fin, ni contenir plusieurs espaces consécutifs.
• Composition : Les noms de champs doivent inclure au moins un caractère alphabétique.
• Caractères interdits : Les noms de champs ne peuvent pas inclure les caractères suivants : .,;':~/*|?"&%$!+=()[]{}<>`.

Étant donné que le système définit des champs personnalisés au niveau de l’organisation ou de la collection, vous ne pouvez pas ajouter un champ personnalisé portant le même nom à plusieurs processus.

Pour plus d’informations, consultez Restrictions de nommage et conventions d’affectation de noms.

Champs personnalisés

Étant donné que le système définit des champs personnalisés au niveau de l’organisation ou de la collection de projets, vous ne pouvez pas ajouter un champ personnalisé portant le même nom à plusieurs processus.

Lorsque vous ajoutez des champs personnalisés, tenez compte des limites suivantes :

• Nombre maximal de champs par type de tâche (WIT) : 64
• Nombre maximum de champs par processus : 512

Le type de données de champ détermine le type et la taille des données que vous pouvez stocker dans le champ. Chaque champ ne peut avoir qu’un seul type défini dans une collection de projets, ce qui encourage l’utilisation de champs communs à différents projets et types d’éléments de travail.

Lorsqu’un champ personnalisé est ajouté à un processus hérité, Azure DevOps affecte un nom de référence qui commence par Custom, suivi du nom du champ sans les espaces. Si, par exemple, vous ajoutez un champ nommé DevOps Triage, le nom de référence est Custom.DevOpsTriage. Les espaces ne sont pas autorisés dans les noms de référence.

Pour plus d’informations, consultez Restrictions de nommage et conventions d’affectation de noms.

Identification du type de données du champ

Passer en revue la liste des champs

Pour consulter la liste des champs définis pour une organisation ou une collection, procédez comme suit :

1. Cliquez sur le logo Azure DevOps pour ouvrir Projets. Sélectionnez Ensuite les paramètres de l’organisation.

   

2. Sélectionnez Traiter.

   

3. Sélectionnez Champs.

   Les champs répertoriés correspondent à tous les champs définis pour l’organisation ou la collection, y compris tous les champs personnalisés et les champs définis pour les processus système.

   

   Note

   Si Champs ne s’affiche pas, cela signifie que votre collection suit le processus XML local. La page Champs n’est pas prise en charge pour ce processus.

   Pour obtenir la description, l’utilisation et les noms de référence de chaque champ, consultez l’Index des champs des éléments de travail. En outre, vous pouvez récupérer des noms de référence de champ à l’aide de l’API REST Types d’éléments de travail – Liste.

Explorateur de champ d'élément de travail

Pour rechercher les affectations de ces champs, vous pouvez utiliser l’outil Explorateur de champs des éléments de travail.

Pour accéder à l’Explorateur de champs des éléments de travail, installez l’outil Éditeur de processus. En fonction de la version de Visual Studio installée, utilisez l’une des extensions suivantes pour obtenir l’outil Éditeur de processus.

• Visual Studio 2019 & 2022: À l’heure actuelle, aucune extension d’éditeur de modèles de processus spécifique n’est disponible. Cependant, vous pouvez toujours personnaliser les modèles de processus à l’aide d’autres outils, tels qu’un éditeur de texte ou un éditeur XML. Vous pouvez aussi utiliser le portail Web Azure DevOps pour certaines personnalisations, en particulier pour les processus hérités.
• Visual Studio 2017 : Éditeur de modèle de processus TFS. Vous pouvez également utiliser cette version de l’éditeur de processus pour modifier les formulaires d’éléments de travail de l’ancien style. Vous ne pouvez pas l’utiliser pour modifier les formulaires associés aux nouveaux formulaires web.
• Visual Studio 2015 : TFS Power Tools.

Attributs de champ

De nombreux attributs non modifiables et masqués existent pour chaque champ d’élément de travail. Le tableau suivant décrit chaque attribut. Les attributs portent des noms différents selon que vous les récupérez via l'API REST Champs - Obtenir ou que vous les visualisez via l'outil Explorateur de champs d'éléments de travail (WIFE).

Les attributs attribués à un champ dépendent de la plateforme et de la version que vous utilisez. Par exemple, certains ne sont pas pris en charge avec le processus d’héritage. Pour rechercher le nom de référence d’un champ, consultez Index des champs d’éléments de travail.

Recensement des attributs de champ

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

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

{
"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"
}

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

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

{
"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"
}

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

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  

Meilleures pratiques pour le travail avec les champs

Tenez compte de ces recommandations lors de l’utilisation des champs d’élément de travail :

Sélection et conception des champs

• Choisir des noms explicites : utilisez des noms de champs descriptifs qui indiquent clairement leur objectif
• Normaliser le nommage : établir des conventions d’affectation de noms cohérentes au sein de votre organisation
• Limiter les champs personnalisés : ajouter des champs personnalisés de manière judicieuse pour éviter d’accabler les utilisateurs
• Prendre en compte les types de données : sélectionnez les types de données appropriés pour les informations que vous stockez

Optimisation des performances

• Utiliser des champs indexés : pour les déploiements locaux, envisagez d’indexer des champs personnalisés fréquemment interrogés
• Éviter les requêtes lourdes : gardez à l’esprit les performances des requêtes lors de l’utilisation de nombreux filtres de champs
• Optimiser les listes de sélection : conserver les valeurs de liste de sélection gérables en taille et bien organisées

Maintenance et gouvernance

• Utilisation des champs de document : gérer la documentation expliquant l’objectif et l’utilisation des champs personnalisés
• Examiner régulièrement : passez régulièrement en revue les champs personnalisés pour identifier les champs inutilisés ou redondants
• Planifier les modifications : tenez compte de l’impact des modifications de champ sur les éléments de travail et les requêtes existants
• Modifications de test : Toujours tester les modifications de champ dans un environnement de développement en premier

Ajout et modification des champs

Résolution des problèmes de champ

Problèmes courants et solutions lors de l’utilisation des champs d’élément de travail :

Problèmes de visibilité des champs

• Champ non affiché : vérifiez si le champ est ajouté à la disposition du type d’élément de travail
• Problèmes d’autorisation : vérifiez que vous disposez des autorisations appropriées pour afficher ou modifier des champs
• Différences de processus : Vérifiez que le champ existe dans le processus actuel

Problèmes de requête et de recherche

• Champ non interrogeable : vérifiez l’attribut IsQueryable du champ
• Problèmes de performances : envisagez d’indexer des champs personnalisés fréquemment interrogés (localement)
• Limitations des opérateurs : vérifier quels opérateurs sont pris en charge pour le type de données de champ

Entrée et validation des données

• Valeurs non valides : vérifiez si le champ a des valeurs autorisées restreintes ou des règles de validation
• Champs en lecture seule : vérifier l’attribut du IsEditable champ
• Configuration requise : Vérifier que les données correspondent au type de données de champ attendu

Contenu connexe