Versions Compared

Key

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

...

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

...

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

  • %VJDBC%WEB_SERVICE_PORT%, the actual JDBC port number
  • %PORT%, same as VJDBC_PORT
  • port 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
languagexml
<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)

...

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)

fewsWebServicesPortRange

piServicePortRange

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

...

When the Explorer.xml file of the Stand Alone system contains an additional element “fewsWebServicesPortRange”“piServicePortRange”, the Delft-FEWS internal embed 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   <fewsWebServicesPortRange start<piServicePortRangestart="8080" end="9000"/>

We advice to use a port range starting from 8080.

Starting FewsWebServices through the debug mode :

When there is no “fewsWebServicesPortRange” “piServicePortRange” configured,  you can start the Fews Web Services with Explorer F12 menu option “Zstart “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.

...