PerformancePoint Services レポートのエディターを作成する

[アーティクル]
09/18/2014

最終更新日: 2011年8月30日

適用対象: SharePoint Server 2010

Microsoft SharePoint Server 2010 の PerformancePoint Services では、カスタムエディターによってユーザーはカスタムオブジェクトにプロパティを設定できます。カスタムエディターは、編集コントロールを提供し、リポジトリのカスタムオブジェクトを取得および更新します。エディターの要件と機能の詳細については、「カスタム PerformancePoint Services オブジェクトのエディター」を参照してください。

適用先: PerformancePoint Services for SharePoint Server (Enterprise バージョン)

レポートエディターは、レポートエンドポイントを初期化する必要があります。レポートエンドポイントは、スコアカードとフィルタープロバイダーからパラメーター値を受け取ります。

このトピックの手順と例は、カスタムオブジェクトサンプルの SampleReportViewEditor クラスに基づいています。エディターは、ユーザーがレポートの名前と詳細を変更できるシン Web アプリケーションです。クラスのための完全なコードは、このトピックの「使用例」セクションで提供されています。

注意

サンプルエディターをテンプレートとして使用することをお勧めします。サンプルは、PerformancePoint Services API でオブジェクトを呼び出す方法、(オブジェクトの作成、更新などの) リポジトリ操作のためにヘルパーオブジェクトによる呼び出しを単純化する方法、PerformancePoint Services 開発のためのベストプラクティスを示します。

次のように 2 つの基本手順を実行して、レポートエディターを作成します。

エディタークラスの作成と設定
編集機能の定義

カスタムエディターを作成するには、エディタークラスの作成から始めます。

エディタークラスを作成して設定するには

PerformancePoint Services をインストールするか、拡張機能が使用する (手順 3. で示した) DLL をコンピューターにコピーします。詳細については、「開発シナリオで使用される PerformancePoint Services DLL」を参照してください。
Visual Studio で、C# クラスライブラリを作成します。拡張機能のためのクラスライブラリを既に作成している場合、新しい C# クラスを追加します。
プロジェクトに、アセンブリ参照として以下の PerformancePoint Services と SharePoint Server 2010 DLL を追加します。
- Microsoft.PerformancePoint.Scorecards.Client.dll
- Microsoft.PerformancePoint.Scorecards.ServerCommon.dll
- Microsoft.PerformancePoint.Scorecards.Store.dll (ヘルパークラスが使用)
- Microsoft.SharePoint.dll (ヘルパークラスが使用)
サンプルエディターには、System.Web.dll と System.Web.Services.dll へのアセンブリ参照も含まれます。拡張機能の機能によっては、その他のプロジェクト参照が必要になることがあります。
サンプルから以下のクラスをプロジェクトに追加します。エディターは、PerformancePoint Services リポジトリを操作するためにこれらのヘルパークラスを使用します。
- DataSourceConsumerHelper.cs
- ExtensionRepositoryHelper.cs
- ReportViewRepositoryHelper.cs
- IDataSourceConsumer.cs
注意

サンプルレポートでは、データをフィルターから取得します。このため、DataSourceConsumerHelper または IDataSourceConsumer オブジェクトは使用しません。ただし、ユーザーのレポートでデータを PerformancePoint Services データソースから取得する場合は、DataSourceConsumerHelper クラスによって公開されるメソッドを使用して、データソースを取得できます。詳細については、「[方法] PerformancePoint Services フィルターのエディターを作成する」を参照してください。
エディタークラスで、以下の PerformancePoint Services 名前空間のための using ディレクティブを追加します。
- Microsoft.PerformancePoint.Scorecards
- Microsoft.PerformancePoint.Scorecards.ServerCommon
拡張機能の機能によっては、その他の using ディレクティブが必要になることがあります。
エディターの実装をサポートする基本クラスから継承します。サンプルレポートエディターは Web アプリケーションなので、Page クラスから継承します。他の実装では、UserControl、WebPart クラスなどの基本クラスから派生できます。

