作業項目の種類のインポート、エクスポート、および管理

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

重要

オンプレミスの XML プロセス モデルでは、 witadmin を使用して、プロジェクトのプロセスの一覧表示、インポート、エクスポート、および変更を行うことができます。 継承およびホストされた XML プロセス モデルの場合、 witadmin を使用してプロセス情報の一覧表示とエクスポートのみを行うことができます。 プロセス モデルの概要とサポートされる内容については、 作業追跡エクスペリエンスのカスタマイズに関するページを参照してください。

次の witadmin コマンドを使用して、プロジェクトの作業項目の種類を管理できます。

  • destroywitd: 作業項目の種類を破棄し、その型のすべての作業項目を回復なしで完全に破棄します。
  • exportwitd: 作業項目の種類の定義を XML ファイルまたはコマンド プロンプト ウィンドウにエクスポートします。
  • importwitd: 作業項目の種類を XML 定義ファイルからプロジェクトにインポートします。 同じ名前の作業項目の種類が既に存在する場合は、新しい作業項目の種類の定義によって既存の定義が上書きされます。 作業項目の種類が存在しない場合は、新しい作業項目の種類が作成されます。 作業項目の種類を定義し、ファイルをインポートしない XML を検証するには、 /v オプションを使用します。
  • listwitd: コマンド プロンプト ウィンドウに、指定したプロジェクト内の作業項目の種類の名前を表示します。
  • renamewitd: 特定のプロジェクト内の作業項目の種類の表示名を変更します。 このコマンドを実行した後、この種類の作業項目には新しい名前が表示されます。

作業項目の種類を使用して作業を追跡する方法の詳細については、「ユーザー ストーリー、問題、バグ、機能、エピックAzure Boards作業項目を追跡する」を参照してください。

witadmin コマンド ライン ツールを実行する方法

witadmin コマンド ライン ツールを実行するには、Visual Studioがインストールされているコマンド プロンプト ウィンドウを開きます。 witadmin コマンド ライン ツールは、任意のバージョンのVisual Studioと共にインストールされます。 このツールには、無料版のVisual Studio Communityまたはチーム エクスプローラー Visual Studioインストールすることでアクセスできます。

注意

オンプレミス サーバーに接続する場合は、Azure DevOps Serverと同じバージョンのVisual Studioまたはチーム エクスプローラーを使用する必要があります。 たとえば、TFS 2017 インスタンスに接続する場合は、Visual Studio 2017 またはチーム エクスプローラー 2017 から接続する必要があります。 Team Explorer 2015 バージョンはありません。

Visual Studio 2019 または Team Explorer 2019 クライアント:

%programfiles(x86)%\Microsoft Visual Studio\2019\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer

または、TeamExplorerProfessionalインストールしたバージョンに応じて、またはEnterprise代わりにCommunity

Visual Studio 2017 または Team Explorer 2017 クライアント:

%programfiles(x86)%\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer

または、TeamExplorerProfessionalインストールしたバージョンに応じて、またはEnterprise代わりにCommunity

Windowsの 32 ビット エディションでは、%programfiles(x86)% を%programfiles% に置き換えます。 Visual Studio Community (チーム エクスプローラーへのアクセスを提供) または Visual Studio Team Explorer 2017 を無料でインストールできます。

ヒント

witadmin を使用すると、定義ファイルをインポートおよびエクスポートできます。 使用できるその他のツールには、プロセス エディターが含まれます (Visual Studioのバージョンをインストールしている必要があります)。 Visual Studio Marketplace からプロセス テンプレート エディターをインストールします

または、TFS チーム Project マネージャー (GitHubから使用できるオープン ソース クライアント) を使用することもできます。

ヒント

witadmin を使用すると、定義ファイルをインポートおよびエクスポートできます。 使用できるその他のツールには、プロセス エディターが含まれます (Visual Studioのバージョンをインストールしている必要があります)。 Visual Studio Marketplace から TFS プロセス テンプレート エディターをインストールします。 このバージョンのプロセス エディターを使用して、古いスタイルの作業項目フォームを変更できます。 これを使用して 、新しい Web フォームに関連付けられているフォームを編集することはできません。

または、TFS チーム Project マネージャー (GitHubから使用できるオープン ソース クライアント) を使用することもできます。

前提条件

作業項目の種類が定義されているプロジェクトでは、次のアクセス許可が設定されている必要があります。

  • 作業項目の種類をエクスポートまたは一覧表示するには、Project Administrators グループのメンバーであるか、プロジェクト レベルの情報の表示権限が [許可] に設定されている必要があります。
  • 作業項目の種類を破棄、インポート、または名前変更するには、Team Foundation Administrators セキュリティ グループまたは Project Administrators セキュリティ グループのメンバーである必要があります。

詳細については、「 プロジェクトコレクションレベルのアクセス許可を変更する」を参照してください。

注意

