| TOPICA Report ReportDefinition |
[This is preliminary documentation and is subject to change.]
The ReportDefinition element is the root element of an XML file in the TOPICA Report Format.
The ReportDefinition element is used to specify the report title, and controls what date/month/year intervals, the user may specify when running the report.
ReportDefinition attributesAttribute | Type | Description |
|---|---|---|
HeaderText | String | Report title displayed when running the report. Note that this is not necessarily the same text as the report name displyed in the tree showing available reports. The tree showing available reports displays the file names of the available reports. |
HeaderTag | String | The HTML-tag used for rendering HeaderText. |
IntervalDefault | String | The interval type selected per default. Valid values:
|
IntervalNone | Boolean | false: user cannot select interval "None" true: user may select interval "None" |
IntervalDay | Boolean | false: user cannot select interval "Day" true: user may select interval "Day" |
IntervalMonth | Boolean | false: user cannot select interval "Month" true: user may select interval "Month" |
IntervalYear | Boolean | false: user cannot select interval "Year" true: user may select interval "Year" |
DefaultDays | Integer | When specified, this attribute controls the initial (default) values for "Date from" and "Date to" fields, when user selects interval type "Day". Only used when IntervalDay="true". |
DefaultMonths | Integer | When specified, this attribute controls the initial (default) values for "Month from", "Year from", "Month to" and "Year To" fields, when user selects interval type "Month". Only used when IntervalMonth="true". |
DefaultYears | Integer | When specified, this attribute controls the initial (default) values for "Year from" and "Year to" fields, when user selects interval type "Year". Only used when IntervalYear="true". |
AutoSubmit | Boolean | false: User must click "OK" button to start report (default). true: The report is run automatically using the interval parameters set by properties IntervalDefault, DefaultDays, DefaultMonths, DefaultYears, and any default values set for each TOPICA Report ReportParam element. NB: Currently AutoSubmit="true" does NOT work when using ReportReportingService! |
Child elementsElement type | Description |
|---|---|
Variable definitions - used internally in a report. | |
Parameter definitions - defines the additional parameters that the user may enter (besides date interval) when starting a report. | |
Defines name etc. of a Reporting Services report to start. The ReportDefition element should contain 0 or 1 ReportReportingService element. When this element is used, the ReportDefition element should NOT contain anything else than Reportparam elements. That is, elements ReportVariable, ReportTable, ReportExport are all ignored. | |
Generating headers | |
Generating tables | |
Generating export commands |