Since 2023.02 Column name used in the tabular config file display
Represents space character
Represents tab character
initial version.
comment added to pi_timeseries.xsd
qualifierId, ensembleId, ensembleMemberIndex added to pi_timeseries.xsd
forecastTime added to pi_timeseries.xsd
forecastTime added to pi_profiles.xsd
location coordinates added to pi_timeseries.xsd
log level to pi_run.xsd
added pi_timeseriesparameters.xsd, pi_filters.xsd included pi_locations.xsd in build. altered pi_locations.xsd
added user and ensembleMemberId to pi_timeseries.xsd
Since 2013.01. FEWS-8624. Added flag source to pi_timeseries.xsd
Since 2013.02. FEWS-8876/FEWS-8821 Added comments and flags to pi_ratingcurves.xsd
Since 2014.01 added header properties to pi_timeseries.xsd
Since 2014.02 added header threshold group info to pi_timeseries.xsd
Since 2015.01 added parent location id to pi_locations.xsd
Since 2015.01 added statistics to pi_timeseries.xsd
Since 2015.02 added moduleInstanceId to pi_timeseries.xsd
Since 2015.02 added times attribute to time step
Since version 1.19. Used for flag source column names and their custom flag source values. For example a flag source column named 'A' that has a custom flag source
value 'OK' will result
in an attribute:
fs:A="OK"
Since 2015.02 added approved time to header
Since 2016.01 added samples support
Since 2016.02 added threshold labels to pi_timeseries.xsd
Since 2016.02 a time / value range to event to pi_timeseries.xsd
Since 2017.02 added minutes attribute to time step
This percentage of the lowest values will be removed. Should be smaller than max, set to 0 to remove none of the lowest values.
(100% - this percentage) of the highest values will be removed. Should be greater than min, set to 100 to remove none of the largest values.
yyyy-MM-dd
HH:mm:ss
shortMinutesListType that allows (global) properties
00 to 59 (the minutes in a digital clock)
days of year are encoded as month*100 + the day of the month. For example: july the eleventh = 7*100 + 11 = 711
Since 2013.01. FEWS-7940. Vietnam
Since 2013.01. FEWS-7940. Vietnam
Since 2013.01. FEWS-7940. Vietnam
Since 2014.01
Since 2014.01
Id that references an qualifier listed in the regionConfigFiles/Qualifiers.xsd. All qualifiers of a time series must match all qualifiers of the filter
The value at a time represents the aggregated value over the aggregation period
e.g when the aggregation period is -6 to 0 hour the value at 13:00 represents
an aggregation (e.g. moving average) from 7:00 till 13:00 (including)
If cycle specified, then the data is repeated periodically with this cycle as the
period length. There is original data for only one cycle. After that cycle the data will be
repeated periodically. In other words, when cycle is defined, then a missing value is filled up
with a value from the last available cycle before the missing value.
Optional field for running ensembles.
Since 2019.01. Optional field for filtering on ensemble members.
Since 2015.01. To exclude module instances
Since 2015.01. * and ? are allowed in the pattern
Query a single module instance in the data store that is available for this time series set
Query all module instances in the data store that are available for this time series set
For a spectrum specify the frequency / wave length parameter. For a directional spectrum specify first the frequency parameter and secondly the directional parameter
Id that references an qualifier listed in the regionConfigFiles/Qualifiers.xsd
Relation id to map the time series set locations to related locations. Instead of the
time series set locations the related locations are used to read/write the time series.
Since 2020.01 When true locations that do not have a related location will be skipped, when false all location must have a related location. Default is false
Id of location set which represents a chainage of locations. This can only be used in combination with readWriteMode readOnly
The value at a time represents the aggregated value over the aggregation period
e.g when the aggregation period is -6 to 0 hour the value at 13:00 represents
an aggregation (e.g. moving average) from 7:00 till 13:00 (including)
If cycle specified, then the data is repeated periodically with this cycle as the period length. There is original data for only one cycle. After that cycle the data will be repeated periodically. In other words, when cycle is defined, then a missing value is filled up with a value from the last available cycle before the missing value.
Period relative the time 0 of the workflow or the system time of the fews explorer
Period relative to first time of a simulated or external forecast time series
Since 2024.01. Only time series with an external forecast time that match this time step are visible while searching
When no external forecast exists in the data store younger that the specified age a
new external forecast is returned with a minimum age that applies to the specified cardinal time step
When specified all the time series that have ALL the specified qualifiers are aggregated to a single time series on read. Can not be specified when this time series set is meant for writing
Note: this readWriteMode is only used in the TimeSeriesDisplay. Other modules ignore this readWriteMode.
Optional field for running ensembles. Ensemble id's in a time series set will override
ensemble id's defined in the workflow.
Optional field used for reading or writing one or more particular ensemble member
Optional field used for reading or writing one particular ensemble member
Optional field used for reading or writing one particular sub set of the ensemble
All values that not passed this validation step are removed on read. Set to missing for equidistant and removed for non-equidistant
Since 2022.02. All values that passed this validation step and are reliable will be included other will be set to missing for equidistant and removed for non-equidistant. This will work as an "or" operation together with "visibilityControllingFlagSourceColumnId", so data should either have passed "visibilityControllingFlagSourceColumnId" or "onlyReliableFlagSourceColumnId".
Since 2015.02. The latest available external forecast in this period will be read. By default the latest before time0 is returned
Since 2014.02. By default is there is no minimum age. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0
By default is there is no maximum age so the returned external forecast can be very old when there is no recent forecast available. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0
Since 2018.01. Forecast time reference id configured in the forecast length estimator config. Can only be used in workflows and only after the forecast length estimator.
Since 2022.01, distance between two ticks on the vertical slider
Since 2024.01, list of ticks to display on the vertical slider
Defines a moving period in time. The start and end time are relative time to a certain time.
When the running module (e.g. general adaptor)
has exported a state the state time is used instead of the specified start time.
This option is only available during a (forecast) run.
When a forecast length is specified (e.g. in the manual forecast dialog)
the time 0 + forecast length is used instead of the specified end time
This option is only available during a (forecast) run.
Defines a time relative to T0.
Optional description with additional comments. This is never used in the code.
Defines a moving period in time. The start and end time are relative time to a certain time.
When the start time is not specified it is determined by the start time of the state of the current
run.
When the start is overrulable the time is overruled by the start of search period or the start of cold
state run when one of two is specified
When the end is overrulable this time is overruled by the end of the forecast when
specified
e.g. -1 hour means one before time 0
e.g. 1 hour means one hour after time 0
When the running module (e.g. general adaptor)
has exported a state the state time is used instead of the specified start time.
This option is only available during a (forecast) run.
When a forecast length is specified (e.g. in the manual forecast dialog)
the time 0 + forecast length is used instead of the specified end time
This option is only available during a (forecast) run.
Time step, There are 5 valid combinations of attributes. id, unit+[multiplier]+[divider]+[timeZone],
times+[timeZone] + monthDays+[timeZone] ([]=optional)
Optional description of this timeStep. This is not used and is only present for convenience.
Id of the time step. You can reference time steps defined in the regionConfig/timeSteps.xml.
Only specify the id attribute when referring to a predefined time step.
In the regionConfig/timeSteps.xml the time steps list both the id and the attributes
that define the time step
Short name for the time step which is shown to the user when he can choose one from a list.
Defines the time step by a list of times without dates, e.g. "10:00 23:00"
Since 2017.02. Defines the time step by a list of minutes (with prefix 0 for single digits), e.g. "05 25" which results in times 0:05, 0:25, 1:05, etc.
Defines the time step by a list of days of month, use "01 11 21" for a decade time step
Defines the time step by a list of dates, e.g. ""--03-01 --06-01 --09-01 --12-01" for
the meteorological seasons
Same as timeUnitEnumStringType plus the nonequidistant time step
A period that occurs every year.
Short name for the season which is shown to the user when he can choose one from a
list.
Tolerance limit for time stamps belonging to a given (FEWS) parameterId
Period for which rating curve is valid.
Start time of valid period. If missing rating curve is valid for entire period prior to 'endDate'.
End time of valid period. If missing rating curve is valid for entire period after 'startDate'.
input/output Data Set which can consist of TimeSeriesSet or defined data (so called - typical
Profile) each identified with unique variable Id
timeSeriesSet
defined time series data
variableId which represents a timeSeries or an value (keep as short as possible)
variable Type (if given the VariableId is overwritten)
Convert datum from Ordnance level during Import.
Convert datum to Ordnance level during Export.
defined data input as per time series format date time (defined either by dateTime or time or
month day) and value
all week days
all week days
all possible logging levels
The lower priority logging levels (WARN, INFO or DEBUG).
Element to configure event codes of the log messages that are stored in the table LogEntries
Sinds 2015.02 Expiry time of all log message with this code
An event code for a log message has to contain a dot, e.g. "TimeSeries.Check", because the log message is only visible to the master controller if the event code contains a dot.
predefined variable types used to further identify the data in
VariableComplexType
see http://www.columbia.edu/~sue/colors-on-white.html
Float that allows (global) properties
Float that allows (global) properties
Double that allows (global) properties
Positive Double that allows (global) properties
Integer that allows (global) properties
Integer that allows (global) properties
Integer that allows (global) properties
Positive integer that allows references to location attributes.
Integer that allows references to attributes
Integer that allows references to attributes and (global) properties
Since 2014.02. Float that allows references to attributes
Float that allows references to attributes and (global) properties
Boolean that allows (global) properties
Boolean that allows references to attributes
Boolean that allows references to attributes and (global) properties
You can specify a predefined color (see see http://public.deltares.nl/display/FEWSDOC/A+Colours+Available+in+DELFT-FEWS) or a hexadecimal RGB color e.g FF0000 is red. see http://www.squarebox.co.uk/users/rolf/download/ColourWheel/ or http://javaboutique.internet.com/ColorPicker/ to compose your own color
Timezone type. Has following format +/-hh:mm (eg. +02:00)
Timezone Name : Has Enumerations like GMT,CET, EET, WET, IST
West Samoa Time, winter and summer:GMT-11
Hawaii Standard Time, winter and summer:GMT-10
Alaska Standard Time, winter:GMT-9 summer:GMT-8
Pacific Standard Time, winter:GMT-8 summer:GMT-7
Mountain Standard Time, winter and summer:GMT-7
Mountain Time with daylight saving, winter GMT-7 summer GMT-6
Mountain Standard Time, winter and summer:GMT-7
Central Standard Time, winter:GMT-6 summer:GMT-5
Eastern Standard Time, winter and summer:GMT-5
Eastern Standard Time, winter:GMT-5 summer:GMT-4
Atlantic Standard Time, winter and summer:GMT-4
Newfoundland Standard Time, winter:GMT-3:30 summer:GMT-2:30
Argentine Time, winter:GMT-3 summer:GMT-2
Brasilia Time, winter:GMT-3 summer:GMT-2
GMT and British Summer Time, winter:GMT+0 summer:GMT+1
Western European Time, winter:GMT+0 summer:GMT+1
Central European Time, winter:GMT+1 summer:GMT+2
Middle Europe Time, winter:GMT+1 summer:GMT+2
Central African Time, winter and summer:GMT+2
Eastern European Time, winter:GMT+2 summer:GMT+3
Eastern African Time, winter and summer:GMT+3
Azerbaijan Time, winter:GMT+4 summer:GMT+5
Armenia Time, winter:GMT+4 summer:GMT+5
Pakistan Time, winter and summer:GMT+5
India Standard Time, winter and summer:GMT+5:30
Bangladesh Time, winter and summer:GMT+6
Indochina Time, winter and summer:GMT+7
China Standard Time, winter and summer:GMT+8
Japan Standard Time, winter and summer:GMT+9
Korea Standard Time, winter and summer:GMT+9
Australia Central Time (Northern Territory), winter and summer:GMT+9:30
Australia Eastern Time (New South Wales), winter:GMT+10 summer:GMT+11
Since 2013.01. Australia Western Time, winter:GMT+8 summer:GMT+9
Since 2013.01. Australia Central Standard Time, winter and summer GMT+9:30
Since 2013.01. Australia Eastern Standard Time, winter and summer GMT+10
Since 2016.01. Australia Eastern Daylight Time, winter and summer GMT+11
Solomon Is. Time, winter and summer:GMT+11
New Zealand Standard Time, winter:GMT+12 summer:GMT+13
Paraguay Summer Time, winter: GMT-4 summer: GMT-3
Since 2014.02. FEWS-10303. This style shows vertical lines in plots on time step of time serie
Geo datum used for map extents and for layers that do not have a specified geo datum. When missing WGS 1984 is assumed. NB. For the reports, it is a required element. Since 2017.01 most EPSG codes listed at
https://epsg.io are supported e.g. EPSG:4326
Default visible area of the map
Extra visible areas the user can choose with the a drop down list in the map
tool bar
Deprecated, do not nest the extents
Scale Bar is not visible by default
North Arrow is not visible by default
sets the default value for the location label toggle button in the map display. This button is used to show labels with the names of displayed time serie locations in the map
Default is white
Controls the transparency / opaqueness of the background. 0% is completely transparent and 100% is completely opaque. Can be use in the spatial snapshot function in reports
Defines a Web Feature Service (WFS) connection that can be referenced by a serverShapeLayer
Defines a Web Map Service (WMS) connection that can be referenced by a wmsLayer
Defines an ArcSDE connection that can be referenced by a serverShapeLayer
Since 2014.02 FEWS-10778. Enable this button to add a tooltip button on the toolbar (for maps). This button allows a user to disable all tooltip on a map. If this option is disabled, the tooltip button will only appear for maps with optional tooltips where the optional tooltips can be disabled/enabled.
includes a group or sub group of layers
An esri ascii grid layer.
Since 2013.01 FEWS-8728. Displays pre-generated (elevation) tiles in an archive file. The tiles are compatible with open street map. Class breaks are required to render the tiles to an image
shp file is required, dbf and shx file are ignored, ssx file and lat long file are automatically generated
GeoJSON file. https://en.wikipedia.org/wiki/GeoJSON
A image layer with a world file: tif/tfw, jpg/jpw, bmp/bmw, gif/gwf are supported. Layers are listed from back to front.
Used to connect to server that uses the open street map tile protocol
Used to connect to WMS server
Used to connect to WMS server. Add all layers provided by a wms server by default invisible
The layer where the grids are displayed, when this layer is not specified the grid layer will be automatically added on top. Layers are listed from back to front. Lines from shape layers will always be on top when no grid layer is specified.
References a layer in one of the configured connections. GeoDatum is provided by the server
Only for advanced users, with this layer you can specify the java class and
properties of layers that are implemented by third parties. Layers are listed from back to
front.
Set a permission to control who can view this layer
A name of the map layer or a full path to the shape file (*.shp). The dbf and shx files are not required for FEWS but are required if you want to open them with ArcView later. The shp file is not required when the sll file already exists.
A projection file has the same name as the shp file, only the with extension .prj instead of .shp.
A prj file can be used instead of specifying the geo datum in the layer or map.
When false the geo datum of the map will be used
Set a permission to control who can view this layer
A name of the map layer or a full path to the file (*.geojson).
When the geojson file contains multiple shape types you can add the layer multiple times for each shape type
Set a permission to control who can view this layer
id of the connection, this connection should be defined in this map, just before the
layers
id of the layer provided by the connection
Some layers provide multiple shape types. Fews only supports one shape type per layer.
Shape type is optional when all the shapes are of the same type.
To limit the shapes downloaded from the server you can filter for one or more shape/feature attributes. Only the shapes that have the listed attribute values are downloaded and displayed.
Id of the shape/feature attribute
The text the shape/feature attribute value should equals
Controls if the layer is automatically visible. When false the user has to switch on the layer manually. By default the layer becomes automatically visible
Controls if the layer is used by the "Select by map item tool" in the FEWS explorer to easily select all locations in a polygon.
When this element is specified an location relation is used to find locations at the map instead of the polygon border.
When this element is specified a (multivalued) location attribute is used to find locations at the map instead of the polygon border.
Label that is displayed at the map. Labels are decluttered so not all labels will
be visible when zooming out
Label font size
Since 2017.02. Label font color, regular text color by default.
Since 2017.02. Color of the label background, white by default.
Since 2017.02. Opaqueness percentage of the label background, 50 by default.
Since 2017.02. Color of the border drawn around labels. When no border color is defined, no border will be drawn.
Since 2017.02. True by default. When true, labels for line shape files are drawn on the lines and will move along the line when the view window is adjusted. When false, the labels for lines are placed next to the line and the location is fixed. Should only be used for a line shape file.
Since 2017.02. Name of the shape attribute which is to be used as the x-coordinate for the label. When specified, labelYAttribute must be specified as well.
When no label coordinate attributes are given, the label is placed on the line for line shape files and in the centre for polygons.
Since 2017.02. Name of the shape attribute which is to be used as the y-coordinate for the label. When specified, labelXAttribute must be specified as well.
When no label coordinate attributes are given, the label is placed on the line for line shape files and in the centre for polygons.
Tool tip that is displayed when the user is moving the mouse cursor over a shape.
You can insert a attribute by inserting the attribute name between % You can use \n for a new line mark.
e.g id=%ID%\nName=%NAME%
Deprecated; you can specify a rgb color using the lineColor
element
Deprecated; you can specify a rgb color using the lineColor
element
Controls the transparency / opaqueness of the layer.
0% is completely transparent and 100% is completely opaque
You can specify one or multiple line widths.
The default line width is one pixel. The line width that is used depends on the map scale and
the attribute max scale
Since 2014.02. This offset is always relative to GMT. For example "+02:00" means GMT+02:00. If no offset specified, then time zone GMT is used by default.
Since 2014.02. Optional pattern for the dateTimes in the character column. Default is yyyyMMdd, this is the internal format a dbf file is using when the column is of type 'D'.
Since 2014.02. Name of a shape attribute (dbase column name). When the display time is before the start time this shape is invisible
Since 2014.02. Name of a shape attribute (dbase column name). When the display time is after the start time this shape is invisible
Name of a shape attribute (dbase column name).
The shape fill color can depend on the value of a shape attribute.
When the shape attribute is of type text, e.g country name, add a class break
for every country with a label that equals the country name. For the lower values use 1, 2, 3... etc
Set a permission to control who can view this layer
A FULL ABSOLUTE path to file (.asc)
By default the projection of the geo datum of the map is used,
without any rotation or shift"
Controls if the layer is automatically visible.
When false the user has to switch on the layer manually. By default the layer becomes
automatically visible
Since 2013.01 FEWS-8081. Use this layer as local datum reference. When true grids for a parameter with usesDatum=true can be displayed in local datum
The shape fill color can depend on the value of a shape attribute.
When the shape attribute is of type text, e.g country name, add a class break
for every country with a label that equals the country name. For the lower values use 1, 2, 3... etc
Set a permission to control who can view this layer
A FULL ABSOLUTE path to file (.cta). Multiple files can be specified. When the file is uploaded by the config manager split the cta file into multiple cta files of about 10MB. This can be specified when converting an asc grid to cta
Controls if the layer is automatically visible. When false the user has to switch on the layer manually. By default the layer becomes automatically visible
Use this layer as local datum reference. When true grids for a parameter with usesDatum=true can be displayed in local datum
The shape fill color can depend on the value of a shape attribute. When the shape attribute is of type text, e.g country name, add a class break for every country with a label that equals the country name. For the lower values use 1, 2, 3... etc
User name and password used for http authentication
User name and password used for http authentication
The machine which the ArcSDE instance is running on.
The port the ArcSDE instance is running on. The default is 5151.
Optional The ArcSDE instance name (generally "sde", or whatever you called the database).
User name used for authentication
Encrypted user's password. Password is encrypted with clipboard utils in F12 menu in (any) SA/OC
The user's password. Error will be logged when used. Error message will contain the encrypted password to replace this element with the element encryptedPassword
You can specify multiple line widths with different scale attributes.
The actual line width will be calculated based on the two specified line widths with the scale closest to the actual scale
The line width for the specified scale. The width for the actual scale is calculated by interpolation
Deprecated use scale
Set a permission to control who can view this layer
Reference to class breaks configured in TimeSeriesDisplayConfig.xml.
Class breaks inlined
Reference to class breaks configured in TimeSeriesDisplayConfig.xml.
Class breaks inlined
Color that is used to display missing values (NaN values) for point locations and tracks. Default is fully transparent.
Opaqueness percentage that is used to display missing values (NaN values) for point locations and tracks. This overrules the opaqueness of the configured missingValueColor. If missingValueOpaquenessPercentage is not configured, then opaqueness of missingValueColor is used.
Since 2017.01.01. Color that is used to display values below the lowerValue of the first class break. Default is fully transparent.
Since 2017.01.01. Opaqueness that is used to display values below the lowerValue of the first class break. Default is fully opaque.
Since 2017.01.01. Color that is used to display values above the lowerValue of the last class break. Default is fully transparent.
Since 2017.01.01. Opaqueness that is used to display values above the lowerValue of the last class break. Default is fully opaque.
Default is false. When true the display unit for the class break lowerValues is visible in the legend. The display unit can be configured in parameter group.
Rescaling based on Min-Max in zoom extent, with new breaks based on relative widths between lowerValues. Ordinal Value is required if rescaling should keep a fixed origin (e.g. zero).
Example 1: when rescaling without an ordinal value, then all lowerValues will be transformed so that the lowest lowerValue coincides with the minimum value in the zoom extent, and that the highest lowerValue coincides with the maximum value in the zoom extent.
Example 2: when rescaling with an ordinal value of 100, then each lowerValue will be transformed as follows.
newLowerValue = ( {oldLowerValue - 100} * scalingFactor ) + 100
This means that values of 100 will stay in the same classBreak and keep the same color and symbolSize, while other values may not.
The scalingFactor is changed to ensure that the lowest lowerValue below the ordinal value will be transformed to the min value in the zoom extent, while the highest lowerValue above the ordinal value will be transformed to the max value in the zoom extent.
Deprecated, use break
Since 2014.02 implemented for Track Layer and since 2017.02 for esriShapeLayer with points.
Since 2020.01 If set to true, labels of values which fall into the classBreak will not be displayed.
Set a permission to control who can view this layer
When the scale of the map is smaller then the minimum scale the layer is invisible. The scale is based on a normal monitor resolution. e.g. 1:100000 means 1 cm equals 1 km
When the scale of the map is larger then the maximum scale the layer is invisible. The scale is based on a normal monitor resolution. e.g. 1:100000 means 1 cm equals 1 km
Set a permission to control who can view this layer
The directory where downloaded osm tiles are cached. Put the cache on a network drive so the cache can be shared among multiple OC / SA
Set a permission to control who can view this layer
Base url for the wms server. This is everything before the text "VERSION=" in the url. Use & to include a &
Layer name to display. It's the part after the text "LAYERS=" till the next & in the url. To find the layer names enter the url that ends withs "request=GetCapabilities" in a browser.
Only set to true when the WMS layer supports GetFeatureInfo. For performance reasons the server capabilities are not queried by FEWS.
Cache dir to store the downloaded tiles. Every layer needs its own cache dir. When specifying a connection id instead of a url the general map cache dir will be used.
id of the wms connection, this connection should be defined in this map, just before the layers
Layer name to display. It's the part after the text "LAYERS=" till the next & in the url. To find the layer names enter the url that ends withs "request=GetCapabilities" in a browser.
Only set to true when the WMS layer supports GetFeatureInfo. For performance reasons the connection capabilities are not queried by FEWS.
Re-download tile when expired.
Set a permission to control who can view this layer
Base url for the wms server. This is everything before the text "VERSION=" in the url. Use & to include a &
Cache dir to store the downloaded tiles. When specifying a connection id instead of a url the general map cache dir will be used
id of the wms connection, this connection should be defined in this map, just before the layers
Default
Changes with respect to version 1.1.1 are to use "CRS=EPSG:4326" instead of "SRS=EPSG:4326", and the order of the BBOX coordinates is flipped from xmin,ymin,xmax,ymax to ymin,xmin,ymax,xmax.
Since 2018.02, default 1.1.1. Version of the wms service. Please ensure the configured version is supported by the wms service you wish to use. The url used to get the layer will be formatted according to the specified wms version. For example, with version 1.1.1 the url will contain "SRS=EPSG:4326" while with version 1.3.0 this will be "CRS=EPSG:4326". The version is included in the url as the part after the text "version=" till the next & in the url.
Since 2023.01. (2022.01 for animated wms). By default EPSG:4326 (wgs84). To connect to the FEWS webservice use EPSG:3857 (web mercator)
Default is jpg
Only supported for png and gif
WMS vendor parameters are options that are not defined in the official WMS specification, but are allowed by it. For example geoserver supports a range of custom WMS parameters. see http://docs.geoserver.org/latest/en/user/services/wms/vendor.html
When the wms server required an index in the url instead of an date/time string
Time between two wms frames
Period relative to the time 0 of the workflow or the system time of the fews explorer
Default, choose this format for photos
Format suitable for rendered maps with a distinct number of colors
Format suitable for rendered maps with a distinct number of colors
Set a permission to control who can view this layer
Deprecated, exists for backward compatibility
visible area of map
X (latitude) of the upper left corner
X (latitude) of the lower right corner
Y (longitude) of the upper left corner
Y (longitude) of the lower right corner
Optional description (this is never used in the code).
Since 2014.01
Since 2014.01
Optional description (this is never used in the code).
Optional description (this is never used in the code).
Optional description (this is never used in the code).
Optional description (this is never used in the code).
Optional description (this is never used in the code).
Optional description (this is never used in the code).
TaskRunIds of the forecast runs that are to be exported to an
archive.
Folder to export archive files to.
Deprecated. Option to allow archives to be written to files in the export folder of the archive
module.
List of forecast taskRunIds that are to be imported from archive.
List of archive files to import.
Deprecated. Option to allow archives to be read from the import folder of the archives
module.
Type of coordinate system.
Coordinates of the upper left corner of the upper left grid cell.
Number of rows in grid
Number of columns in grid
Width of the grid cells
Height of the grid cells
X coordinate of the point (Easting)
Y coordinate of the point (Northing)
Z coordinate of the point (altitude)
The ID of the referenced module instance.
Overall time span of the task run.
Type of rating curve
Contains information on the data that is present in the columns of either the input files
(post-activity) or output files (pre-activity)
In combination with a ChartFormatComplexType and the input variables it contains all the
information to generate a chart
used in reports and the chart layer in the fews explorer
Deprecated. Use leftAxis to overrule tickUnit or ticks
Deprecated. Use rightAxis to overrule tickUnit or ticks
Deprecated. Use leftAxis to overrule scaleUnit
Deprecated. Use rightAxis to overrule scaleUnit
Use leftAxis to customize the left y-axis in the chart format. Note that the settings are only used if at least one time series is attached to the left axis
Optional. If specified, then only thresholds in the specified thresholdGroup are displayed in this chart. If not specified, then thresholds in all thresholdGroups can be displayed.
Displays the extent of multiple time series as a single area. The area between the max
and min values for each time are filled with a single color. The areas are always displayed behind the other lines.
The area is painted on top of areas already specified, so specify the largest areas first.
The area is filled with vertical lines. The configured lineStyle is used. The line filled area is displayed always behind the other lines that do not belong to any areas.
Use rightAxis to customize the right y-axis in the chart format. Note that the settings are only used if at least one time series is attached to the right axis
Since 2017.01 Datum axis is an axis on the right side of the chart, and it shows left axis ticks in global datum. To convert to global datum the location altitude (z) of the first location in the chart is used. Where relevant , datum axis uses the same axis settings as left axis
Datum axis caption. If no caption is configured, then datum axis shows left axis title with suffix “global datum”
Obtain the tick values for the right chart axis by applying a rating curve to the values of the left axis. Note the opposite axis must exist
If deprecated rating curves are used , enter ratingCurveId available in deprecated ratingCurves.xml. Otherwise enter location Id here to select the PI rating curve
This option is applicable only to deprecated rating curves. Option to use the rating curve in reverse direction. Defaults to false. If rating curve is not reversible then error is thrown
Instead of displaying the value as axis label a text is specified to display.
Makes it possible to make a discharge and water level axis that share the same line.
At one axis the the discharges (as text) are displayed corresponding to a water level
A template for a chart. Contains the chart layout information that is location
independent
Use leftAxis to customize the left y-axis in the chart format. Note that the settings are only used if at least one time series is attached to the left axis
Default: legend wil be displayed at the bottom
option includeLegend is Deprecated. For backward compatibility
options how to display legend.
this footer will be added to the bottom of the chart. Tags (e.g. CURRENTTIME, USERNAME, ...) can be used
Customize view period.
Use relativeWholePeriod to round the chart view period to whole days
Use season to specify chart view period that overrules the relative view period as specified with TimeSerieSets
Since 2015.02 If True then the time series view period will be first trimmed to the last non missing value after time0, and then the time series chart will be created
If True and the chart shows simulated forecasting series, then the workflowId and T0 of that forecast will be displayed as the bottom title
The image should be included in the config folder ReportImageFiles. The image is resized to fill the whole plot
The image should be included in the config folder ReportImageFiles and should be transparent. The image is resized to fill the whole plot
Hide the qualifiers that all displayed time series have in common. Same is done for locations. This is the default
Show all the qualifiers of the displayed time series in the legend
Fixed number of ticks. The tick values depend on the axis range, and can be rounded using scaleUnit.
Tick format
Overruling tick font. The default tick font is SansSerif, size 9. If only the font style and/or size is configured, the default font (=SansSerif) is used.
Since 2016.01 Overruling axis title font. The default axis title font is SansSerif, size 10. If only the font style and/or size is configured, the default font (=SansSerif) is used.
Title displayed below the time axis. This title will be overruled with workflowId and T0 of the forecast if there is also 'includeWorkflowId' configured and the chart shows simulated forecasting series
Since 2016.01 Font of the title (caption) displayed below the time axis.
Date format
Tick font
Places you want a date/time label and/or tick and/or grid line
Tick mark is a small mark on the time axis
style of the grids lines . Use "none" if the grid lines should be not visible
Label date format
Label font
Since 2013.02 Number of forecast at or before Time0 that should be shown in the chart
time series label in legend that overrules the default label
Absolute path plus file name of the executable.
Fully qualified name of a Java class with method: public static void main(String [] args) throws Exception
Directory with jar files and optionally native dlls. When not specified the bin dir and class loader of FEWS is used. When specified the java class is executed in a private class loader, it will not use any jar in the FEWS bin dir. Only one class loader is created per binDir, adapters should still not use static variables.
Name of dataset file containing the binaries located in the 'binDir'. Use this to update 'binDir' through configuration changes.
Since 2016.01 Directory of specific jre that should be used to run java class. This could be required for modules that are not compatible with the java version used by FEWS
Since 2016.01 Specifies extra jvm arguments for instance -mx512m to give the jvm more memory than the -mx256m that FEWS uses by default for the custom jre
Since 2018.01. Copy console output to this log file
Since 2018.01. As soon the executable writes a line, matching this pattern, to the console the complete workflow is restarted
Since 2018.01. Max number of times the workflow is restarted. Default is 2
Since 2021.02. Pattern to extract a percentage number from a console log line, each line will be checked for the pattern when it comes through. The places of the question marks should contain the value. Will be read as double but written as integer rounded down. Question marks should be at the start or end of the pattern. For instance "progress: ???". The progress will be shown in the running tasks panel of the system monitor.
Name of the environment variable.
Value of the environment variable.
Optional description of the execute activity.
Command to execute. This can be either an executable or a Java class.
Arguments to be passed to the executable.
Environment variables to be passed to the executable.
Since 2018.01. Redirect output to log file and define trigger to restart the workflow
Since 2014.01. Optional. One or more text files that contain log information from the module that is executed. After the module has executed, the specified lines from these files will be imported in FEWS as log messages with the specified log level.
Weight of the activity compared to others, used for tracking progress percentage of the module. Can be any positive number, FEWS will compare the total weight configured in the module config file and compare it to the individual weights of the activities to calculate the progress percentage
Timeout for execute activity in milliseconds.
Since 2013.01. FEWS-8674. Some models only allow a limited number of runs simultaneously, sometimes limited by license server. maxNumberOfSimultaneousRuns = 1 is exactly the same as waitForOtherRun = true. By default the number of runs is limited by the workflow and runInLoopParallelProcessorCount in the global properties.
Since 2009.02. When an adapter is using shared writable resources (e.g. common blocks in a linked fortran library or writable static java fields) it will not allow multiple runs of this java class at the same time. When waitForOtherRun is true it will wait until any other run of the specified class is finished. When the executable only allows one instance set this option to true. Some executables only allow one instance due to licensing issues or temporary files that are used.
File containing diagnostic information about activity. This file always is located in the importDir and overrules the global diagnostic file.
For this activity no check should be done whether the diagnostics file is present or not
For this activity no check should be done whether the executable returns a non zero exit code. A non zero exit code can prevent the post adapter from running. When the post adapter parses a log file the exit code can be ignored. The error in the log file is more descriptive than the error code.
Since 2019.02 Execute even after error occurred, run will still fail, can be useful to still process (partial) output
to define the type of the data (double, float, string, logical etc
To define the type of the property
American Standard Code for Information Interchange
Windows Eastern European
Windows Cyrillic
Windows Latin-1
Windows Greek
Windows Turkish
Windows Baltic
ISO 8859-1, Latin Alphabet No. 1
Latin Alphabet No. 2
Latin Alphabet No. 4
Latin/Cyrillic Alphabet
Latin/Greek Alphabet
Latin Alphabet No. 5
Latin Alphabet No. 7
Latin Alphabet No. 9
KOI8-R, Russian
Eight-bit UCS Transformation Format
Sixteen-bit UCS Transformation Format, byte order identified by an optional
byte-order mark
Sixteen-bit Unicode Transformation Format, big-endian byte order
Sixteen-bit Unicode Transformation Format, little-endian byte order
Windows Hebrew
Windows Arabic
Windows Vietnamese
Latin Alphabet No. 3
Latin/Arabic Alphabet
Latin/Hebrew Alphabet
Windows Japanese
JISX 0201, 0208 and 0212, EUC encoding Japanese
JISX 0201, 0208 , EUC encoding Japanese
Shift-JIS, Japanese
JIS X 0201, 0208, in ISO 2022 form, Japanese
Windows Simplified Chinese
Simplified Chinese, PRC standard
GB2312, EUC encoding, Simplified Chinese
GBK, Simplified Chinese
ISCII91 encoding of Indic scripts
Windows Korean
KS C 5601, EUC encoding, Korean
ISO 2022 KR, Korean
Windows Traditional Chinese
Windows Traditional Chinese with Hong Kong extensions
CNS11643 (Plane 1-3), EUC encoding, Traditional Chinese
Big5, Traditional Chinese
Big5 with Hong Kong extensions, Traditional Chinese
TIS620, Thai
Big5 with seven additional Hanzi ideograph character mappings for the Solaris
zh_TW.BIG5 locale
USA, Canada (Bilingual, French), Netherlands, Portugal, Brazil,
Australia
IBM Austria, Germany
IBM Denmark, Norway
IBM Finland, Sweden
IBM Italy
IBM Catalan/Spain, Spanish Latin America
IBM United Kingdom, Ireland
IBM France
IBM Arabic
IBM Hebrew
MS-DOS United States, Australia, New Zealand, South Africa
EBCDIC 500V1
PC Greek
PC Baltic
IBM Thailand extended SBCS
MS-DOS Latin-1
MS-DOS Latin-2
IBM Cyrillic
IBM Hebrew
IBM Turkish
Variant of Cp850 with Euro character
MS-DOS Portuguese
MS-DOS Icelandic
PC Hebrew
MS-DOS Canadian French
PC Arabic
MS-DOS Nordic
MS-DOS Russian
MS-DOS Pakistan
IBM Modern Greek
IBM Multilingual Latin-2
IBM Iceland
IBM Thai
IBM Greek
IBM Pakistan (Urdu)
IBM Latvia, Lithuania (AIX, DOS)
IBM Estonia (AIX, DOS)
Japanese Katakana-Kanji mixed with 4370 UDC, superset of 5026
Korean Mixed with 1880 UDC, superset of 5029
Simplified Chinese Host mixed with 1880 UDC, superset of 5031
Traditional Chinese Host miexed with 6204 UDC, superset of 5033
Japanese Latin Kanji mixed with 4370 UDC, superset of 5035
IBM OS/2 Japanese, superset of Cp932
Variant of Cp942
IBM OS/2 Japanese, superset of Cp932 and Shift-JIS
Variant of Cp943
OS/2 Chinese (Taiwan) superset of 938
PC Korean
Variant of Cp949
PC Chinese (Hong Kong, Taiwan)
AIX Chinese (Taiwan)
AIX Korean
IBM AIX Pakistan (Urdu)
IBM Multilingual Cyrillic: Bulgaria, Bosnia, Herzegovinia, Macedonia
(FYR)
IBM Latin-5, Turkey
IBM Arabic - Windows
Latin-1 character set for EBCDIC hosts
IBM Iran (Farsi)/Persian
IBM Iran (Farsi)/Persian (PC)
IBM Latvia, Lithuania
IBM Estonia
IBM Ukraine
IBM AIX Ukraine
Variant of Cp037 with Euro character
Variant of Cp273 with Euro character
Variant of Cp277 with Euro character
Variant of Cp278 with Euro character
Variant of Cp280 with Euro character
Variant of Cp284 with Euro character
Variant of Cp285 with Euro character
Variant of Cp297 with Euro character
Variant of Cp500 with Euro character
Variant of Cp871 with Euro character
IBM OS/2, DOS People's Republic of China (PRC)
IBM AIX People's Republic of China (PRC)
IBM-eucJP - Japanese (superset of 5050)
CNS11643 in ISO 2022 CN form, Traditional Chinese (conversion from Unicode
only)
GB2312 in ISO 2022 CN form, Simplified Chinese (conversion from Unicode
only)
Detects and converts from Shift-JIS, EUC-JP, ISO 2022 JP (conversion to Unicode
only)
Windows Thai
Macintosh Arabic
Macintosh Latin-2
Macintosh Croatian
Macintosh Cyrillic
Macintosh Dingbat
Macintosh Greek
Macintosh Hebrew
Macintosh Iceland
Macintosh Roman
Macintosh Romania
Macintosh Symbol
Macintosh Thai
Macintosh Turkish
Macintosh Ukraine
Since 2017.02. FEWS-17986. When this gridPlot is selected, the zoom extent will be changed to the given map extent. Can also be specified through defaults.
When double clicking on a location in the spatial display the the time dialog will be displayed with the display group for the specified plot and the double clicked
location.
Since 2019.02. Supported only for external historical time series, in online systems only (no stand-alone). If configured, the spacial grid display will display in the footer when the latest import happened for the given dataFeedId.
Since 2018.01. Omit the layers only if the grid plot is used as a template (format) . Then the time series should be injected by the responsible components.
Since 2016.02 #68240. (Copy right logo) visible in the map. Please note that the logo cannot be shown in the maps of the Report module
If this is true, then the grid display shows the spatial thumbnails panel when this grid plot is selected. Otherwise the grid display will not show the spatial thumbnails panel when this grid plot is selected. Default is false. After this grid plot has been selected, the user can still switch on/off the spatial thumbnails panel manually, using the toggle button in the grid display. If this element is never configured for any grid plot, the user settings will be used to decide whether the thumbnails panels is shown on start-up. If this element is configured for any grid plot, the thumbnails panel will always be hidden on start-up.
If this is true and the grid plot contains ensemble time series, then the ensemble thumbnails window will be opened directly after selecting the grid plot. Default is false.
The grid thumbnails panel in the grid display shows the specified number of most recent forecasts with a time0 before or at the display time. It shows one row of thumbnails for each forecast shown. This option is only used for gridPlots that show forecast time series. For gridPlots that do not show forecast time series, only one row of thumbnails is shown. Default is 1, i.e. by default thumbnails are only shown for the current forecast.
The gap between two consecutive thumbnails in the grid thumbnails panel (in number of timeSteps). If this is 1, then a thumbnail is shown for every timeStep. If this is 2, then a thumbnail is shown for every other timeStep. If this is 3, then a thumbnail is shown for each third timeStep, etc. Default is 1. The first time in the displayed period is the reference time where the gaps "start counting", i.e. there is always a thumbnail for the first time in the displayed period.
The number of milliseconds a frame / time step is visible before the next time step becomes visible.
The default is 200 milliseconds.
When the CPU is too slow to catch the specified frame rate a frame will be displayed longer than specified.
When configured a slider is displayed with the configured time spans. If a time span is selected in the slider, then the data in the grid display is aggregated (moving average) using that time span. The start of a timeSpan is exclusive and the end of a timeSpan is inclusive. Configure a very large time span (eg 100000 days) to allow the user to see the total average of the loaded time series.
When configured an accumulation slider is displayed with the configured time spans. If a time span is selected in the slider, then the data in the grid display is aggregated (moving accumulation) using that time span. The start of a timeSpan is exclusive and the end of a timeSpan is inclusive. Configure a very large time span (eg 100000 days) to allow the user to see the total sum of the loaded time series.
Since 2014.02. When configured an accumulation slider is displayed with the configured time spans. When a time span is selected with the slider, the interval of the ticks in the time slider in the grid display is recalculated to the selected time step. Configure a very large time span (eg 100000 days) to allow the user to see the total sum of the loaded time series.
Since 2016.02. When configured an accumulation slider is displayed with the configured time steps. When a time step is selected with the slider, the interval of the ticks in the time slider in the grid display is recalculated to the selected time step. Configure a very large time step (eg 100 years) to allow the user to see the total sum of the loaded time series.
Since 2017.02. Default false. When set to true, the "show last value" will be hidden. Note that if an accumulation slider is configured, the checkbox will be hidden by default.
Specify the location attributes the user can use to filter the locations/polygons/lines that are visible in the plot. When specified the filter by location attribute button will be enabled. If a attribute name besides the id in the locationsSets.xml is specified this will be used in the attribute filter tree.
Legend style
Since 2019.02. Color used to mark time periods where a spatial modifier is applied.
Optional when default class breaks are available for this plot group and parameter group. Note: the missingValueColor configured in this classBreaks element is also used to display missing values (NaN values) for point locations and tracks when the display is showing threshold warning level flags. Since 2017.01 it is possible to configure multiple class breaks. When multiple class breaks are configured the user can switch between different class breaks. This first one is the default. The configured class break description is listed in a drop down box above the class breaks
Use different class breaks for the arrows. Makes sense when you have an arrow layer on top.
Since 2020.02. Class breaks that ares used to show the difference between two grids
Since 2020.02. Class breaks that ares used to show the relative difference between two grids
When specified a contour line with the class break value is painted for every new class break.
ONLY SUPPORTED FOR REGULAR GRIDS
Since 2017.02. Min and max depth or levels
Optional when a default map is available for this plot group and parameter
group
Available in the WebOC since 2024.01. Configuration values for the animated vectors used in the spatial display.
Available in the WebOC since 2024.01. Number of particles to use with animated vectors.
Available in the WebOC since 2024.01. Size of particles used with animated vectors.
Available in the WebOC since 2024.01. The amount particles should fade out per second.
Available in the WebOC since 2024.01. Particle color, only relevant when "coloured particles" is false.
Available in the WebOC since 2024.01. Speed factor of particles.
Available in the WebOC since 2024.01. When set to true the particles are coloured instead of the image background.
id of the workflow
Validates the drawn sketch. Only a polgyon sketch or a single point sketch is supported
set a permission to control who can view this plot group
Adds multiple plots nodes at once. Every plot will show only one location. Every z layers has it-s own location. The name and the id is postfixed with a space and the location short name. WARNING. This option is NOT recognized by the WMS service
Since 2017.02. If this is configured, then the default map extent will be enlarged to show all locations with non-missing time series. The default map extent is the minimum extent
Width of the animation in pixels
Height of the animation in pixels
Since 2016.02, optional. If this is configured, then labels will be drawn next to the locations on the map in the produced snapshot/animation. These labels will show the actual values of the corresponding locations and optionally also the units. Please note that labels will not be drawn if they would overlap other labels (decluttering), therefore some locations may not have a label on the map.
Since 2018.01, optional. If configured then the location attribute will be drawn next to the locations on the map in the created snapshot/animation
Since 2022.01, optional. The font of the valueLabels and textLabels that will be drawn next to the locations on the map in the created snapshot/animation
If this is true, then the units are shown next to the values in the labels. If this is false, then the units are not shown.
Id of the location attribute that should be shown as a label
Deprecated; you can specify a font using the element labelFont. This textLabel font will be ignored if the labelFont is configured
Snapshot
Time of the plot relative of time0 of the report run, when no times are specified the first time in the time series is used
The file name under which the spatial snapshot (image) is stored on the file system can be optionally configured. When omitted a file name is generated.
date time label is visible by default
Id referenced in the report template, $SPATIAL_PLOT_SNAPSHOT(id)$
Type of regression equation
Number of pixels from the left, the most left coordinate is 0
Number of pixels from the top, the most top coordinate is 0
Number of pixels
Number of pixels
Type of coordinate system.
PRJ file from the MapLayerFiles
Define a custom stereoGraphic geo datum.
Define a custom rotated pole geo datum based on WGS 1984. The rotation of the latitude/longitude grid is such that the intersection of the "prime meridian" and the "equator" has been located at the central latitude and longitude of the area represented.
Define a custom rotated pole geo datum based on WGS 1984. The rotation of the latitude/longitude grid is such that the intersection of the "prime meridian" and the "equator" has been located at the central latitude and longitude of the area represented.
Rotates an existing geo datum with a cartesian coordinate system counter clock wise around a specified point.
Define a custom lambert conformal conic geo datum.
Lambert AzimuthalEqualArea Projection spherical earth.
Azimuthal equidistant projection
AlbersEqualArea Projection spherical earth.
does not support a latitude of natural origin other than the equator for now.
Transverse Mercator
Alias GEOS, Alias Normalized Geostationary Projection. Viewed from above the equator (latitude = zero, height = 35768 km). Only the central meridian parameter is required.
Radius of equator in meters (approximate 6400000 meters)
Radius at pole in meters (approximate 6400000 meters)
Radius of earth in meters (approximate 6400000 meters)
First standard parallel
Second standard parallel
Latitude of natural origin,
Longitude of natural origin, longitude of central meridian, longitude that the cylinder is tangent at central meridian
Scale factor at natural origin, scale factor along the central meridian
Position (longitude) of the satellite at the equator
Unrotated cartesian coordinate system.
Rotation point x coordinate
Rotation point y coordinate
Counter clockwise rotation in degrees
Radius of earth in meters (approximate 6400000 meters)
Radius of earth at equator in meters (approximate 6400000 meters)
Radius of earth through poles in meters (approximate 6400000 meters)
A period condition
Start date and time for this period.
End date and time for this period.
Valid for entire period prior to this date and time.
Valid for entire period after this date and time.
A seasonal period that is repeated every year.
Start month and day of this season.
End month and day of this season.
Direction of extrapolation
flow or wind. Flow arrow symbols (-->) start at the location corresponding to the data point (e.g. start at cell center). Wind arrow symbols (>) are centered at the location corresponding to the data point (e.g. centered at cell center).
to (used for flow) or from (used for wind)
DEPRECATED use onlyShowDotForCurrentTime
Color of the track line behind the dots, by default no line is painted
Since 2022.01. the width of the displayed line, by default two pixels
Since 2022.01. by default the complete track is displayed and the current time dot is highlighted
Since 2022.01. by default no border is displayed
Since 2022.01. Used insteadof the valueTimeSeries and classbreak colors
Since 2022.01. Used instead of the valueTimeSeries and classbreak symbol sizes
Since 2022.01. by default the dots for all time steps are displayed and the current one is highlighted
geo datum of the x and y coordinate in the time series
TimeSeriesSet with single scalar time series for the x coordinate
TimeSeriesSet with single scalar time series for the y coordinate
Optional since 2022.01. TimeSeriesSet with single scalar time series for the values. The class breaks are used for the size and color of the dots
Indicates if this timeseries is visible in a TimeSeriesDialog which is opened from from the griddisplay
Indicates if this timeSeries is visible in the griddisplay
Instead of coloring the grid using the class breaks only draw contour (iso) lines at the specified iso values. When multiple contourValues series are configured the best that fits the value range for the view period is selected
Instead of coloring the grid draw contour lines instead. By default the the line are painted at the class breaks. Explicit contour values can be configured in the default sections at the start of this configuration file.
Controls the transparency / opaqueness of the true color grids. 0% is completely transparent and 100% is completely opaque. Can be use in the spatial snapshot function in reports>
Since 2020.02. When the red and green and blue channel are all below this threshold the grid cell is not painted. Value between 0 and 255
By default only a circle is used when no grid cell or polygon is available
Diameter of the circle symbols in pixels. Location attributes can be used in this function, eg 0.001*@CAPACITY@
Border size of the circles. To improve contrast with the background layers / grids By default no circle border is painted
Border color of the circles. Default color is black
Optional item to specify a fixed color for arrows corresponding to u,v or directional data defined in this layer. If no arrowColor specified, then the color of each arrow will depend on the arrow's data value and follow the classBreak colors.
Optional symbol to specify which symbol should be used to display vector data for this GridPlot. If not specified, then the wind symbol (>) will be used.
Direction of the arrow (to or from), Default is from (wind). From creates arrows that point in the opposite direction with respect to the direction of the data vector. This is used e.g. for wind direction: wind blowing to the East is indicated with an arrow pointing to the West.
When false (default) and arrows overlap only draw the biggest one.
When true (default) extra arrows are painted to fill the complete area
Disables the automatic decluttering to prevent jumping arrows when playing movie. The same cell
arrow will be displayed every time step as long the zoom extent kept unchanged. Disadvantage is
that no longer larger arrows are preferred during the declutter process.
Since 2018.01. Configure as true to show flow direction arrows on the lines for time series set on a location with an underlying shapefile containing lines. The direction of the lines is read from the shape file, where the first point in the file is the starting point and the second point the end point of the arrow. If the value in the time series is negative for a line, the flow arrow is inverted.
TimeSeriesSet for data to display in this layer.
TimeSeriesSets for directional vector data to display in this layer.
since 2019.02 time series set for the red component of the cell colo. Configure a time series set multiplier to convert the value to a range in 0..255
since 2019.02 time series set for the green component of the cell colo. Configure a time series set multiplier to convert the value to a range in 0..255
since 2019.02 time series set for the blue component of the cell colo. Configure a time series set multiplier to convert the value to a range in 0..255
TimeSeriesSets for u,v vector data to display in this layer.
Since 2015.02 (FEWS-8186). Id of a parameter that corresponds to the amplitude of this u,v data (e.g. wind speed). If this amplitude parameter is configured and the user double clicks on a grid cell in the grid display, then the TimeSeriesDialog will only display the amplitude sqrt(u^2+v^2) of this u,v data. The displayed amplitude time series uses the configured amplitude parameter. If neither the uvAmplitudeParameterId nor the uvDirectionParameterId is configured, then the TimeSeriesDialog only displays the separate u and v time series.
Since 2016.01 (FEWS-14003). Id of a parameter that corresponds to the direction of this u,v data (e.g. wind direction). If this direction parameter is configured and the user double clicks on a grid cell in the grid display, then the TimeSeriesDialog will only display the direction. The displayed wind direction time series uses the configured direction parameter.
If neither the uvAmplitudeParameterId nor the uvDirectionParameterId is configured, then the TimeSeriesDialog displays the separate u and v time series.
Since 2016.02. to (used for flow) or from (used for wind), default is wind
Since 2017.02 The cell depth, height, pressure when the sigma coordinate is 1.00. For the location of the grid a sigma coordinate should be configured in the region config
Since 2018.01. When configured a vertical slide is displayed to interpolate between the layers. Configure only the most important layer. The sibling layers are used automatically
Base url for the wms server. This is everything before the question mark '?' in the url, including the question mark '?' itself at the end. Do not put & signs in this url, if required extra options can be configured below as vendorParameters.
Layer name to display. It's the part after the text "LAYERS=" till the next & in the url. To find the layer names enter the url that ends withs "request=GetCapabilities" in a browser.
Only set to true when the WMS layer supports GetFeatureInfo. For performance reasons the server capabilities are not queried by FEWS.
Since 2014.02. User name and password used for http authentication
iso value of the contour line
type of extrapolation if outside the range:
non = not allowed, critical stop
maxmin = stays fixed at max (or) min level in table
linear = linear extrapolation
type of interpolation:
linear = linear extrapolation
class = values snapped to the nearest class boundaries
Only the locations/parameters/qualifiers with an id that starts with the specified text will be included in the
location set, other locations in the shape file or location sets are ignored
Only the locations/parameters/qualifiers with an id that ends with the specified text will be included in the
location set, other locations in the shape file or location sets are ignored
Only the locations/parameters/qualifiers with an id that contains the specified text will be included
Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included.
Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included
Only the locations with attribute value start with the specified text will be included.
Only the locations/parameters/qualifiers with attribute value start with the specified text will be included.
Only the locations/parameters/qualifiers with attribute value contains the specified text will be included.
Only the locations/parameters/qualifiers with attribute value equals the specified text will be included in the location set, other locations in the shape file or location sets are ignored
Only the locations/parameters/qualifiers with attribute value equals true will be included in the location set, other locations in the shape file or location sets are ignored.
Only the locations/parameters/qualifiers with attribute value equals false will be included in the location set, other locations in the shape file or location sets are ignored.
The the id should start with
The text the id should end with
The text the id should contain
Id of the location relation (eg. UPSTREAM)
Id of the attribute
Id of the attribute
The text the attribute value should start with
Id of the attribute
The text the attribute value should end with
Id of the attribute
The text the attribute value should contain
Id of the attribute
The text the attribute value should match
When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display
Id of the attribute
When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display
Time independent default module instance state.
Module instance state for a particular timestamp.
Since 2019.01. Different module instance id used for finding warm state, when original warm state can't be found
Since 2017.02. Different module instance id used for finding cold state (when warm state is configured but can't be found, or always when cold state is configured)
ID of the group of cold states to be used within the task run. If not specified default cold state will be used.
Absolute start time of the coldstate. Since 2012_02, used via upload in Admin Interface.
Relative date of the cold state to the time0 of the taskrun.
Time window used to search for a warm state. If no warm module instance state could
be found the default cold state will be used instead.
A state run should not start with a transient state, default is true, set to false for state runs
Expiry time of imported states with a time after the warm the state search period.
These states should on be used by state runs.
When no warm state is found the default cold state is used. The time is a relative
time against t0. By default the start time of the state search period is used.
Deprecated, for backward compatibility only.
Contains information on the server providing the the JMS queues for the system.
The JMS application server type (jboss (=jboss4), jboss4, jboss5, jboss7, activemq or weblogic).
Since 2014.01
The server name or IP address of the JMS application server.
Optional JNDI port if non-standard. Default is 4447 for jboss7, 61616 for activemq, 1099 for other types.
The JNDI root prefix for the JMS queues.
Java home directory of JRE, directory is assumed to contain a bin/ sub-directory with the JRE executable.
Contains information on the central database for the system.
The central database server type (oracle, sqlserver or postgresql).
Deprecated and obsolete since 2018.02
Deprecated and obsolete since 2018.02
The server name or IP address of the central database server.
Optional database port if non-standard. Assumed are 1521 for Oracle, 5432 for
PostgreSQL, 1433 for SQL Server.
The database instance ID.
The database user name.
The database user's password.
Option to produce an encrypted database password in the output configuration.
oracle, sqlserver or postgresql database server
Reference to .fdb (firebird) or .derby directory (derby) that contains the locations table. This is for testing purposes..
Contains information on the central database for the system.
jdbc url. jdbc:postgresql://host:port/database OR jdbc:oracle:thin:@//host:port/service_name OR jdbc:oracle:thin:@host:port:SID OR jdbc:oracle:thin:@TNSName OR jdbc:sqlserver://host:port/database
Deprecated and obsolete since 2012.02. Use url, user, password
Deprecated and obsolete since 2012.02. Use url, user, password
Deprecated and obsolete since 2012.02. Use url, user, password
Deprecated and obsolete since 2012.02. Use url, user, password
Deprecated and obsolete since 2012.02. Use url, user, password
Deprecated and obsolete since 2012.02. Use url, user, password
Deprecated and obsolete since 2012.02. Use url, user, password
To share one DB among multiple SA. Connects to another FEWS SA that has VJDBC server running
Describes where and why this location relation is used
Id of a location relation. Should be defined in locations.xml or locationsets.xml
eg. "H_%LOCATION_ID%, put the actual shape/dbase file column name between %%
Since 2015.01. Describes where and why this location relation is used
Since 2015.01. Name of the attribute in the locations to select
Since 2015.01. Text of the attribute. For example the region name. Locations can belong to multiple regions by creation a multiple value attribute at the location to select eg. "H_%REGION%, put the actual shape/dbase file column name between %%
Font name, e.g. sansserif. If not specified or if an invalid name is given, a default font for the component concerned will be used.
Font size. If not specified, then a default font size for the component concerned will be used.
Font style. If not specified, then a default style for the component concerned will be used.
Table is default legend. Bar legend shows fluent scale bar on the right. If you wish more advanced bar legend, use element barLegend
Location of the bar on the grid plot
Width of the bar in pixels
Length of the bar in pixels
If true, the tick labels are drawn inside the bar. Default is outside the bar.
Color of the tick labels. If omitted, then the outside labels are black and the inside labels are white
Background color of the tick labels. If omitted then white color is used. NOTE: this option is not implemented yet for inside ticks
Transparency/opaqueness of the background of the tick labels. 0% is completely transparent and 100% is completely opaque. If omitted then the background is not transparent. NOTE: this option is not implemented yet for inside ticks
When set to true the legend will display the ticks and color logarithmically.
Groups of Descriptive Statistics Functions: has at least one Descriptive Statistics Functions group. A separate statistics table will be created for each group.
Group of Descriptive Statistics Functions: has at least one Descriptive Statistics Function
Descriptive Statistical Function Complex Type: has a function name and optional parameter to be displayed in the feedback display.
The ignore missings flag is optional and is false by default. True means that missing values will be ignored. Some functions are not affected by this flag. The functions 'min' and 'max' for instance always ignore missing values, 'count' and 'missings' never do that.
Used for the descriptive statistical function using a percentile to configure the different percentiles which are to be used.
Used for the movingAccumulationMax statistical function to configure the time spans for which the maximum accumulation is to be calculated.
completed = number of values that were missing and have been completed.
corrected = number of values that were removed and have been corrected.
count = number of values.
doubtfuls = number of values that are doubtful due to validation limits.
missings = number of values that are missing.
reliables = number of values that are reliable.
unreliables = number of values that are unreliable.
Deprecated, for backward compatibility only
Deprecated, for backward compatibility only
Deprecated, for backward compatibility only. Configure 'true' if the time, the plot applies to, should be painted in the snapshot
Since 2016.02. Use this option to specify if the dateTime label should be visible in the plot, and optionally the font of this label
true if the time, the plot applies to, should be painted in the snapshot
Since 2023.02. Instead of predefined reference points, the x-coordinate of the points can be configured as values of a multi-value location attribute.
Since 2023.02. Instead of predefined reference points, the y-coordinate of the points can be configured as values of a multi-value location attribute.
Statistical Function Name: has enumerations like Percentiles, Mean
Groups all metadata options.
A short description of the dataset. Its value will be used by THREDDS opendap servers as the name of the dataset. It therefore should be human readable and reasonable to display in a list of such names.
Specifies where the original data was produced.
The method of production of the original data. If it was model-generated, source should name the model and its version, as specifically as could be useful. If it is observational, source should characterize it (e.g. "surface observation" or "radiosonde").
Provides an audit trail for modifications to the original data. It should contain a separate line for each modification with each line including a timestamp, user name, modification name, and modification arguments. Its value will be used by THREDDS opendap servers as a history-type documentation. It is recommended that each line begins with a timestamp indicating the date and time of day at which the modification was performed.
Published or web-based references that describe the data or methods used to produce it.
Miscellaneous information about the data or methods used to produce it.
The "summary" attribute gives a longer description of the dataset. In many discovery systems, the title and the summary will be displayed in the results list from a search. It should therefore capture the essence of the dataset it describes. For instance, include information on the type of data contained in the dataset, how the data was created (e.g. instrument X or model X, run Y), the creator of the dataset, the project for which the data was created, the geospatial coverage of the data, and the temporal coverage of the data.
Optional one or more key words or phrases that are relevant to the dataset. The values in this list may be taken from a controlled list of keywords (e.g. the AGU Index list or the GCMD Science Keywords).
If you want to add an attribute that is not predefined in the schema, then you can add it as a custom attribute here.
Path and name of a log file to be filtered for log entries. This should be either an absolute path or a path relative to the rootDir defined in the general section.
Each line in the specified file that matches this pattern will be extracted as a FEWS error log message.
Each line in the specified file that matches this pattern will be extracted as a FEWS warning log message.
Each line in the specified file that matches this pattern will be extracted as a FEWS info log message.
Each line in the specified file that matches this pattern will be extracted as a FEWS debug log message.
Since 2014.02. FEWS-11097 When equal to the value at T0, this module data set with moduleDataSetName will be selected
Since 2014.02. FEWS-11097 Module data set to select when value at T0 corresponds to timeSeriesValue
Add custom attributes. eg numberAttribute:myA, textAttribute:myB or booleanAttributeC
Custom attribute that can be referenced from id maps, validation rules, thresholds, warning levels, transformations. e.g. "%EXTERNAL_ID%, put the actual column name between %%
Describes where and why this attribute is used
Text that can be referenced from id maps, validation rules, thresholds, warning levels, transformations. e.g. "%EXTERNAL_ID%, put the actual column name between %% e.g. "%PARS%, when the PARS column in the dbf file lists the parameter. e.g "H Q.in" you can use the attributeTextContains constraint when defining a locations set to only include the locations that has Q.in
When configured a config error will be logged when the attribute value do not equal one of the enumeration values. In the tabular config file viewer a dropdown list will appear when editable
When configured a config error will be logged when the attribute value does not match the expression
Number that can be referenced from id maps, validation rules, thresholds, warning levels, transformations e.g. "%HARD_MAX% put the actual column name %% Expressions are allowed, eg %HARD_MAX%/1000 + %CONSTANT%
Can be used in transformations. In transformations 0=false and 1=true. t, T, y, Y are recognized as true in dbf, f, F, n, M are recognized as false in dbf. 0 and 1 is also allowed when you reference a number column instead of boolean column
Since 2018.01. Can be used in modifiers and reports. e.g. "%EXTERNAL_ID%, put the actual column name between %% e.g. "%PARS%, when the PARS column in the csv file lists the date and time. e.g "1992-07-09T17:00".
When there is no value for the referenced column are config error is logged
Id of the attribute, this id can be referenced from id maps, validation rules, thresholds, warning levels. An location/parameter/qualfier attribute is referenced from other config files by quoting the attribute id with @s, e.g. @HARD_MAX@.
name of the attribute, the name will be used in the FEWS Gui. For example in the modifiers display
Currently the generalCsv and Database import and generalCsv export require a table layout description configured by the user. Non-standard imports (plugins) can also required a table layout. See the documentation of the specific import. The order of the listed column is used to calculate the column indices when there is no column name information available. Add the columns that are not used as skipped columns so the column indices can be calculated correctly
Column that contains the date and time for the complete row.
Column that only contains the date without time for the complete row. Time information is read from the timeColumn or from the fixed time attribute that can be specified separately for every value column. Day of month information can be overruled by the day of month attribute of the value column.
Column that only contains the year for the complete row. Do not use in combination with dateColumn or dateTimeColumn. When used, a month and day column must also be used. (Only available for GeneralCsv import)
Column that only contains the month for the complete row. Do not use in combination with dateColumn or dateTimeColumn. When used, a year and day column must also be used. (Only available for GeneralCsv import)
Column that only contains the day of the month for the complete row. Do not use in combination with the day of month attribute of the value column, or the dateColumn or dateTimeColumn. When used, a month and year column must also be used. (Only available for GeneralCsv import)
Column that only contains the time without date for the complete row. Time information of the column. Do not use in combination with time attribute of value column.
Column that only contains the hour for the complete row, using 24h notation, i.e., a number between 0 and 24 where 24 is interpreted as 0 the next day. Do not use in combination with time attribute of value column or timeColumn or dateTimeColumn. When no minute or no second column is used, the minutes and seconds are assumed to be 0. (Only available for GeneralCsv import)
Column that only contains the minute for the complete row, i.e., a number between 0 and 59. Do not use in combination with time attribute of value column or timeColumn or dateTimeColumn. When used, an hour column must also be used. (Only available for GeneralCsv import)
Column that only contains the second for the complete row, i.e., a number between 0 and 59. Do not use in combination with time attribute of value column or timeColumn or dateTimeColumn. When used, an hour and minute column must also be used. (Only available for GeneralCsv import)
Column that contains the (external) forecast time. All rows that share the same external forecast are stored as a single forecast.
Column that contains the date part of the (external) forecast time. All rows that share the same external forecast date and time are stored as a single forecast.
Column that contains the time part (external) forecast date time. All rows that share the same external forecast date and time are stored as a single forecast.
Column that contains the start time. This start time will be used for a time range instead of a single time
Column that contains the end time. This end time will be used for a time range instead of a single time
Column that contains the (external) location id for the complete row. The location id can be converted with an id map. When the location id is different for each value column or there is no locationColumn, fill in the location id attribute of each value column.
Column that contains the (external) parameter id for the complete row. The location id can be converted with an id map. When the parameter id is different for each value column or there is no parameterColumn, fill in the parameterId attribute of each value column.
Column that contains the (external) qualifier id for the complete row. The qualifier id can be converted with an id map or can be used in the id map to map to a different location parameter. Multiple qualifier columns can be specified.
Column that contains the comment for the complete row. The comment is attached to all values in the current row.
Column that contains the user for the complete row. The user is attached to all values in the current row. (Only available for GeneralCsv and Database import)
Column that contains the flag for the complete row. The flag is attached to all values in the current row unless locationId or parameterId is specified.
Column that contains the flag source id. Multiple columns are allowed. If no flagSourceColumn is specfied, the flagColumn is used. (Only available for GeneralCsv import and export.)
Column that contains the value. Multiple value columns are allowed
Column that contains the (external) unit. Only one unit column is allowed. Attribute unit for value column should not be specified when this column is available. When field is NULL, "-" is used as default unit.
Column that contains information that can not be imported or exported. Required to calculate the correct column index of the non skipped columns It is not required to list the none used columns when the file format contains column name information (like a databases or a csv file with header).
Column that contains sample id. (Only available for GeneralCsv import and export.)
Column that contains a property value. (Only available for GeneralCsv import and export)
Column that contains an attribute value (only available for GeneralCsv export since attributes can not be imported, only configured)
Since 2014.02 build 58201 Column that contains a limit symbol
Since 2020.02
Name of the table. Only required when file contains multiple tables. Always required for databases.
Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated
Only required when the type of the column is text instead of timestamp
Only required when the type of the column is text instead of date
Only required when the type of the column is text instead of time
Only required when the column type is blob/grid/file.
When there is no location id column for the location id
When there is no parameter id column for the parameter id
specify ensembleMemberIndex for this valueColumn
Used for unit conversion. Unit should not be specified when unit column is available
This time is combined with the date from the specified date column
The day is combined with the month from the specified date column.
Since 2017.01. When for the current parameter an enumeration is defined ignore the value. Skip the value when reading and replace by missing when writing
Since 2021.02. When for the current parameter an enumeration is defined decline the value / sample when reading, do nothing for writing
Since 2017.01. When for the current parameter no enumeration is defined ignore the value. Skip the value when reading and replace by missing when writing
Since 2021.02. When for the current parameter no enumeration is defined decline the value / sample when reading, do nothing for writing
Since 2017.01 When there is no location id column for the location id. Only implemented for GeneralTimeSeriesCsvParser.
Since 2017.01 When there is no parameter id column for the parameter id. Only implemented for GeneralTimeSeriesCsvParser.
Optional. Used to add in front of the external qualifier id. Can be useful for id mapping.
Since 2020.02 if the qualifier is missing, use this default value instead.
The id of the flag source column
The key for the found property value.
Only required when the attribute type is dateTime.
The id of the attribute.
Only required when the attribute type is dateTime.
Optional. Used to add in front of the external sample id. Can be useful to separate same sample imported from different sources.
This complexType should be extended by all function complexTypes.
Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
The time the color starts appearing
After this time the default color will be used again.
Since 2015.01. URL of the geo network services. You can test if the url is correct by pasting in into your browswer. If you remove the csw part from the end of the url you should be able to access the gui. Login with the user and password to check that they are correct.
Since 2015.01. User name and password used for http authentication
Since 2015.01. FEWS-11063
Since 2015.01. FEWS-11063
Since 2022.02. Event code used by the predefined Import Status Checker workflow module to log data feeds that did not receive data longer than the period length
Log level used by the predefined Import Status Checker workflow module to log data feeds that did not receive data longer than the period length
name of layer in the map layer files or a full absolute path to the csv file (*.csv).
Character set of the text in the csv file. Specify only when the csv file contains non western characters.
config ids in the csv file. e.g. "H_%ID%", put the actual csv column name between %%.
persistent ids in the csv file. e.g. "%DATABASE_ID%", put the actual csv column name between %%.
A file that maps config ids to database ids. Only locations where the config id is different from the database are listed. Config ids can be changed as long the database id stays the same.
Defines the possible prefixes and suffixes of the filename
Generally it is used when specifying a temporary prefix
Use timeZero of the task-run as prefix/suffix. Format it as specified with this element.
Use currentTime as prefix/suffix. Format it as specified with this element.
png, gif or jpg file from the map layers folder
corner of the map
Use this option to display multiple data grids. Each grid will be displayed in a separate data layer. The layer specified last, will be shown on top. If a layer
contains
a timeSeriesSet with scalar data (possibly with a locationSet with multiple locations), then this will be converted to a grid to display in that layer.
Use this option to display a cyclone track. The whole track is always visible. The point for the time in the slider is highlighted.
Since 2013.01. FEWS-8875. Use this option to display an (animated) wms layer.
Since 2013.01. FEWS-8729. Use this option to display water level data that is defined on a quadtree grid. The water levels will be shown using the colours configured
in the classBreaks. This only works if a local datum reference layer (e.g. coverageTileArchiveLayer) has been defined in the corresponding geoMap with digital elevation model
(DEM) data.
Since 2013.01. FEWS-8729. Use this option to display flow velocity data that is defined on the flow links of a quadtree grid. The specified timeSeriesSet should
contain speed values normal to the quadtree cell faces for each flowlink. A flowlink is the "connection" between two adjacent quadtree cells. This only works if the specified
flow velocity data comes from the same quadtree grid as the corresponding quadtreeWaterLevelsLayer and if a local datum reference layer (e.g. coverageTileArchiveLayer) has been
defined in the corresponding geoMap with digital elevation model (DEM) data. The velocities within the quadtree cells are computed from the velocities on the flowlinks using
the subgrid method (see the paper "Quadtree flood simulations with sub-grid digital elevation models" by Guus S. Stelling that is available from
http://www.3di.nu/wp-content/uploads/2013/02/Stelling_ice_2012.pdf). The velocities are shown using arrows that use the symbolSizes configured in the arrowClassBreaks.
Optional description of the profile.
When disabled the config tables that are stored as xml are not synchronized. Normally enabled using synchLevel 11.
When disabled the ColdStates are not synchronized. Normally enabled using synchLevel 11.
When disabled the moduleDataSets are not synchronized. Normally enabled only in synchProfile "Full" using synchLevel 11. Disabled in other synch profiles.
When disabled the MapLayers are not synchronized. Normally enabled using synchLevel 11.
When disabled the Icons are not synchronized. Normally enabled using synchLevel 11.
When disabled the ReportTemplates are not synchronized. Normally enabled only in synchProfile "Full" using synchLevel 11. Disabled in other synch profiles.
When disabled the reportImages are not synchronized. Normally enabled only in synchProfile "Full" using synchLevel 11. Disabled in other synch profiles.
Controls which timeseries with what synchLevels are enabled to be synchronized to the Operator Client.
Controls whether or not to synchronize the current and approved simulated forecast TimeSeries with the specified synchLevel and maximum age.
When disabled the WarmStates records are not synchronized. Normally enabled only for the last 10 days in synchProfile "Full" using synchLevel 11. Disabled in other synch profiles.
Controls whether and how old logentries can be when synchronized. Normally always enabled.
Name of the synch channel.
Boolean flag to disable this synchChannel.
Controls the synchLevel to synchronize.
Controls how old records may be before they are synchronized.
Time unit for the maxAge field.
Name of the synch channel.
Boolean flag to disable this synchChannel.
Controls how old records may be before they are synchronized.
Time unit for the maxAge field.
Name of the synch channel.
Boolean flag to disable this synchChannel.
Controls the synchLevel to synchronize.
Controls how old records may be before they are synchronized.
Time unit for the maxAge field.
Name of the synch channel.
Boolean flag to disable this synchChannel.
Controls the synchLevel to synchronize.
Controls the synchLevel to synchronize.
Contains information on the central database for the system.
Name of the variable in the NetCdf file.
Attribute id to be used as attribute value.