管理者特権でサインインした場合でも、管理者特権のコマンド プロンプト ウィンドウを開いて、Server 2008 Windows実行しているサーバーでこの機能を実行する必要があります。 管理者特権のコマンド プロンプト ウィンドウを開くには、[ スタート] を選択し、 コマンド プロンプトのショートカット メニューを開き、[ 管理者として実行] を選択します。 詳細については、「Microsoft Web サイト: ユーザー Access Control」を参照してください。

構文

witadmin destroywitd /collection:CollectionURL /p:Project /n:TypeName [/noprompt]   
witadmin exportwitd /collection:CollectionURL /p:Project /n:TypeName [/f:FileName] [/e:Encoding] [/exportgloballists]  
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:Project 作業項目の種類を管理するプロジェクト。 このプロジェクトは、 /collection パラメーターで指定されたプロジェクト コレクションで定義する必要があります。

/v オプションを指定して importwitd コマンドを実行しない限り、/p パラメーターが必要です。
/n:TypeName 破棄、エクスポート、インポート、または名前を変更する作業項目の種類の名前。
/f:FileName エクスポートまたはインポートする作業項目の種類を含む XML 定義ファイルのパスとファイル名。 exportwitd コマンドを使用するときにこのパラメーターを省略すると、コマンド プロンプト ウィンドウに XML が表示されます。

メモ:Windows Vista を使用している場合は、特定のフォルダーに対するアクセス許可がない可能性があります。 アクセス許可がない場所に作業項目の種類をエクスポートしようとすると、レジストリ仮想化テクノロジが、自動的にエクスポートされたファイルをリダイレクトし、仮想ストアに保存します。 このリダイレクトが行われないようにするには、アクセス許可のある場所にファイルをエクスポートします。 詳細については、Microsoft Web サイトの レジストリ仮想化 ページを参照してください。
/e:Encoding .NET Framework 2.0 エンコード形式の名前。 XML データをエクスポートまたはインポートするときに、指定したエンコーディングを使用します。 たとえば、 /e:utf-7 Unicode (UTF-7) エンコードを指定します。 このパラメーターを省略すると、 witadmin は エンコードの検出を試み、検出に失敗した場合、 witadmin は UTF-8 を使用します。
/exportgloballists 作業項目の種類で参照されるグローバル リストの定義をエクスポートします。 グローバル リストの定義は、作業項目の種類の定義 XML に埋め込まれます。 指定しない場合、グローバル リストの定義は省略されます。
/v 作業項目の種類を定義する XML の検証だけを行い、XML 定義ファイルはインポートしません。 メモ: プロジェクトを指定せずに型定義を検証できます。 プロジェクト スコープのグループの参照は無視されます。
/new:NewName 作業項目の種類の新しい名前。
/noprompt 確認のプロンプトを無効にします。
/? または ヘルプ コマンド プロンプト ウィンドウにコマンドのヘルプを表示します。

注釈

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: アップグレード後に機能の構成ウィザードを使用してプロジェクトを更新するには、どのようなカスタマイズを行うことができますか?

A: カスタム WIT を追加し、フォーム レイアウトを変更できます。 機能の構成ウィザードによってプロジェクトが更新され、最新の機能にアクセスできるようになります。

ワークフローを変更したり、WIT の名前を変更したりするには、プロジェクトを更新するときに手動操作を実行する必要がある場合があります。 安全に実行できるカスタマイズと回避する必要があるカスタマイズについては、「 作業追跡エクスペリエンスのカスタマイズ: カスタマイズする前に、メンテナンスとアップグレードの影響を理解する」を参照してください。

Q: WIT に関連付けられた色を変更する方法を教えてください。

A: Web ポータルでは、作業項目がクエリ結果に表示され、アジャイル計画ツールのバックログページとボード ページに表示されます。 既存の WIT に関連付けられている色を変更したり、新しい WIT に使用する色を追加したりするには、 プロセス構成を編集します

Color assignments to different work item types

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 つあります。

<TRANSITION from=" " to="New">  
   <FIELDS>  
     <FIELD refname="System.CreatedBy">  
         <VALIDUSER for="Allowed Group" not="Disallowed Group" />  
     </FIELD>  
   </FIELDS>  
</TRANSITION>  

Q: WIT を削除する方法を教えてください。

A: チーム メンバーが特定の WIT を使用して作業項目を作成できないようにするには、プロジェクトから削除します。 使用すると witadmin destroywitd、その WIT と WIT 自体を使用して作成されたすべての作業項目が完全に削除されます。 たとえば、チームが Impediment を使用していない場合は、Fabrikam Web サイト プロジェクトから WIT ラベルの Impediment を削除できます。

witadmin destroywitd /collection:"http://FabrikamPrime:8080/tfs/DefaultCollection" /p:"Fabrikam Web Site" /n:"Impediment"   

カテゴリに属する WIT を削除する場合は、新しい名前を反映するようにプロジェクトのカテゴリ定義を更新する必要があります。 特に、 アジャイル計画ツール は、カテゴリ定義を更新するまで機能しません。

詳細については、「 カテゴリのインポートとエクスポート」を参照してください。