S P A C E F O L D  
data... any distance... minimal time  
 
XMLRSDocs logo
RDLDocumenter Deployment and Use
these are early adopter draft docs
an early deployement set of files is available from our download page
these notes require javascript in your browser
click these symbols to expand and collapse doc sections below: expand a sectioncollapse a section 
hover over this symbol preview to see an illustration briefly; click the symbol to show an illustration of the step embedded in the page (for printing purposes or close viewing); click the illustration to hide it again.
click to expand table of contents Table of Contents
What's in this document?
click to expand documentation for this sectionWhat is RDLDocumenter?
Learn about what this tool is and does.
click to expand documentation for this sectionTest Drive RDLDocumenter: TestHarness
TestHarness lets you quickly and easily extract documentation from standard RDL/RDLCs, so you can get a feel for how the system works.You can get documentation directly from a single RDL/RDLC, or extract and store documentation data from multiple reports and document the set.
click to expand documentation for this sectionAdd custom documentation while designing any RDL: RDLDocumenterDesigner
By default, you have extracted only standard RDL/RDLC elements for documentation. While using TestHarness you may have noticed a small control at the bottom of the form. This is a reminder that RDLDocumenter has a ReportDesigner-hosted control you can use to include custom remarks about reports, or individual report elements, during your design process. When you use this control, it places information into the RDL or RDLC that is extracted and included in your documentation.

RDLDocumenterDesigner is a CustomReportItem and, as such, it appears that it is not currently supported in the ReportDesigner for RDLCs. This may change. In the meantime, you can use RDLDocumenterDesigner only with RDLs. You can add the same custom content into RDLCs with other XML tools -- and then of course RDLDocumenter can extract it along with the default content.

click to expand documentation for this sectionDeploy RDLDocumenter-decorated reports to a Reporting Services server: Options
What happens to an RDLDocumenter-decorated report when you deploy it? Here are your choices.
click to expand documentation for this sectionTurn any RDL or RDLC into RDLDoc.XML: Sample VBS script
As you learned by using TestHarness, you don't need to add custom documentation to a report to extract a standard set of documentation from the report. You can do this without using TestHarness' interface, by using the simple steps shown here on any report(s) you have handy. If you have added custom documentation, either by hand-editing the XML or by using the RDLDocumenterDesigner object, of course these items are extracted too.
click to expand documentation for this sectionLoad RDLDoc.XML to any database: Sample SQL scripts
Just as you don't need TestHarness to extract documentation to docRDL.xml, you don't need TestHarness to move that regularly-shaped XML into a database. You can do it with the simple scripts discussed in this section.
click to expand documentation for this sectionSet up an automated production deployment: RDLDocumenter's SSIS package
TestHarness's internal code and the scripts discussed in the last two sections prototype RDLDocumenter's production processing. This section discusses the customizable SSIS package that puts everything together to automatically extract and load documentation from a set of reports into the database of your choice.
click to expand documentation for this sectionExtend RDLDocumenter to new documentation schemas and new types of output

The ExportRSResult output target introduced in the last section only hints at the vast number of things you can add to RDLDocumenter by adding new tasks and new types of output results into the SSIS package. You can also vastly improve the type and quality of documentation available from the RDLDocumenter data by adding more metadata tables into your database, such as lookup tables that recognize documentation categories, order them intelligently, etc.

By extending other aspects of the RDLDocumenter feature set, such as the Report Designer decorator utility, you can do much more.

This section includes some ideas for extensions.