FIELD (定義) 項目參考

您可以使用 FIELD (定義) 項目來定義工作項目欄位,以及指定套用至該欄位的規則和條件。 您指派給欄位的屬性會決定其資料類型,以及是否可以加入報表中。

注意事項注意事項

如需 FIELD (工作流程) 項目 (在狀態變更或工作流程轉換期間用於指定欄位的規則和條件) 的詳細資訊,請參閱 FIELD (工作流程) 項目

結構描述階層架構

WITD

   WORKITEMTYPE

      FIELDS

            FIELD

<FIELD name="fieldDisplayName" 
refname="fieldReferenceName" 
type="String | Integer | Double | DateTime | PlainText | HTML | History | TreePath | GUID" 
syncnamechanges ="true | false" 
reportable="Dimension | Detail | Measure"
formula="sum"
reportingname="ReportingDisplayName" 
reportingrefname="ReportingReferenceName" >
   <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>

屬性和項目

下列章節說明屬性、子項目和父項目。

屬性

屬性

描述

name

必要項。 出現在工作項目查詢下拉式功能表中的欄位易記名稱。 在 Team 專案中定義的所有欄位中,易記名稱必須是唯一的。 此外,易記名稱可能與工作項目表單上的欄位旁出現的標籤不同。 如需詳細資訊,請參閱Control XML 項目參考

屬性類型為 typelib:FieldName。 最小長度:1;最大長度:128。

模式值:^[^\. \[\]]+$

模式值範例:指派給

refname

必要項。 可使某個欄位與 Team 專案集合中定義的所有其他欄位有所區別的唯一標籤。

如需了解其他需求以及易記名稱與參考名稱的限制,請參閱工作項目追蹤物件的命名慣例

屬性類型為 typelib:ReferenceFieldName。 最小長度:1;最大長度:70。

模式值:^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

模式值範例:Company.IssueType

type

必要項。 指定欄位所接受資料的類型。

注意事項注意事項

具有相同 reportingrefname 的不同專案集合中的欄位,必須指派為相同的 type 值。如果值不同,則可能在處理資料倉儲時發生資料衝突。如需詳細資訊,請參閱解決資料倉儲中發生的結構描述衝突

下表列出這個屬性的有效值:

使用方式

DateTime

根據國際標準時間 (UTC) 時間點來指定日期。

Double

指定浮點值。

GUID

指定要用來包含唯一識別項的欄位。

History

支援討論區並追蹤其他歷史資訊。

注意事項注意事項

System.History 欄位是唯一使用此資料類型的欄位。您無法使用這個資料類型來定義自訂欄位。

HTML

支援 RTF 文字資料的擷取,而且會用於較長的文字說明,例如工作項目說明。

Integer

指定 32 位元帶正負號的整數值。

PlainText

支援輸入可以包含超過 255 個 Unicode 字元的文字字串。

String

支援輸入可以包含最多 255 個 Unicode 字元的文字字串。 String 欄位適用於標籤,或其他最長只有一行的簡短文字字串。

TreePath

指定欄位以顯示在階層或樹狀目錄結構中的項目,例如需要什麼才能顯示產品的區域和反覆項目路徑。 若要定義子節點,請參閱加入及修改區域和反覆項目路徑

注意事項注意事項

System.AreaPath 和 System.IterationPath 欄位是唯一使用這個資料類型的欄位。您無法使用這個資料類型來定義自訂欄位。

syncnamechanges

選擇項。 指定是否使用工作項目欄位,來儲存要隨著 Active Directory 或某個工作群組中的變更而更新的名稱。 只有當 type="String" 時,此選項才有效。 屬性類型為 xs:boolean。

指定 true 可啟用資料欄位的同步處理,指定 false 可停用資料欄位的同步處理。

reportable

選擇項。 指定欄位的資料是否可以加入報表中。 具有預設值 None 的欄位既不會被匯出至關聯式資料倉儲,也不會由 SQL Server Analysis Services Cube 處理。 如需可報告欄位的詳細資訊,請參閱加入或修改工作項目欄位以支援報告

注意事項注意事項

具有相同 reportingrefname 值的不同專案集合中的欄位,必須指派為相同的 reportable 值。如果值不同,則可能在處理資料倉儲時發生資料衝突。如需詳細資訊,請參閱解決資料倉儲中發生的結構描述衝突

