作業項目トラッキング オブジェクトの名前付け規則
作業項目トラッキング オブジェクトはすべて、1 つ以上の名前に関連付けられます。ほとんどのオブジェクトが表示名を持ち、作業項目の種類とグローバル リスト以外のすべてに参照名が関連付けられます。表示名は、プロジェクト コレクション内のすべてのチーム プロジェクトと作業項目の種類において一貫性を確保するために使用するフィールドの、ユーザーが参照できる一意の識別子です。参照名は、Team Foundation Server により内部的に使用され、定義後に変更することはできません。
次の表に、各作業項目トラッキング オブジェクトの名前付けに対する要件を示します。
作業項目トラッキング オブジェクト |
参照名 |
表示名 |
|---|---|---|
作業項目の種類 |
該当なし |
作業項目の種類の名前は最大 255 文字の Unicode 文字で、チーム プロジェクト内において一意である必要があります。 |
作業項目フィールド |
必ず指定します。「参照名の要件」を参照してください。 |
フィールド名は最大 128 文字の Unicode 文字で、チーム プロジェクト コレクション内において一意である必要があります。 |
リンクの種類 |
必ず指定します。「参照名の要件」を参照してください。 |
転送名と反転名の各リンクの種類に対して 2 つの表示名を定義します。これらの名前は最大 128 文字の Unicode 文字で、チーム プロジェクト コレクションで定義されるすべてのリンクの種類において一意である必要があります。 |
[カテゴリ] |
必ず指定します。「参照名の要件」を参照してください。 |
カテゴリ表示名は最大 128 文字の Unicode 文字で、チーム プロジェクト内において一意である必要があります。 |
グローバル リスト |
該当なし |
各グローバル リストの名前は最大 254 文字の Unicode 文字で、チーム プロジェクト コレクション内において一意である必要があります。 |
トピック目次
表示名の要件
参照名の要件
フィールド参照名と移植性の要件
フィールド参照名の例
表示名の要件
このトピックの上の表で示した要件に加えて、定義する表示名は次の要件を満たす必要があります。
名前を空にすることはできません。
名前の先頭または末尾に空白は指定できません。
名前に円記号 (\) を含めることはできません。
フィールド名には、円記号 (\)、ピリオド (.)、左角かっこおよび右角かっこ ([]) を含めることはできません。
名前に連続する 2 つ以上の空白を含めることはできません。
参照名の要件
作業項目フィールド、リンクの種類、カテゴリを追加または作成する際には、必ず参照名を定義する必要があります。参照名は最大 70 文字の Unicode 文字になります。
参照名の定義には、英数字、アンダースコア (_)、およびハイフン (-) を使用できます。各参照名には少なくとも 1 つのピリオド (.) が必要ですが、名前の先頭と末尾にはピリオドは使用できません。参照名の先頭には、数字およびアンダースコアは使用できません。参照名では、複数のハイフンを (--) のように連続して使用することはできません。
フィールド参照名と移植性
作業項目の種類の定義言語には "フィールド参照名" の概念が導入されています。フィールド参照名により、Team Foundation プロジェクト コレクション間で定義を移植したり、サードパーティによる統合から特定のフィールドを見つけて参照したりできます。.NET Framework アプリケーション内の名前空間がグローバルに一意であるのと同じく、フィールド参照名もグローバルに一意なものにします。
フィールド参照名は名前変更できません。たとえば、フィールド名を "Title" から "Header" に変更した場合でも、そのフィールドのフィールド参照名は同じ名前のままになります。フィールドの統合と内部処理形式では、フィールド名自体に依存するのではなく、フィールド参照名を使用する必要があります。
System 名前空間は、Team Foundation システム関数に必須のすべてのコア システム フィールドを定義する場合のみ使用します。Team Foundation Server では、独自の System.X フィールドを作成することはできません。Team Foundation Server の機能が阻害される可能性があるためです。
Microsoft 名前空間は、Microsoft Solutions Framework (MSF) プロセス テンプレートの作業項目の種類の定義で定義されるフィールドを定義するのに使用されます。Team Foundation Server では、独自の Microsoft.X フィールドを作成することができます。しかし、そのような方法は使用しないことを強くお勧めします。Team Foundation Server の機能が阻害される可能性があるためです。
顧客およびパートナーは、独自の作業項目の種類用に独自のフィールド名前空間を作成できます。
システム フィールド、および MSF for Agile Software Development v5.0 で定義されるフィールドについては、「Visual Studio ALM の作業項目フィールド参照」を参照してください。
フィールド参照名の例
以下の例は、さまざまな名前空間での有効なフィールド参照名を示します。
.gif "ms194941.collapse_all(ja-jp,VS.110).gif")
System 名前空間の例
System.Id
System.Title
System.CreatedBy
System.CreationDate
System.ChangedBy
System.ChangedDate
System.State
System.Reason
Microsoft 名前空間の例
Microsoft.Common.Status
Microsoft.Common.Priority
Microsoft.Scheduling.Duration
Microsoft.Scheduling.PercentComplete
Microsoft.Testing.TestCaseName
他の名前空間の例
顧客やパートナーも、カスタムの作業項目の種類をサポートする独自の名前空間を定義できます。たとえば、Trey Research という架空の企業の場合なら、カスタムの作業項目の種類を次のように定義できます。
TreyResearch.Common.Severity
TreyResearch.Common.Phase
TreyResearch.RiskManagement.RiskType
TreyResearch.RiskManagement.Resolution
A.Datum Corporation という架空のソフトウェア企業の場合なら、作業項目の種類を次のように定義できます。
A_Datum.Common.BusinessPriority
A_Datum.Bug.FoundInPhase
A_Datum.Bug.FixInPhase