Partager via

Référence de tous les éléments XML FIELD

  • Article

Cette rubrique vous permet de connaître la syntaxe de l'élément FIELD ou de l'un de ses éléments enfants.

Vous spécifiez ces éléments dans le conteneur d'élément FIELD (Définition). Vous ajoutez un champ pour un type d'élément de travail en spécifiant un élément FIELD (Définition) dans l'élément FIELDS (Définition). Vous pouvez spécifier ces éléments dans la définition d'un type d'élément de travail ou dans le cadre d'un flux de travail global.

Vous pouvez ajouter des éléments enfants pour spécifier le comportement d'un champ, définir des valeurs par défaut ou définir une liste de sélection de valeurs. Vous pouvez utiliser des éléments de règles de champs les uns avec les autres. Vous pouvez faire en sorte que la plupart des règles s'appliquent à un ou plusieurs utilisateurs ou groupes ou qu'elles soient ignorées pour un ou plusieurs utilisateurs ou groupes.

Élément de conteneur FIELD (Définition)

Vous utilisez la syntaxe suivante pour définir les champs de données pour un type d'élément de travail. Cet exemple montre le format de l'élément FIELD (Définition) et tous les éléments enfants facultatifs. Pour plus d'informations, consultez Référence des éléments FIELD (Définition).

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

Éléments enfants FIELD

Utiliser des éléments enfants pour définir diverses restrictions quant aux données qui peuvent être entrées dans un champ. Vous pouvez spécifier des valeurs pour une liste de choix (menu déroulant), définir des valeurs par défaut, effacer des entrées ou limiter les modifications. Le tableau suivant indique la structure de syntaxe pour chaque élément enfant.

Pour savoir comment utiliser ces éléments, consultez Appliquer une règle à un champ d'élément de travail. Il existe des restrictions sur l'application de la plupart des règles aux champs système. Tous les éléments enfants sont facultatifs.

Élément

Description et syntaxe

ALLOWEDVALUES

Définit une liste de valeurs que les utilisateurs peuvent spécifier dans une liste de champs dans des formulaires d'éléments de travail ou dans l'éditeur de requête. Les utilisateurs doivent spécifier l'une des valeurs que vous fournissez.

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

Pour plus d'informations, consultez Définir les listes de choix.

ALLOWEXISTINGVALUE

Indique qu'un champ peut conserver une valeur existante, même s'il ne figure plus dans une liste de sélection. Toutes les nouvelles valeurs de champs doivent figurer dans la liste.

<ALLOWEXISTINGVALUE />

Pour plus d'informations, consultez Définir les listes de choix.

CANNOTLOSEVALUE

Indique que les utilisateurs ne peuvent pas effacer toutes les valeurs d'un champ une fois qu'une valeur a été spécifiée. Une fois que le champ contient une valeur, il doit toujours contenir une valeur non nulle.

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

Pour plus d'informations, consultez Appliquer une règle de champ.

COPY

Copie une valeur spécifiée vers un champ lorsqu'un utilisateur crée ou modifie un élément de travail.

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

Pour plus d'informations, consultez Définir une valeur par défaut ou copier une valeur dans un champ.

DEFAULT

Spécifie une valeur pour un champ qui est vide lorsqu'un utilisateur crée ou modifie un élément de travail. Si un champ contient déjà une valeur, la règle par défaut est ignorée.

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

Pour plus d'informations, consultez Définir une valeur par défaut ou copier une valeur dans un champ.

EMPTY

Efface toutes les valeurs du champ. La règle EMPTY définit aussi un champ en lecture seule. Vous ne devez pas l'utiliser avec la règle READONLY.

La valeur du champ est effacée quand un utilisateur enregistre l'élément de travail et vous ne pouvez pas spécifier de valeur. Cette règle s'utilise principalement durant la transition d'état pour effacer des champs qui s'appliquent à l'état vers lequel l'élément bascule.

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

Pour plus d'informations, consultez Appliquer une règle de champ.

FROZEN

Indique que vous ne pouvez pas modifier le champ en lui affectant une valeur non vide après la validation des modifications. Dès qu'un utilisateur enregistre l'élément de travail avec une valeur dans ce champ, la valeur ne peut plus être modifiée.

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

Pour plus d'informations, consultez Appliquer une règle de champ.

HELPTEXT

Définit le texte affiché quand un utilisateur pointe sur le champ dans le formulaire d'élément de travail.

tooltipText : chaîne de texte qui contient entre 1 et 255 caractères.

<HELPTEXT>tooltipText </HELPTEXT>

