...
- id: identifier to the template tag ($TABLE(scheduledWorkflowTable)$);
- formatId: reference to the format of this type of systemStatus table in the declarations section);
- workflowStatusQuery
- workflowId: textual reference (case-sensitive!) to an existing workflow in the configuration
- o itemText: text in the 'Item' Column (can be left blank in case of this statusTableSubType) o
- benchmarkText: text in the 'Benchmark' column (can be left blank in case of this statusTableSubType)
- o selectCompletedWorkflowsOnly: boolean variable: 'true' refers to query completed workflows (see next table subtype) and 'false' refers to query scheduled workflows (this type)
- o statusField: textual reference to the field in the database table Tasks. In this case taskStatus. In case of scheduled workflows the column 'taskRepeatTime' contains a integer value indicating that it is a repeating activity (workflow) o
- extraOutputField
- Text: textual references to the fields in the database table ImportStatus to fill the defined ExtraOutputFields (Declaration section). In this case it is recommended to add here:
- workflowId
- description
- ownerMcId
- taskRepeatTime
- taskPendingSinceTime
- Text: textual references to the fields in the database table ImportStatus to fill the defined ExtraOutputFields (Declaration section). In this case it is recommended to add here:
1.2.121.112
1.2.121.113 anchor_Toc154574452 _Toc154574452
completedWorkflowStatus table
A completedWorkflowStatus table contains an overview of all workflows carried out in the last 24 hours. An example is given below.
1.2.121.114 
1.2.121.115 Figure 121 Example of a completedworkflowStatus table (NE Region)
1.2.121.116 *+
+* 1.2.121.117 h5.
Declarations Section
...
1.2.121.119 
1.2.121.120
1.2.121.121 Figure 122 Example of the configuration of a completedWorkflowStatus table in the declarations section 1.2.121.122
1.2.121.123 The following elements need to be defined:
1.2.121.124
The following elements need to be defined:
- tableStyle: a choice of tableStyle which can be influenced by using the corresponding classes in a cascading style sheet. Choices are tableStyle1 to tableStyle10;
- id: unique identifier (as reference to this table);
- statusTableSubType: Choice for one of the subtypes of systemStatusTables: Choices are: liveSystemStatus, exportStatus, importStatus, scheduledWorkflowStatus, completedWorkflowStatus, currentForecastStatus, logMessageListing, forecastHistory;
- tableTitle: a text for a title for this table;
- headerRows: integer value for the number of header rows;
- itemHeader: header text for the 'Item' column;
- benchmarkHeader: header text for the 'Benchmark' column;
- statusHeader: header text for the 'Status' column;
- statusHeaderSplit: value indicating the number of header rows in the status column.
- statusSubHeader: Additional Field(s) definition specifically for completed workflow related topics. Recommended fields are:
- Nr. of Runs
- Nr. Failed
- showOutputFieldsOnly: boolean value for displaying the outputfields only. 1.2.121.125
1.2.121.126 ++
1.2.121.127 * 1.2.121.128 h5.
Report Section
...
...
...
...
Figure 123 Example of the configuration of a completedWorkflowStatus table in the report section
...
The following elements need to be defined:
- 1.2.121.134 id: identifier id: identifier to the template tag ($TABLE(scheduledWorkflowTable)$);
- formatId: reference to the format of this type of systemStatus table in the declarations section);
- workflowStatusQuery
- workflowId: textual reference (case-sensitive!) to an existing workflow in the configuration
- itemText: text in the 'Item' Column (can be left blank in case of this statusTableSubType)
- benchmarkText: text in the 'Benchmark' column (can be left blank in case of this statusTableSubType)
- selectCompletedWorkflowsOnly: boolean variable: 'true' refers to query completed workflows (this type) and 'false' refers to query scheduled workflows (see previous table subtype)
- statusField: textual reference to the field in the database table TaskRuns. In this case taskRunStatus
1.2.121- .
Anchor _Toc154574453 _Toc154574453
currentForecastStatus table
The currentForecastStatus table gives an overview of which workflows are set to CURRENT. These mentioned workflows in this tables are the same as the marked with a green icon the System Monitor of the Operator Client. An example of this table is given below.
1.2.121.137 Figure 124 Example of a currentForecastStatus table (NE Region) 1.2.121.138 *
...
Declarations Section
...
...
...
Figure 125 Example of the configuration of a currentForecast table in the declarations section
...
The following elements need to be defined:
- 1.2.121.146 tableStyle: a choice of tableStyle which can be influenced by using the corresponding classes in a cascading style sheet. Choices are tableStyle1 to tableStyle10;
- id: unique identifier (as reference to this table);
- statusTableSubType: Choice for one of the subtypes of systemStatusTables: Choices are: liveSystemStatus, exportStatus, importStatus, scheduledWorkflowStatus, completedWorkflowStatus, currentForecastStatus, logMessageListing, forecastHistory;
- tableTitle: a text for a title for this table;
- headerRows: integer value for the number of header rows;
- itemHeader: header text for the 'Item' column;
- benchmarkHeader: header text for the 'Benchmark' column;
- statusHeader: header text for the 'Status' column;
- statusHeaderSplit: value indicating the number of header rows in the status column.
extraOutputFieldHeader: Additional Field(s) definition specifically for scheduled workflow related topics. Recommended fields are:Anchor OLE_LINK3 OLE_LINK3 - T0
- What-if Scenario
- Description
- FDO
- showOutputFieldsOnly: boolean value for displaying the outputfields only.
1.2.121.147 ++ 1.2.121.148 * 1.2.121.149 h5.
Report Section
...
...
...
Figure 126 Example of the configuration of a currentForecastStatus table in the report section
...
...
The following elements need to be defined:
- 1.2.121.155 id: identifier to the template tag ($TABLE(scheduledWorkflowTable)$);
- formatId: reference to the format of this type of systemStatus table in the declarations section);
- currentForecastQuery
- workflowId: textual reference (case-sensitive!) to an existing workflow in the configuration
- itemText: text in the 'Item' Column
- benchmarkText: text in the 'Benchmark' column
- statusField: textual reference: should be "dispatchTime"!
- extraOutputField: textual references to specific TaskRun details (see figure above):
- extraOutputField: textual references to specific TaskRun details (see figure above):
1.2.121.158* whatIfId
1.2.121.159* description
1.2.121.160* FDO
...
- T0
- whatIfId
- description
- FDO
...
logMessageListing table
A logMessageListing table contains logmessages which are available in the Log Browser tab in the System Monitor of the Operator Client. Log messages of a specific type can be queried. By making use of a correct reference to the cascading style sheet this table can be set to 'scrollable' An example of such a table is given in the figure below.
1.2.121.163 Figure 127 Example of a logMessageListing table (NE Region) 1.2.121.164 ++
1.2.121.165
1.2.121.166 h5.
Declarations Section
1.2.121.167 ++
1.2.121.168 
1.2.121.169
1.2.121.170 Figure 128 Example of the configuration of a logMessageListing table in the declarations section
1.2.121.171 1.2.121.172
The following elements need to be defined: 1.2.121.173
- tableStyle: a choice of tableStyle which can be influenced by using the corresponding classes in a cascading style sheet. Choices are tableStyle1 to tableStyle10;
- id: unique identifier (as reference to this table);
- statusTableSubType: Choice for one of the subtypes of systemStatusTables: Choices are: liveSystemStatus, exportStatus, importStatus, scheduledWorkflowStatus, completedWorkflowStatus, currentForecastStatus, logMessageListing, forecastHistory;
- tableTitle: a text for a title for this table;
- headerRows: integer value for the number of header rows;
- itemHeader: header text for the 'Item' column;
- benchmarkHeader: header text for the 'Benchmark' column;
- statusHeader: header text for the 'Status' column;
- statusHeaderSplit: value indicating the number of header rows in the status column.
- extraOutputFieldHeader: Additional Field(s) definition specifically for scheduled workflow related topics. Recommended fields are:
- Log Creation Time
- Log Message
- TaskrunId
- showOutputFieldsOnly: boolean value for displaying the outputfields only. This tableType requires a 'true' here.
1.2.121.174 ++
1.2.121.175
1.2.121.176 h5. Report Section
1.2.121.177 ++
1.2.121.178+
+
1.2.121.179 ++
1.2.121.180 'true' here.
Report Section
Figure 129 Example of the configuration of a currentForecastStatus table in the report section
...
...
The following elements need to be defined:
...
- id: identifier to the template tag ($TABLE(scheduledWorkflowTable)$);
- formatId: reference to the format of this type of systemStatus table in the declarations section);
- logMessageQuery
- logLevelFilter: textual (case-sensitive) reference to one of the log message levels. Choices are: INFO, WARN, ERROR, FATAL.
- logEntryEventCode: textual (case-sensitive) reference to a specific type of log message. The eventCode is a 'filter' to retrieve certain types or error messages. In this case the "TaksRun.Completed " eventCode has been used.
- statusField: textual reference to the correct field in the LogEntries table in the database (="logLevel");
- extraOutputField: textual reference to other fields in the LogEntries table which fill the corresponding columns. In this case 3 additional columns need to be filled with information:
- logCreationTime (creation time of message)
- logMessage (content of the log message itself)
- taskRunId (reference to the taskrun that throwed this message)
Anchor _Toc154574455 _Toc154574455
forecastHistory table
A forecastHistory table provides an overview of all most recent forecasts carried out. The number of foracast to include is configurable. An example of such a table is given below.
1.2.121.185 Figure 130 Example of a forecastHistory table (NE Region)
1.2.121.186 *
...
Region)
Declarations Section
Figure 131 Example of the configuration of a forecastHistory table in the declarations section
The following elements need to be defined:1.2.121.193*
- tableStyle: a choice of tableStyle which can be influenced by using the corresponding classes in a cascading style sheet. Choices are tableStyle1 to tableStyle10;
...
- id: unique identifier (as reference to this table);
...
- statusTableSubType: Choice for one of the subtypes of systemStatusTables: Choices are: liveSystemStatus, exportStatus, importStatus, scheduledWorkflowStatus, completedWorkflowStatus, currentForecastStatus, logMessageListing, forecastHistory;
...
- tableTitle: a text for a title for this table;
...
- headerRows: integer value for the number of header rows;
...
- itemHeader: header text for the 'Item' column
...
- ;
- benchmarkHeader: header text for the 'Benchmark' column;
...
- statusHeader: header text for the 'Status' column;
...
- statusHeaderSplit: value indicating the number of header rows in the status column.
...
- extraOutputFieldHeader: Additional Field(s) definition specifically for scheduled workflow related topics. Recommended fields are:
...
- Dispatch Time
...
- Completion Time
...
- T0
...
- Workflow
...
- What-if Scenario
...
- Description
...
- FDO
...
- showOutputFieldsOnly: boolean value for displaying the outputfields only. This tableType requires a 'true' here
...
- .
...
...
Report Section
...
1.2.121.215+ 
+
1.2.121.216 ++
1.2.121.217 Figure 132 Example of the configuration of a forecastHistory table in the report section
...
- id: identifier to the template tag ($TABLE(scheduledWorkflowTable)$);
- formatId: reference to the format of this type of systemStatus table in the declarations section);
- forecastHistoryQuery
- nrOfForecasts: integer value referring to the number of most recent forecast to include in this table;
- statusField: textual reference to the field in the TaskRuns table of the database
- extraOutputFields: textual references to required fields
- dispatchTime
- completionTime
- T0
- workflowId
- whatIfId
- description
- fdoName
- mcId
- fssId
1.2.122Anchor _Toc154574456 _Toc154574456 Anchor _Toc95297294 _Toc95297294
Report Export Module Configuration
This Report Export module is one of the DELFT-FEWS export modules. This export module is responsible for retrieving reports generated by forecasting runs 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- ie the 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.
...
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). |
1.2.123 Figure 133 Elements of the reportExport module configuration
1.2.124 1.2.125 h5.
reportExportRootDir
Root directory to which the all reports are to be exported to. This directory is typically the root directory of the web server 1.2.126
1.2.127 h5.
currentForecastReports
Root element for definition of exporting reports for the current forecast 1.2.128
1.2.129 h5.
currentForecastSubDir
Root directory for exporting current forecasts to.
1.2.130 1.2.131 h5.
excludeModuleInstanceId
Optional list of reports generated by report module instances that should not be included in the export of current forecasts. 1.2.132
1.2.133 h5.
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. 1.2.134
1.2.135 h5.
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.
1.2.136 1.2.137 h5.
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.
1.2.138 1.2.139 h5.
excludeModuleInstanceId
Optional list of reports generated by report module instances that should not be included in the export of other forecasts. 1.2.140
1.2.141 h5.
exportSystemStatusReports
Root directory for exporting system status reports to. 1.2.142
1.2.143 h5.
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.
1.2.144