プロセステンプレートのカスタマイズ

[アーティクル]
10/08/2024

Azure DevOps Server 2022 - Azure DevOps Server 2019

プロセステンプレートは、プロジェクトの作成時に使用できるオブジェクトとプロセスを定義します。プロセステンプレートをカスタマイズすることで、さらにオブジェクトの 1 つをカスタマイズします。一般的なカスタマイズの種類は次のとおりです。

既存の作業項目の種類 (WIT) に新しいフィールドを追加する
フィールドの値の選択リストを変更する
既定またはカスタムの作業項目の種類のワークフローの状態、理由、遷移、およびアクションを変更する
作業項目フォームのレイアウトを編集する
作業項目の種類を追加または削除する
Azure Boards ハブに関連付けられているプロセス構成または既定値を変更する

Note

この記事では、Azure DevOps Services で定義されたプロジェクトを作成するために使用されるプロセステンプレートについて説明します。ソフトウェア開発のプロジェクトテンプレートをお探しの場合は、「Visual Studio テンプレートの作成を参照してください。

既定のプロセステンプレートでは、Azure Boards と Azure Test Plans で使用される既定の構成と作業項目の種類を定義します。たとえば、アジャイルプロセステンプレートは、次の図に示す作業項目の種類のセットを定義します。

アジャイルプロセステンプレート成果物の概念図。

これらの成果物の多くは、作業の追跡に使用される作業項目の種類によって異なります。たとえば、機能、バグ、ユーザーストーリー、またはタスクの定義で定義されているデータフィールドは、作業項目クエリの定義にも使用されます。これらの成果物に加えて、初期プロジェクト領域とイテレーション、セキュリティ構成、およびテスト計画をサポートするその他の既定の設定を定義することもできます。

プロジェクトを作成したら、構成を変更して成果物をカスタマイズできます。ただし、プロジェクトを作成する前にプロセステンプレートをカスタマイズすることで、作成した結果のプロジェクトはすべて、標準的なチームプロセスのセットと一致します。プロセステンプレートをカスタマイズする主な理由は次のとおりです。

複数のプロジェクトを作成する予定であり、作成する各プロジェクトで後で実装する必要がある繰り返しのタスクを最小限に抑える必要がある
ソフトウェア開発チームが使用するツールセット内のテンプレートと構造を提供して、すべてのチームが特定の標準に準拠していることを確認する必要がある
アップグレード後の機能の構成ウィザードの使用をサポートするには、カスタムプロセステンプレートを更新する必要があります

1 つのプロジェクトのみを操作する場合は、プロジェクトを作成し、後で 1 つ以上のオブジェクトをカスタマイズすることを検討してください。

プロセステンプレートはどのように使用されますか?

プロセステンプレートの主な用途は、プロジェクトを作成することです。 Hosted XML プロセスモデルの場合は、プロジェクトの更新にも使用されます。プロジェクトは、相互に依存するテンプレートファイルのセットで定義されているオブジェクト、成果物、および構成のセットを提供します。プロジェクトを使用して、ソースコードの整理、作業と情報の追跡、ソフトウェアのビルド、テストアクティビティのサポートを行います。

ホストされた XML プロセスモデル

オンプレミス XML プロセスモデル

プロジェクトの作成

まず、何を行う必要がありますか。

プロセステンプレートのカスタマイズを開始する前に、構成およびカスタマイズできる内容を理解し、それに応じて変更を計画します。

プロセステンプレートを初めて使用する場合は、最初に既定のプロセステンプレート確認します。
プロセステンプレートのファイル構造を理解するには、各ファイルの説明を確認するかプロセステンプレートダウンロードします。

プロジェクトのプロセスは、作成後に変更できます。プロジェクトを操作する際に、定義されたプロセステンプレートの初期設定がニーズを満たさなくなる可能性があります。
テスト計画、テストスイート、テストケースなど、作業の追跡に使用されるオブジェクトのカスタマイズに最も関心がある場合は、「作業の追跡エクスペリエンスをカスタマイズするを確認してください。プロジェクトの XML 定義ファイルを変更して行うカスタマイズは、プロセステンプレートファイルで行うカスタマイズと同じ種類です。

