...
| Table of Contents | ||||
|---|---|---|---|---|
|
Report Module Configuration
...
The role of the report module is to generate reports of the forecast results in a form that can easily be displayed without using DELFT-FEWS on a web server. Reports that are produced by DELFT-FEWS serve two purposes:
...
Related TAG: $TABLE(tableId)$
The following A number of table types are availabe:. Tables 3 to 7 have references to cascading style sheets. Below the different tables are explained.
- table: original table;
- rowPerLocationHtmlTable: table with a row per location
- htmlTable: new style table with same functionality as 'table';
- countTables:
- thresholdsCrossingsTable: table containing numbers (count) of threshold crossings.
- thresholdsCrossingsCountTable: new thresholdsCrossingTable
- flagCountTable
- flagSourceCountTable
- maximumStatusTable: table containing (coloured) indicating threshold crossings over time.
- mergedPrecipitationTable: table containing (merged) precipitation figures in specific time intervals
- systemStatusTable: tables containing system (management) information;
...
- ;
- liveSystemStatus: information about live system: MC and FSS('s);
- exportStatus: information about exported files/reports;
- importStatus: information about files imported;
- scheduledWorkflowStatus: information about (next) scheduled workflows;
- completedWorkflowStatus: information about number of workflows completed in last 24 hrs.
- currentForecastStatus: information about which workflows are set to CURRENT;
- logMessageListing list of logmessages (based on a query)
- forecastHistory: historic overview of forecasts.
table
See Table above
rowPerLocationHtmlTable
...
class | description | specific for |
_beforeT0 | date/time indication before time zero (TO) of the forecast | time column (most left column) |
_firstAfterT0 | date/time indication of the first occurrence after time zero (T0) of the forecast | time column (most left column) |
_afterT0 | date/time indication after time zero (TO) of the forecast | time column (most left column) |
_data | default indication of data content of a cell | data cells |
_anyString | user defined cellFormat | data cells |
_datamax | addition to current style if value is maximum of that series (_data_datamax or _anyString_datamax) | data cells |
_leftcol | default indication of a row header |
|
_header | default indication of a column header |
|
_threshold_n | indication of threshold level (n=0,1,2,...) | threshold tables (colouring of backgrounds) |
countTables
thresholdsCrossingsTable
| Info |
|---|
Notice: the thresholdCrossingsCountTable (see further below) is a newer version of this type of table |
...
Figure 99 Example of a thresholdCrossingTable (NE Region)
Declarations section
In the declaration sections the layout of the table needs to be defined.
...
- id: unique identifier (as reference to this table);
- tableStyle: a choice of tableStyle which can be influenced by using the corresponding classes in a cascading style sheet. Choices are tableStyle1 to tableStyle10;
- thresholdsCrossingsCounterHeaderText: String to be displayed in the table header;
- thresholdsCrossingsTableUpCrossingsHeaderText: not in use anymore: can be left blank.
- thresholdsCrossingsTableDownCrossingsHeaderText: not in use anymore: can be left blank.
- cellFormat: any string but "_thresholds" is recommended: style class of the table header in combination with the typeId (range always starts with a 0);
- topFormat; not in use anymore, can be left blank ;
- colWidth: width of a column in pixels;
- missingThresholdsText: Choice for missing threshold. Choices are: " ", "#", "" or " -";
- noThresholdsCrossed: definition of the null value (NAN) indicator. Choices are: " ", "-", "-999", " no data";
- countIndividualThresholds: true if individual threshold crossings must be counted; false (= default) if per location only the worst case must be counted
- thresholdTypes: array of thresholds, assuming a logical order
o typeId: textual indication of corresponding threshold level;
o name: indication of the text to appear in column headers;
Report section
A thresholdsCrossingsTable should be defined in the report as well. E.g. this table needs to be 'filled' with its corresponding timeseries.
...
Since this type of table is a table in which you can aggregate data (which means combine timeseries) the following option is available: mergeLocations.
thresholdCrossingCountsTable
A thresholdCrossingsCountsTable displays threshold crossing counts depending on which thresholds have been crossed within a given time period. The thresholdCrossingCountsTable is a new version of the thresholdsCrossingsTable. A thresholdCrossingCountsTable has the same layout as a thresholdCrossingCountsTab in the thresholdOverviewDisplay for consistency.
Declarations section
In the declaration sections the layout of the table needs to be defined in a thresholdCrossingCountsTableFormat.
...
- id: identifier of this table format.
- thresholdGroupId: id of a thresholdGroup that is defined in the thresholds configuration file. This table displays all thresholds in the specified thresholdGroup.
- relativePeriod: Relative time period for this table. The time period is relative to timeZero. A relative period can be e.g. -3 to +3 hours or e.g. +3 to +6 hours (relative to timeZero).
- countAllActiveThresholds: If true, then this table counts all thresholds that are active (all thresholds that have been crossed). If false, then for a given location this table only takes into account the active threshold with the most severe warning level. Default is false.
- countWarningAreas: If true, then this table counts warning areas, as follows. It is possible to define warning areas for a levelThresholdValue in the thresholdValueSets configuration file. If a crossed levelThresholdValue has warning areas defined, then the number of warning areas is counted for that levelThresholdValue. If a crossed levelThresholdValue has no warning areas defined, then a count of 1 is used for that levelThresholdValue. If this option is false, then for each crossed levelThresholdValue a count of 1 is used (i.e. the warning areas are ignored). Default is true.
- noThresholdsDefinedText: If specified, then this text is shown in cells that correspond to data for which no thresholds are defined. Default is empty space.
- noDataAvailableText: If specified, then this text is shown in cells for which no data is available. Default is "n/a".
- crossingCountZeroText: If specified, then this text is shown in cells for which there are no threshold crossings. Default is "-".
- tableHeaderText: String to be displayed in the table header. The relative period and thresholdGroup name will be appended to this string.
- columnWidth: The width of the columns in the table.
- tableStyle: The tableStyle to use for this table. The available tableStyles are defined in the report tables .css file.
- cellFormat: The cellFormat to use for this table. The available cellFormats for the configured tableStyle are defined in the report tables .css file.
- scrollableTable: Use this to split the table into two parts, one for the header row(s) and one for the data rows. The data row part refers to the tableStyle for this table with "_scrollable" appended. This can be used to make the data rows scrollable while the header row(s) remain fixed. For this to work the referred style needs to be defined in the report tables .css file.
Report section
In the reports section define a thresholdCrossingCountsTable.
...
- id: identifier for the template tag (in this case: $TABLE(table1)$);
- formatId: reference to the format of this table (to one of the thresholdCrossingCountsTableFormats in the declarations section);
- mergeLocations: boolean indicator. True means: treat all locations of mentioned timeseries together for combined assessment. False means: extract individual timeseries so that every row indicates one location (timeseries);
- Choice between
o timeSeries;
o table; --> this can be used to display a table within another one.
o tableRow
flagCountsTable
FlagCountsTable is available since Delft-FEWS release 2011.01. A FlagCountsTable displays flag counts depending on the flags of the values in a time series within a given time period.
Example of a flagCountsTable
Declarations section
In the declaration section the layout of the table needs to be defined in a flagCountsTableFormat.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<flagCountsTableFormat id="flagCountsTableFormat"> <tableStyle>tableStyle1</tableStyle> <hyperlinkUrl>report.html#!LOCATION_NAME!_!PARAMETER_NAME!</hyperlinkUrl> </flagCountsTableFormat> |
Report section
In the reports section define a flagCountsTable.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<flagCountsTable id="flagCountsTable" formatId="flagCountsTableFormat"> <inputVariableId>Cowbeech</inputVariableId> <inputVariableId>Romsey</inputVariableId> <inputVariableId>CrosslandsDrive</inputVariableId> </flagCountsTable> |
flagSourceCountsTable
FlagSourceCountsTable is available since Delft-FEWS release 2011.01. A FlagSourceCountsTable displays counts of flag sources depending on the flag sources of the values in a time series within a given time period. The flag source for a value contains the reason why that value got a certain flag. For example if a value was rejected by a "hard max" validation rule, then it gets flag unreliable and flag source "hard max".
Example of a flagSourceCountsTable
Declarations section
In the declaration section the layout of the table needs to be defined in a flagSourceCountsTableFormat.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<flagSourceCountsTableFormat id="flagSourceCountsTableFormat"> <tableStyle>tableStyle1</tableStyle> </flagSourceCountsTableFormat> |
Report section
In the reports section define a flagSourceCountsTable.
...