Web Report Properties
This topic describes the properties of a Web Report object.
Property Name | Description |
---|---|
General | |
Default Format for Viewing Report | Specifies the default format to view the report on Server. Default is to adopt the format setting on Server. If you select a specific format, you can further configure the format options. Choose an option from the drop-down list.
Data type: Enumeration This property only controls direct running of the report on Server, but has no effect on advanced running or scheduled running of the report. |
Result Buffer | |
Result Buffer Size | Specifies the number of the report pages to store in the buffer. The default size 4 indicates Report Engine allocates four pages of the report to the result buffer, and stores the other pages on disk. If you have enough memory, you can increase the result buffer size to store more pages of the report, so that you can get better performance. Data type: Integer |
Others | |
Click Priority | Specifies the priority of the actions to be triggered at runtime when users select certain objects that are bound with some actions in the report. Select the ellipsis in the value cell to set the priority in the Click Priority dialog box.
Data type: String |
Constrained Data | Specifies whether to constrain users to use the business views the report applies only, if they need to add more data components into the report at runtime. Data type: Boolean |
Embedded Fonts | Specifies the True Type Fonts that you want to embed in the PDF output of the report, if you have used TTF in the report. You can select multiple fonts from the value drop-down list by pressing the Ctrl or Shift key. See Delivering TTF in PDF.
Data type: String |
Continuous Page Number with TOC | Specifies whether to calculate pages for the Export Page Number and Export Total Page Number special fields in the report continuously when the report contains a TOC page panel. Data type: Boolean |
Ignore TOC Anchor of Parent | Specifies whether to ignore the TOC Anchor property of objects that act as parent containers of other objects in the report, when generating Tables of Contents for the report. When you set this property to "true", Report Engine generates a TOC entry for an object if its TOC Anchor property is "true", even when you do not include its parent object in the TOC. If you do not want to create TOC entries for those child objects when their parent objects are excluded, set this property to "false". Data type: Boolean |
No Temp File | Specifies whether to create temporary files for the report. You gain faster performance if you do not create the temporary files (true), while have better accuracy in data calculation with the temporary files (false). Data type: Boolean |
On Parameter Value Change | Specifies the formulas for validating the parameter values in the report. After you specify the formulas, when users change the parameter values at runtime, Report Engine passes the values to the formulas first for validation: if the values are valid, Report Engine applies them to the parameters; otherwise, it displays the messages you define in the formulas. Choose the view elements in the business view the web report uses that are mapped to the required formulas from the drop-down list (to select multiple view elements, use the Ctrl or Shift key on the keyboard, then select outside the value cell to confirm).
For example, for a String type parameter that requires a value of 4-7 characters, you can define a formula like this:
Then, when users specify a string value of 9 characters to the parameter, Report Engine displays the message "The value is too long.". Data type: Object Array When you define the formula, you need to make it return a blank string for valid parameter values. |
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 in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Push Down On-screen Filter | Specifies whether to push down the on-screen filters in the report to execute the filters in the database at runtime. Data type: Boolean |
Remove Extra Characters from First Line | Specifies whether to remove the quotation marks and commas from the first line of the report's Text and CSV outputs.
Data type: Boolean |
Style Group | Specifies the style group for the report.
When you use the report as a linked report, if you select "Pass style group information down to linked report" while defining the link condition, the report inherits the style group from the primary report; if you do not select that option, it applies the style group that you specify for this property. Data type: String |
Suppress Object Space If Not Exported | Specifies whether to suppress the space for holding the objects in the output of the report, if you have specified to exclude them from exporting.
Data type: Boolean |
Excel | |
Columned | Specifies whether to turn on the properties related with exporting the report to a columned file, such as Excel and CSV.
Data type: Boolean |
Full Fill and Border | Specifies whether to apply background color and display border for empty cells in the Excel output of the report, using the format you have specified in the report template. Data type: Boolean This property takes effect when you export the report to Excel using Report Format or Column Format; and if you use Column Format, you should set the report's Columned property to "false". |
No Page Break for Column Format | Specifies whether to remove the page breaks on each individual sheet when you export the report to Excel using Column Format.
Data type: Boolean |
No Page Break for Data Format | Specifies whether to remove the page breaks on each individual sheet when you export the report to Excel using Data Format.
Data type: Boolean |
No Page Break for Report Format | Specifies whether to remove the page breaks on each individual sheet when you export the report to Excel using Report Format.
Data type: Boolean |
Rows per Sheet | Specifies the maximum number of rows in every worksheet in the Excel output of the report. Type an integer value to change the number.
Data type: Integer |
Sheet Name | Specifies the sheet name for the report in the Excel output. Data type: String Excel does not support using the following characters in the sheet name: "|", ":", "/", "?", "\", "*", "]", "[", and the single quotation mark (') as the last character either. If you use any one of them in the value of the property, Excel replaces it with "_". |