What | application_config.xml (stand alone WaterCoach), or waterCoachDisplay.xml (embedded WaterCoach part of Delft-FEWS config, 2016.01 and up) |
---|---|
Description | Configuration of the WaterCoach application or WaterCoach Display Some changes to the Delft-FEWS configuration are required. |
schema location | http://fews.wldelft.nl/watercoachschemas/version1.0/application_config.xsd or http://fews.wldelft.nl/schemas/version1.0/waterCoachDisplay.xsd |
In the application configuration, global settings for the WaterCoach (aka FEWS Game) which are valid for all scenarios/scripts can be specified.
|
|
The WaterCoach Display configuration for the embedded WaterCoach replaces the application configuration of the Stand Alone WaterCoach configuration. In it, global settings for the WaterCoach can be specified, which are valid for all scenarios/scripts. This display is part of the is part of the Delft-FEWS configuration , and as such needs to be declared in the Delft-FEWS configuration.
|
It is advisable to use a Stand Alone application for the WaterCoach, to prevent any possible obstructions to operational activities. Also, some minor changes are needed in the FEWS configuration in order to use it with the WaterCoach. These changes can be made to the live system as well, without much consequences.
Note: for a more detailed description of the FEWS configuration files, please refer to the wiki pages of the Delft FEWS Configuration Guide .
Explorer.xml
in the directory SystemConfigFiles
dateTime
section dateTimeFormat
must be configured accordingly.
cardinalTimeStep
should be consistent with
fewsSystemTimeUpdateInMinutes
. Indeed, it makes no sense to set it in the WaterCoach to 1 minute, while it is set to 1 hour in the FEWS configuration (although this will not cause any problems in the game). (obsolete as of FEWS release 2013.02)adjustSystemTimeAutomatically
should be set to 'true' (this is the default), otherwise it will not be possible for the WaterCoach to alter the systemTime during the game. (Also make sure that you don't have a T0 configured in the global.properties file).To have a pop-up appear with new messages, vjdbcServicePortRange
needs to be configured in Explorer.xml
. This same service is also required for the participant mode, and should only be configured for a Stand Alone or a Master application. Note: by specifying this range the vjdbc service is started. This part of the configuration can be kept the same in the live system, but be aware that this means that this service will be started in the live system as well.
<vjdbcServicePortRange start="40402" end="40402"/> |
Note: this change is no longer required with the embedded WaterCoach: The port number fewsPiPortNumber
for the FEWS PI service has to be in the range of port numbers that must be specified in Explorer.xml
. Note: by specifying this range the PI service is started. This part of the configuration can be kept the same in the live system, but be aware that this means that the PI service will be started in the live system as well.
<piServicePortRange start="50505" end="50505"/> |
systemCaption
and the name of the panels with
panelHeaderLabels
. For example, the term TRAINING or SERIOUS GAME could be added to the captions of these panels. (obsolete as of FEWS release 2013.02 since the FEWS user interface contains a yellow border when operated in WaterCoach mode)
hideExternalHistoricalAfterSystemTime=true
in the file
global.properties
, which is located in the FEWS configuration directory. As the name of this key implies, only time series of the type "external historical" are hidden; time series of the types "external forecast", "simulated historical", and "simulated forecast" are completely visible. As of FEWS release 2012.02, this step is no longer required.configure localDatastoreFormat=firebird, since the default 2016.01 database is Dirby
Note: the shared database approach for the participant mode is only supported for Firebird at the moment |
config
with root element waterCoachDisplay
config
locale
,fewsExecutable
,fewsRegionDir
,fewsPiPortNumber
hideYear
under the element scenarioScriptDatabasePath
scenarioScriptDatabasePath
/waterCoachDisplay
to the end of the fileExplorer.xml
in the directory SystemConfigFiles
Add WaterCoach plugin to Explorer.xml, see the configuration example (Only for the embedded WaterCoach, Delft-FEWS 2016.01 and up).
Note: with the embedded WaterCoach (Delft-FEWS 2016.01 and up), it is recommended to use the option loadAtStartup in Explorer.xml set to true, when the script_config.xml makes use of the option dataStart . This is because to be able to change the time in the GUI Delft-FEWS needs to restart. After the restart, only those tasks in Explorer.xml with loadAtStartup=true are started. If this option is set to false for the WaterCoachDisplay, the user will have to manually restart the display, just after she started the WaterCoach mode the first time, which can be confusing. |
Optional: Modifiy Delft-Fews layout to start with WaterCoach plugin in the front
loadAtStartup
is true (see previous step)Start Delft-FEWS
Bring WaterCoach plugin window to the front and
select 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 configuration example , in which all debug messages in WaterCoach are suppressed.
When Fews is used in combination with the WaterCoach, automatically forecast made in "the future" are invisible, both in the displays as in the forecast manager. Forecasts that where current in the past at the system time are made current again.
In practice, forecasts often come available with a certain delay. To take this into account, a delay can be specified.
Simulated forecasts are linked to a workflow, which can be delayed in the WorkflowDescriptors xml file.
<workflowDescriptor id="exampleWorkFlow" visible="true" forecast="true"> <waterCoachDelay unit="hour" multiplier="4"/> </workflowDescriptor> |
External forecasts can have a delay configured for each seperate moduleInstance in the ModuleInstanceDescriptors xml file.
<moduleInstanceDescriptor id="ImportECMWF"> <waterCoachExternalForecastDelay unit="hour" multiplier="6"/> </moduleInstanceDescriptor> |
Astronomical tide is often imported once a year into the system as an external historical, even though it's in fact a forecast. Default the WaterCoach mode won't show future values of external historical timeseries. To be able to show the tide "forecast", an exception has been made for external historical timeseries with synchlevel=4. This same synchlevel also for proper synchronisation of this data to the OC in a live system (see B Enumerations#A.5SynchronisationLevels). Note that the synchLevel=4 should explicitly be specified also in the display configuration files (e.g. Filter.xml, etc) in order for the future values of the timeseries to be visible in WaterCoach.
The shared database approach for the participant mode is only supported for Firebird at the moment |
The WaterCoach can be used in the so called participant mode. In that case there is one "master" WaterCoach session, which controls the LocalDataStore as used by FEWS. The other students start up the WaterCoach and make a connection to this same LocalDataStore. For this the shared LocalDataStore should be available to all students (e.g. network, citrix, internet). Also, some actions are necessary.
The particpant WaterCoach session(s) should link to this embeded vjdbc server by configuring this in the clientConfig.xml of the FEWS application, see configuration example. Note: the participant WaterCoach sessions should not have the vdjbc server configured in the Explorer.xml
The master WaterCoach session can not be used for the training, because LocalDataStore of its Fews application is not updated by changes made by the participant WaterCoach sessions.
With the embedded WaterCoach (2016.01 and up) the master WaterCoach session can be used for training and the LocalDataStore of its Fews applications are updated by changes made by the participant WaterCoach sessions.
<clientConfiguration 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/schemas/version1.0/clientConfig.xsd"> <databaseServer> <url>jdbc:vjdbc:rmi://<host>:<port>/VJdbc,FewsDatabase</url> <!-- replace <host> with the correct host (e.g. localhost if both applications are run on the same pc, the Ip address of the pc, or a network location) --> <!-- replace <port> according to the port configuration in Explorer.xml in the Master FEWS configurations (e.g. 40404 according to the example on this wiki) --> </databaseServer> <localCacheSizeMB>500</localCacheSizeMB> </clientConfiguration> |
<config 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/schemas/version1.0/application_config.xsd"> <name>Example of application configuration</name> <locale>EN</locale> <hideYear>false</hideYear> <fewsExecutable>..\FEWS_WaterCoach\bin\Fews_WC.exe</fewsExecutable> <fewsRegionDir>..\FEWS_WaterCoach\Fews_WC</fewsRegionDir> <scenarioScriptDatabasePath>ScenarioScriptDatabase\Fews_WC</scenarioScriptDatabasePath> <fileAssociation extension="pdf">C:\Program Files\Adobe\Reader 9.0\Reader\AcroRd32.exe</fileAssociation> <fileAssociation extension="jpg">C:\WINDOWS\system32\mspaint.exe</fileAssociation> <timeControl> <pause>true</pause> <next>false</next> <set>false</set> <fastForwardBackward>true</fastForwardBackward> </timeControl> <experienceLevel> <levels>Beginner;Expert</levels> <adjustLevel>false</adjustLevel> </experienceLevel> <fewsPiPortNumber>50505</fewsPiPortNumber> <showVisualizeScriptButton>true</showVisualizeScriptButton> <! participant keyword is deprecated since 2016.01. This has to be configured in the clientConfig file. !> <participant>false</participant> <!-- option for developer, useful when you are working on the same scenario --> <copyLocalDataStore>false</copyLocalDataStore> </config> |
<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> |
<waterCoachDisplay 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/schemas/version1.0/waterCoachDisplay.xsd"> <config> <scenarioScriptDatabasePath>ScenarioScriptDatabase\Fews_WC</scenarioScriptDatabasePath> <hideYear>false</hideYear> <fileAssociation extension="pdf">C:\Program Files\Adobe\Reader 9.0\Reader\AcroRd32.exe</fileAssociation> <fileAssociation extension="jpg">C:\WINDOWS\system32\mspaint.exe</fileAssociation> <timeControl> <pause>true</pause> <next>false</next> <set>false</set> <fastForwardBackward>true</fastForwardBackward> </timeControl> <experienceLevel> <levels>Beginner;Expert</levels> <adjustLevel>false</adjustLevel> </experienceLevel> <fewsLogEventCodes>*</fewsLogEventCodes> <!-- option for developer, useful when you are working on the same scenario --> <copyLocalDataStore>false</copyLocalDataStore> <defaultUserName>defaultUserName</defaultUserName> <defaultScenario>defaultScenario</defaultScenario> <defaultScript>defaultScript</defaultScript> <scriptLogPath>%REGION_HOME%/WaterCoach_log</scriptLogPath> <displayConfirm>false</displayConfirm> </config> </waterCoachDisplay> |
<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> <!-- select true if configuration will only be used in WaterCoach mode __> <!-- and/or dataStart is used in script_config.xml --> </explorerTask> |
<category name="nl.wldelft.fews.gui.plugin.watercoach" additivity="false"> <priority value="INFO"/> <!--If another level is used, the WC script messages won't become visible in Delft-FEWS--> <appender-ref ref="dataStoreLogEntriesTable"/> <appender-ref ref="defaultLogFile"/> <appender-ref ref="explorerLogPanel"/> </category> |