Page History

...

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

The various explorerTasks can be organized into sub-menus through the subMenu element

Code Block

	xml
	xml

<explorerTask name="Graph">
	<mnemonic>G</mnemonic>
	<predefinedDisplay>time series dialog</predefinedDisplay>
	<toolbarTask>true</toolbarTask>
	<menubarTask>true</menubarTask>
	<allowMultipleInstances>true</allowMultipleInstances>
	<accelerator>ctrl G</accelerator>
	<loadAtStartup>true</loadAtStartup>
</explorerTask>
<subMenu name="Tools">
	<subMenu name="Data">
		<explorerTask name="Interval statistieken">
			<predefinedDisplay>interval statistics</predefinedDisplay>
			<menubarTask>true</menubarTask>
			<allowMultipleInstances>true</allowMultipleInstances>
		</explorerTask>	
	</subMenu>
	<subMenu name="Debugging">
		<explorerTask name="Attributes">
			<predefinedDisplay>attribute filter</predefinedDisplay>
			<menubarTask>true</menubarTask>
		</explorerTask>
		<explorerTask name="Database Lister">
			<predefinedDisplay>time series lister</predefinedDisplay>
			<menubarTask>true</menubarTask>
		</explorerTask>
		<explorerTask name="Workflow Navigator">
			<predefinedDisplay>workflow navigator</predefinedDisplay>
			<menubarTask>true</menubarTask>
		</explorerTask>
		<explorerTask name="Tabular config files">
			<predefinedDisplay>tabular config files display</predefinedDisplay>
			<menubarTask>true</menubarTask>
		</explorerTask>	</subMenu>
	</subMenu>	
</subMenu>

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

Since 2019.02, the type of the button can be added to the toolbar (Icon or Text). Only the ButtonType (in <toolbarTask>) Icon will use the configured <iconFile>. If left blank, it will show the new, default grey-scale icon provided from the code.

Since 2022.02 all PNG/GIF icons are replaced by SVG icons. PNG/GIF icons are still supported for compatibility reasons but they will become blurry when scaled.

The complete set of new, default, grey-scale icons can be downloaded here. See also the table below in the <predefinedDisplay> section.

...

Optional shortcut key, note that the shortcut keys only work for tasks in the menu bar (when <menuBarTask> is set to true). Examples of shortcuts: "shift X", "control DELETE", "alt shift X" etc. .

A list of accelerator keys and their availability for use can be found here.

Permission

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

...

When double clicked at a location at the map or in the list, all the explorerTasks with this option set to true are started. The location is selected before the tasks are started, so you can for example start the time series dialog (TSD) and jump to the shortcut chart of the clicked location.

Note 1:
This functionality has been designed before the introduction of docking displays and assumes that each double click opens a new TSD. To be able to open a new TSD (with argument shortcuts), this task should have the option allowMultipleInstances=true. An already opened shortcuts TSD is not able to switch to an another shortcut chart.

Note 2:
a TSD with the argument shortcuts will open to the shortcut chart that is configured in DisplayGroups.xml. By default the first chart that contains the clicked location will open. To open a specific shortcut chart, an ‘explorerLocationId’ can be configured in this shortcut chart and the chart will open if the same location is double clicked at the map or in the list.

you can for example start the time series dialog (TSD) and jump to the shortcut chart of the clicked location.

Specific for TSD with the argument "Shortcuts" :

TSD with the argument "Shortcuts" will open to the shortcut chart that is configured in DisplayGroups.xml. By default the first chart that contains the clicked location will open. To open a specific shortcut chart, an ‘explorerLocationId’ and/or ‘explorerfilterId’ can be configured in this shortcut chart and the chart will open if the same location is double clicked at the map or in the list. If explorerFilterId is configured, also the selected filter should match .

If the “Shortcuts” explorerTask has allowMultipleInstances = true, then every separate double click will open a new “Shortcuts” display.

If allowMultipleInstances = false, then the first double click on location opens the “Shortcuts” and shows the display associated with the location.
Unlock this “Shortcuts” display with lock icon in the toolbar and next double clicks on a location will direct to an associated display in the already opened “Shortcuts”.

An example:
If LocA is double clicked , TSD will open to "Display 2", since this display has <explorerLocationId>LocA</explorerLocationId> .

