Versions Compared

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 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.

Info
titledisplayStart 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.

 

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.

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

Column

...

Code Block
xml
xml
titleExample of script configuration
<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSpy v2009 sp1 (http://www.altova.com) by ICT (Stichting Deltares) -->
<script xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/watercoachschemasschemas/version1.0/script_configwaterCoachScript.xsd">
	<title>Demonstration</title>
	<dataStart    date="2007-10-04" time="10:00:00"/>
	<dataStop     date="2007-10-04" time="13:05:00"/>
	<displayStart date="2012-11-23" time="09:55:00"/>
	<stories>
		<inbox>
			<title>inbox</title>
			<frame>
				<title lang="EN">Session start</title>
				<start date="2007-10-04" time="10:05:05"/>
				<popup>true</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<requiredExperienceLevel>1</requiredExperienceLevel>
				<file lang="EN">start_session.txt</file>
			</frame>
			<frame>
				<title lang="EN">Help</title>
				<start date="2007-10-04" time="10:05:15"/>
				<popup>false</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<requiredExperienceLevel>1</requiredExperienceLevel>
				<message lang="EN">If you need help, take a look at file://%fewsRegionDir%\Help.pdf</message>
			</frame>
			<frame>
				<title lang="EN">KNMI analysis_1</title>
				<start date="2007-10-04" time="10:06:05"/>
				<popup>false</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<requiredExperienceLevel>1</requiredExperienceLevel>
				<file lang="EN">windfield_03111200.pdf</file>
			</frame>
			<frame>
				<title lang="EN">Assignment 1</title>
				<start date="2007-10-04" time="10:16:00"/>
				<popup>false</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<once>true</once>
				<file lang="EN">assignment_1.txt</file>
			</frame>
		</inbox>
		<story color="aquamarine">
			<title>KNMI</title>
			<frame>
				<title lang="EN">Telephone call</title>
				<start date="2007-10-04" time="10:06:00"/>
				<stop date="2007-10-04" time="10:16:00"/>
				<popup>true</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<requiredExperienceLevel>1</requiredExperienceLevel>
				<file lang="EN">phonecall_knmi_1.txt</file>
			</frame>
			<frame>
				<title lang="EN">KNMI phoneline is busy</title>
				<start date="2007-10-04" time="10:16:00"/>
				<stop date="2007-10-04" time="11:05:00"/>
				<popup>false</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<requiredExperienceLevel>1</requiredExperienceLevel>
				<message lang="EN">KNMI phoneline is busy. PLease try again later.</message>
				<message lang="NL">KNMI telefoonlijn is ingesprek. Probeer het later nogmaals.</message>
			</frame>
		</story>
		<story color="goldenrod">
			<title>HMCZ</title>
			<frame>
				<title lang="EN">Telephone call</title>
				<start date="2007-10-04" time="11:07:00"/>
				<stop date="2007-10-04" time="12:07:00"/>
				<popup>false</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<file lang="EN">phonecall_hmcz_1.txt</file>
			</frame>
		</story>
		<story color="forest green">
			<title>HMCN</title>
			<frame>
				<title lang="EN">Telephone call</title>
				<start date="2007-10-04" time="10:08:00"/>
				<stop date="2007-10-04" time="12:08:00"/>
				<popup>false</popup>
				<requiredExperienceLevel>0</requiredExperienceLevel>
				<file lang="EN">phonecall_hmcn_1.txt</file>
			</frame>
		</story>
	</stories>
	<forecastTable>
		<header>
			<column id="sector">sector</column>
			<column id="station">station</column>
			<column id="astro_date" lang="EN">date</column>
			<column id="astro_time" lang="EN">time astro high tide</column>
			<column id="astro_level" unit="cm" isExport="true" exportName="H.tidal.astronomic">astro water level</column>
			<column id="svsd_forecast" unit="cm" isEditable="true" exportName="H.tidal.peak">forecast</column>
		</header>
		<row id="Vlissingen">
			<cell columnId="sector">Schelde</cell>
			<cell columnId="station">Vlissingen</cell>
			<cell columnId="astro_date" lang="EN">January 1</cell>
			<cell columnId="astro_time">19:16</cell>
			<cell columnId="astro_level">237</cell>
		</row>
		<row id="HoekVanHolland">
			<cell columnId="sector">West Holland</cell>
			<cell columnId="station">Hoek van Holland</cell>
			<cell columnId="astro_date" lang="EN">January 1</cell>
			<cell columnId="astro_time">20:01</cell>
			<cell columnId="astro_level">122</cell>
		</row>
	</forecastTable>
	<forecastNote>
		<initialText lang="EN">Here you can add notes to support your forecast.</initialText>
	</forecastNote>
	<dictionaryFiles>
		<dictionaryFile lang="EN">Dictionary_1.xml</dictionaryFile>
	</dictionaryFiles>
</script>
Code Block
titleExample of dictionary file configuration
<?xml version="1.0" encoding="UTF-8"?>
<dictionary xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/waterCoachDictionary.xsd">
    <entry>
        <word>ACCESS C</word>
        <definition>
	    ACCESS C (1 hour high resolution 36 hour models covering limited domains). Same 
	    disaggregation and sub-area estimation as for OCF.
		</definition>
    </entry>
    <entry>
        <word>ACCESS R</word>
        <definition>
	    ACCESS R (1 hour medium resolution 72 hour model).  Same disaggregation and 
		sub-area estimation as for OCF.
		</definition>
    </entry>
    <entry>
        <word>ACCESS G</word>
        <definition>
    	ACCESS G (3 hour low resolution model). Same disaggregation and sub-area 
	    estimation as for OCF. 
		</definition>
    </entry>
    <entry>
        <word>ECMWF</word>
        <definition>
	    ECMWF (3 hour low resolution model). Same disaggregation and sub-area 
	    sestimation as for OCF.
		</definition>
    </entry>
</dictionary>