エディタークラスを作成して設定した後で、エディターの機能を定義する必要があります。

編集機能を定義するには

ユーザーが表示または変更できるプロパティを表示するコントロールの変数を宣言します。サンプルレポートエディターでは、最初にユーザーインターフェイスコンポーネント (ASPX ページ) で定義されている Web サーバーコントロールの変数を宣言します。サンプルエディターでは、ユーザーが変更を送信できるボタンコントロールも定義します。次に、エディターで CreateChildControls() メソッドを呼び出して、これらのコントロールをページで使用できるようにします。

注意

エディターは、ユーザーインターフェイスとは別のプログラミングロジックを定義します。エディターのユーザーインターフェイスコンポーネントを作成するための説明は、この文書の範囲外となります。
AllowUnsafeUpdates プロパティを true に設定します。これにより、レポートエディターはフォーム POST 操作を使用せずにデータをリポジトリに書き込むことができます。

サンプルレポートエディターでは、Page_Load メソッドで手順 2. ～ 6. を実行します。Page_Load は、変数とコントロールの初期化と検証、コントロールの事前設定、およびカスタムレポートとヘルパーオブジェクトの状態情報の保存を実行するためにも使用されます。

クエリ文字列からパラメーターを取得し、それらを以下のコード例で示すローカル変数のための値として設定します。

// The URL of the site collection that contains the PerformancePoint Services repository.
string server = Request.QueryString[ClickOnceLaunchKeys.SiteCollectionUrl];

// The location of the report in the repository.
string itemLocation = Request.QueryString[ClickOnceLaunchKeys.ItemLocation];

// The operation to perform: OpenItem or CreateItem.
string action = Request.QueryString[ClickOnceLaunchKeys.LaunchOperation];

クエリ文字列パラメーターの詳細については、「カスタム PerformancePoint Services オブジェクトのエディター」を参照してください。

以下のコード例に示すように、リポジトリに呼び出しをするための ReportViewRepositoryHelper オブジェクトを取得します。
```
reportviewRepositoryHelper = new ReportViewRepositoryHelper();
```
以下のコード例に示すように、クエリ文字列パラメーターに基づいてレポートの場所を設定します。
```
RepositoryLocation repositoryReportViewLocation = RepositoryLocation.CreateFromUriString(itemLocation);
```
以下のコード例に示すように、クエリ文字列から実行する操作 (OpenItem または CreateItem) を取得し、カスタムレポートを取得または作成します。
```
if (ClickOnceLaunchValues.OpenItem.Equals(action, StringComparison.OrdinalIgnoreCase))
    {

        // Use the repository-helper object to retrieve the report.
        reportview = reportviewRepositoryHelper.Get(repositoryReportViewLocation);
        if (reportview == null)
        {
            displayError("Could not retrieve the report view for editing.");
            return;
        }
    }
    else if (ClickOnceLaunchValues.CreateItem.Equals(action, StringComparison.OrdinalIgnoreCase))
    {
        reportview = new ReportView
        {
            RendererClassName = typeof(SampleReportRenderer).AssemblyQualifiedName, 
            SubTypeId = "SampleReportView"
        };
    }
    else
    {
        displayError("Invalid Action.");
        return;
    }
```
- カスタムレポートを取得するには、ReportViewRepositoryHelper.Get メソッドを使用します。
- カスタムレポートを作成するには、ReportView() コンストラクターを使用し、レポートの Name、RendererClassName、および SubTypeId プロパティを定義します。
  
  SubTypeId は、レポートの一意識別子です。これは、PerformancePoint Services web.config ファイルでカスタムレポートに対して指定する subType 属性と一致する必要があります。RendererClassName は、レンダラー Web サーバーコントロールを定義するクラスの完全修飾名です。エディターで定義していない場合、この値は、既定で web.config ファイルに指定されているレンダラークラスに設定されます。
