01 FEWS Explorer

Introduction

The layout of the FEWS Explorer is configured in an XML file in the SystemConfigurations section. When available on the file system, the name of the XML file is for example:

Explorer 1.00 default.xml

Explorer Fixed file name for the explorer settings

1.00 Version number

default Flag to indicate the version is the default configuration (otherwise omitted).

Figure 5 shows the main elements of the Explorer configuration, these are divided into a number of sections, each of which will be discussed individually (these are indicated with a + sign).

Figure 5 Elements in the Explorer configuration

System Information

This section contains some general information of the DELFT-FEWS configuration.

Figure 6 Elements in the System Information section of the Explorer configuration

description

An optional description of the configuration element. This is for reference purposes only and will not be used elsewhere.

systemCaption

The caption that will appear in the title bar of the FEWS Explorer window.

systemHelpFile

Reference to the file name and location of the help file

regionId

Overruling regionId. By default the regionId is taken from the REGION_HOME directory variable. This can be used by the archive dialogue in the case that the REGION_HOME variable differs between OC clients (e.g. Salzburg and SalzburgOC for the OC).

Date Time

This optional section allows to specify the handling of date and time in the GUI.

dateTimeFormat

This element specifies how date/time should be displayed in FEWS, except the clock in the status bar. The dateTimeFormat should be configured according to the specifications listed here. When specifying a T0 in the global properties file, the configured dateTimeFormat should be obeyed.

Panel sizes

This optional section allows the panel sizes to be pre-set by the configuration as a percentage of the window size.

Panel header labels

This optional section allows the configurator to specify headers above the left panels in the Explorer window. Not all headers need to be specified simultaneously.

Explorer Options

 Deprecated section

Figure 7 Elements in the Explorer Options section of the Explorer configuration

The explorer options define whether a number of items are visible on the main display when started. Each of these may either have the value "true" or "false". The items listed in Figure 7 lists all the items. The names are self-explanatory.

Map

In this section the background maps can be defined. The configuration of this section is described in the Grid Display (definition of a background map).

Location labels

Locations in the map by default are labeled with the ID or the name of the location (configured in locations.xml or locationSets.xml). In LocationSets.xml (for EsriShapeFile or CSVFile) it is also possible to replace or add text to the label, such as location attributes (using @ATTRIBUTE_ID@, Since 2013.02 or csv/dbf columns without defining an attribute with %COLUMN_NAME%), or timeserie related information (%LAST_VALUE%, %LAST_VALUE_TIME%,%FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME%). In case of timeserie related information, the label only shows the information for the selected parameter.

In the Filters.xml there is an additional option to show the last value (within the RelativeViewPeriod): lastValueVisible.

Zoom extents

The zoom extents is used to define the pre-configured zoom levels that can be selected from the main display.

Figure 8 Elements in the Explorer Options section of the Explorer configuration

zoomExtent

Main element of each zoomExtent defined. Note that multiple zoom extents may exist, with the elements below to be defined for each.

Attributes:

• title name of the zoom extent in the list of extents.

left, right, top, bottom

Coordinates of the corners of the zoom extent (specified in the geoDatum selected below)

mnemonic

Optional definition of a letter in the title to use as shortcut. Usage: Press Alt-E (to open menu "Extra"), then the configured letter.

Explorer Tasks

The explorer tasks define the tasks that can be carried out from the explorer. These tasks are for example the initiation of plug-ins such as the time series display.

NOTE: These settings should be amended only by expert users.

Figure 9 Elements in the Explorer Tasks section of the Explorer configuration

explorerTask

Main element of each explorer Task. Note that multiple tasks may exist, with the elements below to be defined for each.

Attributes;

• name name of the task

iconFile

Reference to an icon file to be used in the toolbar. If left empty the name will be used to identify the task in the toolbar

Mnemonic

Optional definition of a letter in the title to use as shortcut.

predefinedDisplay

Enumeration of possible displays:

• time series dialog
• time series lister (also known as database lister)
• plot overview
• documents
• topology tree
• topology diagram
• forecast management
• workflow navigator

displayConfigFileName

Since 2013.02. Config file of the display. The display to start is recognized by the schema name in the config file

taskExe

Command line for executable to run on initiating the task (the task may be either a call to an executable or to a Java class)

taskClass

Java class to run on initiating the task (the task may be either a call to an executable or to a Java class)
The possible taskClasses are listed in the next howto
Notice that you better use the predefinedDisplay or displayConfigFileName elements.

arguments

Optional argument string to be passed to the task.
In case of a embedded vJDBC service, you can parse the actual portnumber to an application with the argument %VJDBC_PORT% or %PORT%.
Since 2012.01, the TimeSeriesDisplay can be started with preselection of a statistical function (see example below)

workDir

Optional working directory to start the task in.

Description

