Wiki Markup |
---|
{scrollbar} |
Water Coach WaterCoach application configuration
What | application_config.xml (stand alone WaterCoach) waterCoachDisplay.xml (embedded WaterCoach, 2016.01 and up) |
---|---|
Description | Configuration of the Water Coach applicationWaterCoach application or WaterCoach Display (embedded WaterCoach, 2016.01 and up) |
schema location | application_config.xsd or waterCoachDisplay.xsd (embedded WaterCoach, 2016.01 and up) |
Application configuration
In the application configuration, global settings for the Water Coach WaterCoach (fka FEWS Game) which are valid for all scenarios/scripts can be specified.
Section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | |||||||
---|---|---|---|---|---|---|---|
|
...
It is advisable to use a copy of the operational system for the Water CoachWaterCoach, 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 Water CoachWaterCoach:
Note: for a more detailed description of the FEWS configuration files, please refer to the wiki pages of the Delft FEWS Configuration Guide .
- FEWS configuration file
Explorer.xml
in the directorySystemConfigFiles
- the
dateTime
section- In order to hide the year within FEWS, the
dateTimeFormat
must be configured accordingly. - The
cardinalTimeStep
should be consistent withfewsSystemTimeUpdateInMinutes
. Indeed, it makes no sense to set it in the Water Coach 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) - The element
adjustSystemTimeAutomatically
should be set to 'true', otherwise it will not be possible for the Water Coach WaterCoach to alter the systemTime during the game. (Also make sure that you don't have a T0 configured in the global.properties file).
- In order to hide the year within FEWS, the
The port number
fewsPiPortNumber
for the FEWS PI service has to be in the range of port numbers that must be specified inExplorer.xml
. Note: by specifying this range the PI service is started. This part of the configuration can be kept the same in the operational configuration.Code Block xml xml <piServicePortRange start="50505" end="50505"/>
- To distinguish the FEWS configuration for the Water CoachWaterCoach, one could change the name and panel labels. The name of the Explorer window is configured with
systemCaption
and the name of the panels withpanelHeaderLabels
. 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 Water Coach WaterCoach mode)
- the
- Depending on the set-up of the scenario and script database, an additional change could be required, see Scenario and Script database.
- Note: with some configurations at the start-up of fews via the water coachWaterCoach, the error message 'Fault occurred' may occur. This message can be ignored.
- Since all data for a scenario is pre-loaded in the FEWS local data store, it is desirable to hide certain data after the current system time, e.g. measurement data. This can be accomplished by specifying
hideExternalHistoricalAfterSystemTime=true
in the fileglobal.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.
...
FEWS configuration - Delay visibility of forecasts
When Fews is used in combination with the Water Coach, 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 for a workflow in the workflow descriptors.
...
<workflowDescriptor id="exampleWorkFlow" visible="true" forecast="true">
<waterCoachDelay unit="hour" multiplier="4"/>
</workflowDescriptor>
Additional steps for embedded WaterCoach (2016.01 and up)- Changes to the global.properties
- add the key WATERCOACH_SCENARIO_DATABASE_FOLDER (this key can be used in the live system as well, this will have no effect)
- configure localDatastoreFormat=firebird, since the default 2016.01 database is Dirby
- Create <My_WaterCoachDisplay>.xml in <root_folder>\Config\DisplayConfigFiles\ and modify it
- replace root element config with root element waterCoachDisplay
- add element <config>
- remove elements <locale>, <fewsExecutable>, <fewsRegionDir>, <fewsPiPortNumber>
- move element <hideYear> under the element <scenarioScriptDatabasePath>
- use key from global.properties to configure <scenarioScriptDatabasePath>
Add WaterCoch plugin to Explorer.xml
See example belowStart Fews (use Development branch)
WaterCoach (i.e. WaterCoach scenario selection) will be opended as a toolWindow, without focusModifiy Fews layout to start next time with WaterCoach in the front
Bring WaterCoach tool window to the front and use menu File -> Save LayoutManaging 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.
Anchor | ||||
---|---|---|---|---|
|
FEWS configuration - Delay visibility of forecasts
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 for a workflow in the workflow descriptors.
Code Block | ||||
---|---|---|---|---|
| ||||
<workflowDescriptor id="exampleWorkFlow" visible="true" forecast="true">
<waterCoachDelay unit="hour" multiplier="4"/>
</workflowDescriptor>
|
Anchor | ||||
---|---|---|---|---|
|
FEWS configuration - Participant mode
The WaterCoach can be used in the so called participant mode. In that case there is on "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 master WaterCoach session needs to make her LocalDataStore shareable using the F12-P function within the Fews application. In the future this action will be done automatically, if the WaterCoach application is so configured. As of FEWS release 2013.02, this step is no longer required, as long as the vjdbcServicePortRange is configured in SystemConfigFiles/Explorer.xml to a specific port, e.g.: <vjdbcServicePortRange start="40404" end="40404"/>Start the embeded vdjbc server using the F12-L option. This action provides an IP adress and port number in the log-window of the Fews application. These should correspond to the IP adress and port defined in the client_config.xml file of the particpant WaterCoach sessions.Replace by next step (url).- The particpant WaterCoach session(s) should link to this embeded vjdbc server by configuring this in the clientConfig.xml of the FEWS application.
- Note: 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
...
FEWS configuration - Participant mode
The Water Coach can be used in the so called participant mode. In that case there is on "master" Water Coach session, which controls the LocalDataStore as used by FEWS. The other students start up the Water Coach 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 master Water Coach session needs to make her LocalDataStore shareable using the F12-P function within the Fews application. In the future this action will be done automatically, if the Water Coach application is so configured. As of FEWS release 2013.02, this step is no longer required, as long as the vjdbcServicePortRange is configured in SystemConfigFiles/Explorer.xml to a specific port, e.g.: <vjdbcServicePortRange start="40404" end="40404"/>Start the embeded vdjbc server using the F12-L option. This action provides an IP adress and port number in the log-window of the Fews application. These should correspond to the IP adress and port defined in the client_config.xml file of the particpant Water Coach sessions.Replace by next step (url).- The particpant Water Coach session(s) should link to this embeded vjdbc server by configuring this in the clientConfig.xml of the FEWS application.
- Note: The master Water Coach session can not be used for the training, because LocalDataStore of its Fews application is not updated by changes made by the participant Water Coach sessions.
FEWS configuration - Migrate to WaterCoach SA Embedded (2016.01 and up)
...
- add the key WATERCOACH_SCENARIO_DATABASE_FOLDER (this key can be used in the live system as well, this will have no effect)
- configure localDatastoreFormat=firebird, since the default 2016.01 database is Dirby
...
- replace root element config with root element waterCoachDisplay
- add element <config>
- remove elements <locale>, <fewsExecutable>, <fewsRegionDir>, <fewsPiPortNumber>
- move element <hideYear> under the element <scenarioScriptDatabasePath>
- use key from global.properties to configure <scenarioScriptDatabasePath>
...
Add WaterCoch plugin to Explorer.xml
See example below
...
Start Fews (use Development branch)
WaterCoach (i.e. WaterCoach scenario selection) will be opended as a toolWindow, without focus
...
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
...
- .
Anchor | ||||
---|---|---|---|---|
|
...