06 System Monitor Display

Description

Configuration file for the optional elements of the SystemMonitorDisplay. These are:

• Import Status Tab
• Export Status Tab
• Bulletin board

Configuration

importStatus

The Import Status Tab shows the last time a data type has been imported and can be colour coded based on the amount of time since the last import. An example file is attached.

description

Optional description

tabName

Required element that defines the name of the tab in the user interface.

tabMnemonic

Optional Mnemomic for the tab.

visibleColumns

Optional element with sub elements to control the visibility of the workflow and suspended columns.

defaultTimeThreshold

Default color coding for all datafeeds. The next element (extraTimeThreshold) can override these settings per datafeed.

Each timeThreshold element (see figure above) specifies a minimum age (<periodLength>) needed to switch to a certain colour (<color>). It is also possible to add a <label> to a timeThreshold. This label is returned in the FEWS PI REST Web Service as "status". This makes it possible to monitor a datafeed based on text, in addition to a color code.

dataFeed

Available since 2026.01. User can specify name and description for data feeds. Use the <dataFeed> which can contain a sequence of TimeThreshold as well as an id, name, and description.
In the OC, the import and export Status panels show the data feed name in the data feed column instead of the id. If the name isn't configured the id is shown. In the OC, the description is shown in a tooltip if configured.
The description and name are included in the importStatus and exportStatus webservice endpoints.
In the admin interface, the import status and export status tables, the name and description are shown in a popup if you click on the cells in the data feed id column.
Note: the name and description are never stored in the database; they are always read from the config.

extraTimeThreshold (deprecated)

Starting from FEWS 2026.01 use dataFeed element instead (see above).

This element is similar to the defaultTimeThreshold element. However, in this case the colours are defined separately for each dataFeed id.

exportStatus

The Export Status Tab shows the last time a data type has been exported and can be colour coded based on the amount of time since the last export.

description

Optional description

tabName

Required element that defines the name of the tab in the user interface.

tabMnemonic

Optional Mnemomic for the tab.

visibleColumns

Optional element with sub elements to control the visibility of the workflow and suspended columns.

defaultTimeThreshold and dataFeed

These are configured in the same way as the time thresholds for the import status tab above.

extraTimeThreshold (deprecated)

Starting from FEWS 2026.01 use dataFeed element instead (see above).

bulletinBoard

The bulletinBoard tab allows users to manually add log messages to the system. In order to use this the following should be added to the configuration file:

	<bulletinBoard>
		<tabName>Bulletin Board</tabName>
		<tabMnemonic>B</tabMnemonic>
	</bulletinBoard>

The tabname and Mnemonic can be configured. A complete example is attached.

Running Forecast

In the running tasks tab of the System monitor the task details can be displayed. To enable this, two config settings are necessary.

1. In the Workflow file the option ‘<completed>’ should be configured after each module instance

<activity>
   <runIndependent>true</runIndependent>
   <moduleInstanceId>CanadaMeteo</moduleInstanceId>
</activity>
<completed>
   <moduleInstanceId>CanadaMeteo</moduleInstanceId>
</completed>

2. In the module instance descriptors ‘updateModuleRunTimesOnCompletion’ needs to be enabled.

<moduleInstanceDescriptor id="CanadaMeteo">
   <updateModuleRunTimesOnCompletion>true</updateModuleRunTimesOnCompletion>
</moduleInstanceDescriptor>