次の方法で共有

すべての FIELD XML 要素のリファレンス

  • [アーティクル]

このトピックを使用して、FIELD 要素またはその子要素の構文を調べてください。

これらの要素は FIELD (定義) 要素コンテナーで指定します。 作業項目の種類 (WIT) にフィールドを追加するには、FIELDS (定義) 要素内に FIELD (定義) 要素を指定します。 これらの要素は、WIT の定義内で、またはグローバル ワークフローの一部として指定できます。

子要素を追加することによって、フィールドの動作の指定、既定値の定義、値の選択リストの定義などを実行できます。 フィールド規則の要素は要素同士を組み合わせて使用できます。 ほとんどの規則は、1 つ以上のユーザーやグループに適用されるように指定したり、1 つ以上のユーザーやグループで無視されるようにしたりすることができます。

FIELD (定義) コンテナー要素

作業項目の種類のデータ フィールドを定義するには、次の構文を使用します。 この例には、FIELD (定義) 要素と省略可能なすべての子要素の形式が示されています。 詳細については、「FIELD (定義) 要素リファレンス」を参照してください。

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

FIELD 子要素

子要素は、フィールドに入力可能なデータに関して各種の制限を設定するときに使用します。 選択リスト (ドロップダウン メニュー) の値の指定、既定値の設定、エントリの消去、または変更の制限が可能です。 次の表に、それぞれの子要素の構文構造を示します。

こうした要素の使用法については、「作業項目フィールドへの規則の適用」を参照してください。 ほとんどの規則をシステム フィールドに適用する場合、制限が存在します。 すべての子要素は、省略可能です。

要素

説明と構文

ALLOWEDVALUES

ユーザーが作業項目フォームのフィールド リストおよびクエリ エディターで指定できる値のリストを定義します。 ユーザーは、このリストのいずれか 1 つの値を指定する必要があります。

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

詳細については、「選択リストの定義」を参照してください。

ALLOWEXISTINGVALUE

値が選択リストからなくなった場合でも、フィールドに既存の値を保持することを指定します。 新しいフィールド値はすべてリストにある必要があります。

<ALLOWEXISTINGVALUE />

詳細については、「選択リストの定義」を参照してください。

CANNOTLOSEVALUE

値を指定した後にユーザーがフィールドから値のすべてをクリアすることができないように指定します。 フィールドに値を格納した後は、NULL 以外の値を常にフィールドに格納する必要があります。

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

詳細については、「フィールドへの規則の適用」を参照してください。

COPY

ユーザーが作業項目を作成したり変更したりする際に、指定された値をフィールドにコピーします。

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

詳細については、「既定値の定義またはフィールドへの値のコピー」を参照してください。

DEFAULT

ユーザーが作業項目を作成または変更する際に、空のフィールドの値を指定します。 フィールドに既に値がある場合は、既定の規則は無視されます。

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

詳細については、「既定値の定義またはフィールドへの値のコピー」を参照してください。

EMPTY

フィールドに格納されているすべての値をクリアします。 EMPTY 規則では、フィールドが読み取り専用としても設定されます。これを READONLY 規則と併用しないでください。

フィールド値はユーザーが作業項目を保存するときにクリアされますが、値を指定することはできません。 この規則は、項目の遷移先の状態を適用するフィールドをクリアするために状態遷移中に主に使用されます。

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

詳細については、「フィールドへの規則の適用」を参照してください。

FROZEN

変更がコミットされた後、フィールドを空でない値に変更できないように指定します。 ユーザーがこのフィールドの値を使用して作業項目を保存した後、その値を変更することはできません。

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

詳細については、「フィールドへの規則の適用」を参照してください。

HELPTEXT

ユーザーが作業項目フォームのフィールドをポイントするとテキストが表示されるように定義します。

tooltipText: 1 ～ 255 文字で構成されるテキスト文字列です。

<HELPTEXT>tooltipText </HELPTEXT>