Optional description of the task (for reference only)

toolbarTask

Boolean flag to indicate if the task is to appear as a part of the toolbar

menubarTask

Boolean flag to indicate if the task is to appear in the tools menu

allowMultipleInstances

Boolean flag to indicate if multiple instances of task can be initiated concurrently

loadAtStartup

In this field can be configured which windows will be opened by default when the system starts up. This feature can only be used in docking mode.

Permission

Optional name of the permission that is needed to use this task

Examples

In the below example references are made to:

• %VJDBC_PORT%, the actual JDBC port number
• %PORT%, same as VJDBC_PORT
• %HOSTNAME%, the actual JDBC host, returned as IP adress
• %REGION_HOME%, internal variable of FEWS: returns the current FEWS application directory
• %FEWSDIR%, internal variable of FEWS: returns reference to the current FEWS application directory

• $ART_VERSCHIL_EXE$, a variable from the global properties

  <explorerTask name="Art_Verschil tool">
    <iconFile>%FEWSDIR%/icons/matlab.ico</iconFile>
    <mnemonic>B</mnemonic>
    <arguments>/VJDBC_HOST=localhost /VJDBC_PORT=@VJDBC_PORT@</arguments>
    <workDir>%REGION_HOME%/Modules/Art_Verschil</workDir>
    <taskExe>$ART_VERSCHIL_EXE$</taskExe>
    <toolbarTask>true</toolbarTask>
    <menubarTask>true</menubarTask>
    <accelerator>ctrl B</accelerator>
  </explorerTask>
  

The next example calls the TimeSeriesDisplay with a preselected Statistical function:

<explorerTask name="Ensemble exceedence analysis">
  <iconFile>exceedence.png</iconFile>
  <arguments>statisticalFunction ensemblePercentileExceedence</arguments>
  <taskClass>nl.wldelft.fews.gui.plugin.timeseries.TimeSeriesDialog</taskClass>
  <toolbarTask>true</toolbarTask>
  <menubarTask>true</menubarTask>
</explorerTask>

statusBar

The status Bar settings define the format of the time string displayed in the status bar

Figure 10 Elements in the Status bar section of the Explorer configuration

dateTimeFormat

String defining the time format for time displayed in the status bar. For example HH:mm:ss will display time as 10:43:26.
Using <dateTimeFormat>dd-MM-yyyy kk:mm</dateTimeFormat> leads to hrs-indication of "24" of previous day instead of "00" (by using kk instead of HH).

restSettings

This section includes additional settings for the FEWS Explorer.

Figure 11 Elements in the Rest Settings section of the Explorer configuration

defaultSelectFilterId

Defines the default filter to be selected on starting the fewsExplorer

geoDatum

Default definition of the geographic datum. This is an enumeration of geographic datums supported. As further geographic datums are supported, the list will be expanded;

For the enumeration of geoDatums suppoted, see Appendix B

dateTimeFormat

Format definition for time strings in displays (e.g. yyyy-MM-dd HH:mm:ss is resolved to 2004-07-03 10:43:26)

cardinalTimeStep

Default cardinal time step for the system. The system time will be rounded down to the actual time to the closest cardinal time step.

Attributes;

• unit (enumeration of: second, minute, hour, day, week)
• multiplier defines the number of units given above in a time step.
• divider same function as the multiplier, but defines fraction of units in time step.

timeZone

Defines the default time zone for the system. The default time zone is used for all times in user displays, unless locally overruled. This includes time series displays and the system time. The time zone used by the system should conform to a time zone that does not consider summer time. If this optional entry is not included then the timeZone is considered to be UTC+0:00 (or GMT). The time zone can be defined in two ways:

• timeZoneOffset: The offset of the time zone with reference to UTC (equivalent to GMT). Entries should define the number of hours (or fraction of hours) offset. (e.g. +01:00)
• timeZoneName: Enumeration of supported time zones. See appendix B for list of supported time zones.

logPanelConfig

Configuration of the log panel at the bottom of the main display. This can be configured to show all messages (DEBUG level and up), or filtered from a defined level. Two types of log message can be displayed; those generated by the DEBUG logger and those by the EVENT logger. In normal use the latter is defined to show messages from a level of INFO or above. The former is not normally used except for configuration in the stand alone when additional information may be useful. Different settings are available for stand alone clients and for operator clients

Figure 12 Elements in the Log Panel section of the Explorer configuration

clientFilter

Root element of a definition of filters (multiple entries may exist).

clientId

Definition of log filters for Operator client or for Stand alone system (both may be included).

logFilter

Root element for log filter definition

eventType

Filter applicable to System logger or to debug logger. Enumeration of "system"or "event".

Level

Level of log message below which messages are not displayed. Enumeration of DEBUG, INFO, WARN, ERROR, FATAL ERROR

rollingBarrelOptions