下表列出這個屬性的有效值:

Value

使用方式

Detail

可針對 DateTime、Double、Integer 或 String 類型的欄位指定。

這個欄位中的資料會移入工作項目和目前工作項目資料表中的關聯式倉儲資料庫,但不會移入 Analysis Services Cube。 這個類型是不受限制文字欄位的理想選擇,因為您可以在報表中使用它們,並可避免讓 Cube 變得過大。

Dimension

可針對 DateTime、Integer、String 或 TreePath 類型的欄位指定。

這個欄位中的資料會進入關聯式倉儲資料庫以及 Analysis Services Cube 成為工作項目維度的屬性,以便讓資料可用來篩選報表。 請對具有有效值清單的欄位使用這個類型。 Work Item Type 和 State 是 dimension 的良好範例。

Measure

只有 Integer 和 Double 欄位才使用 measure 類型。 Measure 是報表中的數值。

在處理 Analysis Services Cube 時,會在 reportable 屬性設定為 measure 的欄位上預先計算資料。 例如,工作項目和目前的工作項目量值群組包含下列欄位的累積資料:[原始評估]、[剩餘時數] 和 [已完成的時數]。

當您指定 measure 時,也必須指定 formula 屬性。

None

當您不想使用要加入報表中的欄位時,請指定 None。 這是預設的指派。

formula

選擇項。 measure 可報告類型的彙總類型。 唯一有效的值是 sum,它會傳回整個集合中所有值的總和。

reportingname

選擇項。 指定顯示在報表中的名稱。 如果您未指定值,則會使用指派給 name 屬性的值。

注意事項注意事項

具有相同 reportingrefname 的不同專案集合中的欄位,必須指派為相同的 reportingname 值。如果值不同,則可能在處理資料倉儲時發生資料衝突。如需詳細資訊,請參閱解決資料倉儲中發生的結構描述衝突

屬性類型為 typelib:FieldName。 最小長度:1;最大長度:128。

模式值:^[^\. \[\]]+$

模式值範例:指派給

reportingrefname

選擇項。 指定在處理可報告欄位時使用的參考名稱。 如果您未指定值,則會使用指派給 refname 屬性的值。

您可以使用這個屬性,合併或分離在資料倉儲中處理的欄位。 若要合併具有不同參考名稱且在不同的專案集合中定義的兩個欄位,您可以指派相同的 reportingrefname 給這兩個欄位。 若要分離有相同的參考名稱但定義於不同的專案集合中的兩個欄位,您可以指派不同的 reportingrefname 給每個欄位。

您應該盡可能合併欄位,將倉儲中的欄位數目減到最少,並保持不超過 1024 個可報告欄位數上限。 您可以使用合併欄位產生跨群組報表。

屬性類型為 typelib:ReferenceFieldName。 最小長度:1;最大長度:70。

模式值:^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

模式值範例:Company.IssueType

子項目

項目

描述

ALLOWEDVALUES

選擇項。 定義欄位的允許值清單。 允許的值是在工作項目表單和查詢產生器的欄位清單中可供選取的值。 您必須從這些值中選取一個。

ALLOWEXISTINGVALUE

選擇項。 定義允許現有值的欄位。 這個項目允許使用已存在的欄位值 (即使這些值無效)。 所有新的欄位值都必須有效。

CANNOTLOSEVALUE

選擇項。 將欄位定義為不可遺失值。 這個項目會保存目前的欄位值,且無法清除或設為空白。

COPY

選擇項。 指定另一個欄位,其中包含要複製到目前欄位中的值。

DEFAULT

選擇項。 定義欄位的預設值。

EMPTY

選擇項。 將欄位定義為空白。

FROZEN

選擇項。 將欄位定義為凍結。 在認可變更之後,已凍結的欄位就不能變更為任何非空白的值。 不過,您可以手動清除欄位、儲存工作項目,然後指定不同的值。

HELPTEXT

選擇項。 定義顯示於欄位工具提示中的文字。

MATCH

選擇項。 定義欄位值必須符合之欄位的模式。

NOTSAMEAS

選擇項。 指定另一個欄位,其值不可與目前欄位的值相同。

PROHIBITEDVALUES