注意

既定では、ユーザーは PerformancePoint ダッシュボードデザイナーからのみカスタムオブジェクトを作成できます。ユーザーにダッシュボードデザイナーの外でカスタムオブジェクトを作成できるようにするには、リポジトリのコンテンツタイプから CreateItem 要求をエディターに送るメニュー項目を追加する必要があります。詳細については、「カスタム PerformancePoint Services オブジェクトのエディター」を参照してください。
レポートのエンドポイントを定義します。エンドポイントによってレポートは、フィルターとスコアカードからデータを取得できます。サンプルレポートエディターでは、エンドポイントに必要なプロパティを以下のコード例のように定義します。
```
if (0 == reportview.EndPoints.Count)
{
    EndPoint endpoint = new EndPoint
    {
        Category = EndPointCategory.None,
        UniqueName = "SampleReportView_EndPoint",

        // The display name is shown to users in Dashboard Designer.
        // It represents the endpoint that can be connected 
        // to a filter or scorecard.
        DisplayName = "Sample Report View EndPoint"
    };

    reportview.EndPoints.Add(endpoint);
}
```
サンプルエディターでは、VerifyReportView メソッドでエンドポイントを定義します。また、VerifyReportView を使用して、必要なプロパティが設定されていることを確認し、オプションの CustomData プロパティを定義します。このプロパティを使用してレポートの情報を格納できます。
レポートをユーザー定義の変更で更新します。サンプルレポートエディターの buttonOK_Click メソッドは、ReportViewRepositoryHelper.Update メソッドを呼び出して、リポジトリでレポートの Name と Description プロパティを更新します。buttonOK_Click は、コントロールの内容を検証したり、カスタムレポートとヘルパーオブジェクトの状態情報を取得するときにも使用されます。

注意

ユーザーは、カスタムオブジェクトの Name、Description、および Owner ([責任者]) プロパティを編集して、ダッシュボードデザイナーおよび PerformancePoint Services リポジトリからカスタムオブジェクトを直接削除することができます。

次の手順: レポートエディター (必要な場合はそのユーザーインターフェイスも) とレポートレンダラーを作成した後で、「[方法] PerformancePoint Services の拡張機能を手動で登録する」の説明に従って拡張機能を展開します。レポート拡張機能のサンプルをインストールおよび設定する方法については、「コードサンプル: カスタムレポート、フィルター、および表形式データソースオブジェクト」の「サンプルのレポート、フィルター、およびデータソースオブジェクトのインストール」セクションを参照してください。

例

次のコード例では、リポジトリでカスタムレポートを作成、取得、および更新します。このコード例は、ASPX ページで定義されているコントロールのプログラミングロジックとして使用できます。

注意

このコード例をコンパイルできるようにするには、「エディタークラスを作成して設定するには」で説明しているとおりに開発環境を設定する必要があります。

using System;
using System.Web.UI;
using System.Web.UI.WebControls;
using Microsoft.PerformancePoint.Scorecards;
using Microsoft.PerformancePoint.Scorecards.ServerCommon;

namespace Microsoft.PerformancePoint.SDK.Samples.SampleReport
{

    // Represents the class that defines the sample report editor. 
    public class SampleReportViewEditor : Page
    {

        // Declare private variables for the ASP.NET controls defined in the user interface.
        // The sample's user interface is an ASPX page that defines the controls in HTML.
        private TextBox textboxName;
        private TextBox textboxDescription;
        private Label labelErrorMessage;
        private Button buttonOK;

        // Make the controls available to this class.
        protected override void CreateChildControls()
        {
            base.CreateChildControls();

            if (null == textboxName)
                textboxName = FindControl("textboxName") as TextBox;
            if (null == textboxDescription)
                textboxDescription = FindControl("textboxDescription") as TextBox;
            if (null == labelErrorMessage)
                labelErrorMessage = FindControl("labelErrorMessage") as Label;
            if (null == buttonOK)
                buttonOK = FindControl("buttonOK") as Button;
        }

