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

  • [アーティクル]

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

重要

オンプレミスの 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 Team エクスプローラーの無料バージョンをインストールします。

Note

Azure DevOps Services に接続するには、最新バージョンの Visual Studio または Visual Studio Community を使用することをお勧めします。

Note

オンプレミス サーバーに接続するには、Azure DevOps Server と同じまたはそれ以降のバージョンの Visual Studio を使用することをお勧めします。 たとえば、Azure DevOps Server 2019 に接続する場合は、Visual Studio 2019 のバージョンからプロジェクトに接続します。

Visual Studio 2022 の場合

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

またはProfessionalEnterprise、Communityインストールしたバージョンによって異なります。

Visual Studio 2019 の場合

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

またはProfessionalEnterprise、Communityインストールしたバージョンによって異なります。

Visual Studio 2017 の場合

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

またはTeamExplorerProfessional、Enterpriseインストールしたバージョンによって異なります。

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

ヒント

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

前提条件

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

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

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

Note

管理者権限でサインインした場合でも、管理者特権のコマンド プロンプト ウィンドウを開いて、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] [/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]

Parameters

パラメーター 説明
/collection:CollectionURL プロジェクト コレクションの URI を指定します。 次に例を示します。

オンプレミスの形式:http://ServerName:Port/VirtualDirectoryName/CollectionName
仮想ディレクトリを使用しない場合は、次の形式 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 確認のプロンプトを無効にします。
/? または 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: アップグレード後に機能の構成ウィザードを使用してプロジェクトを更新するには、どのようなカスタマイズを行うことができますか。

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

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

Q: WIT に関連付けられている色操作方法変更しますか?

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

さまざまな作業項目の種類への色の割り当て

Q: WIT 操作方法非アクティブ化または無効化しますか? 操作方法ユーザーが特定の種類の作業項目を作成できないように制限しますか?

A: 削除する作業項目の種類があるが、その種類に基づいて作成された作業項目メイン含まれている場合は、有効なすべてのユーザーが作業項目の種類を保存できないようにするルールを追加できます。

    <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 サイト プロジェクトから、Impediment というラベルの付いた WIT を削除できます。

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

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

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