Water Coach script configuration
script_config.xml (stand alone WaterCoach), or
waterCoachScript.xml (embedded WaterCoach, from 2016.01 and up)
Configuration of a script in the Water Coach
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.
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.
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.
Two types of stories can be specified:
inboxis optional and may be specified only once. In the inbox storyline you define the messages that appear in the inbox, which can be selected by the user.
storyis optional and can be specified an arbitrary number of times. Each story corresponds to a "Communication" button in the user interface that can be activated by the user. The content of story buttons can be dynamic, i.e. different events may be triggered by pushing the story button at different times.
Each story must have a title by specifying the
title key (but the title for the inbox is optional). This title will be used as the title of the story button. The title can be different for various languages, using the attribute
lang. If the language attribute for
title is specified and it corresponds to the preferred language in the application configuration, then this title is used in the script. If no language attribute is found that corresponds to the preferred language, then the default
title for which no language attribute was specified will be used. For example:
stories section of the script configuration, an arbitrary number of stories can be specified.
A story (including the inbox) may consist of an arbitrary number of frames by specifying 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.
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.
popup key is a flag indicating whether or not draw 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. Note: 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.
once key is a flag indicating that an event must be executed only once during a time frame.
Any number of
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).
An event can be associated with a story frame by specifying the
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
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 ' ', ' ', 'file://', 'ftp://' or ' ) 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.
A condition can be based on components of the forecast table. It must be specified according to:
columnIdis a reference to a column in the forecast table (see below), usually a parameter,
rowIdis a reference to a row in the forecast table (see below), usually a location,
ifForecastValueindicates a condition based on the value of the published forecast,
ifForecastPublicationTimeindicates a condition based on the publication time of the forecast,
ifForecastPublishedindicates a condition based on whether a forecast has been published or not,
operatoris one of "lt" (less than), "gt" (greater than), "le" (less than or equal to), "ge" (greater than or equal to), "eq" (equal to), "ne" (not equal to), "before", or "after", depending on the type of condition,
valueis the reference value to compare to; depending on the condition type, this can be an integer/real value, a boolean value, or a date/time value.
An example in which conditions are used:
The contents of the forecast table can be configured using the
forecastTable key. The schema for this section is shown on the right.
header key, the column headers in the forecast table can be specified. A column can be added with the the
column key. The value of this key is used as the name in the header of that column. For each column an
id attribute must be specified. Furthermore, the following optional attributes may be specified for a column:
unit: a string containing the unit for the column (e.g. "cm" for a water level), which will also appear in the header of the column,
type: one of "string", "integer", "float", "boolean", or "dateTime", which indicates the type of data that is displayed in the column,
isEditable: a flag with value
falseindicating whether the column is editable for the user (e.g. the user can enter the forecast in this column),
isExport: a flag with value
falseindicating whether the column must be exported to file if the forecast is published (editable columns are exported by default),
exportName: a string containing the name that must be used for exporting the column to file,
lang: a string that specifies the language of the header; this attribute behaves the same as for the
For example, the header section in the forecast table may look like:
Rows can be added to the forecast table by specifying the
row key. The number of rows is arbitrary. For each row, an identifier must be specified using the
id attribute. Content for a row is added using the
cell key, where each cell must correspond to a column in the header. This can be achieved with the
columnId attribute of the
row key. For example:
cell key also supports a
lang attribute that behaves the same as for the
With the publication of a forecast, a note can be attached. An optional initial text in this note field can be specified with the
It is possible to schedule workflows in a script, much like you would schedule tasks in an operational system. This is also useful when multiple Delft-FEWS applications are linked for a combined training with WaterCoach. In such a set-up there will be a need to share data between the systems, like forecasts that are created or changed during the training. This data exchange can be set-up with the help of (dedicated) workflows that are run all through the script.
For each scheduled workflow (
workflowId) you can define the first time it is run (
schedulingStart, which is relative to
displayStart) as well as the repeat interval (
schedulingInterval). This can be done for any workflow available in the folder for this script (i.e. the folder where the script_config.xml is stored).
Below is an example of a script where an import and export are run with an interval of ten minutes to import forecasts created by another Delft-FEWS system and export forecasts for import by this other system. The data is shared through a shared folder. In this way, the trainees do not have to manually import and export data after forecasts are made or modified.
An example of a script configuration is given here:
Dictionary file configuration
dictionary.xml (stand alone WaterCoach), or
waterCoachDictionary.xml (embedded WaterCoach, from 2016.01 and up)
Configuration of a dictionary file in the Water Coach
A dictionary can be added to a script for helping the user to look up words and definitions. These words have to be configured in a dictionary file. The key
dictionaryFile contains the path to such a dictionary file. In the section
dictionaryFiles, a dictionary file can be specified for an arbitrary number of languages, but only one dictionary file per language is supported. The schema for a dictionary file is as shown on the right. The definition field can also contain a file. In that case the specified file will be opened when the dictionary entry is clicked.
An example of a dictionary file configuration is given here: