Ejemplo de código: Objetos de origen de datos tabular, filtro e informe personalizados

Artículo
09/18/2014

Última modificación: martes, 31 de mayo de 2011

Hace referencia a: SharePoint Server 2010

Se aplica a: PerformancePoint Services para SharePoint Server, versión Enterprise
El ejemplo de objetos de origen de datos tabular, filtro e informe personalizados para PerformancePoint Services de Microsoft SharePoint Server 2010 se incluye en el ejemplo de referencia de SDK de PerformancePoint Services. El ejemplo está diseñado para mostrar cómo crear extensiones de origen de datos tabular, filtro e informe personalizadas para PerformancePoint Services. Contiene un origen de datos que recupera el índice de cotizaciones desde un servicio web externo, un filtro que permite a los usuarios especificar las cotizaciones para las que se van a mostrar valores y un informe que muestra los valores de las cotizaciones seleccionadas en el filtro.

Se recomienda usar el ejemplo como plantilla para las extensiones personalizadas. El ejemplo contiene objetos auxiliares que simplifican las llamadas para las operaciones de repositorio (como crear y actualizar) y muestra los procedimientos recomendados para la programación con PerformancePoint Services. Para obtener más información sobre los tipos de extensión admitidos, vea Escenarios de desarrollo con PerformancePoint Services.

Componentes de objetos personalizados en el ejemplo

El ejemplo contiene los siguientes componentes relacionados con objetos personalizados:

Extensión de informe
Extensión de filtro
Extensión de origen de datos
Objetos auxiliares

Las extensiones de origen de datos, filtro e informe incluyen componentes de representador o proveedor, así como componentes de editor. Los representadores se implementan como controles de servidor web, mientras que los editores se implementan como páginas ASPX con clases de código subyacente. Los editores de ejemplo siguen la práctica de desarrollo de SharePoint Server de definir la lógica de programación del editor para la página ASPX en una clase que se compila en un archivo DLL.

Nota

Para obtener instrucciones sobre cómo instalar los objetos personalizados del ejemplo en el equipo de desarrollo, vea Instalación de los objetos de informe, filtro y origen de datos de ejemplo.

Extensión de informe

El informe de ejemplo recibe datos del filtro de ejemplo y muestra información de índice de cotizaciones en una tabla. Las extensiones de informe personalizadas suelen incluir un representador (necesario) y un editor.

El informe de ejemplo contiene los archivos siguientes:

SampleReportRenderer.cs Representa el informe de ejemplo en un elemento web. El representador es un control de servidor web que usa un objeto HtmlTextWriter para escribir el HTML para la visualización del informe.
SampleReportViewEditor.aspx Proporciona la interfaz de usuario del editor, que es una página ASPX que se ejecuta en el servidor front-end web y muestra controles de servidor web. La página ASPX define los controles de servidor web en HTML.
SampleReportViewEditor.cs Proporciona la lógica de programación para el editor, incluida la lógica para los controles que se definen en la página ASPX.

Para obtener más información, vea Creación de extensiones de informes para PerformancePoint Services.

Extensión de filtro

El filtro de ejemplo usa información de índice de cotizaciones recuperada de un servicio web o libro de Microsoft Excel. Las extensiones personalizadas de filtro suelen incluir un proveedor (necesario), un representador y un editor. Un filtro puede usar un representador personalizado o un representador de PerformancePoint Services nativo. En este ejemplo se usa el control de árbol de selección múltiple de PerformancePoint Services.

El filtro de ejemplo contiene los archivos siguientes:

SampleFilterDataProvider.cs Define el proveedor de datos para el filtro personalizado. Esta clase controla la interacción con el origen de datos del filtro.
SampleFilterEditor.aspx Proporciona la interfaz de usuario del editor, que es una página ASPX que se ejecuta en el servidor front-end web y muestra controles de servidor web. La página ASPX define los controles de servidor web en HTML.
SampleFilterEditor.cs Proporciona la lógica de programación para el editor, incluida la lógica para los controles que se definen en la página ASPX.

Para obtener más información, vea Creación de extensiones de filtros para PerformancePoint Services.

Extensión de origen de datos

El origen de datos de ejemplo proporciona información de índice de cotizaciones desde un servicio web. Las extensiones personalizadas de origen de datos suelen incluir un proveedor (necesario) y un editor. PerformancePoint Services solo admite orígenes de datos tabulares.

El origen de datos de ejemplo contiene los archivos siguientes:

BasicTabularDataSourceProvider.cs Contiene métodos invalidados que no se implementan mediante el proveedor de origen de datos personalizado.
SampleDataSourceEditor.aspx Proporciona la interfaz de usuario del editor, que es una página ASPX que se ejecuta en el servidor front-end web y muestra controles de servidor web. La página ASPX define los controles de servidor web en HTML.
SampleDataSourceEditor.cs Proporciona la lógica de programación para el editor, incluida la lógica para los controles que se definen en la página ASPX.
SampleDSCacheHandler.cs Representa el origen de datos subyacente que proporciona información de índice de cotizaciones. Esta clase recupera valores de cotizaciones de un archivo caché y lo actualiza con valores que se recuperan desde el servicio web.
WSTabularDataSourceProvider.cs Representa el proveedor de origen de datos personalizado.