        // Handles the Load event of the Page control.
        // Methods that use a control variable should call the Control.EnsureChildControls
        // method before accessing the variable for the first time.
        protected void Page_Load(object sender, EventArgs e)
        {

            // Required to enable custom report and filter editors to
            // write data to the repository.
            ServerUtils.AllowUnsafeUpdates = true;

            // Initialize controls the first time the page loads only.
            if (!IsPostBack)
            {
                EnsureChildControls();
                ReportViewRepositoryHelper reportviewRepositoryHelper = null;
                try
                {

                    // Get information from the query string parameters.
                    string server = Request.QueryString[ClickOnceLaunchKeys.SiteCollectionUrl];
                    string itemLocation = Request.QueryString[ClickOnceLaunchKeys.ItemLocation];
                    string action = Request.QueryString[ClickOnceLaunchKeys.LaunchOperation];

                    // Validate the query string parameters.
                    if (string.IsNullOrEmpty(server) ||
                        string.IsNullOrEmpty(itemLocation) ||
                        string.IsNullOrEmpty(action))
                    {
                        displayError("Invalid URL.");
                        return;
                    }

                    // Retrieve the repository-helper object.
                    reportviewRepositoryHelper =
                        new ReportViewRepositoryHelper();

                    // Set the report location by using the location from the query string.
                    RepositoryLocation repositoryReportViewLocation = RepositoryLocation.CreateFromUriString(itemLocation);

                    ReportView reportview;

                    // Retrieve or create the report object, depending on the operation
                    // passed in the query string (OpenItem or CreateItem).
                    if (ClickOnceLaunchValues.OpenItem.Equals(action, StringComparison.OrdinalIgnoreCase))
                    {

                        // Retrieve the report object by using the repository-helper object.
                        reportview = reportviewRepositoryHelper.Get(repositoryReportViewLocation);
                        if (reportview == null)
                        {
                            displayError("Could not retrieve the report view for editing.");
                            return;
                        }
                    }
                    else if (ClickOnceLaunchValues.CreateItem.Equals(action, StringComparison.OrdinalIgnoreCase))
                    {

                        // Create a report view.
                        // CreateItem requests can be sent from a SharePoint list, but
                        // you must create a custom menu item to send the request.
                        // Dashboard Designer can send edit requests only.
                        reportview = new ReportView
                        {
                            RendererClassName = typeof(SampleReportRenderer).AssemblyQualifiedName, 
                            SubTypeId = "SampleReportView"
                        };
                    }
                    else
                    {
                        displayError("Invalid Action.");
                        return;
                    }

                    VerifyReportView(reportview);

                    // Save the original report and helper objects across page postbacks.
                    ViewState["action"] = action;
                    ViewState["reportview"] = reportview;
                    ViewState["reportviewrepositoryhelper"] = reportviewRepositoryHelper;
                    ViewState["itemlocation"] = itemLocation;

                    // Populate the child controls.
                    textboxName.Text = reportview.Name.ToString();
                    textboxDescription.Text = reportview.Description.ToString();
                }
                catch (Exception ex)
                {
                    displayError("An error has occurred. Please contact your administrator for more information.");
                    if (reportviewRepositoryHelper != null)
                    {

                        // Add the exception detail to the server event log.
                        reportviewRepositoryHelper.HandleException(ex);
                    }
                }
            }
        }