詳細については、「フィールドへの規則の適用」を参照してください。

MATCH

文字列型フィールドの値が一致する必要があるパターンを定義します。

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

詳細については、「文字列フィールドへのパターン マッチの適用」を参照してください。

NOTSAMEAS

フィールドに、指定された別のフィールドに割り当てられた値と同じ値が割り当てられないように指定します。 field 属性の値には、フィールドの有効な参照名を指定する必要があります。

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

詳細については、「フィールドへの規則の適用」を参照してください。

PROHIBITEDVALUES

フィールドに格納できない値のリストを定義します。 フィールドに禁止値が設定されている場合は、ユーザーは作業項目を保存できません。

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

詳細については、「選択リストの定義」を参照してください。

READONLY

フィールドに割り当てられている値を変更できないように指定します。

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

注意

この要素を EMPTY 要素と併用しないでください。EMPTY もフィールドを読み取り専用に設定するためです。これらの要素を組み合わせると、矛盾した結果になります。

詳細については、「フィールドへの規則の適用」を参照してください。

REQUIRED

ユーザーがフィールドの値を指定する必要があるように指定します。 必須フィールドを空にすることはできません。 ユーザーは、すべての必須フィールドに値を割り当てるまで作業項目を保存できません。

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

詳細については、「フィールドへの規則の適用」を参照してください。

SERVERDEFAULT

ユーザーが作業項目を保存するときに、指定されたサーバー値をフィールドにコピーします。 これらのフィールドは、通常、フォームでは読み取り専用として表示されます。

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

詳細については、「既定値の定義またはフィールドへの値のコピー」を参照してください。

SUGGESTEDVALUES

ユーザーが作業項目フォームのフィールド リストおよびクエリ エディターで指定できる推奨値のリストを定義します。 ユーザーは、推奨値以外の値を指定することもできます。

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

詳細については、「選択リストの定義」を参照してください。

VALIDUSER

指定したグループに属するユーザーによる作業項目の変更を制限します。 既定のグループは、Team Foundation 有効ユーザー グループです。

すべての属性は省略できます。 すべての属性は、1 ～ 255 文字のテキスト文字列で構成されている必要があります。 トークンを使用してグループを指定できます。

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

詳細については、「フィールドへの規則の適用」を参照してください。

WHEN

別のフィールドが特定の値を持つときに現在のフィールドに適用する 1 つまたは複数の規則を指定します。 現在のフィールドは、親 FIELD 要素によって定義されます。

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

詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。

WHENNOT

別のフィールドが特定の値ではないときに現在のフィールドに適用される 1 つ以上の規則を指定します。 現在のフィールドは、親 FIELD 要素によって定義されます。

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

詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。

WHENCHANGED

作業項目のリビジョン中に別のフィールドが変更された場合に現在のフィールドに適用される 1 つ以上の規則を指定します。 現在のフィールドは、親 FIELD 要素によって定義されます。

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

詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。

WHENNOTCHANGED

作業項目のリビジョン中に別のフィールドが変更されなかった場合に現在のフィールドに適用される 1 つ以上の規則を指定します。 現在のフィールドは、親要素によって定義されます。

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

詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。

GLOBALLIST 子要素と LISTITEM 子要素

GLOBALLIST 要素と LISTITEM 要素は、ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、PROHIBITEDVALUES 要素の子要素として指定します。 これらの要素を使用すると、表示される値のリストを列挙できます。 ユーザーは、選択リストまたはドロップダウン メニューから値を選択します。 詳細については、「グローバル リストの定義」を参照してください。

要素

説明

GLOBALIST

チーム プロジェクト コレクション用に格納したり、あるコレクションのすべてのチーム プロジェクトが使用できたりする一連の LISTITEM 要素を定義します。

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

globalListName: 1 ～ 255 文字のテキスト文字列。

