カテゴリのインポートとエクスポート [witadmin]
チーム プロジェクトに定義されたカテゴリをインポートおよびエクスポートするには、次の witadmin コマンドを使用します。
exportcategories: Team Foundation Server を実行しているサーバーで定義されているカテゴリの XML 定義をエクスポートします。
importcategories: 作業項目の種類の XML 定義ファイルを、Team Foundation Server を実行するサーバーのチーム プロジェクトにインポートします。
同じ名前のカテゴリが既に存在する場合、このコマンドは既存の定義を上書きします。 同じ名前の作業項目の種類が存在しない場合は、新しいカテゴリが作成されます。
既定のカテゴリとその使用方法については、こちらを参照してください。
witadmin コマンド ライン ツールは、オンプレミスの TFS に対して実行される場合にのみ機能します。 このツールを実行するには、Visual Studio またはチーム エクスプローラーがインストールされている環境でコマンド プロンプト ウィンドウを開き、次のように入力します。
cd %programfiles(x86)%\Microsoft Visual Studio 14.0\Common7\IDE
32 ビット版の Windows で、%programfiles(x86)% を %programfiles% に置き換えます。
注意
カテゴリは、Visual Studio のパワー ツールであるプロセス エディターを使用して作成および変更できます。このパワー ツールはサポートされていません。詳細については、Microsoft Web サイトのページ「Team Foundation Server パワー ツール」を参照してください。
必要条件
カテゴリが定義されているチーム プロジェクトに対して、次のアクセス許可を設定する必要があります。
作業項目の種類のカテゴリをエクスポートするには、[プロジェクトレベル情報を表示します] のアクセス許可が [許可] に設定されている必要があります。
作業項目の種類のカテゴリをインポートするには、プロジェクト管理者セキュリティ グループのメンバーであるか、または [プロジェクトレベル情報を編集します] のアクセス許可が [許可] に設定されている必要があります。
witadmin exportcategories /collection:CollectionURL /p:Project [/f:FileName] [/e:Encoding]
witadmin importcategories /collection:CollectionURL /p:Project /f:FileName [/e:Encoding]
パラメーター
パラメーター |
説明 |
|---|---|
/collection:CollectionURL |
チーム プロジェクト コレクションの URI を指定します。 URI の形式は http://ServerName:Port/VirtualDirectoryName/CollectionName です。 仮想ディレクトリを使用していない場合、URI の形式は次のようになります。 http://ServerName:Port/CollectionName |
/p:Project |
カテゴリのエクスポート元またはカテゴリのインポート先のチーム プロジェクトの名前。 |
/f:FileName |
エクスポートまたはインポートするカテゴリを含む XML 定義ファイルのパスとファイル名。 exportcategories コマンドの使用時にこのパラメーターを省略すると、カテゴリの一覧はコマンド プロンプト ウィンドウに表示されます。 |
/e:エンコーディング |
.NET Framework 2.0 のエンコーディング形式の名前。 XML データをエクスポートまたはインポートするときに、指定したエンコーディングを使用します。 たとえば、/e:utf-7 は Unicode (UTF-7) エンコーディングを指定します。 このパラメーターを省略すると、witadmin はエンコーディングの検出を試みます。検出に失敗した場合、witadmin は UTF-8 を使用します。 |
/? または help |
コマンド プロンプト ウィンドウにコマンドのヘルプを表示します。 |
解説
カテゴリ ファイルをインポートすると、カテゴリがまだ存在しない場合は作成されます。 カテゴリが既に存在する場合は、witadmin importcategories コマンドから、現在のリストが上書きされるという警告が出力されます。 独自のプログラムを作成して既存のカテゴリのセットを更新したり、新しいデータに基づいてカテゴリを自分で更新したりできます。
重要
カテゴリに加えた変更は、プロセスの構成に影響します。「チーム プロジェクトに合わせたアジャイル プランニング ツールの構成とカスタマイズ」を参照してください。
カテゴリの XML ファイルの構造については、「カテゴリ XML 要素リファレンス」を参照してください。
使用例
特に指定されていない場合、それぞれの例に適用される値は次のとおりです。
チーム プロジェクト コレクションの URI: http://AdventureWorksServer:8080/tfs/DefaultCollection
プロジェクト名: AdventureWorks
入力または出力ファイル名: myCategories.xml
既定のエンコーディング: UTF-8
カテゴリの一覧の表示
次のコマンドは、AdventureWorks プロジェクトに定義されている作業項目の種類のカテゴリを一覧表示します。
witadmin exportcategories /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks
隠し型カテゴリへのカテゴリの追加
カテゴリを隠し型カテゴリに追加すると、ユーザーがそのカテゴリで作業項目の種類を作成できなくなります。
チーム プロジェクトのカテゴリに関する定義ファイルをエクスポートします。
witadmin exportcategories /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myCategories.xmlカテゴリ ファイルを任意のテキスト エディターで開き、CATEGORY の "Hidden Types 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" /> </CATEGORY>追加する作業項目の種類の表示名を指定する WORKITEMTYPE 要素を追加します。
たとえば、次の構文では隠し型カテゴリに "Integration Build" というカスタムの作業項目の種類が追加されています。
<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="Integration Build" /> </CATEGORY>チーム プロジェクトに、カテゴリの定義ファイルをインポートします。
witadmin importcategories /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myCategories.xml
参照
概念
チーム プロジェクトに合わせたアジャイル プランニング ツールの構成とカスタマイズ