作業項目の種類追加または変更するにはプロセステンプレート全体を変更せずに行うことができます。既存のプロジェクトを使用して、変更を行ってテストできます。オンプレミスの XML プロセスモデルでは、 witadmin exportwitd および importwitd コマンドラインツールを使用して、作業項目の種類の XML 定義ファイルをダウンロードしてアップロードできます。
広範なカスタマイズを検討している場合は、変更プロジェクトのメンテナンスとアップグレードに与える影響を確認してください。

カスタマイズできるプロセステンプレートファイルと機能領域

プロセステンプレートは、9 つのプラグインで構成されます。各プラグインは、実行する一連のタスクと、プロジェクトの作成時に表示される画面を定義します。タスクは、アクセス許可の設定、フォルダーの作成、ファイルのアップロード、サイトのアクティブ化、またはその他の構成可能な変数の設定を行います。プラグインでは、タスクが他のタスクの正常な完了時に持つ依存関係も指定します。

プロセステンプレートプラグインの概念図。

重要

Web ポータルからプロジェクトを作成すると、いくつかのプロセステンプレートファイルは無視されます。具体的には、レポートマネージャーサイトを作成するファイルはサポートされていません。プロジェクトコレクションのレポートをサポートするには、「チームプロジェクトにレポートを追加する」を参照してください。

プロセステンプレートをカスタマイズするには、機能領域に関連付けられている 1 つ以上のファイルをカスタマイズします。 1 つのオブジェクトのカスタマイズは非常に簡単ですが、カスタマイズ時に相互依存関係を中断しないようにしてください。 ProcessTemplate.xml プラグインファイルは、テンプレートに含めるプラグインを定義します。このファイルには、プロジェクトを作成するために実行するすべてのタスクグループが含まれています。各タスクグループは、そのプラグインの特定のタスクが定義されている下位 XML プラグインファイルを参照します。

Teams、グループ、アクセス許可、および領域と反復パス
- 領域と反復パス
- グループ、チーム、メンバー、アクセス許可
作業項目のトラッキング
テスト管理
- テスト環境、構成、解決の状態、設定

プラグインの依存関係

多くのオブジェクトは、プロセステンプレート内の他のオブジェクトの定義に依存します。必要なプラグインとプラグインの依存関係の概要については、「タスクグループとタスクの依存関係の定義を参照してください。

プラグインと名前付けの制限

プロセステンプレートにオブジェクトを追加するときは、XML 検証エラーを回避するために、オブジェクトに正しいラベルを付けてください。

制限は、ほとんどの Team Foundation オブジェクトの名前またはラベルに適用されます。プロセステンプレート、セキュリティグループ、領域と反復ノード、作業項目の種類、作業項目フィールドに適用される名前付け制限の概要については、「名付けの制限を参照してください。
カスタマイズするほとんどのプロセステンプレートコンポーネントは、プロセステンプレートを使用して作成したプロジェクトにのみ影響します。このルールの例外は、グローバルリスト、リンクの種類、作業項目フィールドです。これらのオブジェクトは、プロジェクトコレクションに対して定義されます。
各作業項目フィールドには、各フィールドを一意に識別するフィールド参照名が関連付けられています。参照名は、割り当てられた後は変更できません。

さらに、プロジェクトコレクションに SQL Server Reporting Services を使用している場合は、作業項目フィールドに割り当てられたレポート名が、プロジェクトコレクションに定義されているすべての作業項目の種類で一致する必要があります。そうしないと、プロセステンプレートをアップロードするときに検証エラーが発生したり、データウェアハウスデータベースで競合が発生したりする可能性があります。