If LocB is double clicked and the filter ModelA is selected, TSD will open to "Display 3", since this display has <explorerFilterId>ModelA</explorerFilterId> and <explorerLocationId>LocB</explorerLocationId> .An example:
if LocB or LocC is double clicked , TSD will open to "Plot LocB" resp. "Plot LocC". If LocA is double clicked , TSD will open to "Plot LocC" , since this shortcut has <explorerLocationId>LocA</explorerLocationId>

Code Block

language	xml
title	DisplayGroups.xml config with doubleClickLocationEnabled option in explorerTasks (Explorer.xml)

<displayGroup name="Example">
            <display name="PlotDisplay LocA1">
                        <locationId>LocA</locationId>
                        <plotId>Discharge</plotId>
            </display>                   
    	        <display name="PlotDisplay LocB2">
                        <locationId>LocB<<explorerLocationId>LocA</locationId>explorerLocationId> 
                        <plotId>Discharge<<locationId>LocB</plotId>locationId>
            </display>            <plotId>Discharge</plotId>
        
     </display>   
 	        <display name="PlotDisplay LocC3">
                        <explorerFilterId>ModelA</explorerFilterId> 
	     <explorerLocationId>LocA</explorerLocationId> 
              <explorerLocationId>LocB</explorerLocationId>			
	          <locationId>LocC</locationId>
          <locationId>LocC</locationId>
                        <plotId>Discharge</plotId>  
            </display>       
</displayGroup>

loadAtStartup

...

In the below example for an explorerTask references are made to:

%VJDBC%WEB_SERVICE_PORT%, the actual JDBC port number%PORT%, same as VJDBC_PORTport where the embedded web service is running. This port is also written to the third line in running file in the region home
%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>

...

With this setting the username and usergroup can be made visible in the FEWS Explorer statusbar (bottom left). By default the userName and userGroup elements are set to false.

scheduledTaskEndWarning

Optional field. It gives a warning when a manually scheduled task is close to reaching the last repetition. You need to configure a time span (how much time before the end would you like the warning to appear) and a colour. (The background colour of tasks that are about to expire will change to this colour.)

...

Code Block

language	xml

<localDatum>someLocalDatum</localDatum>

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)

...

showIconForUnacknowledgedWarnings

Boolean option whether to show an opaque warning icon () in the status bar when unacknowledged warnings are present in database. Only if no unacknowledged errors are present.

Code Blockxmlxml

  <showIconForUnacknowledgedWarnings>true</showIconForUnacknowledgedWarnings>

Image Removed

warnings are present in database. Only if no unacknowledged errors are present.

Code Block

	xml
	xml

  <showIconForUnacknowledgedWarnings>true</showIconForUnacknowledgedWarnings>

Image Added

ocConfigDirPermission

When a local config dir in the OC region home is detected the user is asked to restart using this config dir. This feature is for testing purposes and can be disabled for normal users by specifying a required permission. Fews will always first start with the database config before asking to restart. The permission from the original config is used.

Code Block
<ocConfigDirPermission>admin</ocConfigDirPermission>

DebugMenuPermission

If the user has the debug menu permission, by pressing F12, the debug menu appears. Please note, if this permission is not configured, then the debug menu can be accessed by all users. An example of how to configure the debug menu permission and an screenshot of the debug menu follow:

...

From the FEWS Explorer File menu it is possible to configure a number of additional menu items (from which a few can also be found in the <F12> menu) . They are explained below.below.

Open most recent forecast

Opens the most recent forecast for selection (in dataviewer).

Code Block

language	xml

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

Open most recent current forecast

Opens the most recent forecast for selection (in dataviewer) current forecast for selection (in dataviewer).

Code Block
<fileMenu> <openMostRecentCurrentForecast visible="true"/> </fileMenu>

Open last forecast

Opens the last forecast for selection (in dataviewer)

Code Block

language	xml

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

Set system time to last available

Sets the system time to last available.

Code Block

language	xml

<fileMenu>
	<openMostRecentForecast<setSystemTimeToLast visible="true"/>
</fileMenu>

Open most recent current forecast

Delete localdatastore

Deletes the local datastoreOpens the most recent current forecast for selection (in dataviewer).

Code Block
<fileMenu> <openMostRecentCurrentForecast<deleteLocalDataStore visible="true"/> </fileMenu>

Open last forecast

Opens the last forecast for selection (in dataviewer)

Code Block

language	xml

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

Set system time to last available

Sets the system time to last available.

Code Block
<fileMenu> <setSystemTimeToLast visible="true"/> </fileMenu>

Delete localdatastore

Deletes the local datastore.

