プロセス テンプレートへのレポートの追加
レポートのプラグインを使用すると、新しいチーム プロジェクトの [レポート] ノード (.png "レポート"){kind=icon}
) に表示されるフォルダー構造およびレポート セットを指定できます。
重要
レポートのプラグインでは、チーム プロジェクトを作成するチーム プロジェクト コレクションが SQL Server Analysis Services および SQL Server Reporting Services で構成済みである必要があります。詳細については、「チーム プロジェクトへのレポートの追加」を参照してください。
レポートのプラグインを使用して、主な 2 つのタスクを指定します。 最初に、site 要素を使用して、レポート サイトを作成します。 続いて、folder 要素と report 要素を使用して、サイトにアップロードされるフォルダー構造とレポートを指定します。 アップロードするレポートは拡張子が .rdl になり、Reporting Services で使用できます。 TFS プロセス テンプレートに用意されているレポートの概要については、「レポート (SQL Server Reporting Services)」を参照してください。
プロセス テンプレートからチーム プロジェクトを作成したら、レポートのフォルダー構造の追加、削除、名前の変更、および内容の変更を行うことができます。 詳細については、「レポートの表示、アップロード、および整理 (Reporting Services レポート)」を参照してください。
レポート プラグインの名前と場所
次の表に、MSF プロセス テンプレートのファイル、フォルダー、およびプラグインの名前を示します。
ファイル名: |
ReportsTasks.xml |
フォルダー名: |
レポート |
プラグイン名: |
Microsoft.ProjectCreationWizard.Reporting |
注意
この XML ファイルとフォルダーの名前は変更できますが、プラグインの名前は変更できません。Visual Studio Team Foundation Server には、クライアント側のプラグイン、ポリシー、その他の変更を配置する機構は含まれていません。このような機能を配置するには、配布とインストールを行う独自のプログラムを使用する必要があります。
XML ファイルでは、1 つまたは複数のタスクとその依存関係を指定します。 一連のレポートを指定するタスクの例については、MSF for Agile Software Development プロセス テンプレートの ReportsTasks.xml ファイルを参照してください。
レポート プラグインの構文構造
レポート プラグイン ファイルは、Rosetta.xsd ファイルで定義されている ReportingServices のスキーマ定義に従っており、独自のファイルで指定されている必要があります。
次の構文は、レポート プラグインの構造を示しています。 各要素の詳細については、このトピックで後述する ReportingServices の子要素を参照してください。
<?xml version="1.0" encoding="utf-8"?>
<tasks>
<task id="Site" plugin="Microsoft.ProjectCreationWizard.Reporting" completionMessage="Project Reporting site created.">
<dependencies />
<taskXml>
<ReportingServices>
<site> </site>
</ReportingServices>
</taskXml>
</task>
<task id="Populate Reports" plugin="Microsoft.ProjectCreationWizard.Reporting" completionMessage="Project reports uploaded.">
<dependencies>
<dependency taskId="Site" />
</dependencies>
<taskXml>
<ReportingServices>
<folders> . . . </folders>
<reports> . . . </reports>
</ReportingServices>
</taskXml>
</task>
</tasks>
レポート サイトの作成
レポートを正しく実行するには、レポート サイトを作成する必要があります。 レポート サイトはプロジェクト ポータル ホーム ページ上にリンクされ、そのリンクは ([レポート]) というラベルで示されます。 レポート サイトを作成するには、次の例で示すように site 要素を使用します。
<taskXml>
<ReportingServices>
<site></site>
</ReportingServices>
</taskXml>
フォルダーの定義
レポート サイトにフォルダーを作成するには、folder 要素を使用します。 path 属性を使用して、新しいフォルダーの相対パス名を指定します。 作成したフォルダーは、プロジェクト サイト、およびチーム エクスプローラー内のレポート フォルダーの下に表示されます。
次の例では、レポート サイトに 4 つのトップ レベル フォルダーと 2 つのサブフォルダーを作成します。 トップ レベルのフォルダーには、Bugs、Builds、Project Management、Tests というラベルが付けられます。 2 つのサブフォルダーは、Project Management に配置され、Visual Studio および Visual Studio ALM というラベルが付けられます。
<taskXml>
<ReportingServices>
<folders>
<folder path="Bugs" />
<folder path="Builds" />
<folder path="Project Management" />
<folder path="Project Management/Visual Studio" />
<folder path="Project Management/Visual Studio ALM" />
<folder path="Tests" />
</folders>
</ReportingServices>
</taskXml>
アップロードするレポートの指定
レポートは、.rdl ファイルによって定義されます。 レポート サイトにレポートを追加するには、プロセス テンプレートの Reports フォルダーの下のフォルダーにレポートの .rdl ファイルをコピーします。 次に report 要素を使用して、そのレポートに必要なプロパティおよびデータ ソースを記述します。
次の例では、Remaining Work.rdl ファイルが Project Management フォルダーにアップロードされるように指定しています。 ExplicitProject パラメーターとデータ ソースは、レポートごとに指定する必要があります。 次の例のデータ ソースは、Analysis Services キューブとデータ ウェアハウス リレーショナル データベースに自動的に割り当てられた名前に対応しています。
注意
レポート サービスのデータ ソースの名前は、Tfs2010ReportsDS と Tfs2010OlapReportsDS です。TFS 2012 または TFS 2013 をインストールしたかアップグレードした場合でも、TFS 2010 のインストールのデータ ソースに割り当てられていたこれらの名前が引き続き使用されます。
<taskXml>
<ReportingServices>
<reports>
<report name="Remaining Work" filename="Reports\Remaining Work.rdl" folder="Project Management" cacheExpiration="30">
<parameters>
<parameter name="ExplicitProject" value="" />
</parameters>
<datasources>
<reference name="/Tfs2010OlapReportDS" dsname="TfsOlapReportDS" />
<reference name="/Tfs2010ReportDS" dsname="TfsReportDS" />
</datasources>
</report>
. . .
</reports>
</ReportingServices>
</taskXml>
ReportingServices 要素リファレンス
次の構文は、ReportingServices 要素およびその子要素の構造を示しています。 これらの要素は taskXml コンテナー要素内で指定し、レポート プラグイン専用です。
<ReportingServices>
<folders>
<folder />
. . .
</folders>
<reports>
<report>
<parameters>
<parameter />
</parameters>
<datasources>
<reference />
</datasources>
</report>
. . .
</reports>
</ReportingServices>
次の表に、チーム プロジェクトをアップロードするためのレポートの指定に使用する要素を示します。このレポートは SQL Server Reporting Services を通じてアクセスされます。
要素 |
構文 |
説明 |
|---|---|---|
datasources |
|
report の子要素です (必須)。 レポートで使用するデータ ソースを指定する reference 要素のコレクションを格納します。 |
folder |
|
folders の子要素です (必須)。 チーム プロジェクトの [レポート] ノードの下に作成するフォルダーの名前を定義します。 |
folders |
|
ReportingServices の子要素です (省略可能)。 作成するフォルダーの名前をそれぞれ指定する folder 要素のコレクションを格納します。 |
parameter |
各属性は次の定義を持ちます。
少なくとも次のパラメーターを定義する必要があります。これにより、レポートで、レポートを含んでいるプロジェクトが自動的に使われるようになります。 |
parameters の子要素です (必須)。 レポート パラメーターの名前と、割り当てる値を指定します。 |
parameters |
|
report の子要素です (必須)。 レポートの parameter 要素のコレクションを定義します。 |
properties |
|
report の子要素です (省略可能)。 |
property |
各属性は次の定義を持ちます。
|
properties の子要素です (必須)。 |
reference |
各属性は次の定義を持ちます。
レポートのデータ ソースの名前に関する詳細については、「Team Foundation Server 2010 へのアップグレード後のレポートの検索」を参照してください。 |
datasources の子要素です (必須)。 データウェアハウス リレーショナル データベースおよび Analysis Services キューブとして Team Foundation Server で割り当てた名前を指定します。 |
report |
各属性は次の定義を持ちます。
|
reports の子要素です (必須)。 レポート名、.rdl 定義を含むファイル、アップロードされるレポートのフォルダーを指定します。 Team Foundation Server |
reports |
|
ReportingServices の子要素です (必須)。 アップロードするレポート ファイルの名前をそれぞれ指定する report 要素のコレクションを格納します。 |
ReportingServices |
|
レポート プラグインの taskXml 要素の子要素 (必須)。 SQL Server Reporting Services のレポートとフォルダーを定義するために必要なタスクを定義します。 |
site |
|
レポート プラグインの要素 (必須)。 チーム プロジェクトが作成されるレポート サイトを指定します。 |