Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Figure 133 Elements of the reportExport Report Export module configuration

reportExportRootDir

...

Root directory for exporting current forecasts to. 

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.

numberCurrentForecasts

Number of most recent current forecast reports to keep in the output directory.

zipReports

Set the value of this element to 'true' to export the reports as zip files, instead of extracting the zip files content to directories. This option cannot be combined with the reportExportTelegramPhoto option.

dateTimeFormat

Date time format of the timestamp that is used for the output directory.

exportTimeZone

The time zone for the timestamp in the zip file or output directory.

prefix

Prefix for the destination zip file or directory

excludeModuleInstanceId

Optional list of reports generated by report module instances that should not be included in the export of current forecasts.

exportTimeZone
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. Should not be used together with excludeModuleInstanceId.

incremental

This option can be used for writing reports incrementally. When true, older forecast reports will not be deletedThe time zone for the timestamp in the zip file or output directory.

generatePdf

Include this optional element with the value 'true' to convert each html page in the report to a pdf file.

generateImage

Include this optional element with a value indicating the image format (i.e. png, jpg) to cause each html page in the report to be converted to an image of specified format.

N.B. This option works similar to the <generateImage> element in the report configuration Report Module configuration. An external conversion program (default is wkthtmltoimage) needs to be configured using the global property REPORT_HTML2IMG_PROGRAM defined in the global properties file.

...

Exports the most recent reports from the datastore that are in the list of _includeModuleInstanceId_s.

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
exportSystemStatusSubDir

Directory to use as root directory for exporting other forecasts tosystem status reports. For identification a sub-directory is created for each forecast report 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
zipReports

Set the value of this element to 'true' to export the reports as zip files, instead of extracting the zip files content to directories. This option cannot be combined with the reportExportTelegramPhoto option.

dateTimeFormat

Date time format of the timestamp that is used for the output directory.

prefix

Prefix for the destination zip file or directory

exportSystemStatusZipFile

Name of the zip file to createList 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.