DTDs and XML-Schema definitions
This page contains downloadable versions of the XML-Schema definitions and XML-Document-Type-Declarations used in the Pentaho-Reporting projects. All schema files are also contained in the source and binary versions of the reporting engines.
The Pentaho-Reporting Classic Engine defines two major report definitions formats. Both formats are accepted transparently, the engine automatically selects the correct parser for each XML file.
Information: Starting with version 0.8.10, these fileformats are deprecated. We guarantee that existing reports and existing features will continue to work, but none of these fileformats gets extended to support the new features introduced with 0.8.10 or any later version.
This schema defines the format of the Simple-XML report description. The Simple-XML format provides a simplified report schema that can be easily read and written by human users. It covers all commonly needed features of the Pentaho Reporting Classic engine.
The Extended Report-Definition Format fully describes a report-object. The fileformat has been developed to add some sort of XML serialization to the reporting engine to simplify the creation of design tools. This format is not meant to be written by human users. It is complex, verbose and can be confusing. Reference documentation describing the accepted Objects, Properties and Style-Keys can be generated with the Reference-Doc-Generator module in the Pentaho Reporting Classic project.
As of Version 0.8.10 the Pentaho-Reporting Classic Engine starts to use a ODF-based compound fileformat for all report definitions and all reporting related files.
A report-bundle (file-extension: prpt) is basically a ZIP file with some additional meta-data. The ZIP structure and the meta-data is described in the OpenOffice-ODF standard chapter 3 (MetaData) and 17 (Packages).
The content file contains the script that controls which files get parsed to compose the report. In addition to the files specified in that file, the standard files "settings.xml", "datadefinition.xml", "dataschema.xml", "styles.xml" and "layout.xml" are loaded as well.
The Data-Definition file contains links to the datasources used (which are stored as independent files within the report-bundle), the parameters the report accepts and the functions that provide data for the report.
The data-schema describes rules for enriching and mapping meta-data provided by the datasources for ther reporting system.
The settings file contains global settings that apply to the master as well as all sub-reports. In short: the settings file contains the report-configuration.
The styles file contains all style-sheet definitions and contains all page-definitions (page-size, page-header and footer, watermark).
The layout definition describes the report layout, including all bands, groups and contains the links to subreports (which are independend files inside the report-bundle).
The Pentaho-Reporting Engines can reference several types of datasources. The data-sources can be described in XML. The XML definition can either be defined inline in the report-definition files or can be defined in an external file.
The static datasource uses reflection to call static and non-static methods on a given class.
The SQL-DataSource uses JDBC to retrieve the data for the reporting.
Hibernate-DataSources can be used to query a database using the Hibernate-Query-Language.
A Data-Factory that combines other data-factories; this can be used to combine data from several datasources in one report.
A static non-parametrizable datasource that contains hardcoded tables inside.
Kettle-DataSources can be used to read data from Kettle transformations.
PMD-DataSources can query data-sources using the MetaData-Query-Language of Pentaho-MetaData.
A data-source that can execute MDX-(OLAP)-Queries on Mondrian.
A data-source that can execute MDX-(OLAP)-Queries on any OLAP4J provider, like Mondrian, Palo or via XML/A .
This schema defines some abstract common types that are referenced in the other schemas.
This schema defines the format of the XML description of all available configuration options. The definition-file can be edited with the Config-Description-Editor of the Pentaho Reporting Classic project. Configuration files for the Pentaho Reporting Classic project can be edited with the Config-Editor (also contained in the Pentaho-Reporting Classic Project).
Warning: The following DTDs are ancient now and are most likely no longer acceptable for newer versions of the Pentaho Reporting Engines. These historic definitions are kept for documentation purposes only.
The DTD is valid for version 0.8.4-9 up to but not including JFreeReport 0.8.5. This DTD describes the simple report-definition format for JFreeReport. This description does not support all features of JFreeReport, but is easier to read and understand by humans. Due to its limited nature, reports cannot be serialized into this format, as parsing this xml-definition heavily transformes the report. This transformation is irreversible.
The extended report definition-format fully describes a JFreeReport reportdefinition. The format is extensible and describes the object composition of an valid report. All JFreeReport features are supported by this definition format, but humans tend to have problems reading this. JFreeReport objects can be serialized into this format using a ReportWriter implemtation. This DTD is valid for JFreeReport version 0.8.4 up to but not including JFreeReport 0.8.5.
The DTD is valid for version 0.8.5 and later. This DTD describes the simple report-definition format for JFreeReport. This description does not support all features of JFreeReport, but is easier to read and understand by humans. Due to its limited nature, reports cannot be serialized into this format, as parsing this xml-definition heavily transformes the report. This transformation is irreversible.
The extended report definition-format fully describes a JFreeReport reportdefinition. The format is extensible and describes the object composition of an valid report. All JFreeReport features are supported by this definition format, but humans tend to have problems reading this. JFreeReport objects can be serialized into this format using a ReportWriter implemtation. This DTD is valid for JFreeReport version 0.8.5 and later.
Last Changed: 2008-Jul-01