In a script configuration, the start and end time, and events for the script are specified. A script is a directory in the scenario/script database in which files relevant for that script are collected, including the script configuration file. For more information, see scenario/script database.
Schema definition overview
The global structure of the XML-schema for the script configuration is shown on the right.The
title key is an optional identifier for the script.The time zone for the Water Coach is specified within the section
timeZone. All times in the script configuration must be specified relative to this time zone. The time zone can be specified as a name using the keyword
name (e.g. GMT, MET, ...) or as an offset to the default time zone GMT using the keyword
offset (e.g. +02:00, -06:00, ...).The start and end date/time for the script have to be specified using attributes
time in the format
hh:mm:ss, respectively. The date/time of the data in the FEWS local data store does not have to match the date/time that is displayed in the game. The actual start and end date/time (or current system time) of the local data store can be specified with the keys
dataStop. The time that is displayed in the game is controlled by the key
displayStart. With this functionality, it is possible to play a scenario of several years ago as if it happened today. Please note that the displayStart should be later than the date of your data, i.e. you can't predate the watercoach scenario.
|title||displayStart in the embedded WaterCoach|
Note: with the embedded WaterCoach (Delft-FEWS 2016.01 and up), it is recommended to use displayStart only together with the option loadAtStartup in Explorer.xml set to true. This is because to be able to change the time in the GUI to displayStart, 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.
displayStart is specified, then this defaults to
dataStart. All dates and times that are specified in the remainder of the script configuration are in data store time, i.e. between
dataStop. The keys
scriptStop are deprecated as of FEWS release 2013.02; if these keys are used in the script configuration then an error is displayed.
The configuration of
stories (events), the
Files for a script are explained below.
A story (including the inbox) may consist of an arbitrary number of frames by specifying the The
frame key according to the following schema:
title of a frame in the inbox will be used in the list of actions that the user can invoke from the inbox drop-down menu. The title of a frame in a regular story will be used as the name of the button that the user can activate. As explained above, the title can be different for various languages.The
stop keys indicate the time window in which the frame of a story is active. For a frame in the inbox this means that the associated event is available in the inbox within the time window defined by the start and stop time. For a frame in a regular story, the associated event will be executed if the user pushes the story button between the start and stop time. The
stop keys have attributes
time following the format
hh:mm:ss, respectively. Both the
stop keys are optional. If these are not specified, then these default to the start and end time of the game, respectively.The
popup key is a flag indicating whether or not to show a pop-up window at the start of the frame. For a frame belonging to the inbox this means that the associated event is executed. For a frame of a regular story, a message dialog appears informing the user that new content is available for that storydraw attention to the availability of a new message. With popup = false, no message visibly appears (unless you either open the inbox dropbox or click on a story button). With popup = true: the message itself appears Forecaster Notes for the Inbox story. With other stories, a notification that new information is available behind a story button appears in the Forecaster Notes, which can trigger the user to activate the relevant story button. If FEWS is running, these messages will appear within FEWS, otherwise a new window containing the message will be shown. Note: the pop-up window only appears when the vjdbc is started (i.e. in Participant mode) an actual pop-up window appears when popup=true, see for more details Application configuration#Delft-FEWSconfiguration.
requiredExperienceLevel key specifies that an event is only executed for the indicated experience level. Experience levels are defined in the application configuration as a list, e.g. "Beginner;Intermediate;Expert". This key can be specified multiple times if the event should be executed for multiple levels (e.g. both Beginner and Intermediate). In a frame, one refers to these levels by a number (starting with 0), e.g. if an event is only to be executed for experts, then this is configured as
If this key is not specified, then the event will be executed for all experience levels.The
once key is a flag indicating that an event must be executed only once during a time frame.
Any number of An event can be associated with a story frame by specifying the
conditions can be added to a story (or inbox) frame; the associated event will only be executed if all of these conditions are fulfilled (see below).
file key. Depending on the file type, a suitable application is started for displaying the file (e.g. a pdf-file is displayed in Adobe Reader and the contents of a txt-file is displayed in a message dialog window). The
file key has an optional language attribute
lang that behaves the same as for the
title keys.Apart from a
file, an event for the story frame may also be a
message. For such a message, no file has to be added to the scenario/script database. Instead, the contents of the message (a text string) can be specified directly in the script configuration. The
message key takes an optional
lang attribute as explained before. If the message contains an URL (starting with 'http://', 'https://', 'file://', 'ftp://' or 'mailto:// ) then this URL is made clickable automatically. For links to files, absolute path names should be used, but two shortcuts may be used: the strings '
%fewsRegionDir%' and '
%scenarioScriptDatabasePath%' will be replaced by the paths as specified in the application configuration. If FEWS is running, messages appear within FEWS, otherwise a new window containing the message appears.