Para obtener más información, vea Creación de extensiones de orígenes de datos tabulares para PerformancePoint Services.

Objetos auxiliares

PerformancePoint Services usa listas de SharePoint como su repositorio para objetos de primera clase (FCO). Almacena orígenes de datos en una biblioteca de documentos de SharePoint y almacena paneles, cuadros de mandos, informes, filtros, indicadores clave de rendimiento (KPI) e indicadores en una lista de SharePoint. El repositorio predeterminado consta de la biblioteca DataConnections para PerformancePoint y la lista de contenido de PerformancePoint.

El ejemplo incluye objetos auxiliares que simplifican las operaciones necesarias entre un editor y el repositorio de PerformancePoint Services, como la recuperación y actualización de objetos personalizados y el acceso a orígenes de datos de PerformancePoint Services. Los objetos auxiliares también proporcionan enlaces para el registro del servidor y el control de excepciones.

Nota

Dado que los editores de ejemplo se ejecutan en el servidor front-end web, usan los objetos BIMonitoringServiceApplicationProxy y SPDataStore para realizar operaciones de repositorio. Para obtener más información, vea Editores para objetos personalizados de PerformancePoint Services.

Las siguientes clases del ejemplo representan objetos auxiliares:

ExtensionRepositoryHelper.cs Representa la clase base para los objetos auxiliares del repositorio.
- DataSourceRepositoryHelper.cs Crea, recupera y actualiza objetos de origen de datos personalizados en el repositorio de PerformancePoint Services. Esta clase se usa mediante el editor del origen de datos de ejemplo.
- FilterRepositoryHelper.cs Crea, recupera y actualiza objetos de filtro personalizados en el repositorio de PerformancePoint Services. Esta clase se usa mediante el editor del filtro de ejemplo.
- ReportViewRepositoryHelper.cs Crea, recupera y actualiza objetos de informe personalizados en el repositorio de PerformancePoint Services. Esta clase se usa mediante el editor del informe de ejemplo.
IDataSourceConsumer.cs Representa una interfaz implementada por las clases FilterRepositoryHelper y ReportViewRepositoryHelper que las identifica como consumidores de origen de datos.
DataSourceConsumerHelper.cs Tiene acceso a los datos de los orígenes de datos subyacentes y los consume. Esta clase se usa mediante el filtro e informe de ejemplo.

Instalación de los objetos de informe, filtro y origen de datos de ejemplo

Para instalar los objetos de informe, filtro y origen de datos de ejemplo, debe compilar el ensamblado de ejemplo, registrar el ensamblado en la memoria caché global de ensamblados, copiar el editor y los archivos de hoja de estilos y registrar las extensiones en el archivo web.config de PerformancePoint Services. Estas tareas requieren permisos administrativos necesarios en el servidor de aplicaciones, que es el equipo que ejecuta PerformancePoint Services.

Nota

La funcionalidad de redirección que abre los editores personalizados requiere que la configuración de SharePoint Server 2010 contenga una colección de sitios de nivel superior (raíz).

Nota

Las instrucciones acerca de cómo instalar el ejemplo completo se incluyen en los archivos de ejemplo.

Para instalar los objetos de ejemplo

Descargue el archivo comprimido (.zip) del ejemplo de referencia de SDK de PerformancePoint Services, que incluye los componentes de origen de datos tabular, filtro e informe personalizado.
Extraiga el contenido en una carpeta del equipo.
Abra el ejemplo en Visual Studio.
En el Explorador de soluciones, expanda la carpeta Referencias y restablezca todas las referencias del proyecto faltantes. Los ensamblados de PerformancePoint Services se instalan únicamente en la memoria caché global de ensamblados. Según el entorno de desarrollo, es posible que deba copiarlos en un directorio diferente. Para obtener instrucciones acerca de cómo copiar ensamblados de PerformancePoint Services desde la memoria caché global de ensamblados, vea Archivos DLL de PerformancePoint Services usados en escenarios de desarrollo.

El ejemplo incluye referencias a los siguientes ensamblados de PerformancePoint Services y SharePoint Server 2010:
- Microsoft.PerformancePoint.Scorecards.Client
- Microsoft.PerformancePoint.Scorecards.DataSourceProviders.Standard
- Microsoft.PerformancePoint.Scorecards.Server
- Microsoft.PerformancePoint.Scorecards.ServerCommon
- Microsoft.PerformancePoint.Scorecards.ServerRendering
- Microsoft.PerformancePoint.Scorecards.Store
- Microsoft.SharePoint
Compile el ensamblado de ejemplo.

Nota