作業項目フィールド名、リンク型名、およびグローバルリストは、プロジェクトコレクションにスコープが設定されます。これらのオブジェクトのいずれかをカスタマイズすると、コレクションで定義されているすべてのプロジェクトと、その作業項目フィールドを含む作業項目の種類に変更が反映されます。
プロセステンプレートの最大サイズは 2 ギガバイトです。プロセステンプレートをカスタマイズするときは、変更によってその値を超えるサイズが増えないことを確認します。

プロセステンプレートをカスタマイズする手順

プロセステンプレートのカスタマイズは反復的なプロセスです。 Azure DevOps Server を実行しているサーバーで定義されているプロジェクトコレクションが必要です。ここで、プロセステンプレートをテストして、正しくカスタマイズされたことを確認できます。

プロセステンプレートをカスタマイズするには、まず既存のプロセステンプレートをダウンロードし、ファイルを変更または追加し、プロセステンプレートファイルをアップロードしてから、変更を確認します。

プロセステンプレートのカスタマイズワークフローを示す概念図。

Step	タスク
	プロセステンプレートをダウンロードします。プロセステンプレートをカスタマイズする前に、ローカルコンピューターにダウンロードする必要があります。必要な変更を最小限に抑えるには、チームプロセスに最も近いテンプレート選択します。一般に、作業項目とワークフローの種類に基づいてプロセステンプレートを選択します。
	ファイルの変更または追加。プロセステンプレートをカスタマイズするには、プロセステンプレートに対して定義されているファイルを変更、削除、または追加します。プラグインまたは定義ファイルをカスタマイズする場合は、その XML コンテンツを変更します。各プラグインファイルと型定義ファイルは、その XML スキーマ定義に準拠している必要があります。プロセステンプレートを初めてカスタマイズするときは、小さな変更を加えます。変更がテンプレートに与える影響をよく理解せずに多くの変更を行うと、デバッグが困難な複数のミスが発生するリスクがあります。プロセステンプレートの名前が一意であることを確認します。プロセステンプレートをダウンロードして変更し、アップロードする場合は、その名前を変更するか、プロジェクトコレクションから既存のプロセステンプレートを過剰に書き込む必要があります。
	プロセステンプレートをアップロードします。テンプレートをカスタマイズしたら、プロジェクトを作成するプロジェクトコレクションにアップロードします。理想的には、他のプロジェクトで使用されていないプロジェクトコレクションを使用する必要があります。テストベッドプロジェクトコレクションで作業することで、開発中の既存のチームプロセスと競合する可能性のある変更を導入しないようにすることができます。また、プロジェクトコレクションは、プロジェクトポータルやレポートサイトなど、アクセスするのと同じリソースをサポートする必要があります。プロセステンプレートの名前が一意であることを確認します。プロジェクトコレクションからプロセステンプレートをダウンロードし、変更を加え、テンプレートをアップロードする場合は、その名前を変更するか、プロジェクトコレクションから既存のプロセステンプレートを削除する必要があります。アップロードプロセスでは、検証チェックを実行して、XML が有効であることを確認します。プロセステンプレートをアップロードしようとしたときにエラーが発生した場合は、行った変更によってエラーが発生します。変更内容を確認し、見つけた XML 構文エラーを修正します。
	プロジェクトを作成します。新しいプロセステンプレートをテストするには、プロジェクトを作成する必要があります。エラーが発生した場合は、プロジェクト作成のログを表示します。これには、実行しようとしたタスクの一覧が含まれ、失敗したタスクが表示されます。失敗したタスクを XML にマップし直して、エラーの原因を特定できます。不要なプロジェクトは、 TFSDeleteProject コマンドラインツールを使用してクリーンアップできます。
	プロセステンプレートの変更を確認します。プロセステンプレートを運用モードにして、複数のプロジェクトの基礎として使用する前に、それが明確に定義されていることを確認する必要があります。このタスクを実行するには、各オブジェクトと成果物が期待どおりに動作することを体系的に確認します。