作業項目の種類のインポート、エクスポート、および管理 [witadmin]
次の witadmin コマンドを使用して、チーム プロジェクトの作業項目の種類を管理できます。
destroywitd: ある特定の作業項目の種類を破棄し、その種類のすべての作業項目を復元できないように完全に破棄します。
exportwitd: 作業項目の種類の定義を、XML ファイルまたはコマンド プロンプト ウィンドウにエクスポートします。
importwitd: 作業項目の種類を、XML 定義ファイルから Team Foundation Server を実行するサーバーのチーム プロジェクトにインポートします。 同じ名前の作業項目の種類が既に存在する場合は、新しい作業項目の種類の定義によって既存の定義が上書きされます。 同じ名前の作業項目の種類が存在しない場合は、新しい作業項目の種類が作成されます。 ファイルをインポートしないで、作業項目の種類を定義する XML を検証するには、/v オプションを使用します。
listwitd: 指定したプロジェクト内の作業項目の種類の名前を、コマンド プロンプト ウィンドウに表示します。
renamewitd: 特定のプロジェクト内にある作業項目の種類の表示名を変更します。 このコマンドを実行した後、この種類の作業項目には新しい名前が表示されます。
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 パワー ツール」を参照してください。
必要条件
作業項目の種類が定義されているチーム プロジェクトに対して、次のアクセス許可を設定する必要があります。
作業項目の種類をエクスポートまたは一覧表示するには、プロジェクト管理者グループのメンバーであるか、[プロジェクトレベル情報を表示します] のアクセス許可が [許可] に設定されている必要があります。
作業項目の種類の破棄、インポート、または名前変更を行うには、Team Foundation 管理者セキュリティ グループまたはプロジェクト管理者セキュリティ グループのメンバーである必要があります。
詳細については、「Team Foundation Server のアクセス許可の参照」を参照してください。
注意
管理者のアクセス許可を使ってログオンしている場合でも、Windows Server 2008 を実行中のサーバーでこの機能を実行するには、昇格した特権でコマンド プロンプト ウィンドウを開く必要があります。昇格した特権でコマンド プロンプト ウィンドウを開くには、[スタート] を選択し、[コマンド プロンプト] のショートカット メニューを開き、[管理者として実行] を選択します。詳細については、Microsoft Web サイトの「ユーザー アカウント制御」を参照してください。
witadmin destroywitd /collection:CollectionURL /p:Project /n:TypeName [/noprompt]
witadmin exportwitd /collection:CollectionURL /p:Project /n:TypeName [/f:FileName] [/e:Encoding] [/exportglobalists]
witadmin importwitd /collection:CollectionURL [/p:Project] /f:FileName [/e:Encoding] [/v]
witadmin listwitd /collection:CollectionURL /p:Project
witadmin renamewitd /collection:CollectionURL /p:Project /n:TypeName /new:NewName [/noprompt]
パラメーター
パラメーター |
説明 |
---|---|
/collection:CollectionURL |
チーム プロジェクト コレクションの URI を指定します。 URI の形式は http://ServerName:Port/VirtualDirectoryName/CollectionName です。 仮想ディレクトリを使用していない場合、URI の形式は次のようになります。 http://ServerName:Port/CollectionName |
/p: プロジェクト |
作業項目の種類を管理するチーム プロジェクト。 このチーム プロジェクトは、/collection パラメーターで指定されているプロジェクト コレクションで定義されている必要があります。 /p オプションを指定して importwitd コマンドを実行する場合を除き、/v パラメーターは必須です。 |
/n: TypeName |
破棄、エクスポート、インポート、または名前を変更する作業項目の種類の名前。 |
/f: FileName |
エクスポートまたはインポートする作業項目の種類を含む XML 定義ファイルのパスとファイル名。 exportwitd コマンドの使用時にこのパラメーターを省略すると、XML はコマンド プロンプト ウィンドウに表示されます。 注意 Windows Vista を使用している場合、アクセス許可を持たないフォルダーが存在する可能性があります。アクセス許可がない場所に作業項目の種類をエクスポートしようとすると、レジストリ仮想化テクノロジが、自動的にエクスポートされたファイルをリダイレクトし、仮想ストアに保存します。このリダイレクトが行われないようにするには、アクセス許可のある場所にファイルをエクスポートします。 レジストリの仮想化について詳しくは、Microsoft Web サイトの「レジストリの仮想化」および「Windows Vista でのファイルおよびレジストリの仮想化に関する一般的な問題」をご覧ください。 |
/e: エンコード |
.NET Framework 2.0 のエンコーディング形式の名前。 XML データをエクスポートまたはインポートするときに、指定したエンコーディングを使用します。 たとえば、/e:utf-7 は Unicode (UTF-7) エンコーディングを指定します。 このパラメーターを省略すると、witadmin はエンコーディングの検出を試みます。検出に失敗した場合、witadmin は UTF-8 を使用します。 |
/exportgloballists |
作業項目の種類で参照されるグローバル リストの定義をエクスポートします。 グローバル リストの定義は、作業項目の種類の定義 XML に埋め込まれます。 指定しない場合、グローバル リストの定義は省略されます。 |
/v |
作業項目の種類を定義する XML の検証だけを行い、XML 定義ファイルはインポートしません。 注意 チーム プロジェクトを指定せずに種類の定義を検証できます。プロジェクト スコープのグループの参照は無視されます。 |
/new: 新しい名前 |
作業項目の種類の新しい名前。 |
/noprompt |
確認のプロンプトを無効にします。 |
/? または help |
コマンド プロンプト ウィンドウにコマンドのヘルプを表示します。 |
解説
destroywitd コマンドを使用すると、次のすべてのオブジェクトが破棄されます。
作業項目の種類
その種類のすべての作業項目
作業項目テーブル、長いテキスト テーブル、およびリンク テーブルの対応するエントリ
作業項目の種類のメタデータ キャッシュ内のオブジェクト
例
特に指定されていない場合、それぞれの例に適用される値は次のとおりです。
チーム プロジェクト コレクションの URI: http://AdventureWorksServer:8080/tfs/DefaultCollection
プロジェクト名: AdventureWorks
入力または出力ファイル名: myworkitems.xml
作業項目の種類の名前: myworkitem
既定のエンコーディング: UTF-8
WIT の定義のエクスポート
次のコマンドは、myworkitem の定義を myworkitems.xml ファイルにエクスポートします。
witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myworkitems.xml /n:myworkitem
次の例は、Unicode (UTF-7) エンコーディングを使用して作業項目をエクスポートします。
witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myworkitems.xml /n:myworkitem /e:utf-7
WIT の定義および参照先のグローバル リストのエクスポート
次の例は、作業項目の種類とその参照先のグローバル リストをエクスポートします。
witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /f:myworkitems.xml /n:myworkitem /exportgloballists
WIT の定義の一覧表示
次の例は、作業項目の種類の定義をコマンド プロンプト ウィンドウに表示します。
witadmin exportwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /p:AdventureWorks /n:myworkitem
WIT の定義のインポート
次の例は、作業項目の定義を XML ファイルからインポートします。
witadmin importwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /f:myworkitem.xml /p:AdventureWorks
WIT の XML 定義の検証
次の例は、作業項目の種類を定義する XML を検証しますが、定義のインポートは行いません。
witadmin importwitd /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /f:myworkitem.xml /p:AdventureWorks /v
Q & A
Q: どのようなカスタマイズが可能ですか。 また、TFS のアップグレード後も機能の構成ウィザードを使用してチーム プロジェクトを更新できますか。
A: カスタム WIT の追加、およびフォーム レイアウトの変更が可能です。 機能の構成ウィザードは、チーム プロジェクトを更新し、最新機能へのアクセスを可能にします。
ワークフローを変更したり、WIT の名前を変更したりすると、チーム プロジェクトを更新するときにいくつかの手動操作を実行することが必要になる場合があります。 安全なカスタマイズおよび避けるべきカスタマイズの詳細については、「作業追跡エクスペリエンスのカスタマイズ: カスタマイズの前に、メンテナンスおよびアップグレードの影響について理解する」を参照してください。
Q: WIT に関連付けられた色を変更する方法を教えてください。
A: Team Web Access では、作業項目がクエリ結果に表示されます。アジャイル計画ツールのバックログとボード ページにも表示されます。 既存の WIT に関連付けられている色を変更したり、新しい WIT に使用する色を追加したりするには、プロセス構成を編集します。
Q: WIT を非アクティブまたは無効にする方法を教えてください。ユーザーに対して特定の種類の作業項目の作成を制限する方法を教えてください。
A: 無効にする WIT があるが、その種類に基づいて作成された作業項目を維持する場合は、すべての有効なユーザーに対してその種類の作業項目の保存を無効にする規則を追加できます。
<TRANSITION from=" " to="New">
<FIELDS>
<FIELD refname="System.CreatedBy">
<VALIDUSER not="[Team Project Name]Project Valid Users" />
</FIELD>
</FIELDS>
</TRANSITION>
ユーザーのグループに対して特定の WIT の作成を制限する場合は、アクセスを制限する方法が 2 つあります。
Hidden Categories グループに WIT を追加することで、プロジェクト共同作成者の大部分に対してそれらの WIT の作成を禁止します。 ユーザー グループに対してアクセスを許可する場合は、作業項目フォームを開くテンプレートへのハイパーリンクを作成し、それらの WIT を作成するチームのメンバーと共有できます。
System.CreatedBy フィールドのワークフローにフィールド規則を追加することで、ユーザー グループに対して特定の種類の作業項目の作成を効果的に制限します。 次の例に示すように、作業項目を作成するユーザーは作業項目を保存するには、Allowed Group に属している必要があります。
<TRANSITION from=" " to="New"> <FIELDS> <FIELD refname="System.CreatedBy"> <VALIDUSER for="Allowed Group" not="Disallowed Group" /> </FIELD> </FIELDS> </TRANSITION>
Q: WIT を削除する方法を教えてください。
A: チーム メンバーが作業項目を作成するために特定の WIT を使用することを避ける場合には、チーム プロジェクトからその WIT を削除できます。 witadmin destroywitd を使用する場合は、該当する WIT 自体に加えて、その WIT により作成されたすべての作業項目を完全に削除します。 たとえば、チームで "懸案事項" を使用していない場合、Fabrikam Web Site プロジェクトから WIT ラベル "懸案事項" を削除できます。
witadmin destroywitd /collection:"http://FabrikamPrime:8080/tfs/DefaultCollection" /p:"Fabrikam Web Site" /n:"Impediment"
あるカテゴリに属する WIT の名前を削除する場合、新しい名前に合わせてチーム プロジェクトのカテゴリ定義を更新する必要があります。 特に、アジャイル計画ツールは、カテゴリ定義を更新するまで使用できません。
詳細については、「カテゴリのインポートとエクスポート [witadmin]」を参照してください。
参照
処理手順
概念
チームのプロセスをサポートするための作業トラッキング オブジェクトのカスタマイズ