Versions Compared

Key

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

...

Source: 12 hrs of 15min data
Display: maximumStatus with 15 minute data, time header by the hour (with minutes)
Configuration

 

value

explanation

timeStepsInTable

48

(12*4=48 timesteps)

timeStepsAggregation

1

each column represent 1 timestep

timeHeaderInterval

4

4 columns have a merged header (hour)

timeHeaderDisplayMinutes

true

minute indication

...

Source: 6 hrs of 15min data
Display: maximumStatus with hourly data (no minute indication)
Configuration

 

value

explanation

timeStepsInTable

24

(6*4=24 timesteps)

timeStepsAggregation

4

4*15min aggregate to 1 hour

timeHeaderInterval

1

each hour 'column' has its own header

timeHeaderDisplayMinutes

false

no minute indication in header

...

In the report section the content (timeseries) are 'attached' to this table.

1.2.110.108
1.2.110.109 Figure 107 mergedPrecipitationTable in the report section.

...

  • id: identifier (reference to the template tag)
  • formatId: reference to the format of this table (to one of the mergedPrecipitationTables in the declarations section);
  • table:
      o
      • id: identifier (used for comments only)
      o
      • formatId: reference to the format of this table (to one of the mergedPrecipitationTables in the declarations section)
      o
      • timeSeries: reference to an inputVariable
      .
      1.2.110.110
      1.2
      • .
      111 anchor
      _Toc154574447_Toc154574447

    SystemStatusTables

    SystemStatusTables display information about the status and behaviour of the FEWS system itself (like in the System monitor).

    SystemStatysTables come in different types: 1.2.112*

    • 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.

    In most tables it is possible to add 'benchmark' data to compare the actual and the desired/required situation. The configuration of such a table requires the definition of this benchmark value. Such a table contains a 'Item', "Benchmark' and a 'Status' column.

    Besides a 'benchmark' (something to compare the actual status with) additional fields (columns from the database) can be included in the table. A specific boolean value (showOutputFieldsOnly) can be used to either include or exclude these benchmark columns. In most tables this boolean is set to 'False' because most tables contain both status information as well as additional (meta)information. See figure below.

    1.2.120
    1.2.121 Figure 108 A systemStatusTable is divided into a status part and an extraOutputFields part.

    Each type will be briefly explained: 1.2.121.1

    liveSystemStatus

    A liveSystemStatusTable displays Anchor_Toc154574448_Toc154574448liveSystemStatus
    A liveSystemStatusTable displays information about the status and behaviour of the live system components (MasterController and Forecasting Shell Server(s))

    1.2.121.2
    1.2.121.3 Figure 109 Example of a liveSystemStatus table (NE Region) 1.2.121.4

    Declarations Section

    1.2.121.5
    1.2.121.6
    1.2.121.7 Figure 110 Example of the configuration of a liveSystemStatus table in the declarations section 1.2.121.8
    1.2.121.9

    The following elements need to be defined: 1.2.121.10

    • 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.
    • showOutputFieldsOnly: boolean value for displaying the outputfields only.
      1.2.121.11 1.2.121.12
      1.2.121.13 h5.
    Report Section

    ...

    Image Modified

    ...


    Figure 111 Example of the configuration of a liveSystemStatus table in the report section

    ...

    The following elements need to be defined:

    ...

    • id: identifier to the template tag ($TABLE(liveSystemStatusTable)$);
    • formatId: reference to the format of this type of systemStatus table in the declarations section); 1.2.121.19*
    • mcStatusQuery:
    • 1.2.121.20* itemTextStatus: left blank will display MC name; 1.2.121.21*
    • benchmarkTextStatus: benchmark text; 1.2.121.22*
    • fssStatusQuery:
    • 1.2.121.23* itemTextStatus: left blank will display FSS name; 1.2.121.24*
    • benchmarkTextStatus: benchmark text for status;
    • 1.2.121.25* itemTextSize: text for size query; 1.2.121.26*
    • benchmarkTextStatus: benchmark text for size 1.2.121.27*
    • singleRecordQuery
    • 1.2.121.28* tableName: tablename in local datastore; 1.2.121.29* inputfield
    • inputfield reference to column in table (to query): 1.2.121.30*
    • recordId reference to record in table:
    • 1.2.121.31* statusField reference to column in table (to display): 1.2.121.32*
    • itemText: text to be displayed (can be empty) 1.2.121.33*
    • benchmarkText: benchmark text

    ...

    exportStatus table

    1.2.121.35 A exportStatus table displays information about the status of a number export features of the system, such as: 1.2.121.36*

    • last occurence of a (export) workflow (by workflowStatusQuery);

    ...

    • nr of files present in an export directory (by logMessageParseQuery);

    ...

    • transfer speed of exporting files (by
      Anchor
      OLE_LINK1
      OLE_LINK1
      logMessageParseQuery);

    1.2.121.39
    1.2.121.40
    1.2.121.41 Figure 112 Example of an exportStatus table (NE Region)
    1.2.121.42
    1.2.121.43
    1.2.121.44 h5. Declarations Section
    1.2.121.45
    1.2.121.46 Image Removed
    1.2.121.47

    Declarations Section

    Image Added
    Figure 113 Example of the configuration of an exportStatus table in the declarations section

    ...

    • 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.
    • showOutputFieldsOnly: boolean value for displaying the outputfields only.
      1.2.121.48 1.2.121.49
      1.2.121.50 h5.
    Report Section

    ...

    Image Modified ++

    ...

    Figure 114 Example of the configuration of an exportStatus table in the report section

    ...

    ...

    This table is constructed using two types of queries:

    ...

    • workflowStatusQuery;
    • logMessageParseQuery

    The following elements need to be defined:

    ...

    ...

    • OLE_LINK2id: identifier to the template tag ($TABLE(liveSystemStatusTable)$);
    • formatId: reference to the format of this type of systemStatus table in the declarations section);
        1.2.121.60*
        • workflowStatusQuery:
            1.2.121.61*
              • workflowId:
            1.2.121.62*
              • itemText: text in 'Item' column;
            1.2.121.63*
              • benchmarkTextStatus: text in the 'Benchmark' column;
            1.2.121.64*
              • selectCompletedWorkflowsOnly: boolean indicating completed or scheduled workflows;
            1.2.121.65*
              • statusField: field from the taskRunsCompletions table indicating whether a workflow has been completed or not;
            1.2.121.66*
            • logMessageParseQuery
                1.2.121.67*
                  • itemText: text in 'Item' column;
                1.2.121.68*
                  • benchmarkTextStatus: text in the 'Benchmark' column;
                1.2.121.69* logEntryEventCode
                  • logEntryEventCode: eventcode to filter on;
                1.2.121.70*
                  • keyword: typical/unique keyword to parse for;
                1.2.121.71*
                  • displayWord: integer value for the word to display (n-th word in this log message);

              ...

              importStatus table

              An importStatus table displays information about the datafeeds which have been imported, how many of them were read and how many failed to be imported. The frequency of the files imported can be (visually) compared with a benchmark figure. See below for an example.


              1.2.121.74 Figure 115 Example of an importStatus table (NE Region)
              1.2.121.75 ++
              1.2.121.76 + +
              1.2.121.77 ++
              1.2.121.78
              1.2.121.79 h5.

              Declarations Section

              ...

              1.2.121.81
              1.2.121.82
              1.2.121.83 Figure 116 Example of the configuration of an importStatus table in the declarations section 1.2.121.84
              1.2.121.85

              The following elements need to be defined:
              1.2.121.86

              • 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 definition specifically for import related topics. Recommended fields are:
                  o
                  • Last file imported
                  o
                  • Nr. of files read
                  o
                  • Nr. of files failed
                • showOutputFieldsOnly: boolean value for displaying the outputfields only. 1.2.121.87

                Remark: when defining extraOutputFieldHeaders it is important to maintain the same order in the declarations sections (definition of the fields) and in the report section (referencing the content) otherwise the header and the content will not correspond

                ...

                .

                ...

                ...

                Report Section

                1.2.121.91 ++
                1.2.121.92 ++
                1.2.121.93 Figure 117 Example of the configuration of an importStatus table in the report section 1.2.121.94 ++
                1.2.121.95

                The following elements need to be defined: 1.2.121.96

                • id: identifier to the template tag ($TABLE(importStatusTable)$);
                • formatId: reference to the format of this type of systemStatus table in the declarations section);
                • datafeedStatusQuery
                    o
                    • BenchmarkText
                      • id: textual string contain the name of the datafeed
                      • text: textual string indicating the benchmark for this datafeed
                    o
                    • statusField: textual reference to main field in the database table ImportStatus, lastImportTime
                  • extraOutputField
                      o
                      • 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:
                        • lastFileImported
                        • filesReadCount
                        • filesFailedCount

                      1.2.121.97 Anchor_Toc154574451_Toc154574451

                    scheduledWorkflowStatus table

                    A scheduledWorkflowStatus table displays the workflows which are scheduled together with their repeat time and next due time. The figure below illustrates this.


                    1.2.121.98
                    Figure 118 Example of a scheduledworkflowStatus table (NE Region)1.2.121.99
                    1.2.121.100 h5.

                    Declarations Section

                    ...

                    1.2.121.102
                    1.2.121.103
                    1.2.121.104 Figure 119 Example of the configuration of a completedWorkflowStatus table in the declarations section 1.2.121.105
                    1.2.121.106

                    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.
                    • extraOutputFieldHeader: Additional Field(s) definition specifically for scheduled workflow related topics. Recommended fields are:
                        o
                        • Workflows
                        o
                        • Description
                        o
                        • MC Id
                        o
                        • Repeat Time
                        o
                        • Next Due Time
                      • showOutputFieldsOnly: boolean value for displaying the outputfields only.

                      ...

                      remark: One reference to an existing workflow is sufficient to extract all scheduled workflows out of the database, that's why it seems that there is only one table row configured here. In fact, this table will be filled with ALL scheduled workflows when configured as above.

                      ...

                      Report Section

                      ...

                      1.2.121.110 ++
                      1.2.121.111 Figure 120 Example of the configuration of a scheduledWorkflowStatus table in the report section

                      ...