En estas instrucciones se supone que firma el ensamblado con el archivo SDKSamples.snk que se incluye en el ejemplo. Si usa otro archivo de clave de nombre seguro para generar un token de clave pública para el ensamblado, reemplace el token de clave pública del ejemplo de estas instrucciones (fa525c8383a44a52) por la clave real. En estas instrucciones también se supone que la dirección URL relativa al servidor al repositorio de orígenes de datos es /BICenter/Data Connections for PerformancePoint/. Si esto no coincide con la configuración, modifique la dirección URL en el método SampleFilterEditor.PopulateDataSourceDropDown. En función de la configuración, es posible que la dirección URL no requiera una barra diagonal.
En el servidor de aplicaciones, agregue el ensamblado de ejemplo (Microsoft.PerformancePoint.SDK.Samples.dll) a la memoria caché global de ensamblados. Para obtener instrucciones, vea How to: Install an Assembly into the Global Assembly Cache.
Copie las páginas ASPX del editor de las carpetas SampleDataSource, SampleFilter y SampleReport en los archivos de ejemplo a la carpeta LAYOUTS en la ruta de acceso %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\LAYOUTS.
Copie ppsmasdk.css de los archivos de ejemplo a la carpeta STYLES en la ruta de acceso %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\LAYOUTS\STYLES.
Realice los pasos 1 a 3 en el procedimiento "Para agregar metadatos para un objeto de informe, filtro u origen de datos personalizado" en Procedimiento para registrar manualmente las extensiones de PerformancePoint Services. Este procedimiento crea una copia de seguridad del archivo web.config de PerformancePoint Services y, a continuación, agrega código para admitir el registro de objetos personalizados.

Para registrar los objetos de informe, filtro y origen de datos de ejemplo, pegue el siguiente código en el elemento CustomFCOGroup.

<CustomFCO type="DataSource" subType="WSTabularDataSource">
    <Resources FCOName="Custom Data Source" FCODescription="This is my custom data source." />
    <EditorURI uri="/_layouts/SampleDataSourceEditor.aspx" />
</CustomFCO>
<CustomFCO type="Filter" subType="SampleFilter">
    <Resources FCOName="Custom Filter" FCODescription="This is my custom filter." />
    <RendererClass name="Microsoft.PerformancePoint.Scorecards.ServerRendering.MultiSelectTreeViewControl, 
    Microsoft.PerformancePoint.Scorecards.ServerRendering, Version=14.0.0.0,
    Culture=neutral, PublicKeyToken=71e9bce111e9429c" />
    <EditorURI uri="/_layouts/SampleFilterEditor.aspx" />
</CustomFCO>
<CustomFCO type="ReportView" subType="SampleReportView">
    <Resources FCOName="Custom Report" FCODescription="This is my custom report."/>
    <RendererClass name="Microsoft.PerformancePoint.SDK.Samples.SampleReport.SampleReportRenderer,
    Microsoft.PerformancePoint.SDK.Samples, Version=14.0.0.0,
    Culture=neutral, PublicKeyToken=fa525c8383a44a52" />
    <EditorURI uri="/_layouts/SampleReportViewEditor.aspx" />
</CustomFCO>

Para registrar el proveedor de origen de datos de ejemplo, pegue el siguiente código en el elemento CustomDataSourceProviders.

<add key="WSTabularDataSource" value="Microsoft.PerformancePoint.SDK.Samples.SampleDataSource.WSTabularDataSourceProvider,

    Microsoft.PerformancePoint.SDK.Samples, Version=14.0.0.0, Culture=neutral,

    PublicKeyToken=fa525c8383a44a52" />

Para registrar el proveedor de datos de filtro de ejemplo, pegue el siguiente código en el elemento CustomParameterDataProviders.

<add key="SampleFilterDataProvider" value="Microsoft.PerformancePoint.SDK.Samples.SampleFilter.SampleFilterDataProvider,

    Microsoft.PerformancePoint.SDK.Samples, Version=14.0.0.0, Culture=neutral,

    PublicKeyToken=fa525c8383a44a52" />

Guarde y cierre el archivo web.config.
En función de su entorno, es posible que deba reiniciar Internet Information Services (IIS).

Tras instalar el ejemplo, puede usar Diseñador de paneles de PerformancePoint para crear instancias de los objetos de informe, filtro y origen de datos de ejemplo. (Cree primero el origen de datos de ejemplo para que pueda seleccionarlo como origen de datos para el filtro. Asegúrese de hacer clic en Aceptar en el editor de informes para inicializar los extremos del informe y actualizar Diseñador de paneles para obtener las versiones actualizadas de los objetos personalizados). A continuación, agregue el filtro y el informe a un panel, y conéctelos mediante la selección del extremo de vista del informe de ejemplo como el extremo del informe y de Símbolo como el valor de origen para el punto inicial del filtro. Si desea obtener más información sobre cómo usar Diseñador de paneles, vea el sitio web de Office.