GLOBALLIST は、GLOBALLISTS 要素の必須の子要素、および ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、PROHIBITEDVALUES 要素の省略可能な子要素です。 グローバル リストを、作業項目の定義、グローバル リスト定義、またはグローバル ワークフロー内で定義できます。

LISTITEM

有効なリスト値を定義します。

<LISTITEM value="listName" />

LISTITEM は、GLOBALLIST の必須の子要素、および ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、PROHIBITEDVALUES 要素の省略可能な子要素です。

FIELD 子要素ごとに指定する属性

for 属性または not 属性を含めると、ほとんどの FIELD 規則を一連のグループまたはユーザーに適用するまたは適用しないように制限できます。 詳細については、「フィールドへの規則の適用」を参照してください。

属性

構文

説明

expanditems

expanditems="true | false"

省略可能です。 LISTITEM の要素を識別するリスト内の下位グループを含めるには、グループを展開するかどうかを指定します。 この属性の既定値は true です。

filteritems

filteritems="excludegroups"

省略可能です。 グループのメンバーだけをリストに含め、グループ名を含めないことを指定します。 この属性に使用できる値は、excludegroups のみです。

for

for="userGroupName"

省略可能です。 この規則を適用する Team Foundation のユーザーまたはグループの名前を指定します。 有効な値は、1 ～ 255 文字のテキスト文字列で構成されます。

not

not="userGroupName"

省略可能です。 この規則を適用しない Team Foundation のユーザーまたはグループの名前を指定します。 有効な値は、1 ～ 255 文字のテキスト文字列で構成されます。

from

from="value | field | clock | currentuser"

必ず指定します。 値のコピー元または既定値の指定元となる値のソースを指定します。 有効な値は、次のとおりです。

  • clock:  システム時計から DateTime の各フィールドに現在の日付と時刻をコピーします。他の属性は必要ありません。 COPY 規則と DEFAULT 規則の場合、この値はローカル コンピューターのクロック時間から取得されます。 SERVERDEFAULT の場合、この値はユーザーが作業項目を保存するときにサーバー クロックから取得されます。

  • currentuser:  現在ログオンしているユーザーの名前をコピーします。 現在のユーザーの短いユーザー名を値として使用します。 他の属性は必要ありません。 文字列のフィールドに使用します。

  • field:  指定した field 属性の値をコピーします。 field="abc" 属性が必須です。 既定では、指定された "from" フィールドが空白であれば、何も実行されません。 field 属性は、<COPY> 規則と <DEFAULT> 規則に対してのみ使用されます。

  • value:  指定した value 属性の値をコピーします。 指定した文字列定数の値を使用します。 value="abc" 属性が必須です。 value は、<COPY> 規則と <DEFAULT> 規則に対してのみ使用されます。

"value" または "field" を指定する場合には、値またはフィールドの属性をそれぞれ含める必要があります。

field

field="fieldReferenceName"

省略可能です。 field が from 属性に指定されている場合、フィールドにコピーされる値を持つフィールドの名前を指定します。

pattern

pattern="patternValue"

必ず指定します。 基本的なパターン マッチを文字列だけに適用します。 patternValue は 1 ～ 255 文字で構成される文字列です。 この文字列に円記号 (\) を含めることはできません。 文字列の各文字は、次の 6 種類のメタ文字のいずれかではない場合は、リテラルとして解釈されます。

  • "A" または "a" は、1 つの英文字を表します。

  • "N" または "n" は、1 つの数字を表します。

  • "X" または "x" は、1 つの英数字を表します。

パターン値: ^[^\\]*$

たとえば、pattern="xxxxx.nn.nn" は 5 文字の英数字、ピリオド、および 2 桁の数字、ピリオド、および 2 桁の数字と一致します。

value

value="valueToCopy"

省略可能です。 value が from 属性に指定されている場合、フィールドにコピーされる値を指定します。

参照

概念

作業項目フィールドの定義と変更

作業項目の種類に関するワークフローの変更