カテゴリ XML 要素リファレンス

作業項目の種類 (WIT) をグループ化するには、CATEGORIES 要素を使用します。 「カテゴリを使用した作業項目の種類のグループ化」では、Visual Studio Online および Team Foundation Server (TFS) で使用される既定のカテゴリについての説明を提供します。

<CATEGORIES>
   <CATEGORY name="category display name" refname="category reference name">
      <DEFAULTWORKITEMTYPE name="work item type reference name" />
      <WORKITEMTYPE name="work item type reference name" />
   </CATEGORY>
</CATEGORIES>

属性と要素

要素

属性

説明

CATEGORIES

 

XML カテゴリ ファイル内の必須要素です。

チーム プロジェクトに対して定義される 1 つ以上の CATEGORY 要素のコンテナー要素です。

CATEGORY

 

必須の CATEGORIES 子要素です。

1 つの既定の DEFAULTWORKITEMTYPE 要素と 0 個以上の WORKITEMTYPE 要素を含む名前付きカテゴリ グループを指定します。

 

name

必須の CATEGORY 属性です。

属性型は typelib:FriendlyName です。

カテゴリの表示名を指定します。 1 ~ 254 文字、かつチーム プロジェクト内で一意にする必要があります。

 

refname

必須の CATEGORY 属性です。

属性型は typelib:ReferenceName です。

この名前は、英数字、アンダースコア、およびハイフンで構成する 70 文字以内の Unicode 文字で指定します。 参照名には少なくとも 1 つのピリオド (.) が必要ですが、名前の先頭と末尾にはピリオドは使用できません。 また、参照名の先頭には、数字およびアンダースコアは使用できません。さらに参照名では、複数のハイフンを (--) のように連続して使用することはできません。

予約されたシステムと重複する名前を指定しないでください。 XXX および Microsoft。 XXX 名前空間。 「作業項目トラッキング オブジェクトの名前付け規則」を参照してください。

DEFAULTWORKITEMTYPE

 

必須の CATEGORY 要素です。

名前付きカテゴリに属していることを示すタグを付け、カテゴリの既定の種類として使用する作業項目の種類を指定します。

 

name

必須の DEFAULTWORKITEMTYPE 属性です。

属性型は WorkItemTypeRef です。

カテゴリの既定の種類として使用する、チーム プロジェクトの有効な作業項目の種類の参照名を指定します。

WORKITEMTYPE

 

省略可能な CATEGORY 要素。

名前付きカテゴリに属していることを示すタグを付ける作業項目の種類を指定します。

 

name

必須の WORKITEMTYPE 属性です。

属性型は WorkItemTypeRef です。

名前付きカテゴリに属する、チーム プロジェクトの有効な作業項目の種類の参照名を指定します。

解説

CATEGORIES は、カテゴリ スキーマのルート要素です。

カテゴリは、チーム プロジェクトによって格納および使用される CATEGORIES 要素の CATEGORY セット内で定義します。 各 CATEGORIES 要素には、少なくとも 1 つの CATEGORY 要素が定義されている必要があります。

カテゴリを空にすることはできません。 各 CATEGORY 要素には、少なくとも 1 つの DEFAULTWORKITEMTYPE 要素または WORKITEMTYPE 要素が定義されている必要があります。

各カテゴリには表示名と参照名があり、どちらもチーム プロジェクト内で一意である必要があります。 カテゴリの表示名は、次の要件を満たしている必要があります。

  • 名前の長さは、最大 254 Unicode 文字です。

  • 名前を空にすることはできません。

  • 名前の先頭または末尾に空白は指定できません。

  • 名前に円記号 (\) を含めることはできません。

  • 名前に連続する 2 つの空白は使用できません。

カテゴリの表示名はローカライズされず、トークン化できません。一方、作業項目の種類はローカライズされ、トークン化できます。

アジャイル ツール、カテゴリの要件、および制限

