Versions Compared

Old Version 120

changes.mady.by.user Jeroen Gerrits

Saved on

compared with

New Version 121

changes.mady.by.user Jeroen Gerrits

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width45%

Schema definition overview

The global structure of the XML-schema for the script configuration is shown on the right.

Anchor
titleScript
titleScript
The title key is an optional identifier for the script.

Anchor
timeZone
timeZone
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, ...).

Anchor
startstop
startstop
The start and end date/time for the script have to be specified using attributes date and time in the format YYYY-MM-DD and hh:mm:ss, respectively. The date/time of the data in the FEWS local data store does not have to match the date/time of the script. The actual date/time (or current system time) of the local data store can be specified with the key dataStart (if this key is not specified, dataStart is assumed to be equal to scriptStart). With this functionality, it is possible to play a scenario of several years ago as if it happened today.

The configuration of stories (events), the forecastTable, forecastNote, and dictionaryFilesfor a script are explained below.

Column

Image RemovedImage Added

Section
Column
width45%

Anchor
stories
stories

Stories

Two types of stories can be specified:

  • Anchor
    inbox
    inbox
    inbox is 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.
  • Anchor
    story
    story
    story is 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:

Code Block
xml
xml
<story>
   <title lang="NL">Telefoongesprek</title>
   <title lang="GE">Anruf</title>
   <title>Telephone call</title>
</story>

In the stories section of the script configuration, an arbitrary number of stories can be specified.

Column

...