This allows you to set the rolling barrel options for the client. Available options for the type are:

• not_automatic: The Rolling Barrel will only run if you launch it using the F12 menu
• startup_only: The Rolling Barrel will only run when starting up the client
• shutdown_only: The Rolling Barrel will only run at showdown of the client
• interval: The Rolling Barrel will run at the specified interval

Example:

<rollingBarrelOptions>
	<type>interval</type>
	<interval unit="hour" multiplier="1"/>
</rollingBarrelOptions>

Schema:

parameterListConfig

This allows you to set the default sorting option for the parameters in the Explorer. Available options are:

• default: Use the default sorting from the configuration file Parameters.xml.
• name: Sort by parameter name (ascending).

Example:

<parameterListConfig>
	<sortOption>name</sortOption>
</parameterListConfig>

Schema:

notification

The system can notify the completion of a manually dispatched task run when the notification property is enabled (i.e. enabled=TRUE).

numberOfTimeSeriesBlobsForWarning

Number for the amount of time series blobs in database that indicates when the OC should give a popup warning on startup that FEWS is not designed for unlimited amount of data. Default is 1 million.

  <numberOfTimeSeriesBlobsForWarning>1000000</numberOfTimeSeriesBlobsForWarning>

  <showIconForUnacknowledgedWarnings>true</showIconForUnacknowledgedWarnings>

Filemenu and interactiveExportFormats

From the FEWS Explorer File menu it is possible to export selected time series to a subset of the export file formats. To enable the Export Timeseries file menu option, it should be enabled in the Explorer.xml file.

Example:

<fileMenu>
	<exportTimeSeries visible="true"/>
</fileMenu>

By default the exported time series will not do any ID mapping on exporting. Pre-defined ID mapping configuration files can be configured in the interactiveExportFormats element. In the example below the export type iBever will always use the ID Mapping configuration file IdExportKwaliteit. For each export type a default ID mapping file can be configured. InteractiveExports will always export missing values.

The following exportTypes are available:

• csv
• dutch-csv
• gin-xml
• Hymos 4.03
• Hymos 4.5
• iBever
• Menyanthes
• pi-xml
• UM-Aquo
• generalCsv (with the use of Table Layout)

Some export formats (like UM Aquo) explicitly require an idMap before they are enabled in the file export menu.

Example:

<interactiveExportFormats>
	<interactiveExportFormat>
		<name>iBever Export</name>
		<exportType>iBever</exportType>
		<IdMapId>IdExportKwaliteit</IdMapId>
	</interactiveExportFormat>
	<interactiveExportFormat>
		<name>HYMOS Transferdatabase 4.03</name>
		<exportType>Hymos 4.03</exportType>
		<IdMapId>IdHYMOS</IdMapId>
		<flagConversionsId>ExportHYMOSFlagConversions</flagConversionsId>
	</interactiveExportFormat>
	<interactiveExportFormat>
		<name>HYMOS Transferdatabase 4.50</name>
		<exportType>Hymos 4.5</exportType>
		<IdMapId>IdHYMOS</IdMapId>
		<flagConversionsId>ExportHYMOSFlagConversions</flagConversionsId>
	</interactiveExportFormat>
	<interactiveExportFormat>
		<name>UM aquo</name>
		<exportType>UM-Aquo</exportType>
		<IdMapId>IdExportUMAQUO</IdMapId>
	</interactiveExportFormat>
	<interactiveExportFormat>
		<name>General CSV Sample Export</name>
		<exportType>generalCsv</exportType>
		<IdMapId>IdImport_HydroBiologie</IdMapId>
		<table>
			<dateTimeColumn name="DATE_SMP" pattern="dd-MM-yy HH:mm"/>
			<locationColumn name="LOC_CODE"/>
			<unitColumn name="Eenheid"/>
			<parameterColumn name="PARAMETER_ID"/>
			<qualifierColumn name="PAR_REF" prefix="PAR_REF_"/>
			<qualifierColumn name="PROD_CODE" prefix="PROD_CODE_"/>
			<qualifierColumn name="ANAL_CODE" prefix="ANAL_CODE_"/>
			<qualifierColumn name="TYPE" prefix="TYPE_"/>
			<propertyColumn name="COST_CODE" key="COST_CODE"/>
			<attributeColumn name="Groep" id="Groep"/>
			<valueColumn name="Waarde"/>
		</table>
	</interactiveExportFormat>
</interactiveExportFormats>

someSeriesCompletelyMissingIconVisible

When set to true, an orange cross will appear for locations/parameters/nodes where some, but not all timeseries contain missing data. Default is false (for backward compatibility)

DocumentViewer

The Documentviewer is used to show documents connected to workflows in the IFD. It is also possible to show documents connected to values in timeseries (eg picture of peilschaal). Here is more information on application and configuration.