Web Report

The properties of a web report are:

Property Name	Description
General
Default Format for Viewing Report	Specifies the default format with which to view the report on JReport Server. The default value is to adopt the JReport Server setting. If you select a specific format, you can click the button beside to further configure the format settings. After this property is configured, it will only control the directly-running result of the report on JReport Server, but has no effect on the result of advanced running and scheduled running. <Server Setting> - Adopts the format setting on JReport Server. HTML - Displays the report in HTML format. Click in the value cell to configure the format settings in the HTML Option dialog. PDF - Displays the report in PDF format. Click in the value cell to configure the format settings in the PDF Option dialog. Excel - Displays the report in Excel format. Click in the value cell to configure the format settings in the Excel Option dialog. Text - Displays the report in Text format. Click in the value cell to configure the format settings in the Text Option dialog. RTF - Displays the report in RTF format. Click in the value cell to configure the format settings in the RTF Option dialog. XML - Displays the report in XML format. Click in the value cell to configure the format settings in the XML Option dialog. PostScript - Displays the report in PostScript format. Click in the value cell to configure the format settings in the PostScript Option dialog. Web Report - Displays the report in Web Report Studio. Click in the value cell to configure the format settings in the Web Report Option dialog. Data type: Enumeration
Result Buffer
Result Buffer Size	Specifies the number of report result pages which will be stored in the buffer. Data type: Integer
Others
Click Priority	Specifies the priority of the actions that will be triggered at runtime when you click on certain objects in the report which are bound with some actions. Click in the value cell to set the priority in the Click Priority dialog. Data type: String
Embedded Fonts	Specifies the True Type Fonts that have been used in the report so as to embed them if you want to export the report result to a PDF file. You can select multiple fonts by pressing the Ctrl or Shift key. For more information, refer to Delivering the result in PDF. Data type: String
No Temp File	Specifies whether or not to create temporary files. true - Not to create temporary files. Gains faster engine performance. false - To create temporary files. Gains better accuracy in calculating data. Data type: Boolean
On Parameter Value Change	Specifies to use formulas to validate values of the parameters used by the report, then when the parameter values are changed at runtime, the values will be passed to the formulas first for validation. If the values are valid, they will be applied to the parameters; if not, you can make messages returned. Note that when you define the formula, you need to make it return a blank string for valid parameter values. Choose the view elements in the business view the library component uses which are mapped to the required formulas from the drop-down list (to select multiple view elements, make user of the Ctrl or Shift keys on the keyboard, after selecting the elements, click outside of the value cell to confirm). For example, for a string type parameter which requires a value that is of 4-7 characters, you can define a formula like this: `if(length(@P_String) > 8 ) "The value is too long." else if (length(@P_String) < 3 ) "The value is too short." else ""` Then, when a string value of 9 characters is specified to the parameter, you will be prompted with the "The value is too long." message. Data type: Object Array
Page Background	Specifies the background color of the report page. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Style Group	Specifies the style group for the report. When the report is used as a linked report, if the option "Pass style group information down to linked report" is check when defining the link condition, it will inherit the style group of the primary report; if unchecked, it will take the style group specifed by the property. Data type: String
Suppress Object Space If Not Exported	Specifies whether to suppress the space used for holding the objects in the exported report result when you have specified not to include them for exporting. Data type: Boolean
Excel
Columned	If true, the engine performance will be improved when exporting the report to CSV and Excel formats. Only after the Columned property is set to true, it is meaningful to specify values to the following Excel properties of objects in the report, otherwise the specified values for these Excel properties cannot take effect. Column Index/Row Index Column Number/Row Number. The properties are for chart platforms and images. Data type: Boolean
No Page Break	If true, there will be no page breaks on each individual sheet when exporting the report to Excel with the option Column Format selected in the Export to Excel dialog. This means the column headings will appear just at the top of the Excel spreadsheet and will not be repeated throughout the report. If the report breaks to a new sheet then once again the page header will display. Data type: Boolean Note: Exporting a report to an Excel file without page breaks means the split pages are technically merged within the Excel sheet, which could bring the following results and limitations: In the exported Excel format file, only the first table header and the last table footer of a table will be exported. You cannot get a continuous table if the report has other objects in horizontal locations. Merging tables or crosstabs together will extend the Excel sheet, which may cover other objects if they happen to be in the extended direction. When merging crosstabs together, the column/row index might be extended over the Excel sheet range, and the report part which is out of this range will get lost in the result file. If a whole merged crosstab gets quite large, it might cause out of memory error during the exporting process.

Property Name

Description

General