Pour plus d'informations, consultez Appliquer une règle de champ.

MATCH

Définit un modèle auquel les valeurs des champs de type String doivent correspondre.

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

Pour plus d'informations, consultez Appliquer des critères spéciaux à un champ de chaîne.

NOTSAMEAS

Indique qu'un champ n'est pas renseigné avec la même valeur que celle d'un autre champ spécifié. La valeur de l'attribut field doit être le nom de référence valide d'un champ.

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

Pour plus d'informations, consultez Appliquer une règle de champ.

PROHIBITEDVALUES

Définit une liste de valeurs qu'un champ peut contenir. Les utilisateurs ne peuvent pas enregistrer un élément de travail si le champ contient une valeur interdite.

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

Pour plus d'informations, consultez Définir les listes de choix.

READONLY

Indique que vous ne pouvez pas modifier la valeur à laquelle le champ est assigné.

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

Notes

N'utilisez pas cet élément avec l'élément EMPTY, car EMPTY configure aussi un champ en lecture seule.Si vous combinez ces éléments, les résultats seront incohérents.

Pour plus d'informations, consultez Appliquer une règle de champ.

REQUIRED

Indique que les utilisateurs doivent spécifier une valeur pour le champ. Les champs obligatoires ne doivent pas être vides. Les utilisateurs ne peuvent pas enregistrer un élément de travail tant qu'ils n'ont pas assigné de valeurs à tous les champs requis.

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

Pour plus d'informations, consultez Appliquer une règle de champ.

SERVERDEFAULT

Copie une valeur de serveur spécifiée dans un champ quand un utilisateur enregistre un élément de travail. Ces champs s'affichent généralement en lecture seule dans le formulaire.

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

Pour plus d'informations, consultez Définir une valeur par défaut ou copier une valeur dans un champ.

SUGGESTEDVALUES

Définit une liste de valeurs suggérée que les utilisateurs peuvent spécifier dans une liste de champs dans des formulaires d'éléments de travail ou dans l'éditeur de requête. Les utilisateurs peuvent spécifier des valeurs autres que celles que vous suggérez.

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

Pour plus d'informations, consultez Définir les listes de choix.

VALIDUSER

Empêche les éléments de travail d'être modifiés par les utilisateurs qui appartiennent au groupe que vous spécifiez. Le groupe par défaut est le groupe Team Foundation Valid Users.

Tous les attributs sont facultatifs. Tous les attributs doivent être composés d'une chaîne de texte qui contient entre 1 et 255 caractères. Vous pouvez utiliser des jetons pour spécifier les groupes.

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

Pour plus d'informations, consultez Appliquer une règle de champ.

WHEN

Spécifie une ou plusieurs règles à appliquer au champ actuel lorsqu'un autre champ a une valeur spécifique. L'élément FIELD parent définit le champ actif.

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

Pour plus d'informations, consultez Assigner les valeurs et les règles conditionnelles.

WHENNOT

Spécifie une ou plusieurs règles à appliquer au champ actif quand un autre champ ne contient pas une valeur spécifique. L'élément FIELD parent définit le champ actif.

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

Pour plus d'informations, consultez Assigner les valeurs et les règles conditionnelles.

WHENCHANGED

Spécifie une ou plusieurs règles à appliquer au champ actif quand un autre champ est modifié durant la révision de l'élément de travail. L'élément FIELD parent définit le champ actif.

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

Pour plus d'informations, consultez Assigner les valeurs et les règles conditionnelles.

WHENNOTCHANGED

Spécifie une ou plusieurs règles à appliquer au champ actif quand un autre champ n'est pas modifié durant la révision de l'élément de travail. L'élément parent définit le champ actif.

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

Pour plus d'informations, consultez Assigner les valeurs et les règles conditionnelles.

Éléments de travail GLOBALLIST et LISTITEM

Vous spécifiez les éléments GLOBALLIST et LISTITEM comme éléments enfants des éléments ALLOWEDVALUES, SUGGESTEDVALUES et PROHIBITEDVALUES. Vous pouvez utiliser ces éléments pour énumérer une liste de valeurs qui s'affiche. Les utilisateurs sélectionnent des valeurs dans une liste de sélection ou un menu déroulant. Pour plus d'informations, consultez Définir les listes globales.

Élément

Description

GLOBALIST

Définit un ensemble d'éléments LISTITEM stocké pour une collection de projets d'équipe et utilisable par tous les projets d'équipe dans une collection.

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

globalListName : chaîne de texte qui contient entre 1 et 255 caractères.

