在 SharePoint 中创建 PerformancePoint Services 的筛选数据提供程序
了解如何在自定义筛选器扩展中为 PerformancePoint Services 创建数据提供程序组件。
什么是 PerformancePoint Services 的自定义数据提供程序？
在 PerformancePoint Services 中，自定义数据提供程序从筛选器的基础数据源中检索数据并定义如何使用这些数据。 最重要的是，数据提供程序指定要在筛选器控件中公开的数据值以及可用作筛选器起点的数据。 数据提供程序还会存储用户从筛选控件中选择的值，这些值随后将发送给筛选器使用方。 数据提供程序使用两个 DataTable 对象来组织和存储数据。 有关详细信息，请参阅 PerformancePoint Services 筛选器。
下面的过程和示例以自定义对象示例中的 SampleFilterDataProvider 类为依据，展示了如何创建、配置和定义筛选器数据提供程序。 借助编辑器这一精简 Web 应用，用户可以修改报表名称和说明。 有关 类的完整代码，请参阅代码示例：在 SharePoint 中为自定义PerformancePoint Services筛选器创建数据提供程序。
建议您将示例数据提供程序用作模板。 示例中显示了如何调用 PerformancePoint Services API 中的对象，并演示了 PerformancePoint Services 开发的最佳实践。
为自定义 PerformancePoint Services 筛选器创建数据提供程序
安装 PerformancePoint Services，或者将您的扩展使用的 DLL（步骤 3 中列出）复制到您的计算机上。 有关详细信息，请参阅 具有类库的 DLL。
在 Visual Studio 中，创建一个 C# 类库。 如果您已为扩展创建了一个类库，请添加新 C# 类。
您必须用强名称对您的 DLL 进行签名。 此外，请确保您的 DLL 所引用的所有程序集都具有强名称。 有关如何使用强名称对程序集进行签名以及如何创建公钥/私钥对的信息，请参阅 如何：创建公钥/私钥对。
将以下 PerformancePoint Services DLL 作为程序集引用添加到项目：
- Microsoft.PerformancePoint.Scorecards.Client.dll
- Microsoft.PerformancePoint.Scorecards.Server.dll
根据扩展的功能不同，可能需要其他项目引用。
在您提供程序类中，请为以下 PerformancePoint Services 命名空间添加 using 指令：
根据您的扩展的功能，可能需要其他 using 指令。
继承自 CustomParameterDataProvider 基类。
为数据提供程序名称设置字符串标识符。 此标识符必须与在注册扩展时添加到 web.config 文件的 CustomParameterDataProviders 部分中的项匹配。 有关详细信息，请参阅 如何：手动注册 PerformancePoint Services 扩展。
重写 GetId () 方法以返回数据提供程序的标识符。
重写 GetDisplayDataInternal 方法以定义 DataTable 对象，以存储基础数据源中的数据值。 筛选器可使用此方法填充筛选器选择控件。 显示模拟运算表必须包含以下列名：
Key 记录的唯一标识符。 该值不能为空。 出于性能和安全原因，控件只发出一个项；控件不发出其他列中的值。
Display 筛选器控件中显示的值。
ParentKey 此值用于排列树控件中的分层数据。
IsDefault：此值用于暂留筛选器。
提示
可以添加多个列以扩展筛选器功能。
GetDisplayDataInternal 调用 DataSourceRegistry.GetDataSource(DataSource) 方法，按名称验证数据源类型，如下所示：
- 它通过使用数据源的 SubTypeId 属性引用自定义数据源类型，该属性与在数据源扩展插件的 PerformancePoint Services web.config 文件中注册的 subType 属性的值相同。
- 它通过使用 SourceName 属性引用本机数据源，该属性从 DataSourceNames 类返回字段。
重写 GetMessageData 方法以存储用户从筛选器控件中选择的内容。 筛选器在将用户的选择发送给使用者时使用此方法。
代码示例：在 SharePoint 中创建自定义 PerformancePoint Services 筛选器的数据提供程序
下面的代码示例演示数据提供程序如何从 Web 服务或 Excel 工作表中检索值，并返回筛选器的显示数据和消息数据的 DataTable 对象。
在编译此代码示例之前，您必须配置开发环境，如创建和配置提供程序类中所述。
using System.Data;
using Microsoft.PerformancePoint.Scorecards;
using Microsoft.PerformancePoint.Scorecards.Server.Extensions;
namespace Microsoft.PerformancePoint.SDK.Samples.SampleFilter
{
// Represents the sample filter's data provider.
public class SampleFilterDataProvider : CustomParameterDataProvider
{
// This value must match the key that you register for this extension
// in the CustomParameterDataProviders section in the web.config file.
private const string dataProviderName = "SampleFilterDataProvider";
// Returns a table of all possible values (rows) for the
// filter's beginpoints. The filter's BeginPoint property returns
// one ParameterDefinition object.
protected override DataTable GetDisplayDataInternal(ParameterDefinition parameterDefinition, RepositoryLocation parameterSourceLocation, object custom)
{
DataTable retrievedData = null;
// Get the data source.
DataSource parameterDataSource = SafeGetDataSource(parameterSourceLocation);
if (null != parameterDataSource)
{
// Verify that the data source is the sample data source
// or an Excel workbook, which are the types that the
// sample supports.
// If you modify these types of data source, you must make
// the corresponding change in the filter's editor.
if (parameterDataSource.SourceName == "WSTabularDataSource" || parameterDataSource.SourceName == DataSourceNames.ExcelWorkbook)
{
IDataSourceProvider parameterDataSourceProvider =
DataSourceRegistry.GetDataSource(parameterDataSource);
if (null != parameterDataSourceProvider)
{
var dataSourceMetadata = parameterDataSourceProvider as IDataSourceMetadata;
if (null != dataSourceMetadata)
{
// Get the data and store it in the retrievedDataSet
// variable. The -1 parameter returns all records
// from the data source.
DataSet retrievedDataSet = dataSourceMetadata.GetPreviewDataSet(-1);
// Verify that the dataset contains data.
if (retrievedDataSet != null &&
retrievedDataSet.Tables != null &&
retrievedDataSet.Tables.Count > 0 &&
retrievedDataSet.Tables[0] != null &&
retrievedDataSet.Tables[0].Columns != null &&
retrievedDataSet.Tables[0].Columns.Count > 0 &&
retrievedDataSet.Tables[0].Rows != null &&
retrievedDataSet.Tables[0].Rows.Count > 0 &&
retrievedDataSet.Tables[0].Columns.Contains(parameterDefinition.KeyColumn))
{
retrievedData = retrievedDataSet.Tables[0];
}
}
}
}
if (null != retrievedData)
{
// Name the display data table.
retrievedData.TableName = "ParamData";
// Verify that the table has the correct structure.
EnsureDataColumns(retrievedData, parameterDefinition);
bool firstRowSeen = false;
foreach (DataRow row in retrievedData.Rows)
{
// Set the ParentKeyColumn to null because the data
// does not have a hierarchical structure.
row[parameterDefinition.ParentKeyColumn] = null;
// Set the IsDefaultColumn column in the first row to true.
row[parameterDefinition.IsDefaultColumn] = !firstRowSeen;
if (!firstRowSeen)
{
firstRowSeen = true;
}
}
// Set the column visibility.
SetColumnVisibility(retrievedData);
}
}
return retrievedData;
}
// Adds the ShowColumn extended property to a column in the display data table
// and sets it to true. This exposes the column in Dashboard Designer as
// a source value for the beginpoint.
private static void SetColumnVisibility(DataTable displayData)
{
for (int i = 0; i < displayData.Columns.Count; i++)
{
if (!displayData.Columns[i].ExtendedProperties.Contains("ShowColumn"))
{
displayData.Columns[i].ExtendedProperties.Add("ShowColumn", true);
}
}
}
// Verify that all required columns are in the data table.
// The data table returned by this method is expected to contain a
// Key, ParentKey, IsDefault, Display, and an arbitrary number of
// Value columns.
// The specific column names (except for Value columns) are defined
// in the filter's ParameterDefinition object, which is referenced by
// the filter's BeginPoint property.
private static void EnsureDataColumns(DataTable dataTable, ParameterDefinition parameterDefinition)
{
if (!string.IsNullOrEmpty(parameterDefinition.KeyColumn) && !dataTable.Columns.Contains(parameterDefinition.KeyColumn))
{
dataTable.Columns.Add(parameterDefinition.KeyColumn);
}
if (!string.IsNullOrEmpty(parameterDefinition.DisplayColumn) && !dataTable.Columns.Contains(parameterDefinition.DisplayColumn))
{
dataTable.Columns.Add(parameterDefinition.DisplayColumn);
}
if (!string.IsNullOrEmpty(parameterDefinition.ParentKeyColumn) && !dataTable.Columns.Contains(parameterDefinition.ParentKeyColumn))
{
dataTable.Columns.Add(parameterDefinition.ParentKeyColumn);
}
if (!string.IsNullOrEmpty(parameterDefinition.IsDefaultColumn) && !dataTable.Columns.Contains(parameterDefinition.IsDefaultColumn))
{
dataTable.Columns.Add(parameterDefinition.IsDefaultColumn, typeof(bool));
}
}
// Returns the unique string identifier of the data provider.
// This value must match the key that you register for this extension
// in the CustomParameterDataProviders section in the web.config file.
public override string GetId()
{
return dataProviderName;
}
// Returns a table of rows that match the keys in the passed
// ParameterMessage object.
// This method is used by controls that accept parameters, such as
// scorecard and reports. It can also apply a Post Formula.
public override DataTable GetMessageData(RepositoryLocation providerLocation, ParameterMessage parameterMessage, RepositoryLocation parameterSourceLocation, ParameterMapping parameterMapping, object custom)
{
DataTable msgTable = null;
// The ParameterMapping object contains information about
// linked dashboard items.
// The CustomData object is optionally used to store information
// that is not stored in other properties.
DataTable displayTable = GetDisplayDataInternal(parameterMessage, parameterSourceLocation, custom);
if (null != displayTable)
{
msgTable = displayTable.Clone();
for (int i = 0;i < parameterMessage.Values.Rows.Count; i++)
{
for (int j = 0;j < displayTable.Rows.Count; j++)
{
if (!parameterMessage.Values.Rows[i][parameterMessage.KeyColumn].Equals(displayTable.Rows[j][parameterMessage.KeyColumn].ToString()))
continue;
msgTable.ImportRow(displayTable.Rows[j]);
break;
}
}
}
return msgTable;
}
}
}
后续步骤
创建数据提供程序和筛选器编辑器 (包括其用户界面后，如果需要) ，请部署扩展，如如何：手动注册PerformancePoint Services扩展中所述。