Location sets file
The schema-companion to the Define locations & location sets task guide, which covers the four ways to define set membership (explicit list, compose, file, constraint). This page is the generated field list.
At a glance
Section titled “At a glance”Purpose : Groups locations into named sets so one config line can target many places at once.
Folder
: Config/RegionConfigFiles/
Root element
: <locationSets> (version="1.1", required)
Referenced by
: locationSetId in imports, filters, displays, transformations, and models.
Minimal example
Section titled “Minimal example”<?xml version="1.0" encoding="UTF-8"?><locationSets xmlns="http://www.wldelft.nl/fews" version="1.1"> <locationSet id="AllDischargeGauges"> <locationId>RiverGauge_01</locationId> <locationId>RiverGauge_02</locationId> </locationSet></locationSets>Field reference
Section titled “Field reference”Auto-generated from locationSets.xsd. Descriptions are the schema's own annotations.
Element <locationSets>
Attributes
| Attribute | Use | Notes |
|---|---|---|
version | required | fixed: 1.1. |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
allowEmptyLocationSets | boolean | optional | Since 2018.01. If this element is set to false, an error will be logged if an empty location set is configured. By default FEWS will allow empty location sets and will only log a debug message. |
locationSet | LocationSetComplexType | required · repeats | |
persistentIdsCsvFile | PersistentIdsCsvFileComplexType | required · repeats | 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. |
LocationSetComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | |
name | optional | |
editable | optional | Set editable="true" to enable adding/removing locations to this locationSet in the ConfigEditor UI. |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | string | optional | |
skipDuplicateIds | boolean | optional | Since FEWS 2026.01. If this option is set to true the rows with duplicate location ids are skipped in the listed main files (not the attribute files). |
constraints | ConstraintsComplexType | optional | Restriction for the locations in this location set. Only locations where for all the constraint is valid are included in this location set. It is a filter for the location sets and shape files specified above. |
attributeFile | AttributeFileComplexType | optional · repeats | Links an extra attribute file to multiple parent tabular files. Useful for id maps and thresholds. These attributes can not be used in for constraints configured in this location set. Location set ids can not be listed when using this locationSet wide attribute file |
subLocationSetIdFunction | idStringType | required | e.g. @catchment@. Generate a sub location set id for every unique location set id generated by the function. |
subLocationSetNameFunction | idStringType | optional | e.g. @catchment@. Names of the generated location sets. First location in the generated location set is used to generate the name. |
locationSetId | idStringType | required | Add all the locations in the specified location set to this location set. When were constraints are specified only the locations that matching all the constraints are added |
locationId | idStringType | required | |
esriShapeFile | LocationSetShapeFileComplexType | required | Loads locations from a shape file and adds these locations to the location set. When constraints are specified only locations that matching all the constraints are loaded. Use a different excluding constraints when locations from one shape file are loaded by different location sets For locationId, name, description, shortName, tooltip, parentLocationId and custom attributes you can reference the dbase file columns by putting the dbase column name between name) between % |
geoJsonFile | LocationSetGeoJSonComplexType | required | Loads locations from a geojson file and adds these locations to the location set. When constraints are specified only locations that matching all the constraints are loaded. Use a different excluding constraints when locations from one shape file are loaded by different location sets For locationId, name, description, shortName, tooltip, parentLocationId and custom attributes you can reference the attributes by putting the dbase column name between name) between % |
geoPackageFile | LocationSetGeoPackageComplexType | required | Loads locations from a gpkg file and adds these locations to the location set. When constraints are specified only locations that matching all the constraints are loaded. Use a different excluding constraints when locations from one shape file are loaded by different location sets For locationId, name, description, shortName, tooltip, parentLocationId and custom attributes you can reference the attributes by putting the dbase column name between name) between % |
csvFile | LocationSetCsvFileComplexType | required | Since 2013.01, FEWS-8714. Loads locations from a csv file and adds these locations to the location set. When constraints are specified only locations that matching all the constraints are loaded. Use a different excluding constraints when locations from one csv file are loaded by different location sets For locationId, name, description, shortName, tooltip, parentLocationId and custom attributes you can reference the dbase file columns by putting the csv column name between name) between % |
table | LocationSetDatabaseTableComplexType | required | Loads locations from a database table and adds these locations to the location set. When constraints are specified only locations that matching all the constraints are loaded. Use a different excluding constraints when locations from one shape file are loaded by different location sets For locationId, name, description, shortName, tooltip, parentLocationId and custom attributes you can reference the dbase file columns by putting the dbase column name between name) between % |
sortByName | boolean | required | Sorts the locations in this set by name. When false the order of the specified location ids or the order in the esri shape file is used. Note that this only applies to the sorting of locations within a locationSets and will not influence the location order in, for instance, the data viewer |
sortingLocationAttributeId | idStringType | required | Since 2014.01 Location attribute Id the locations should be sorted by in this set. Each location can only have 1 attribute which defines the sorting, this will automatically be the first defined. Sorting of locations with different sorting attributes will result in grouping locations with the same sorting attribute together. |
chainageLocationAttributeId | idStringType | required | Id of location attribute, each location that has a value for this attribute belongs to the chainage. The value of this attribute determines the position in the chainage. |
chainageLabelLocationAttributeId | idStringType | optional | Optional field. If configured, this location attribute will be used as the label of vertical station lines in longitudinal plot If a location does not have this attribute, there will be no vertical station line drawn. This should be a text attribute. |
PersistentIdsCsvFileComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
file | nonEmptyStringType | required | name of layer in the map layer files or a full absolute path to the csv file (*.csv). |
charset | charsetEnumStringType | optional | Character set of the text in the csv file. Specify only when the csv file contains non western characters.
One of: US-ASCII, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1257, ISO-8859-1, ISO-8859-2, ISO-8859-4, ISO-8859-5, ISO-8859-7, ISO-8859-9, ISO-8859-13, ISO-8859-15, KOI8-R, UTF-8, UTF-16, UTF-16BE, UTF-16LE, windows-1255, windows-1256, windows-1258, ISO-8859-3, ISO-8859-6, ISO-8859-8, windows-31j, EUC-JP, x-EUC-JP-LINUX, Shift_JIS, ISO-2022-JP, x-mswin-936, GB18030, x-EUC-CN, GBK, ISCII91, x-windows-949, EUC-KR, ISO-2022-KR, x-windows-950, x-MS950-HKSCS, x-EUC-TW, Big5, Big5-HKSCS, TIS-620, Big5_Solaris, Cp037, Cp273, Cp277, Cp278, Cp280, Cp284, Cp285, Cp297, Cp420, Cp424, Cp437, Cp500, Cp737, Cp775, Cp838, Cp850, Cp852, Cp855, Cp856, Cp857, Cp858, Cp860, Cp861, Cp862, Cp863, Cp864, Cp865, Cp866, Cp868, Cp869, Cp870, Cp871, Cp874, Cp875, Cp918, Cp921, Cp922, Cp930, Cp933, Cp935, Cp937, Cp939, Cp942, Cp942C, Cp943, Cp943C, Cp948, Cp949, Cp949C, Cp950, Cp964, Cp970, Cp1006, Cp1025, Cp1026, Cp1046, Cp1047, Cp1097, Cp1098, Cp1112, Cp1122, Cp1123, Cp1124, Cp1140, Cp1141, Cp1142, Cp1143, Cp1144, Cp1145, Cp1146, Cp1147, Cp1148, Cp1149, Cp1381, Cp1383, Cp33722, ISO2022_CN_CNS, ISO2022_CN_GB, JISAutoDetect, MS874, MacArabic, MacCentralEurope, MacCroatian, MacCyrillic, MacDingbat, MacGreek, MacHebrew, MacIceland, MacRoman, MacRomania, MacSymbol, MacThai, MacTurkish, MacUkraine |
configId | nonEmptyStringType | required | config ids in the csv file. e.g. "H_%ID%", put the actual csv column name between %%. |
persistentId | nonEmptyStringType | required | persistent ids in the csv file. e.g. "%DATABASE_ID%", put the actual csv column name between %%. |
ConstraintsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
not | ConstraintComplexType | required | |
anyValid | ConstraintsComplexType | required | |
allValid | ConstraintsComplexType | required | |
idStartsWith | IdStartsWithComplexType | required | 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 |
idEndsWith | IdEndsWithComplexType | required | 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 |
idContains | IdContainsComplexType | required | Only the locations/parameters/qualifiers with an id that contains the specified text will be included |
relatedLocationExists | RelatedLocationExistsComplexType | required | Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included. |
attributeExists | AttributeExistsComplexType | required | Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included |
attributeTextStartsWith | AttributeTextStartsWithComplexType | required | Only the locations with attribute value start with the specified text will be included. |
attributeTextEndsWith | AttributeTextEndsWithComplexType | required | Only the locations/parameters/qualifiers with attribute value start with the specified text will be included. |
attributeTextContains | AttributeTextContainsComplexType | required | Only the locations/parameters/qualifiers with attribute value contains the specified text will be included. |
attributeTextEquals | AttributeTextEqualsComplexType | required | 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 |
attributeTrue | AttributeTrueOrFalseComplexType | required | 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. |
attributeFalse | AttributeTrueOrFalseComplexType | required | 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. |
AttributeFileComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | nonEmptyStringType | optional | Description |
charset | charsetEnumStringType | optional | Character set of the text in the dbf file or csv file. Specify only when the csv file contains non- latin characters. Don't configure for geojson/gpkg files
One of: US-ASCII, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1257, ISO-8859-1, ISO-8859-2, ISO-8859-4, ISO-8859-5, ISO-8859-7, ISO-8859-9, ISO-8859-13, ISO-8859-15, KOI8-R, UTF-8, UTF-16, UTF-16BE, UTF-16LE, windows-1255, windows-1256, windows-1258, ISO-8859-3, ISO-8859-6, ISO-8859-8, windows-31j, EUC-JP, x-EUC-JP-LINUX, Shift_JIS, ISO-2022-JP, x-mswin-936, GB18030, x-EUC-CN, GBK, ISCII91, x-windows-949, EUC-KR, ISO-2022-KR, x-windows-950, x-MS950-HKSCS, x-EUC-TW, Big5, Big5-HKSCS, TIS-620, Big5_Solaris, Cp037, Cp273, Cp277, Cp278, Cp280, Cp284, Cp285, Cp297, Cp420, Cp424, Cp437, Cp500, Cp737, Cp775, Cp838, Cp850, Cp852, Cp855, Cp856, Cp857, Cp858, Cp860, Cp861, Cp862, Cp863, Cp864, Cp865, Cp866, Cp868, Cp869, Cp870, Cp871, Cp874, Cp875, Cp918, Cp921, Cp922, Cp930, Cp933, Cp935, Cp937, Cp939, Cp942, Cp942C, Cp943, Cp943C, Cp948, Cp949, Cp949C, Cp950, Cp964, Cp970, Cp1006, Cp1025, Cp1026, Cp1046, Cp1047, Cp1097, Cp1098, Cp1112, Cp1122, Cp1123, Cp1124, Cp1140, Cp1141, Cp1142, Cp1143, Cp1144, Cp1145, Cp1146, Cp1147, Cp1148, Cp1149, Cp1381, Cp1383, Cp33722, ISO2022_CN_CNS, ISO2022_CN_GB, JISAutoDetect, MS874, MacArabic, MacCentralEurope, MacCroatian, MacCyrillic, MacDingbat, MacGreek, MacHebrew, MacIceland, MacRoman, MacRomania, MacSymbol, MacThai, MacTurkish, MacUkraine |
id | ColumnDisplayNameAnnotatedIdType | required | ids of the locations in the dbf file. e.g. "H_%ID%", put the actual dbase column name between %%. |
ignoreIdsMissingInLocationSet | boolean | optional | Since 2021.02. When false (default) a config warning is logged for each location id not in the locations set |
timeZoneOffset | timeZoneOffsetStringType | optional | 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. |
dateTimePattern | nonEmptyStringType | optional | default is yyyyMMdd, this is the internal format a dbf file is using when the column is of type 'D' |
csvFile | nonEmptyStringType | required | name of csv file in the map layer files or a full absolute path to the csv file . |
readOnly | boolean | optional | When the file is automatically overwritten by an external source |
esriShapeFile | nonEmptyStringType | required | name of shp file in the map layer files |
geoDatum | geoDatumStringType | required | Geo datum of the coordinates, default is lat long, WGS 1984 |
projectionFileAvailable | boolean | required | 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. When false lat long, WGS 1984 will be used |
geoJsonFile | nonEmptyStringType | required | name of geojson file in the map layer files |
shapeType | shapeTypeEnumStringType | required | When the geojson file contains multiple shape types you can add the layer multiple times for each shape type
One of: point, line, polygon |
skipGeometry | boolean | optional | When true, no geometry needs to be read. This can be useful when the geojson file is used in multiple places for different attributes. |
geoPackageFile | nonEmptyStringType | required | name of geojson file in the map layer files |
skipGeometry | boolean | optional | When true, no geometry needs to be read. This can be useful when the geopackage file is used in multiple places for different attributes. |
layerName | string | optional | When the file contains multiple layers the layer name should be specified |
dbfFile | nonEmptyStringType | required | name of dfb file in the map layer files or a full absolute path to the dbf file . |
requireAllIdsInLocationSet | boolean | optional | Since 2023.01. When true a config error is logged when not all locations are listed that exist in the location set. Missing rows can be added automatically in the tabular config viewer |
requireAllIdsInParentFile | boolean | optional | Since 2023.01. When true a config error is logged when not all locations are listed that exist in the parent csv/shp file. The location set can contain fewer ids that the csv due a constraint defined in the location set. Missing rows can be added automatically in the tabular config viewer |
shortName | ColumnDisplayNameAnnotatedIdType | optional | Short name of location for chart legend. e.g. %SHORT_NAME%, put the actual column name between %% |
parentLocationId | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0. |
z | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0 |
checkForContinuousPeriod | boolean | optional | Since 2016.01. When true (default) errors will be logged for locations with time dependent attributes that have overlapping periods or gaps between periods |
skipRowWhenColumnValueEquals | ColumnNameAndValueComplexType | optional | Makes it possible to ignore the lines that are not in use. It will skip all rows that have a certain column value |
startDateTime | nonEmptyStringType | optional | start time of the period the values in the row should be used eg "%START_DATE% %START_TIME%", put the actual dbase column name between %%. When the values are always valid do not specify a period. When the all the values in the dbf file are valid for a constant period specify a literal date time eg "2000/1/1" Default is the beginning of time |
endDateTime | nonEmptyStringType | optional | see start date time |
visibilityStartDateTime | nonEmptyStringType | optional | Set the visibilty period of the location when not defined in the main location |
visibilityEndDateTime | nonEmptyStringType | optional | see visibility start date time |
relation | LocationRelationComplexType | required | Relation that can be used in time series sets and constraints and functions. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual shape/dbase column name between %%. Can not be used in combination with startDateTime and endDateTime |
oneToManyRelation | LocationRelationComplexType | required | SINCE 2019.01. Relation that allows map to multiple locations. A one to many relation that can be only be used in time series sets and not in constraints or functions. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual shape/dbase column name between %% Can not be used in combination with startDateTime and endDateTime |
attribute | AttributeComplexType | optional · repeats | 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 %% |
LocationSetShapeFileComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
file | nonEmptyStringType | required | name of layer in the map layer files or a full absolute path to the shape file (*.shp). |
charset | charsetEnumStringType | optional | Character set of the text in the dbf file. Specify only when the dbf file contains non western characters.
One of: US-ASCII, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1257, ISO-8859-1, ISO-8859-2, ISO-8859-4, ISO-8859-5, ISO-8859-7, ISO-8859-9, ISO-8859-13, ISO-8859-15, KOI8-R, UTF-8, UTF-16, UTF-16BE, UTF-16LE, windows-1255, windows-1256, windows-1258, ISO-8859-3, ISO-8859-6, ISO-8859-8, windows-31j, EUC-JP, x-EUC-JP-LINUX, Shift_JIS, ISO-2022-JP, x-mswin-936, GB18030, x-EUC-CN, GBK, ISCII91, x-windows-949, EUC-KR, ISO-2022-KR, x-windows-950, x-MS950-HKSCS, x-EUC-TW, Big5, Big5-HKSCS, TIS-620, Big5_Solaris, Cp037, Cp273, Cp277, Cp278, Cp280, Cp284, Cp285, Cp297, Cp420, Cp424, Cp437, Cp500, Cp737, Cp775, Cp838, Cp850, Cp852, Cp855, Cp856, Cp857, Cp858, Cp860, Cp861, Cp862, Cp863, Cp864, Cp865, Cp866, Cp868, Cp869, Cp870, Cp871, Cp874, Cp875, Cp918, Cp921, Cp922, Cp930, Cp933, Cp935, Cp937, Cp939, Cp942, Cp942C, Cp943, Cp943C, Cp948, Cp949, Cp949C, Cp950, Cp964, Cp970, Cp1006, Cp1025, Cp1026, Cp1046, Cp1047, Cp1097, Cp1098, Cp1112, Cp1122, Cp1123, Cp1124, Cp1140, Cp1141, Cp1142, Cp1143, Cp1144, Cp1145, Cp1146, Cp1147, Cp1148, Cp1149, Cp1381, Cp1383, Cp33722, ISO2022_CN_CNS, ISO2022_CN_GB, JISAutoDetect, MS874, MacArabic, MacCentralEurope, MacCroatian, MacCyrillic, MacDingbat, MacGreek, MacHebrew, MacIceland, MacRoman, MacRomania, MacSymbol, MacThai, MacTurkish, MacUkraine |
attributeFile | AttributeFileComplexType | optional · repeats | Links an extra csv or dbf file to the current shape file to import extra attributes. Optionally allows defining different values for different periods and multiple values (tables) per attribute |
geoDatum | geoDatumStringType | required | Geo datum of the coordinates, default is lat long, WGS 1984 |
projectionFileAvailable | boolean | required | 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. When false lat long, WGS 1984 will be used |
id | ColumnDisplayNameAnnotatedIdType | required | ids of the locations in the shape file. e.g. "H_%ID%", put the actual column name between %%. |
name | ColumnDisplayNameAnnotatedIdType | optional | Names of the locations e.g. %NAME%, put the actual column name between %% |
description | nonEmptyStringType | optional | Long (descriptive) name of location (tool tip) or description. e.g. "Meteo station %NAME%, put the actual column name between %% |
shortName | nonEmptyStringType | optional | Short name of location for chart legend. e.g. %SHORT_NAME%, put the actual column name between %% |
iconName | nonEmptyStringType | optional | Filename of an image file in the IconFiles config directory (including file extension). |
label | nonEmptyStringType | optional | Label to be displayed on the map in FewsExplorer. Besides the global properties and column names you can use the virtual columns %LAST_VALUE%, %LAST_VALUE_TIME%, et cetera (similar to toolTip) |
toolTip | nonEmptyStringType | optional | Tooltip to be displayed in the FewsExplorer. You can reference location attributes with @ATTRIBUTE_ID@ (Since 2013.02) You can reference csv/dbf columns without defining an attribute with %COLUMN_NAME% You can use use \n or CDATA or HTML when you need multiple lines. You can use the following variables %LAST_VALUE%, %LAST_VALUE_TIME%, %FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME% The tooltip supports html including images and hyperlinks. The url in the hyper link can be an internet url, an executable file, a document file, or a folder. Use the CDATA xml tag to include html in a xml file. By default the following tool tip is used. ID: id\n Name: name\n Desc: description Last value [%LAST_VALUE%] Time [%LAST_VALUE_TIME%]\n Forecast Start Time [%FORECAST_START_TIME%]\n Maximum [%MAXIMUM_VALUE%] Time [%MAXIMUM_VALUE_TIME%] |
parentLocationId | ColumnDisplayNameAnnotatedIdType | optional | When a location has a parent id it is an invisible child location. All the children of a location are automatically selected in the fews explorer e.g. H_%PARENT_ID%, put the actual column name between %% |
timeZoneOffset | timeZoneOffsetStringType | optional | 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. |
dateTimePattern | nonEmptyStringType | optional | 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'. |
startDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %START_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
endDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %END_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
checkForContinuousPeriod | boolean | optional | Since 2016.01. When true (default) errors will be logged for locations with time dependent attributes that have overlapping periods or gaps between periods |
visibilityStartTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use startDateTime. Optional start time of the period for which a location is visible in the user interface. The start time is inclusive. If not defined, then a location is visible for all times before end time. Possible to refer to a column. Use e.g. "%START_DATE% %START_TIME%", put the actual dbase column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2000/1/1". |
visibilityEndTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use endDateTime. Optional end time of the period for which a location is visible in the user interface. The end time is inclusive. If not defined, then a location is visible for all times after start time. Possible to refer to a column. Use e.g. "%END_DATE% %END_TIME%", put the actual column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2002/1/1". |
x | ColumnDisplayNameAnnotatedIdType | required | X coordinate of the point (Easting). e.g. %X%, put the actual column name between %%. |
y | ColumnDisplayNameAnnotatedIdType | required | Y coordinate of the point (Northing) e.g. %Y%, put the actual column name between %%. |
z | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0 |
bedLevel | ColumnDisplayNameAnnotatedIdType | optional | Since 2022.02. %Bed_level%, put the actual column name between %% |
layerSigmaCoordinate | ColumnDisplayNameAnnotatedIdType | optional | Since 2017.02. Sigma coordinate of the layer. e.g. %Sigma%, put the actual column name between %% |
area | ColumnDisplayNameAnnotatedIdType | optional | The area of the location/polygon. e.g. %AREA%, put the actual column name between %% |
relation | LocationRelationComplexType | optional · repeats | Relation that can be used in time series sets. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual column name between %% |
attribute | AttributeComplexType | optional · repeats | 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 %% |
LocationSetGeoJSonComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
file | nonEmptyStringType | required | name of layer in the map layer files to the geojson file (*.geojson). |
shapeType | shapeTypeEnumStringType | required | When the geojson file contains multiple shape types you can add the layer multiple times for each shape type
One of: point, line, polygon |
attributeFile | AttributeFileComplexType | optional · repeats | Links an extra csv or dbf file to the current shape file to import extra attributes. Optionally allows defining different values for different periods and multiple values (tables) per attribute |
id | ColumnDisplayNameAnnotatedIdType | required | ids of the locations in the shape file. e.g. "H_%ID%", put the actual column name between %%. |
name | ColumnDisplayNameAnnotatedIdType | optional | Names of the locations e.g. %NAME%, put the actual column name between %% |
description | nonEmptyStringType | optional | Long (descriptive) name of location (tool tip) or description. e.g. "Meteo station %NAME%, put the actual column name between %% |
shortName | nonEmptyStringType | optional | Short name of location for chart legend. e.g. %SHORT_NAME%, put the actual column name between %% |
iconName | nonEmptyStringType | optional | Filename of an image file in the IconFiles config directory (including file extension). |
label | nonEmptyStringType | optional | Label to be displayed on the map in FewsExplorer. Besides the global properties and column names you can use the virtual columns %LAST_VALUE%, %LAST_VALUE_TIME%, et cetera (similar to toolTip) |
toolTip | nonEmptyStringType | optional | Tooltip to be displayed in the FewsExplorer. You can reference location attributes with @ATTRIBUTE_ID@ (Since 2013.02) You can reference csv/dbf columns without defining an attribute with %COLUMN_NAME% You can use use \n or CDATA or HTML when you need multiple lines. You can use the following variables %LAST_VALUE%, %LAST_VALUE_TIME%, %FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME% The tooltip supports html including images and hyperlinks. The url in the hyper link can be an internet url, an executable file, a document file, or a folder. Use the CDATA xml tag to include html in a xml file. By default the following tool tip is used. ID: id\n Name: name\n Desc: description Last value [%LAST_VALUE%] Time [%LAST_VALUE_TIME%]\n Forecast Start Time [%FORECAST_START_TIME%]\n Maximum [%MAXIMUM_VALUE%] Time [%MAXIMUM_VALUE_TIME%] |
parentLocationId | ColumnDisplayNameAnnotatedIdType | optional | When a location has a parent id it is an invisible child location. All the children of a location are automatically selected in the fews explorer e.g. H_%PARENT_ID%, put the actual column name between %% |
timeZoneOffset | timeZoneOffsetStringType | optional | 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. |
dateTimePattern | nonEmptyStringType | optional | 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'. |
startDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %START_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
endDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %END_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
checkForContinuousPeriod | boolean | optional | Since 2016.01. When true (default) errors will be logged for locations with time dependent attributes that have overlapping periods or gaps between periods |
visibilityStartTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use startDateTime. Optional start time of the period for which a location is visible in the user interface. The start time is inclusive. If not defined, then a location is visible for all times before end time. Possible to refer to a column. Use e.g. "%START_DATE% %START_TIME%", put the actual dbase column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2000/1/1". |
visibilityEndTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use endDateTime. Optional end time of the period for which a location is visible in the user interface. The end time is inclusive. If not defined, then a location is visible for all times after start time. Possible to refer to a column. Use e.g. "%END_DATE% %END_TIME%", put the actual column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2002/1/1". |
x | ColumnDisplayNameAnnotatedIdType | required | X coordinate of the point (Easting). e.g. %X%, put the actual column name between %%. |
y | ColumnDisplayNameAnnotatedIdType | required | Y coordinate of the point (Northing) e.g. %Y%, put the actual column name between %%. |
z | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0 |
bedLevel | ColumnDisplayNameAnnotatedIdType | optional | Since 2022.02. %Bed_level%, put the actual column name between %% |
layerSigmaCoordinate | ColumnDisplayNameAnnotatedIdType | optional | Since 2017.02. Sigma coordinate of the layer. e.g. %Sigma%, put the actual column name between %% |
area | ColumnDisplayNameAnnotatedIdType | optional | The area of the location/polygon. e.g. %AREA%, put the actual column name between %% |
relation | LocationRelationComplexType | optional · repeats | Relation that can be used in time series sets. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual column name between %% |
attribute | AttributeComplexType | optional · repeats | 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 %% |
LocationSetGeoPackageComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
file | nonEmptyStringType | required | name of layer in the map layer files to the geojson file (*.geojson). |
layerName | string | optional | When the geojson file contains multiple layer you can can specify the layer name |
attributeFile | AttributeFileComplexType | optional · repeats | Links an extra csv or dbf file to the current shape file to import extra attributes. Optionally allows defining different values for different periods and multiple values (tables) per attribute |
id | ColumnDisplayNameAnnotatedIdType | required | ids of the locations in the shape file. e.g. "H_%ID%", put the actual column name between %%. |
name | ColumnDisplayNameAnnotatedIdType | optional | Names of the locations e.g. %NAME%, put the actual column name between %% |
description | nonEmptyStringType | optional | Long (descriptive) name of location (tool tip) or description. e.g. "Meteo station %NAME%, put the actual column name between %% |
shortName | nonEmptyStringType | optional | Short name of location for chart legend. e.g. %SHORT_NAME%, put the actual column name between %% |
iconName | nonEmptyStringType | optional | Filename of an image file in the IconFiles config directory (including file extension). |
label | nonEmptyStringType | optional | Label to be displayed on the map in FewsExplorer. Besides the global properties and column names you can use the virtual columns %LAST_VALUE%, %LAST_VALUE_TIME%, et cetera (similar to toolTip) |
toolTip | nonEmptyStringType | optional | Tooltip to be displayed in the FewsExplorer. You can reference location attributes with @ATTRIBUTE_ID@ (Since 2013.02) You can reference csv/dbf columns without defining an attribute with %COLUMN_NAME% You can use use \n or CDATA or HTML when you need multiple lines. You can use the following variables %LAST_VALUE%, %LAST_VALUE_TIME%, %FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME% The tooltip supports html including images and hyperlinks. The url in the hyper link can be an internet url, an executable file, a document file, or a folder. Use the CDATA xml tag to include html in a xml file. By default the following tool tip is used. ID: id\n Name: name\n Desc: description Last value [%LAST_VALUE%] Time [%LAST_VALUE_TIME%]\n Forecast Start Time [%FORECAST_START_TIME%]\n Maximum [%MAXIMUM_VALUE%] Time [%MAXIMUM_VALUE_TIME%] |
parentLocationId | ColumnDisplayNameAnnotatedIdType | optional | When a location has a parent id it is an invisible child location. All the children of a location are automatically selected in the fews explorer e.g. H_%PARENT_ID%, put the actual column name between %% |
timeZoneOffset | timeZoneOffsetStringType | optional | 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. |
dateTimePattern | nonEmptyStringType | optional | 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'. |
startDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %START_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
endDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %END_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
checkForContinuousPeriod | boolean | optional | Since 2016.01. When true (default) errors will be logged for locations with time dependent attributes that have overlapping periods or gaps between periods |
visibilityStartTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use startDateTime. Optional start time of the period for which a location is visible in the user interface. The start time is inclusive. If not defined, then a location is visible for all times before end time. Possible to refer to a column. Use e.g. "%START_DATE% %START_TIME%", put the actual dbase column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2000/1/1". |
visibilityEndTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use endDateTime. Optional end time of the period for which a location is visible in the user interface. The end time is inclusive. If not defined, then a location is visible for all times after start time. Possible to refer to a column. Use e.g. "%END_DATE% %END_TIME%", put the actual column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2002/1/1". |
x | ColumnDisplayNameAnnotatedIdType | required | X coordinate of the point (Easting). e.g. %X%, put the actual column name between %%. |
y | ColumnDisplayNameAnnotatedIdType | required | Y coordinate of the point (Northing) e.g. %Y%, put the actual column name between %%. |
z | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0 |
bedLevel | ColumnDisplayNameAnnotatedIdType | optional | Since 2022.02. %Bed_level%, put the actual column name between %% |
layerSigmaCoordinate | ColumnDisplayNameAnnotatedIdType | optional | Since 2017.02. Sigma coordinate of the layer. e.g. %Sigma%, put the actual column name between %% |
area | ColumnDisplayNameAnnotatedIdType | optional | The area of the location/polygon. e.g. %AREA%, put the actual column name between %% |
relation | LocationRelationComplexType | optional · repeats | Relation that can be used in time series sets. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual column name between %% |
attribute | AttributeComplexType | optional · repeats | 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 %% |
LocationSetCsvFileComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
file | nonEmptyStringType | required | name of layer in the map layer files or a full absolute path to the csv file (*.csv). |
readOnly | boolean | optional | When the file is automatically overwritten by an external source |
charset | charsetEnumStringType | optional | Character set of the text in the csv file. Specify only when the csv file contains non western characters.
One of: US-ASCII, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1257, ISO-8859-1, ISO-8859-2, ISO-8859-4, ISO-8859-5, ISO-8859-7, ISO-8859-9, ISO-8859-13, ISO-8859-15, KOI8-R, UTF-8, UTF-16, UTF-16BE, UTF-16LE, windows-1255, windows-1256, windows-1258, ISO-8859-3, ISO-8859-6, ISO-8859-8, windows-31j, EUC-JP, x-EUC-JP-LINUX, Shift_JIS, ISO-2022-JP, x-mswin-936, GB18030, x-EUC-CN, GBK, ISCII91, x-windows-949, EUC-KR, ISO-2022-KR, x-windows-950, x-MS950-HKSCS, x-EUC-TW, Big5, Big5-HKSCS, TIS-620, Big5_Solaris, Cp037, Cp273, Cp277, Cp278, Cp280, Cp284, Cp285, Cp297, Cp420, Cp424, Cp437, Cp500, Cp737, Cp775, Cp838, Cp850, Cp852, Cp855, Cp856, Cp857, Cp858, Cp860, Cp861, Cp862, Cp863, Cp864, Cp865, Cp866, Cp868, Cp869, Cp870, Cp871, Cp874, Cp875, Cp918, Cp921, Cp922, Cp930, Cp933, Cp935, Cp937, Cp939, Cp942, Cp942C, Cp943, Cp943C, Cp948, Cp949, Cp949C, Cp950, Cp964, Cp970, Cp1006, Cp1025, Cp1026, Cp1046, Cp1047, Cp1097, Cp1098, Cp1112, Cp1122, Cp1123, Cp1124, Cp1140, Cp1141, Cp1142, Cp1143, Cp1144, Cp1145, Cp1146, Cp1147, Cp1148, Cp1149, Cp1381, Cp1383, Cp33722, ISO2022_CN_CNS, ISO2022_CN_GB, JISAutoDetect, MS874, MacArabic, MacCentralEurope, MacCroatian, MacCyrillic, MacDingbat, MacGreek, MacHebrew, MacIceland, MacRoman, MacRomania, MacSymbol, MacThai, MacTurkish, MacUkraine |
attributeFile | AttributeFileComplexType | optional · repeats | Links an extra csv file to the current shape file to import extra attributes. Optionally allows defining different values for different periods and multiple values (tables) per attribute |
geoDatum | geoDatumStringType | required | Geo datum of the coordinates, default is lat long, WGS 1984 |
projectionFileAvailable | boolean | required | 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. When false lat long, WGS 1984 will be used |
id | ColumnDisplayNameAnnotatedIdType | required | ids of the locations in the shape file. e.g. "H_%ID%", put the actual column name between %%. |
name | ColumnDisplayNameAnnotatedIdType | optional | Names of the locations e.g. %NAME%, put the actual column name between %% |
description | nonEmptyStringType | optional | Long (descriptive) name of location (tool tip) or description. e.g. "Meteo station %NAME%, put the actual column name between %% |
shortName | nonEmptyStringType | optional | Short name of location for chart legend. e.g. %SHORT_NAME%, put the actual column name between %% |
iconName | nonEmptyStringType | optional | Filename of an image file in the IconFiles config directory (including file extension). |
label | nonEmptyStringType | optional | Label to be displayed on the map in FewsExplorer. Besides the global properties and column names you can use the virtual columns %LAST_VALUE%, %LAST_VALUE_TIME%, et cetera (similar to toolTip) |
toolTip | nonEmptyStringType | optional | Tooltip to be displayed in the FewsExplorer. You can reference location attributes with @ATTRIBUTE_ID@ (Since 2013.02) You can reference csv/dbf columns without defining an attribute with %COLUMN_NAME% You can use use \n or CDATA or HTML when you need multiple lines. You can use the following variables %LAST_VALUE%, %LAST_VALUE_TIME%, %FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME% The tooltip supports html including images and hyperlinks. The url in the hyper link can be an internet url, an executable file, a document file, or a folder. Use the CDATA xml tag to include html in a xml file. By default the following tool tip is used. ID: id\n Name: name\n Desc: description Last value [%LAST_VALUE%] Time [%LAST_VALUE_TIME%]\n Forecast Start Time [%FORECAST_START_TIME%]\n Maximum [%MAXIMUM_VALUE%] Time [%MAXIMUM_VALUE_TIME%] |
parentLocationId | ColumnDisplayNameAnnotatedIdType | optional | When a location has a parent id it is an invisible child location. All the children of a location are automatically selected in the fews explorer e.g. H_%PARENT_ID%, put the actual column name between %% |
timeZoneOffset | timeZoneOffsetStringType | optional | 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. |
dateTimePattern | nonEmptyStringType | optional | 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'. |
startDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %START_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
endDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %END_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
checkForContinuousPeriod | boolean | optional | Since 2016.01. When true (default) errors will be logged for locations with time dependent attributes that have overlapping periods or gaps between periods |
visibilityStartTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use startDateTime. Optional start time of the period for which a location is visible in the user interface. The start time is inclusive. If not defined, then a location is visible for all times before end time. Possible to refer to a column. Use e.g. "%START_DATE% %START_TIME%", put the actual dbase column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2000/1/1". |
visibilityEndTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use endDateTime. Optional end time of the period for which a location is visible in the user interface. The end time is inclusive. If not defined, then a location is visible for all times after start time. Possible to refer to a column. Use e.g. "%END_DATE% %END_TIME%", put the actual column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2002/1/1". |
x | ColumnDisplayNameAnnotatedIdType | required | X coordinate of the point (Easting). e.g. %X%, put the actual column name between %%. |
y | ColumnDisplayNameAnnotatedIdType | required | Y coordinate of the point (Northing) e.g. %Y%, put the actual column name between %%. |
z | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0 |
bedLevel | ColumnDisplayNameAnnotatedIdType | optional | Since 2022.02. %Bed_level%, put the actual column name between %% |
layerSigmaCoordinate | ColumnDisplayNameAnnotatedIdType | optional | Since 2017.02. Sigma coordinate of the layer. e.g. %Sigma%, put the actual column name between %% |
area | ColumnDisplayNameAnnotatedIdType | optional | The area of the location/polygon. e.g. %AREA%, put the actual column name between %% |
relation | LocationRelationComplexType | optional · repeats | Relation that can be used in time series sets. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual column name between %% |
attribute | AttributeComplexType | optional · repeats | 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 %% |
LocationSetDatabaseTableComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
name | ColumnDisplayNameAnnotatedIdType | required | Loads locations from this database table and adds these locations to the location set. When constraints are specified only locations that matching all the constraints are loaded. Use a different excluding constraints when locations from one shape file are loaded by different location sets For locationId, name, description, shortName, tooltip, parentLocationId and custom attributes you can reference the dbase file columns by putting the dbase column name between name) between % |
geoDatum | geoDatumStringType | required | Geo datum of the coordinates |
attributesTable | AttributesTableComplexType | optional · repeats | Links an table to the current table to import extra attributes. Optionally allows defining different values for different periods and multiple values (tables) per attribute |
attributeFile | AttributeFileComplexType | optional · repeats | Since 2021.01. Links an csv or dbf file to the current database table to import extra attributes. Optionally allows defining different values for different periods and multiple values (tables) per attribute. |
databaseServer | DatabaseServerClientConfigComplexType | optional | oracle, sqlserver or postgresql database server |
databaseFile | fileStringType | required | Reference to .fdb (firebird) or .derby directory (derby) that contains the locations table. This is for testing purposes.. |
id | ColumnDisplayNameAnnotatedIdType | required | ids of the locations in the shape file. e.g. "H_%ID%", put the actual column name between %%. |
name | ColumnDisplayNameAnnotatedIdType | optional | Names of the locations e.g. %NAME%, put the actual column name between %% |
description | nonEmptyStringType | optional | Long (descriptive) name of location (tool tip) or description. e.g. "Meteo station %NAME%, put the actual column name between %% |
shortName | nonEmptyStringType | optional | Short name of location for chart legend. e.g. %SHORT_NAME%, put the actual column name between %% |
iconName | nonEmptyStringType | optional | Filename of an image file in the IconFiles config directory (including file extension). |
label | nonEmptyStringType | optional | Label to be displayed on the map in FewsExplorer. Besides the global properties and column names you can use the virtual columns %LAST_VALUE%, %LAST_VALUE_TIME%, et cetera (similar to toolTip) |
toolTip | nonEmptyStringType | optional | Tooltip to be displayed in the FewsExplorer. You can reference location attributes with @ATTRIBUTE_ID@ (Since 2013.02) You can reference csv/dbf columns without defining an attribute with %COLUMN_NAME% You can use use \n or CDATA or HTML when you need multiple lines. You can use the following variables %LAST_VALUE%, %LAST_VALUE_TIME%, %FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME% The tooltip supports html including images and hyperlinks. The url in the hyper link can be an internet url, an executable file, a document file, or a folder. Use the CDATA xml tag to include html in a xml file. By default the following tool tip is used. ID: id\n Name: name\n Desc: description Last value [%LAST_VALUE%] Time [%LAST_VALUE_TIME%]\n Forecast Start Time [%FORECAST_START_TIME%]\n Maximum [%MAXIMUM_VALUE%] Time [%MAXIMUM_VALUE_TIME%] |
parentLocationId | ColumnDisplayNameAnnotatedIdType | optional | When a location has a parent id it is an invisible child location. All the children of a location are automatically selected in the fews explorer e.g. H_%PARENT_ID%, put the actual column name between %% |
timeZoneOffset | timeZoneOffsetStringType | optional | 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. |
dateTimePattern | nonEmptyStringType | optional | 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'. |
startDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %START_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
endDateTime | nonEmptyStringType | optional | Since 2014.01. e.g. %END_TIME%, put the actual column name between %%. When specified multiple rows with the same location id are allowed. The row is used for the specified period. The location is invisible for times when no row is applicable |
checkForContinuousPeriod | boolean | optional | Since 2016.01. When true (default) errors will be logged for locations with time dependent attributes that have overlapping periods or gaps between periods |
visibilityStartTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use startDateTime. Optional start time of the period for which a location is visible in the user interface. The start time is inclusive. If not defined, then a location is visible for all times before end time. Possible to refer to a column. Use e.g. "%START_DATE% %START_TIME%", put the actual dbase column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2000/1/1". |
visibilityEndTime | nonEmptyStringType | optional | Deprecated and obsolete since 2014.01, use endDateTime. Optional end time of the period for which a location is visible in the user interface. The end time is inclusive. If not defined, then a location is visible for all times after start time. Possible to refer to a column. Use e.g. "%END_DATE% %END_TIME%", put the actual column name between %%. When all the locations in the csv/dbf file are visible for the same period, specify a literal date time eg "2002/1/1". |
x | ColumnDisplayNameAnnotatedIdType | required | X coordinate of the point (Easting). e.g. %X%, put the actual column name between %%. |
y | ColumnDisplayNameAnnotatedIdType | required | Y coordinate of the point (Northing) e.g. %Y%, put the actual column name between %%. |
z | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0 |
bedLevel | ColumnDisplayNameAnnotatedIdType | optional | Since 2022.02. %Bed_level%, put the actual column name between %% |
layerSigmaCoordinate | ColumnDisplayNameAnnotatedIdType | optional | Since 2017.02. Sigma coordinate of the layer. e.g. %Sigma%, put the actual column name between %% |
area | ColumnDisplayNameAnnotatedIdType | optional | The area of the location/polygon. e.g. %AREA%, put the actual column name between %% |
relation | LocationRelationComplexType | optional · repeats | Relation that can be used in time series sets. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual column name between %% |
attribute | AttributeComplexType | optional · repeats | 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 %% |
ConstraintComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
not | ConstraintComplexType | required | |
anyValid | ConstraintsComplexType | required | |
allValid | ConstraintsComplexType | required | |
idStartsWith | IdStartsWithComplexType | required | 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 |
idEndsWith | IdEndsWithComplexType | required | 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 |
idContains | IdContainsComplexType | required | Only the locations/parameters/qualifiers with an id that contains the specified text will be included |
relatedLocationExists | RelatedLocationExistsComplexType | required | Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included. |
attributeExists | AttributeExistsComplexType | required | Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included |
attributeTextStartsWith | AttributeTextStartsWithComplexType | required | Only the locations with attribute value start with the specified text will be included. |
attributeTextEndsWith | AttributeTextEndsWithComplexType | required | Only the locations/parameters/qualifiers with attribute value start with the specified text will be included. |
attributeTextContains | AttributeTextContainsComplexType | required | Only the locations/parameters/qualifiers with attribute value contains the specified text will be included. |
attributeTextEquals | AttributeTextEqualsComplexType | required | 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 |
attributeTrue | AttributeTrueOrFalseComplexType | required | 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. |
attributeFalse | AttributeTrueOrFalseComplexType | required | 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. |
RelatedLocationExistsComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
locationRelationId | required | Id of the location relation (eg. UPSTREAM) |
AttributeExistsComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | Id of the attribute |
AttributeTextStartsWithComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | Id of the attribute |
prefix | required | The text the attribute value should start with |
AttributeTextEndsWithComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | Id of the attribute |
postfix | required | The text the attribute value should end with |
AttributeTextContainsComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | Id of the attribute |
contains | required | The text the attribute value should contain |
AttributeTextEqualsComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | Id of the attribute |
equals | required | The text the attribute value should match |
modifierDependent | optional | 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 |
AttributeTrueOrFalseComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | Id of the attribute |
modifierDependent | optional | 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 |
ColumnNameAndValueComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
columnName | required | Name of the column that should be checked |
columnValue | required | Value of the column |
ignoreCase | optional | Ignore the case of the value |
LocationRelationComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | optional | This location relation id can be referenced from time series sets. |
name | optional | Name used in the tabular config file display |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | nonEmptyStringType | optional | Describes where and why this relation is used |
relatedLocationId | nonEmptyStringType | required | Reference to another location. e.g. H_%UPSTREAM_ID%, put the actual column name between %% |
required | boolean | optional | When there is no value for the referenced column are config error is logged |
AttributeComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | optional | 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 | optional | name of the attribute, the name will be used in the FEWS Gui. For example in the modifiers display |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | nonEmptyStringType | optional | Describes where and why this attribute is used |
required | boolean | optional | When there is no value for the referenced column are config error is logged |
number | nonEmptyStringType | required | 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% |
boolean | nonEmptyStringType | required | 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 |
dateTime | nonEmptyStringType | required | 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". |
text | nonEmptyStringType | required | 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 |
enumerationValue | nonEmptyStringType | required · repeats | 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 |
regularExpression | nonEmptyStringType | required | When configured a config error will be logged when the attribute value does not match the expression |
AttributesTableComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | nonEmptyStringType | optional | Description |
name | nonEmptyStringType | required | Table name |
id | ColumnDisplayNameAnnotatedIdType | required | ids of the locations in the dbf file. e.g. "H_%ID%", put the actual dbase column name between %%. |
ignoreIdsMissingInLocationSet | boolean | optional | Since 2021.02. When false (default) a config warning is logged for each location not in the locations set |
shortName | ColumnDisplayNameAnnotatedIdType | optional | Short name of location for chart legend. e.g. %SHORT_NAME%, put the actual column name between %% |
parentLocationId | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0. |
z | ColumnDisplayNameAnnotatedIdType | optional | Z coordinate of the point (altitude). e.g. %Z%, put the actual column name between %% The default z is 0 |
checkForContinuousPeriod | boolean | optional | Since 2016.01. When true (default) errors will be logged for locations with time dependent attributes that have overlapping periods or gaps between periods |
skipRowWhenColumnValueEquals | ColumnNameAndValueComplexType | optional | Makes it possible to ignore the lines that are not in use. It will skip all rows that have a certain column value |
startDateTime | nonEmptyStringType | optional | start time of the period the values in the row should be used eg "%START_DATE% %START_TIME%", put the actual dbase column name between %%. When the values are always valid do not specify a period. When the all the values in the dbf file are valid for a constant period specify a literal date time eg "2000/1/1" Default is the beginning of time |
endDateTime | nonEmptyStringType | optional | see start date time |
visibilityStartDateTime | nonEmptyStringType | optional | Set the visibilty period of the location when not defined in the main location |
visibilityEndDateTime | nonEmptyStringType | optional | see visibility start date time |
relation | LocationRelationComplexType | required | Relation that can be used in time series sets and constraints and functions. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual shape/dbase column name between %%. Can not be used in combination with startDateTime and endDateTime |
oneToManyRelation | LocationRelationComplexType | required | SINCE 2019.01. Relation that allows map to multiple locations. A one to many relation that can be only be used in time series sets and not in constraints or functions. When a location relation is specified in a time series set the time series set locations are mapped to the related locations and these related locations are used to read/write the time series. e.g. "H_%UPSTREAM_ID%, put the actual shape/dbase column name between %% Can not be used in combination with startDateTime and endDateTime |
attribute | AttributeComplexType | optional · repeats | 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 %% |
DatabaseServerClientConfigComplexType
Contains information on the central database for the system.
| Element | Type | Cardinality | Description |
|---|---|---|---|
url | nonEmptyStringType | required | 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 |
user | nonEmptyStringType | required | User name used for authentication |
encryptedPassword | string | required | Encrypted user's password. Password is encrypted with clipboard utils in F12 menu in (any) SA/OC |
password | string | required | 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 |
dbServerType | ClientConfigDbServerEnumStringType | required | Deprecated and obsolete since 2012.02. Use url, user, password
One of: oracle, sqlserver, postgresql, vjdbc |
dbServerName | string | required | Deprecated and obsolete since 2012.02. Use url, user, password |
dbServerPort | integer | optional | Deprecated and obsolete since 2012.02. Use url, user, password |
dbInstanceName | string | required | Deprecated and obsolete since 2012.02. Use url, user, password |
dbInstanceUser | string | required | Deprecated and obsolete since 2012.02. Use url, user, password |
dbInstanceEncryptedPassword | string | required | Deprecated and obsolete since 2012.02. Use url, user, password |
dbInstancePassword | string | required | Deprecated and obsolete since 2012.02. Use url, user, password |
See also
Section titled “See also”- Task guide: Define locations & location sets
- Reference: Locations file
- Schema:
locationSets.xsd