GLOBALLIST est un élément enfant requis de l'élément GLOBALLISTS et un élément enfant facultatif des éléments ALLOWEDVALUES, SUGGESTEDVALUES et PROHIBITEDVALUES. Vous pouvez définir une liste globale dans une définition d'élément de travail, une définition de liste globale ou un flux de travail global.

LISTITEM

Définit une valeur de liste valide.

<LISTITEM value="listName" />

LISTITEM est un élément enfant requis de l'élément GLOBALLIST et un élément enfant facultatif des éléments ALLOWEDVALUES, SUGGESTEDVALUES et PROHIBITEDVALUES.

Attributs spécifiés par des éléments enfants FIELD

Vous pouvez qualifier la plupart des règles FIELD pour qu'elles s'appliquent ou non à un ensemble de groupes ou d'utilisateurs en incluant l'attribut for ou not. Pour plus d'informations, consultez Appliquer une règle de champ.

Attribut

Syntaxe

Description

expanditems

expanditems="true | false"

Facultatif. Indique si un groupe identifié par l'élément LISTITEM doit être développé pour inclure des groupes secondaires dans la liste. La valeur par défaut de cet attribut est true.

filteritems

filteritems="excludegroups"

Facultatif. Indique que seuls les membres des groupes, et non les noms des groupes, sont inclus dans la liste. La seule valeur autorisée pour cet attribut est excludegroups.

for

for="userGroupName"

Facultatif. Indique le nom d'un utilisateur ou d'un groupe dans Team Foundation auquel la règle s'applique. Les valeurs valides sont composées d'une chaîne de texte qui contient entre 1 et 255 caractères.

not

not="userGroupName"

Facultatif. Indique le nom d'un utilisateur ou d'un groupe dans Team Foundation auquel la règle ne s'applique pas. Les valeurs valides sont composées d'une chaîne de texte qui contient entre 1 et 255 caractères.

from

from="value | field | clock | currentuser"

Requis. Indique la source de la valeur à partir de laquelle copier une valeur ou spécifier une valeur par défaut. Les valeurs suivantes sont valides :

  • clock : copie les date et heure actuelles de l'horloge système dans des champs DateTime. Aucun attribut supplémentaire n'est nécessaire. Pour les règles COPY et DEFAULT, cette valeur provient de l'horloge de l'ordinateur local. Pour SERVERDEFAULT, la valeur provient de l'horloge du serveur quand un utilisateur enregistre l'élément de travail.

  • currentuser : copie le nom de l'utilisateur connecté actuellement. Utilisez le nom d'utilisateur court de l'utilisateur actif comme valeur. Aucun attribut supplémentaire n'est nécessaire. Utilisé pour les champs de chaînes.

  • field : copie la valeur de l'attribut field que vous spécifiez. Nécessite un attribut field="abc". Par défaut, si le champ « from » spécifié est vide, rien n'est fait. L'attribut field est utilisé uniquement pour les règles <COPY> et <DEFAULT>.

  • value : copie la valeur de l'attribut value que vous spécifiez. Utilisez la valeur d'une constante de chaîne que vous spécifiez. Nécessite un attribut value="abc". value est utilisé uniquement pour les règles <COPY> et <DEFAULT>.

Si vous spécifiez « value » ou « field », vous devez aussi inclure respectivement l'attribut de valeur ou de champ.

field

field="fieldReferenceName"

Facultatif. Indique le nom du champ dont la valeur doit être copiée dans le champ quand field est spécifié pour l'attribut from.

pattern

pattern="patternValue"

Requis. Applique la mise en correspondance du modèle de base uniquement pour les chaînes. patternValue est une chaîne qui contient entre 1 et 255 caractères. Cette chaîne ne doit pas contenir de barre oblique inverse (\). Chaque caractère de la chaîne est interprété comme un littéral, à moins qu'il ne s'agisse de l'un des six métacaractères suivants :

  • « A » ou « a » représente un seul caractère alphabétique.

  • « N » ou « n » représente un seul caractère numérique.

  • « X » ou « x » représente un seul caractère alphanumérique.

Valeur de modèle : ^[^\\]*$

Par exemple, pattern="xxxxx.nn.nn" met en correspondance cinq caractères alphanumériques quelconques, puis un point, puis deux caractères numériques, puis un point, puis deux autres caractères numériques.

value

value="valueToCopy"

Facultatif. Spécifie la valeur à copier dans le champ quand value est spécifié pour l'attribut from.

Voir aussi

Concepts

Définir et modifier les champs des éléments de travail

Modifier le flux de travail pour un type d'élément de travail