Page History

...

The report template uses tags as placeholders to identify the location of objects in the report. In the following table the available tags are described. Appendix D gives an overview of available tags. Appendix D also gives details on how defined declarations are to be used in the reports- allowing layout of tables etc. to be defined.

For many report elements, the MC ID should be set in the global.properties in "REPORTS_LEFTCOLMCID" (REPORTS_LEFTCOLMCID=none for Stand Alone).

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_Coastal_Forecast may be:

...

• id: identifier to the template tag ($TABLE(liveSystemStatusTable)$);
• formatId: reference to the format of this type of systemStatus table in the declarations section);
• mcStatusQuery:
• itemTextStatus: left blank will display MC name;
• benchmarkTextStatus: benchmark text;
• fssStatusQuery:
• itemTextStatus: left blank will display FSS name;
• benchmarkTextStatus: benchmark text for status;
• itemTextSize: text for size query;
• benchmarkTextStatus: benchmark text for size
• singleRecordQuery
• tableName: tablename in local datastore;
• inputfield reference to column in table (to query):
• recordId reference to record in table:
• statusField reference to column in table (to display):
• itemText: text to be displayed (can be empty)
• benchmarkText: benchmark text

(keep in mind that "REPORTS_LEFTCOLMCID" should be included in the global properties (REPORTS_LEFTCOLMCID=none for Stand Alone)

exportStatus table

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

...

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

(keep in mind that "REPORTS_LEFTCOLMCID" should be included in the global properties (REPORTS_LEFTCOLMCID=none for Stand Alone)

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.

...

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

(keep in mind that "REPORTS_LEFTCOLMCID" should be included in the global properties (REPORTS_LEFTCOLMCID=none for Stand Alone)

scheduledWorkflowStatus table

...

• 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 (see next table subtype) and 'false' refers to query scheduled workflows (this type)
  • 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)
  • 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

(keep in mind that "REPORTS_LEFTCOLMCID" should be included in the global properties (REPORTS_LEFTCOLMCID=none for Stand Alone)

completedWorkflowStatus table

...

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

(keep in mind that "REPORTS_LEFTCOLMCID" should be included in the global properties (REPORTS_LEFTCOLMCID=none for Stand Alone)

currentForecastStatus table

...

• 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):
      • T0
      • whatIfId
      • description
      • FDO

(keep in mind that "REPORTS_LEFTCOLMCID" should be included in the global properties (REPORTS_LEFTCOLMCID=none for Stand Alone)

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.

...

• 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

(keep in mind that "REPORTS_LEFTCOLMCID" should be included in the global properties (REPORTS_LEFTCOLMCID=none for Stand Alone)

AnimatedGIF

An animated GIF is an animation of a grid timeserie in a GIF image format. The advantage of this format is that it can easily be added to HTML pages, without the need to embed extra controls (like with AVI).

...