Versions Compared

Key

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

...

What

Explorer.xml

Config group

SystemConfigFiles

Required

yes

Description

Defines the main display and configures system settings

schema location

http://fews.wldelft.nl/schemas/version1.0/explorer.xsd

Table of Contents

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:

...

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.

...

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

...

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

    Code Block
    xml
    xml
    
    <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:

Code Block
xml
xml

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

...

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

Code Block

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

...

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

Example:

Code Block

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

...

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.

Code Block
xml
xml

  <numberOfTimeSeriesBlobsForWarning>1000000</numberOfTimeSeriesBlobsForWarning>

...

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:

Code Block

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

...

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

Example:

Code Block

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

...