Default Format for Viewing Report

Specifies the default format with which to view the report on JReport Server. The default value is to adopt the JReport Server setting. If you select a specific format, you can click the button

beside to further configure the format settings.

After this property is configured, it will only control the directly-running result of the report on JReport Server, but has no effect on the result of advanced running and scheduled running.

<Server Setting> - Adopts the format setting on JReport Server.
HTML - Displays the report in HTML format. Click in the value cell to configure the format settings in the HTML Option dialog.
PDF - Displays the report in PDF format. Click in the value cell to configure the format settings in the PDF Option dialog.
Excel - Displays the report in Excel format. Click in the value cell to configure the format settings in the Excel Option dialog.
Text - Displays the report in Text format. Click in the value cell to configure the format settings in the Text Option dialog.
RTF - Displays the report in RTF format. Click in the value cell to configure the format settings in the RTF Option dialog.
XML - Displays the report in XML format. Click in the value cell to configure the format settings in the XML Option dialog.
PostScript - Displays the report in PostScript format. Click in the value cell to configure the format settings in the PostScript Option dialog.
Web Report - Displays the report in Web Report Studio. Click in the value cell to configure the format settings in the Web Report Option dialog.

Data type: Enumeration

Result Buffer

Result Buffer Size

Specifies the number of report result pages which will be stored in the buffer.

Data type: Integer

Others

Click Priority

Specifies the priority of the actions that will be triggered at runtime when you click on certain objects in the report which are bound with some actions. Click

in the value cell to set the priority in the Click Priority dialog.

Data type: String

Embedded Fonts

Specifies the True Type Fonts that have been used in the report so as to embed them if you want to export the report result to a PDF file. You can select multiple fonts by pressing the Ctrl or Shift key.

For more information, refer to Delivering the result in PDF.

Data type: String

No Temp File

Specifies whether or not to create temporary files.

true - Not to create temporary files. Gains faster engine performance.
false - To create temporary files. Gains better accuracy in calculating data.

Data type: Boolean

On Parameter Value Change

Specifies to use formulas to validate values of the parameters used by the report, then when the parameter values are changed at runtime, the values will be passed to the formulas first for validation. If the values are valid, they will be applied to the parameters; if not, you can make messages returned. Note that when you define the formula, you need to make it return a blank string for valid parameter values. Choose the view elements in the business view the library component uses which are mapped to the required formulas from the drop-down list (to select multiple view elements, make user of the Ctrl or Shift keys on the keyboard, after selecting the elements, click outside of the value cell to confirm).

For example, for a string type parameter which requires a value that is of 4-7 characters, you can define a formula like this:

if(length(@P_String) > 8 ) "The value is too long." else if (length(@P_String) < 3 ) "The value is too short." else ""

Then, when a string value of 9 characters is specified to the parameter, you will be prompted with the "The value is too long." message.

Data type: Object Array

Page Background

Specifies the background color of the report page. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Style Group

Specifies the style group for the report.

When the report is used as a linked report, if the option "Pass style group information down to linked report" is check when defining the link condition, it will inherit the style group of the primary report; if unchecked, it will take the style group specifed by the property.

Data type: String

Suppress Object Space If Not Exported

Specifies whether to suppress the space used for holding the objects in the exported report result when you have specified not to include them for exporting.

Data type: Boolean

Excel

Columned

If true, the engine performance will be improved when exporting the report to CSV and Excel formats.

Only after the Columned property is set to true, it is meaningful to specify values to the following Excel properties of objects in the report, otherwise the specified values for these Excel properties cannot take effect.

Column Index/Row Index
Column Number/Row Number. The properties are for chart platforms and images.

Data type: Boolean

No Page Break

If true, there will be no page breaks on each individual sheet when exporting the report to Excel with the option Column Format selected in the Export to Excel dialog. This means the column headings will appear just at the top of the Excel spreadsheet and will not be repeated throughout the report. If the report breaks to a new sheet then once again the page header will display.

Data type: Boolean

Note: Exporting a report to an Excel file without page breaks means the split pages are technically merged within the Excel sheet, which could bring the following results and limitations:

In the exported Excel format file, only the first table header and the last table footer of a table will be exported.
You cannot get a continuous table if the report has other objects in horizontal locations.
Merging tables or crosstabs together will extend the Excel sheet, which may cover other objects if they happen to be in the extended direction. When merging crosstabs together, the column/row index might be extended over the Excel sheet range, and the report part which is out of this range will get lost in the result file.
If a whole merged crosstab gets quite large, it might cause out of memory error during the exporting process.