Page History

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

Figure5 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

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

 Depreciated 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).

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.

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.

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)

arguments

Optional argument string to be passed to the task

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

Permission

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

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.

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

notification

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