Schema definition overviewThe 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 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 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 dataStart and 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.
If no 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 dataStart and dataStop. The keys scriptStart and scriptStop are deprecated as of FEWS release 2013.02; if these keys are used in the script configuration then an error is displayed. | Info |
|---|
| 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. |
| Info |
|---|
| title | displayStart and external applications |
|---|
| Note: displayStart won’t work in combination with external applications that both receive data from as well as return data to WaterCoach. An example of what happens when you use displayStart together with a spreadsheet that is used outside of the WaterCoach: - WaterCoach exports data relative to displayStart time
- The data is used in a spreadsheet relative to displayStart time
(i.e. the same time that is shown in the WaterCoach, which is good) - The spreadsheet exports the results in displayStart time
(since the spreadsheets doesn’t know about any delay) - The WaterCoach imports expects data to be in dataStart time, so the import activity fails.
|
The configuration of stories (events), the forecastTable, forecastNote, and Files for a script are explained below. | 