Introduction
Standard BIRT report generation process consist of two main phases - RUN report and RENDER report - which are mapped to same-named Maven goals. The RUN phase gets *.rptdesign file (standard output of BIRT report designers) and parameters and generates *.rptdocument file which is intermidiate format between RUN and RENDER phase and contains all processed data and other structures ready for report rendering. The RENDER phase is then responsible for rendering of those processed data into human readable and well formated documents in requested output format.
Plugin IDs
Plugin is deployed in DailyDev's Maven Repository and is identified using following IDs.
| groupId: |
org.dailydev.maven.plugins |
| artifactId: |
birt-maven-plugin |
Goals
Current list of goals reflects phases of report rendering process.
| Goal Name |
Description |
| birt:run |
Gets *.rptdesign files (standard output of BIRT report designers) and parameters and generates *.rptdocument file which is intermidiate format between RUN and RENDER phase and contains all processed data and other structures ready for report rendering. |
| birt:render |
Gets *.rptdocument files (output from birt:run goal) and generates final report in requested output format. |
| birt:runrender |
As it's name sais, it is aggregate of run and render so you can get final reports in requested output format without intermidiate *.rptdocument files generated. |
Mojo Attributes
- Requires a Maven 2.0 project to execute.
- Automatically executes within the lifecycle phase:
site
Required Parameters
| Parameter |
Type |
Goals |
Description |
reports
|
FileSet  |
run
render
runrender
|
Set of reports to be ganerated.
|
Optional Parameters
| Parameter |
Type |
Goals |
Description |
Required |
| birthome |
String |
run
render
runrender |
Absolute path to the BIRT Runtime installation folder. Overrides BIRT_HOME environment variable if set. |
No if BIRT_HOME environment variable is defined.
|
| format |
String |
render
runrender
|
Target format of the rendered report. The value should be one of HTML, PDF, DOC, PPT, XLS, POSTSCRIPT (for BIRT 2.3) or value associated with additional emitter.
|
No. Default value is HTML.
|
| htmlConfig |
HTMLRenderConfig |
render
runrender |
Configuration of HTML format rendering. Since this parameter is complex see it's details.
|
No.
|
| output |
File |
run
render
runrender |
Path to output directory for generated reports.
|
No. Default value is set to target/reports folder.
|
| locale |
String |
run
runrender |
The output locale.
|
No. Default value is en.
|
| page |
Integer |
render
|
Page number to be rendered.
|
No. By default all pages are rendered.
|
| parametersFile |
String |
run
render
runrender |
Path to property file containing default values of the parameters.
NOTE: Parameters explicitly defined as task attributes or child elements overrides values from parameter file.
|
No.
|
Parameter Details
birthome
Absolute path to the BIRT Runtime installation folder. Overrides BIRT_HOME environment variable if set.
| Type: |
java.lang.String |
| Required: |
No if BIRT_HOME environment variable is defined. |
| Expression: |
${birt.home} |
| Default: |
BIRT_HOME environment variable value
|
format
Target format of the rendered report. The value should be one of HTML, PDF, DOC, PPT, XLS, POSTSCRIPT (for BIRT 2.3) or value associated with additional emitter.
| Type: |
java.lang.String |
| Required: |
No. |
| Expression: |
${birt.format} |
| Default: |
HTML |
htmlConfig
Configuration of HTML format rendering.
| Type: |
org.dailydev.mojo.birt.runner.commandline.HTMLRenderConfig |
| Required: |
No. |
| Expression: |
N/A |
| Default: |
N/A |
Since the parameter is complex following table gives details about it's elements.
| Parameter |
Type |
Description |
Default |
| encoding |
String |
The output encoding. |
UTF-8
|
| htmlReportlet |
boolean |
Marks that the HTML output will be embeddable directly into another
HTML page (output does not contain <html>, <head> and
<body> tags). |
false
|
locale
The output locale.
| Type: |
java.lang.String |
| Required: |
No. |
| Expression: |
${birt.locale} |
| Default: |
Default value is en. |
output
Path to output directory for reports. In a fact the output
is path to the root for output, because the generator copies structures of an
input. It means that if the input is structured into several
subdirectories, the output is root and the same structure of directories is created for generated reports.
| Type: |
java.io.File |
| Required: |
No. |
| Expression: |
${birt.output} |
| Default: |
Default value is set to target/reports folder. |
page
Page number to be rendered.
| Type: |
java.lang.Integer |
| Required: |
No. |
| Expression: |
${birt.page} |
| Default: |
By default all pages are rendered. |
parametersFile
Path to property file containing default values of the parameters.
NOTE: Parameters explicitly defined within parameters configuration element overrides values from parameter file.
| Type: |
java.io.File |
| Required: |
No. |
| Expression: |
${birt.parametersFile} |
| Default: |
N/A |
reports
Target format of the rendered report. The value should be one of HTML, PDF, DOC, PPT, XLS, POSTSCRIPT (for BIRT 2.3) or value associated with additional emitter.
|
|
|
|
|
