FEWS Game application configuration
What |
application_config.xml |
---|---|
Description |
Configuration of the FEWS Game application |
schema location |
application_config.xsd |
In the application configuration, global settings for the FEWS Game which are valid for all scenarios/scripts can be specified.
Schema definition
The structure of the XML-schema for the application configuration is as follows:
Explanation
The keys in the XML-schema are explained in the figure above. Some of the keys are explained in more detail here.
- The value of the key
Locale
must be a 2-letter abbreviation of the language in which the game will be played (e.g. EN for English or NL for Dutch). - Historical scenarios/scripts may be familiar to players of the game. Therefore it is possible to hide the year of the scenario/script in the FEWS Game by setting the flag
HideYear
to true. In order to also hide the year within FEWS, thedateTimeFormat
must be configured accordingly, in thedateTime
section of the FEWS configuration fileExplorer.xml
. - The key
FewsExecutable
must contain the (absolute or relative) path to the FEWS executable, which is usually located in thebin
-directory of a FEWS release. On the Linux platform, the FEWS executable is the shell scriptfews.sh
. - The key
FewsRegionDir
is the (absolute or relative) path to the so-called region directory of FEWS. The region directory contains the FEWS configuration (theConfig
-subdirectory) and the global properties for the FEWS configuration. The FEWS Game is generic and can be played with any FEWS configuration. - The system time in FEWS is controlled by the FEWS Game. The frequency for updating the FEWS system time is specified by the key
FewsSystemTimeUpdateInMinutes
. Note that thecardinalTimeStep
, as configured in thedateTime
section of the FEWS configuration fileExplorer.xml
, should be consistent withFewsSystemTimeUpdateInMinutes
. Indeed, it makes no sense to set it in the FEWS Game to 1 minute, while it is set to 1 hour in the FEWS configuration (although this will not cause any problems in the game). - Scenarios/script that can be played with the FEWS Game must be part of a scenario/script database. The key
ScenarioDatabasePath
contains the (absolute or relative) path to the scenario/script database. - Events in a script can be associated with a file that is executed during the game. For example, a pdf-file can be associated with an event to simulate an incoming e-mail or an mp3-file to simulate telephone calls. In the section
FileAssociations
, programs can be specified with which files with indicated extensions must be processed. Default file associations are used if nothing is specified here. - Communication between FEWS and the FEWS Game is handled by the so-called FEWS PI service. This service requires a port number that must be specified in the section
FewsPiPortNumber
. This port number must be in the range of port numbers that is specified in the FEWS configuration inExplorer.xml
in the directorySystemConfigFiles
, e.g.<piServicePortRange start="8100" end="8200"/>
- The FEWS Game can also be played in a combined setting developed for the Dutch storm surge warning service (SVSD). In such a combined setting, the hostname and the port number for connecting to the combined game must be specified in
ServerHostName
andServerPort
, respectively. In a stand-alone FEWS Game these keys are not relevant.
Example
Example of application configuration
<?xml version="1.0" encoding="UTF-8"?> <Config xmlns="http://localhost" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://localhost ../../../../../xml-schemas/application_config.xsd"> <Name>Example of application configuration</Name> <Locale>EN</Locale> <HideYear>true</HideYear> <FewsExecutable>FEWS\bin\FewsNoordzee_SA.exe</FewsExecutable> <FewsRegionDir>FEWS\FewsNoordzee_SA</FewsRegionDir> <FewsSystemTimeUpdateInMinutes>1</FewsSystemTimeUpdateInMinutes> <ScenarioDatabasePath>ScenarioDatabase</ScenarioDatabasePath> <FileAssociation extension="pdf">C:\Program Files\Adobe\Reader 9.0\Reader\AcroRd32.exe</FileAssociation> <FewsPiPortNumber>8100</FewsPiPortNumber>