Versions Compared

Key

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

...

Code Block
xml
xml
titleExample of meta-application configuration
   <configList xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/watercoachschemas/version1.0/application_config.xsd">
      <configPath>C:\path\to\application\configuration\application_configuration.xml</configPath>
      <configPath>C:\some\other\path\to\application\configuration\application_configuration.xml</configPath>
   </configList>

How to migrate to WaterCoach SA Embedded (2016.01 and up)

  1. Changes to the global.properties
    1. add the key WATERCOACH_SCENARIO_DATABASE_FOLDER (this key can be used in the live system as well, this will have no effect)
    2. configure localDatastoreFormat=firebird, since the default 2016.01 database is Dirby 
  2. Create WaterCoach config.xml in <root_folder>\Config\DisplayConfigFiles\ and modify it
    1. replace root element config with root element waterCoachDisplay
    2. add element <config>
    3. remove elements <locale>, <fewsExecutable>, <fewsRegionDir>, <fewsPiPortNumber>
    4. move element <hideYear> under the element <scenarioScriptDatabasePath>
    5. use key from global.properties to configure <scenarioScriptDatabasePath>
  3. Add WaterCoch plugin to Explorer.xml
    See example below

  4. Start Fews  (use Development branch)
    WaterCoach (i.e. WaterCoach scenario selection) will be opended as a toolWindow, without focus

  5. Modifiy Fews layout to start next time with WaterCoach in the front
    Bring WaterCoach tool window to the front and use menu File -> Save Layout

 

Managing of the logging from WaterCoach
User category name "nl.wldelft.fews.gui.plugin.watercoach" in Log4jConfig.xml to enter specific rules for logging from WaterCoach.
See example below, in which all debug messages in WaterCoach are surpressed.

Code Block
titleExample of WaterCoach plugin configuration in Explorer.xml
  <explorerTask name="WaterCoach">
    <displayConfigFileName>My_WC_Display_Config_File</displayConfigFileName>
    <toolbarTask>false</toolbarTask>
    <menubarTask>false</menubarTask>
    <allowMultipleInstances>false</allowMultipleInstances>
    <toolWindow>true</toolWindow>
    <loadAtStartup>true</loadAtStartup>
</explorerTask>
Code Block
titleExample of logging configuration for category nl.wldelft.fews.gui.plugin.watercoach
 <category name="nl.wldelft.fews.gui.plugin.watercoach" additivity="false">
                <priority value="WARN"/>
                <appender-ref ref="defaultLogFile"/>
 </category>

Working with WaterCoach SA Embedded (2016.01 and up)

  1. Start the Delft-FEWS application,
    1. start the WaterCoach plugin,
    2. select a scenario and script,
    3. start the game.
  2. The current localDataStore will now be replaced with scenario localDataStore.
  3. When the database is replaced,
    1. a message "Database replace finished" is logged and
    2. the separate WaterCoach control panel ("clock") is opened and
    3. Delft-FEWS switches into waterCoach mode (i.e. yellow border, system time is controlled by the WaterCoach clock).
  4. When you close WaterCoach control panel (i.e. "clock"), you will be able to select and start another scenario and/or script in the WaterCoach plugin.
    1. The last selected scenario and script will be written in user_settings.ini.
  5. When you close the WaterCoach plugin, the WaterCoach mode is switched off.

...

Working with WaterCoach Embedded - Participant mode (2016.01 - patch 59314 and up)

...