Robert Bruckner's Advanced Reporting Services Blog : CustomReportItem

What Kind of Reports are Published / Which Use Custom Report Items?

Robert M. Bruckner — Fri, 09 Jan 2009 10:15:00 GMT

As an administrator of a report server, you may occasionally ask yourself the question of what kind of reports are published in terms of their particular feature usage. For example:

· Usage of Custom Report Items (CRIs)
You plan to upgrade from RS 2005 to RS 2008 and there are CRI controls installed on your current RS 2005 server (look for a <ReportItems> section in rsReportServer.config)? You may want to know whether they are actually referenced in any currently published reports on the server, because you may have read this related blog posting and are wondering if you need to install the 2005-based CRI controls on your RS 2008 server?

· Usage of subreports
Which reports use subreports? Not only is this interesting for dependency tracking, but it might also be relevant for optimizing performance.

· Usage of custom assemblies
What kind of (custom) assemblies are referenced by published reports? This might be interesting information for auditing, or for trouble-shooting the security policy configuration of a report server.

Offline Solutions

Well, as always there are multiple ways to accomplish this.

One option is to download all the reports from the server in an automated way and then analyze the RDL contents. This can be accomplished similar to the RS Explorer sample application, via the Reporting Services SOAP API, and using ListChildren and GetReportDefinition. Alternatively, you could utilize RS Scripter, a great tool written by Jasper Smith, to script/download all reports. For the subsequent offline analysis in the file system use full text search tools (e.g. findstr).

Basic SQL Query Solutions

As an administrator of a report server, you may access the catalog database directly. Keep in mind that any queries you execute directly against the report server’s catalog database may affect the performance of the overall system. Make sure that you never take any locks on objects in that database, as this is not supported and interferes with the function of the report server. That said, if you are familiar with the RDL XSD structure, you can write a simple query like the following to find all reports that reference subreports:

USE ReportServer

SELECT Path, Name, Description, *

FROM Catalog

WHERE Type = 2 AND

CONVERT(VARCHAR(MAX),CONVERT(VARBINARY(MAX),Content)) LIKE '%<Subreport%'

SQL XQuery Solutions

Let's now focus on a slightly more complex scenario: you want to determine which types of CRIs are used by which reports on your server.

Note that the RDLs stored in the report server are exactly the RDL files that were originally uploaded. Since the CRI feature was introduced with the RDL 2005/01 namespace, we only need to query that particular namespace to find reports that reference 2005 CRIs. If however you are looking for subreports or other elements, you may have to query several namespaces: RDL 2003/10, RDL 2005/01, and RDL 2008/01. Btw, my esteemed colleague John Gallardo used to work a lot with XQuery before joining the Reporting Services team and helped crafting the initial query, which I further refined to this:

USE ReportServer

/* declare and populate temp table */

DECLARE @tab TABLE (Path NVARCHAR(MAX), xmlColumn XML)

INSERT @tab

SELECT Path, CONVERT(XML, CONVERT(VARBINARY(MAX), Content)) FROM Catalog WHERE Type=2;

/* for all CustomReportItem elements, display the report path, CRI type and name */

WITH XMLNAMESPACES ('http://schemas.microsoft.com/sqlserver/reporting/2005/01/reportdefinition' as rdl)

SELECT Path as ReportPath,

n.x.value('@Name', 'nvarchar(256)') as CRIName,

n.x.value('(//rdl:Type)[1]', 'nvarchar(256)') as CRIType

FROM @tab

CROSS APPLY xmlColumn.nodes('//rdl:CustomReportItem') n(x)

Custom Report Item

Robert M. Bruckner — Wed, 31 Dec 2008 21:55:00 GMT

Custom Report Item in Reporting Services 2005

This server extensibility feature introduced in Reporting Services 2005 (RS 2005) provides the ability to develop custom report items for embedding in reports. Examples of resources available that provide insights into how one can build custom report item solutions include: documentation overview, sample, and a great MSDN magazine article by Teo Lachev.

Over time, several independent partners utilized this extensibility mechanism and developed nice 2005-based Custom Report Item (CRI) controls, such as Dundas Visualization Products for Reporting Services, various barcode controls, and even some that take RTF and draw it as image into reports.

Custom Report Item in Reporting Services 2008

RS 2008 introduces a new RenderingObjectModel and an on-demand paradigm for processing and rendering reports. Consequently, also the CRI runtime control interfaces and how the control interacts with the new on-demand RenderingObjectModel have changed. An updated CRI-Polygon sample is available for RS 2008.

Using 2005-based Custom Report Items in Reporting Services 2008

I have seen two common questions regarding the support of 2005 CRIs in RS 2008:

Q: What if you bought or developed a 2005-based CRI runtime control - can you run those old reports after upgrading your report server to RS 2008?

A: Yes, running 2005-based CRI runtime controls on a RS 2008 server is supported. Your old 2005-based reports will run on RS 2008 without modifications - however make sure to verify that the Web.config of your 2008 report server contains an assembly binding redirect for the Microsoft.ReportingServices.Interfaces.dll as specified in KB 955795.

Q: What about 2005-based CRI design time controls?

A: 2005-based CRI design time controls work with Business Intelligence Development Studio 2005 (BIDS 2005) only. You can continue to design reports with BIDS 2005 and deploy directly to your RS 2008 server with the 2005-based CRI runtime control installed.
For BIDS 2008 however, the CRI integration interfaces have changed, and you will need 2008-based CRI design controls to develop reports utilizing the full 2008 feature set (e.g. tablix) and 2008-based CRIs.

Additional information about upgrading a report with custom report items is provided in the documentation.

Special Case: Deploying 2005 Reports utilizing Dundas CRI controls to a RS 2008 Server

In short, your existing reports will run on RS 2008 without modifications. You may no longer need your 2005 CRI controls on the RS 2008 server in particular cases, as explained below.

With the acquisition of the data visualization products of Dundas Inc., reports utilizing 2005-based CRI controls from Dundas generally will be automatically upgraded on-the-fly into native 2008 charts and gauges in RS 2008. In that case, your old reports will run as native 2008 reports when deployed to a RS 2008 server.

If your 2005-based reports with Dundas CRIs utilize certain features, such as annotations or custom code, the reports won't be automatically converted into native RS 2008 charts/gauges, but instead remain 2005 reports that are executed in a transparent backwards-compatibility mode¹ of the processing engine in the RS 2008 server. In that case, or if you use the Dundas Maps or Dundas Calendar products, the reports will automatically run on the RS 2008 server, but you still need your 2005-based Dundas CRI runtime controls installed on the server.

Alternatively, Dundas is releasing several new 2008-based CRI design and runtime controls. You could upgrade your existing 2005 reports in BIDS (with the 2008 Dundas controls installed) to 2008 reports, utilize all the new 2008 features such as tablix, and then deploy them as 2008 RDLs to a RS 2008 server. Please contact Dundas directly, if you are interested in that option.

¹The related posting about the enhanced ExecutionLog2 in RS 2008 explains, among other topics, how an administrator can utilize the AdditionalInfo.ProcessingEngine value to determine whether an old report automatically upgraded to 2008, or if the report contains a 2005-based CRI and therefore is running in the transparent backwards-compatibility mode of the processing engine.

Happy New Year!