選擇項。 定義欄位的禁用值清單。

READONLY

選擇項。 將欄位定義為唯讀。

REQUIRED

選擇項。 將欄位定義為必要項。

SERVERDEFAULT

選擇項。 指定將提供值給欄位的伺服器元件。

SUGGESTEDVALUES

選擇項。 定義欄位的建議值清單。 建議的值是在工作項目表單和查詢產生器的欄位清單中可供選取的值。 除了清單中的值之外,您也可以輸入其他值。

VALIDUSER

選擇項。 指定允許值的清單只能包含系統的有效使用者。

WHEN

選擇項。 當其他欄位擁有特定值時,指定要套用到目前欄位的一個或多個規則。

WHENCHANGED

選擇項。 當特定欄位的值變更時,將一個或多個規則套用到目前的欄位。

WHENNOT

選擇項。 當其他欄位沒有特定值時,將一個或多個規則套用到目前的欄位。

WHENNOTCHANGED

選擇項。 當特定欄位的值沒有變更時,將一個或多個規則套用到目前的欄位。

父項目

項目

描述

FIELDS

必要項。 包含工作項目類型欄位的定義。

備註

  1. FIELD (定義) 是 FIELDS (定義) 的必要子項目。

  2. 如需針對 TFS 流程範本定義之所有系統欄位和預先定義欄位的概觀,請參閱Visual Studio ALM 的工作項目欄位參考

  3. 您無法定義以 System. 前置詞開頭的自訂欄位。 您可以使用 Microsoft. 前置詞來定義欄位,不過,不建議使用這種作法,因為它可能會妨礙 Team Foundation Server 的功能。

    如需了解其他需求和欄位易記名稱與參考名稱的限制,請參閱工作項目追蹤物件的命名慣例

  4. 雖然您可以重新命名欄位的易記名稱,但是您不可以重新命名欄位的參考名稱。 您可以使用 witadmin 命令列工具列出欄位,以及變更數個欄位屬性。請參閱 管理工作項目欄位 [witadmin]

  5. 您可以在相同的 Team 專案集合中定義 1,024 個以內的工作項目欄位,並且可以在所有 Team 專案集合中將 1,024 個以內的欄位設定為可報告。

    您在所有工作項目類型 (WIT) 中,為所有 Team 專案 (為專案集合定義的專案) 定義的所有欄位,適用於 Team 專案集合。 因此,您指派給一個 WIT 中所定義欄位的屬性,必須符合集合中所有 Team 專案的所有 WIT。 此外,所有集合中的所有可報告欄位都會匯出到資料倉儲資料庫。

  6. 如需如何將欄位標示為報告用途的詳細資訊,請參閱加入或修改工作項目欄位以支援報告

  7. 當您將現有的欄位加入不同的 WIT 時,請將報表屬性明確設為與目前欄位定義相同,或將這些屬性預設為這些值。

    如果對不同 WIT 中的相同欄位,或不同 Team 專案中的相同 WIT 指派不同的報表屬性,可能會發生結構描述衝突。 若要修正這些衝突,請參閱 解決資料倉儲中發生的結構描述衝突

  8. 若要了解如何使用欄位支援查詢、報表和工作項目追蹤,請參閱 修改或加入欄位以支援查詢、報表和工作流程

  9. 如需如何使用子項目對 FIELD 套用條件約束或條件的概觀,請參閱 將規則套用至工作項目欄位

範例

<FIELD name="Activity" refname="Microsoft.VSTS.Common.Activity" type="String" reportable="dimension">
   <HELPTEXT>Type of work involved</HELPTEXT>
   <SUGGESTEDVALUES>
      <LISTITEM value="Development"/>
      <LISTITEM value="Testing"/>
      <LISTITEM value="Requirements"/>
      <LISTITEM value="Design"/>
      <LISTITEM value="Deployment"/>
      <LISTITEM value="Documentation"/>
   </SUGGESTEDVALUES>
</FIELD>

請參閱

參考

管理工作項目欄位 [witadmin]

概念

工作項目追蹤物件的命名慣例

Visual Studio ALM 的工作項目欄位參考

自訂工作追蹤物件以支援小組的流程

定義和修改工作項目欄位

其他資源

工作項目追蹤:XML 項目定義的索引