Report Export Module Configuration
This Report Export module is one of the DELFT-FEWS export modules. This export module is responsible for retrieving reports from the database, and exporting these to the relevant directory structure on the web server. Reports can then be accessed from there via the web interface to DELFT-FEWS. All reports are exported as is, by the report module. The report export module is only responsible for distributing reports created.
Access to these reports through the web server may be at different levels depending on the user in question. The report export module itself does not explicitly consider these access rights, but exports the reports in such a structure to allow the static part of the web server to correctly administer the access rights.
Two options are available for the export of reports:
- Export of the current forecast reports
- Export of most recent system reports
The web server will control access to all or some reports in these categories to appropriate users.
When available as configuration on the file system, the name of the XML file for configuring an instance of the correlation module called for example Report_Export may be:
Report_Export 1.00 default.xml
Report_Export |
File name for the Report_Export configuration. |
1.00 |
Version number |
default |
Flag to indicate the version is the default configuration (otherwise omitted). |
Figure 133 Elements of the reportExport module configuration
reportExportRootDir
Root directory to which the all reports are to be exported to. This directory is typically the root directory of the web server.
currentForecastReports
Root element for definition of exporting reports for the current forecast
currentForecastSubDir
Root directory for exporting current forecasts to.
excludeModuleInstanceId
Optional list of reports generated by report module instances that should not be included in the export of current forecasts.
exportForecastReports
Root element for definition of exporting reports from recent forecasts made. Includes both the current forecast and a configurable number of recently made forecasts.
numberForecastsToExport
Definition of number of recent forecasts to report.
NOTE: The number defined here should comply with the number of links to other forecasts in the index_template.html file. This file is located in the reportExportRootDir directory.
exportForecastSubDir
Directory to use as root for exporting other forecasts to. For identification a sub-directory is created for each forecast exported. This sub-directory is constructed using the id of the taskRun it was created by.
excludeModuleInstanceId
Optional list of reports generated by report module instances that should not be included in the export of other forecasts.
exportSystemStatusReports
Root directory for exporting system status reports to.
includeModuleInstanceId
List of reports identified by moduleInstanceId of the report module instances that created them that should be included in the export of other system status reports.