        // Handles the Click event of the buttonOK control.
        protected void buttonOK_Click(object sender, EventArgs e)
        {
            EnsureChildControls();

            // Verify that the textboxName control contains a value.
            if (string.IsNullOrEmpty(textboxName.Text))
            {
                labelErrorMessage.Text = "A report view name is required.";
                return;
            }

            // Clear any pre-existing error message.
            labelErrorMessage.Text = string.Empty;

            // Retrieve the report and helper objects from view state.
            string action = (string)ViewState["action"];
            string itemLocation = (string) ViewState["itemlocation"];
            ReportView reportview = (ReportView)ViewState["reportview"];
            ReportViewRepositoryHelper reportviewRepositoryHelper = (ReportViewRepositoryHelper)ViewState["reportviewrepositoryhelper"];

            // Update the report object with form changes.
            reportview.Name.Text = textboxName.Text;
            reportview.Description.Text = textboxDescription.Text;

            // Save the report object to the PerformancePoint Services repository.
            try
            {
                reportview.Validate();
                if (ClickOnceLaunchValues.CreateItem.Equals(action, StringComparison.OrdinalIgnoreCase))
                {
                    reportview.CreatedDate = DateTime.Now;
                    ReportView newReportView = reportviewRepositoryHelper.Create(
                        string.IsNullOrEmpty(reportview.Location.ItemUrl) ? itemLocation : reportview.Location.ItemUrl, 
                        reportview);
                    ViewState["reportview"] = newReportView;
                    ViewState["action"] = ClickOnceLaunchValues.OpenItem;
                }
                else
                {
                    reportviewRepositoryHelper.Update(reportview);
                }
            }
            catch (Exception ex)
            {
                displayError("An error has occurred. Please contact your administrator for more information.");
                if (reportviewRepositoryHelper != null)
                {
                    // Add the exception detail to the server event log.
                    reportviewRepositoryHelper.HandleException(ex);
                }
            }
        }

        // Displays the error string in the labelErrorMessage label. 
        void displayError(string msg)
        {
            EnsureChildControls();

            labelErrorMessage.Text = msg;

            // Disable the OK button because the page is in an error state.
            buttonOK.Enabled = false;
            return;
        }

        // Verifies that the properties for the report object are set.
        static void VerifyReportView(ReportView reportview)
        {

            // Verify that all required properties are set. 
            if (string.IsNullOrEmpty(reportview.SubTypeId))
            {

                // This value must match the subType attribute specified
                // in the web.config file.
                reportview.SubTypeId = "SampleReportView";
            }

            if (string.IsNullOrEmpty(reportview.RendererClassName))
            {
                reportview.RendererClassName = typeof (SampleReportRenderer).AssemblyQualifiedName;
            }

            // Reports are consumers and do not use provider endpoints.
           reportview.BeginPoints.Clear();

            // If there are no consumer endpoints, create one so we can connect a filter or a scorecard to the report.
            if (0 == reportview.EndPoints.Count)
            {
                EndPoint endpoint = new EndPoint
                {
                    Category = EndPointCategory.None,
                    UniqueName = "SampleReportView_EndPoint",

                    // The display name is shown to users in Dashboard
                    // Designer to represent the endpoint that can be 
                    // connected to a filter or scorecard.
                    DisplayName = "Sample Report View EndPoint"
                };

                reportview.EndPoints.Add(endpoint);
            }
            
            // Set optional properties for reports.
            reportview.CustomData = "You can use this property to store custom information for this filter as a string or a serialized object.";
        }
    }
}

コードのコンパイル

セキュリティ

DLL には厳密な名前で署名する必要があります。さらに、DLL によって参照されたすべてのアセンブリが厳密な名前を持つことを確認してください。厳密な名前を使用してアセンブリに署名する方法の詳細、および公開/秘密キーのペアを作成する方法の詳細については、「How to: Create a Public/Private Key Pair」を参照してください。

次の方法で共有

PerformancePoint Services レポートのエディターを作成する

エディタークラスを作成して設定するには

編集機能を定義するには

例

コードのコンパイル

セキュリティ

関連項目

タスク

概念

その他の技術情報

その他のリソース

次の方法で共有

PerformancePoint Services レポートのエディターを作成する

エディター クラスを作成して設定するには

編集機能を定義するには

例

コードのコンパイル

セキュリティ

関連項目

タスク

概念

その他の技術情報

その他のリソース

エディタークラスを作成して設定するには