WIT をカテゴリに割り当てる際は、次の操作上の注意事項に注意してください。

  • バックログタスク ボードを使用するには、少なくとも要件カテゴリとタスク カテゴリのそれぞれに、WIT を 1 つずつ割り当てる必要があります。

  • 要件カテゴリとタスク カテゴリの両方に同じ WIT を割り当てることはできません。

  • 要件カテゴリまたはタスク カテゴリに複数の WIT を割り当てた場合、DEFAULTWORKITEMTYPE 要素に割り当てられた WIT が、アジャイル バックログとボード ページに既定の WIT として表示されます。

  • ProcessConfiguration ファイルのバックログを定義するカテゴリに属する WIT には、「プロセス構成 XML 要素のリファレンス」の説明に従って、有効なメタ状態にマッピングしたワークフロー状態 (新規、終了、そして少なくとも 1 つの遷移中のワークフロー状態) を含める必要があります。

  • バグ カテゴリに割り当てた WIT は、各チームのバックログとボードにバグを表示するように構成できます。 ProcessConfiguration ファイルの BugsBehavior のプロパティを定義することにより、既定の動作を設定します。

使用例

次の例では、スクラム プロセス テンプレートの既定のカテゴリ XML ファイルを表示します。

<?xml version="1.0" encoding="utf-8"?>
<cat:CATEGORIES xmlns:cat="https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/categories">
  <!-- Usage: for resilience in Test system. Even if WITs have different name, they can be referred to by the category -->
  <CATEGORY name="Bug Category" refname="Microsoft.BugCategory">
    <DEFAULTWORKITEMTYPE name="Bug" />
  </CATEGORY>
  <CATEGORY name="Epic Category" refname="Microsoft.EpicCategory">
    <DEFAULTWORKITEMTYPE name="Epic" />
  </CATEGORY>
  <CATEGORY name="Feature Category" refname="Microsoft.FeatureCategory">
    <DEFAULTWORKITEMTYPE name="Feature" />
  </CATEGORY>
  <CATEGORY name="Requirement Category" refname="Microsoft.RequirementCategory">
    <DEFAULTWORKITEMTYPE name="Product Backlog Item" />
    <WORKITEMTYPE name="Bug" />
  </CATEGORY>
  <CATEGORY name="Test Case Category" refname="Microsoft.TestCaseCategory">
    <DEFAULTWORKITEMTYPE name="Test Case" />
  </CATEGORY>
  <CATEGORY name="Shared Step Category" refname="Microsoft.SharedStepCategory">
    <DEFAULTWORKITEMTYPE name="Shared Steps" />
  </CATEGORY>
   <CATEGORY name="Shared Parameter Category" refname="Microsoft.SharedParameterCategory">
    <DEFAULTWORKITEMTYPE name="Shared Parameter" />
  </CATEGORY>
  <CATEGORY name="Code Review Request Category" refname="Microsoft.CodeReviewRequestCategory">
    <DEFAULTWORKITEMTYPE name="Code Review Request" />
  </CATEGORY>
  <CATEGORY name="Code Review Response Category" refname="Microsoft.CodeReviewResponseCategory">
    <DEFAULTWORKITEMTYPE name="Code Review Response" />
  </CATEGORY>
  <CATEGORY name="Feedback Request Category" refname="Microsoft.FeedbackRequestCategory">
    <DEFAULTWORKITEMTYPE name="Feedback Request" />
  </CATEGORY>
  <CATEGORY name="Feedback Response Category" refname="Microsoft.FeedbackResponseCategory">
    <DEFAULTWORKITEMTYPE name="Feedback Response" />
  </CATEGORY>
  <CATEGORY name="Test Plan Category" refname="Microsoft.TestPlanCategory">
    <DEFAULTWORKITEMTYPE name="Test Plan" />
  </CATEGORY>
  <CATEGORY name="Test Suite Category" refname="Microsoft.TestSuiteCategory">
    <DEFAULTWORKITEMTYPE name="Test Suite" />
  </CATEGORY>
  <CATEGORY name="Task Category" refname="Microsoft.TaskCategory">
    <DEFAULTWORKITEMTYPE name="Task" />
  </CATEGORY>
  <CATEGORY name="Hidden Types Category" refname="Microsoft.HiddenCategory">
    <DEFAULTWORKITEMTYPE name="Code Review Request" />
    <WORKITEMTYPE name="Code Review Response" />
    <WORKITEMTYPE name="Feedback Request" />
    <WORKITEMTYPE name="Feedback Response" />
    <WORKITEMTYPE name="Shared Steps" />
    <WORKITEMTYPE name="Shared Parameter" />
    <WORKITEMTYPE name="Test Plan" />
    <WORKITEMTYPE name="Test Suite" />
  </CATEGORY>
</cat:CATEGORIES>

参照

その他の技術情報

カテゴリを使用した作業項目の種類のグループ化