Versions Compared

Key

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

FEWS Game

...

script configuration

What

scenario script_config.xml

Description

Configuration of a scenario script in the FEWS Game

schema location

scenario script_config.xsd

In a scenario configuration, the start and end time of a scenario, and events for a scenario are specified. A scenario must be a directory in the scenario database in which files relevant for that scenario are collected.

Schema definition overview

The global structure of the XML-schema for the scenario configuration is as follows:

The Name-key is an optional identifier for the scenario. The start and end date/time for the scenario have to be specified using attributes date and time in the format YYYY-MM-DD and hh:mm:ss, respectively. The NextEventButton-key can be set to yes or no and indicates whether or not a button for proceeding to the next event in the scenario must be included in the user interface. The events and forecasts for a scenario are explained below.

Events

In the section Events of the scenario configuration, an arbitrary number of events can be specified according to the following schema:

...

  • Type must be equal to "Forecast",
  • Station is the name of the forecast station (see below),
  • Operator is one of "lt" (less than), "gt" (greater than), "le" (less than or equal to), or "ge" (greater than or equal to), and
  • Value is the reference value to compare to.

...

The File-key has an optional language attribute that behaves the same as for the Title-key. The NewTime-key has the same date and time attributes as Start, Stop, and Time.

Forecasts

Locations for which a water level forecast must be made are specified in the Forecasts-section. The schema for this section is as follows:

...

The AstroDateTime-key has two attributes date and time with format YYYY-MM-DD} and {{hh:mm:ss, respectively.

Example

A complete example of a scenario configuration is given here:

...