Code Block
<fileMenu> <deleteLocalDataStore visible="true"/> </fileMenu>

Exporttimeseries - 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. See Interactive Export

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.

Info
All geographic locations used in DELFT-FEWS are resolved to WGS 1984. If another coordinate system is to be used, then the transformation between this and WGS 1984 will need to be added. There is a class definition for these transformations. Once added the enumeration used here can be extended

Info
Care needs to be taken when working with time zones. Mixing time zones can lead to great confusion. It is wise to define the time zone as an offset with respect to UTC and use this throughout. In configuring import data, a local time zone can be used. It is advisable to always set time zones when required.

vjdbcServicePortRange

Exporttimeseries - 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. See Interactive Export

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.

Info
All geographic locations used in DELFT-FEWS are resolved to WGS 1984. If another coordinate system is to be used, then the transformation between this and WGS 1984 will need to be added. There is a class definition for these transformations. Once added the enumeration used here can be extended

Info
Care needs to be taken when working with time zones. Mixing time zones can lead to great confusion. It is wise to define the time zone as an offset with respect to UTC and use this throughout. In configuring import data, a local time zone can be used. It is advisable to always set time zones when required.

vjdbcServicePortRange

The FEWS Stand Alone can start an embedded VJDBC server automatically or through the debug mode.

Starting VJDBC server automatically:

When the Explorer.xml file of the Stand Alone system contains an additional element “vjdbcServicePortRange”, the Delft-FEWS internal vjdbc server will start automatically when the Stand alone is started. For the port number a range of the port numbers can be provided, for example <vjdbcServicePortRange start="2000" end="2005"/>

We advice to use the portrange starting from 2000.

Starting VJDBC server through the debug mode :

When there is no “vjdbcServicePortRange” configured, you can start VJDBC server with Explorer F12 menu option “M start embedded vjdbc server”. Then the embedded VJDBC Server will use port number 2000.

This VJDBC functionality can be used to analyse the database of the Stand Alone using external tools like DBVisualizer. Or it can be used to start a FEWS Stand Alone in participant mode or the Water Coach in participant mode (Application configuration#Participantmode)

piServicePortRange

Since 2022.02 the FEWS Stand Alone or Operator Client can start an embedded tomcat server with the Delft-FEWS Web Services The FEWS Stand Alone can start an embedded VJDBC server automatically or through the debug mode.

Starting VJDBC server FewsWebServices automatically:

When the Explorer.xml file of the Stand Alone system contains an additional element “vjdbcServicePortRange”“piServicePortRange”, the Delft-FEWS internal vjdbc embedded tomcat server will start automatically when the Stand alone is started. For the port number a range of the port numbers can be provided, for example <vjdbcServicePortRange start<piServicePortRangestart="20008080" end="20059000"/>

We advice to use the portrange a port range starting from 20008080.

Starting VJDBC server FewsWebServices through the debug mode :

When there is no “vjdbcServicePortRange” configured, you can start VJDBC server with Explorer F12 menu option “M start embedded vjdbc server”. Then the embedded VJDBC Server will use port number 2000.This VJDBC functionality can be used to analyse the database of the Stand Alone using external tools like DBVisualizer. Or it can be used to start a FEWS Stand Alone in participant mode or the Water Coach in participant mode (Application configuration#Participantmode)“piServicePortRange” configured, you can start the Fews Web Services with Explorer F12 menu option “start embedded tomcat web services”. Then the embedded tomcat fews web services will use a free port in the range 8080-9000. The web service is typically accessible at: http://localhost:8080/FewsWebServices/ when port 8080 is not in use.

  showLocationsOutsideVisibilityPeriod

Page tree

Versions Compared

Old Version 128

New Version Current

Key

explorerTask

iconFile

explorerTask

iconFile

Permission

loadAtStartup

scheduledTaskEndWarning

dateTimeFormat

showIconForUnacknowledgedWarnings

ocConfigDirPermission

DebugMenuPermission

Open most recent forecast

Open most recent current forecast

Open last forecast

Set system time to last available

Open most recent current forecast

Delete localdatastore

Open last forecast

Set system time to last available

Delete localdatastore

Exporttimeseries - interactiveExportFormats

someSeriesCompletelyMissingIconVisible

DocumentViewer

vjdbcServicePortRange

Exporttimeseries - interactiveExportFormats

someSeriesCompletelyMissingIconVisible

DocumentViewer

vjdbcServicePortRange

piServicePortRange