Difference between revisions of "GVBIRTReportConfiguration"
(→{{VULCON}} / {{GVCONSOLE}} Configuration) |
(→Description) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | This {{GVESB}} adapter | + | This {{GVESB}} adapter sets the parameters valid for elaborating [http://en.wikipedia.org/wiki/BIRT_Project BIRT reports]. |
=={{VULCON}} / {{GVCONSOLE}} Configuration== | =={{VULCON}} / {{GVCONSOLE}} Configuration== | ||
| Line 67: | Line 67: | ||
|} | |} | ||
| − | + | Might contain the sub-elements: | |
| + | * [[Description]] | ||
| + | * [[#Options|Options]] | ||
| + | |||
| + | ======Options====== | ||
| + | |||
| + | This element contains the Options to pass to renderers. | ||
| + | |||
| + | The Options Element is used by: | ||
| + | * [[#PDFReportRender|PDFReportRender]] | ||
| + | * [[#ExcelReportRender|ExcelReportRender]] | ||
| + | * [[#HTMLReportRender|HTMLReportRender]] | ||
| + | |||
| + | Might contain the sub-elements: | ||
| + | * [[Description]] | ||
| + | * [[#Option|Option]] | ||
| + | |||
| + | ======Option====== | ||
| + | |||
| + | This element represents a single Option to pass to render. | ||
| + | |||
| + | The Option Element is used by: [[#Options|Options]]. | ||
The following table shows the '''option''' element's attributes: | The following table shows the '''option''' element's attributes: | ||
| Line 77: | Line 98: | ||
| value || optional || Value of option. | | value || optional || Value of option. | ||
|} | |} | ||
| + | |||
| + | Might contain the sub-elements: | ||
| + | * [[Description]] | ||
=====PDFReportRender===== | =====PDFReportRender===== | ||
| Line 91: | Line 115: | ||
|} | |} | ||
| − | + | Might contain the sub-elements: | |
| + | * [[Description]] | ||
| + | * [[#Options|Options]] | ||
=====HTMLReportRender===== | =====HTMLReportRender===== | ||
| Line 106: | Line 132: | ||
|} | |} | ||
| − | + | Might contain the sub-elements: | |
| + | * [[Description]] | ||
| + | * [[#Options|Options]] | ||
===ReportGroups=== | ===ReportGroups=== | ||
| Line 139: | Line 167: | ||
|} | |} | ||
| − | + | Might contain the sub-elements: | |
| − | * Description | + | * [[Description]] |
* [[GVBIRTReportConfiguration#Renders|Renders]] | * [[GVBIRTReportConfiguration#Renders|Renders]] | ||
| − | * Parameters: containing more | + | * Parameters: containing more [[#Parameter|Parameter]] elements. |
=====Parameter===== | =====Parameter===== | ||
| Line 167: | Line 195: | ||
|} | |} | ||
| − | Its | + | Its sub-elements are: |
| − | * Description | + | * [[Description]] |
* StringSource or FixedSource or DHSource. The following table shows its attributes: | * StringSource or FixedSource or DHSource. The following table shows its attributes: | ||
{|class="gvtable" | {|class="gvtable" | ||
Latest revision as of 15:20, 9 November 2012
Contents
Description
This GreenVulcano® ESB adapter sets the parameters valid for elaborating BIRT reports.
VulCon / GV Console Configuration
The GVBIRTReportConfiguration Element is present in the Adapter view of VulCon®.
The following table shows its attributes:
| Attribute | Type | Description |
|---|---|---|
| version | fixed | This attribute must assume the value 1.0. |
| type | fixed | This attribute must assume the value module. |
| name | fixed | This attribute must assume the value BIRT_REPO. |
The GVBIRTReportConfiguration Element contains the following items:
- Description
- Engine
- ReportGroups
Engine
This element sets the home directory and the log lever of the BIRT report engine.
You can set the following attributes:
| Attribute | Type | Description |
|---|---|---|
| reportEngineHome | optional | Home directory of the BIRT report engine, default to ${{gv.app.home}}/BIRTReportEngine |
| logLevel | optional | BIRT report engine log level, default to FINEST. The attribute's admitted values are:
|
It has the subelements:
- Description
- Renders
Renders
This element contains the Renders configured by GreenVulcano® ESB. Those are:
ExcelReportRender
The ExcelReportRender Element sets the properties to create Excel Reports.
The following table shows the ExcelReportRender element's attributes:
| Attribute | Type | Description |
|---|---|---|
| type | fixed | This attribute must assume the value report-render. |
| class | fixed | This attribute must assume the value it.greenvulcano.birt.report.internal.ExcelReportRenderOptions. |
Might contain the sub-elements:
Options
This element contains the Options to pass to renderers.
The Options Element is used by:
Might contain the sub-elements:
Option
This element represents a single Option to pass to render.
The Option Element is used by: Options.
The following table shows the option element's attributes:
| Attribute | Type | Description |
|---|---|---|
| name | required | Name of option. |
| value | optional | Value of option. |
Might contain the sub-elements:
PDFReportRender
The PDFReportRender Element sets the properties to create PDF Reports.
The following table shows the PDFReportRender element's attributes:
| Attribute | Type | Description |
|---|---|---|
| type | fixed | This attribute must assume the value report-render. |
| class | fixed | This attribute must assume the value it.greenvulcano.birt.report.internal.PDFReportRenderOptions. |
Might contain the sub-elements:
HTMLReportRender
The HTMLReportRender Element sets the properties to create a HTML Report.
The following table shows the HTMLReportRender element's attributes:
| Attribute | Type | Description |
|---|---|---|
| type | fixed | This attribute must assume the value report-render. |
| class | fixed | This attribute must assume the value it.greenvulcano.birt.report.internal.HTMLReportRenderOptions. |
Might contain the sub-elements:
ReportGroups
Contains the ReportGroup elements which allows to group more reports.
Each ReportGroup element has the attribute
| Attribute | Type | Description |
|---|---|---|
| name | required | Group name |
and might contain more Report items.
Report
The following table shows the Report element's attributes:
| Attribute | Type | Description |
|---|---|---|
| type | fixed | This attribute must assume the value report. |
| name | required | Report name. |
| config | required | Report configuration. |
| defaultRender | optional | Report preferred rendered, default pdf.
The attribute's admitted values are:
|
Might contain the sub-elements:
- Description
- Renders
- Parameters: containing more Parameter elements.
Parameter
The following table shows the Parameter element's attributes:
| Attribute | Type | Description |
|---|---|---|
| name | required | Parameter name. |
| label | optional | The attribute's value can't be null. |
| format | optional | The attribute's value can't be null. |
| expression | optional | The attribute's value can't be null. |
| default-value | optional | The attribute's value can't be null. |
| control-type | optional | The attribute's admitted values are:
|
Its sub-elements are:
- Description
- StringSource or FixedSource or DHSource. The following table shows its attributes:
| Field | Type | Class |
|---|---|---|
| StringSource | source | it.greenvulcano.birt.report.internal.field.StringSource. |
| FixedSource | source | it.greenvulcano.birt.report.internal.field.FixedSource. |
| DHSource | source | it.greenvulcano.birt.report.internal.field.DHSource. |