Qualifiers file
This page is the generated field list for Qualifiers.xml — the file that
declares the qualifier ids used to tell apart multiple time series that share
the same location and parameter (e.g. “1st guess” vs. “corrected”, or one
ensemble member vs. another).
At a glance
Section titled “At a glance”Purpose : Declares the set of valid qualifier ids. A time series is uniquely identified by location + parameter + qualifier(s), so qualifiers are how you keep multiple variants of “the same” series distinct instead of overwriting each other.
Folder
: Config/RegionConfigFiles/
Root element
: <qualifiers> (no version attribute)
Used by
: qualifierId on a timeSeriesSet (import/export/General Adapter config),
and on the ID map <map> element for external ↔ internal
qualifier translation.
Minimal example
Section titled “Minimal example”<?xml version="1.0" encoding="UTF-8"?><qualifiers xmlns="http://www.wldelft.nl/fews"> <qualifier id="1stGuess" name="First guess"> <description>Uncorrected first-guess forecast</description> </qualifier> <qualifier id="Corrected" name="Corrected"> <description>Forecaster-corrected forecast</description> </qualifier></qualifiers>Field reference
Section titled “Field reference”Auto-generated from qualifiers.xsd. Descriptions are the schema's own annotations.
Element <qualifiers>
| Element | Type | Cardinality | Description |
|---|---|---|---|
allowReferencingUndefinedQualifiers | boolean | optional | When true qualifiers in time series sets or id maps that are not listed below are added on the fly to this list. |
qualifier | QualifierComplexType | optional · repeats | |
csvFile | QualifiersCsvFileComplexType | optional · repeats | Since 2014.02. FEWS-10077. Define qualifiers in csv file |
qualifierRootNode | QualifierNodeComplexType | optional | Since 2014.02. FEWS-10077. Define tree for qualifies based on attribute constraints |
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. |
QualifierComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | |
name | optional |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | string | optional | Long (descriptive) name of qualifier or description |
shortName | string | optional | Short name of qualifier for chart legend |
child | QualifierComplexType | optional · repeats | Since 2014.02. FEWS-10077. To order the qualifiers in a tree |
group | string | optional | Since 2021.01. Assign this qualifier to a group. Only 1 qualifier from the same group can be added to a time series. Within a qualifier tree node qualfiers of the same group can be summed, in the TSD the values of time series will be summed and replaced by 1 summed time series. |
QualifiersCsvFileComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
file | nonEmptyStringType | required | Since 2014.02. FEWS-10077. name of a csv file in the map layer files or a full absolute path to the csv file (*.csv). |
charset | charsetEnumStringType | optional | Since 2014.02. FEWS-10077. 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 |
id | nonEmptyStringType | required | Since 2014.02. FEWS-10077. e.g. "%ID%", put the actual column name between %%. |
name | idStringType | optional | Since 2014.02. FEWS-10077. put the actual column name between %% |
shortName | idStringType | optional | Since 2014.02. FEWS-10077. put the actual column name between %% |
description | string | optional | Since 2014.02. FEWS-10077. put the actual column name between %% |
parentQualifierId | idStringType | optional | Since 2014.02. FEWS-10077. put the actual column name between %%. |
group | idStringType | optional | Since 2014.02. FEWS-10077. put the actual column name between %%. |
timeZoneOffset | timeZoneOffsetStringType | optional | Since 2018.01. Optional timeZoneOffset for the dateTime attributes. 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 | Since 2018.01. Optional pattern for the dateTime attributes. Default is yyyyMMdd, this is the internal format a dbf file is using when the column is of type 'D'. |
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 %% |
QualifierNodeComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | required | Since 2014.02. FEWS-10077. Id of the qualifier node |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
name | string | optional | Since 2014.02. FEWS-10077. Short name of qualifier |
description | string | optional | Since 2014.02. FEWS-10077. Long descriptive name of qualifier node (tooltip) Description or description |
qualifierId | string | optional | Since 2014.02. FEWS-10077. Reference to qualifier |
qualifierNode | QualifierNodeComplexType | optional | Since 2014.02. FEWS-10077. child node |
constraints | ConstraintsComplexType | required | Since 2014.02. FEWS-10077. Add all qualifiers that fulfill the constraints to this node |
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 %%. |
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 |
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. |
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 |
Gotchas
Section titled “Gotchas”allowReferencingUndefinedQualifiers(root, optional) — whentrue, any qualifier id used elsewhere (time series sets, id maps) but not declared here gets silently added on the fly instead of raising a config error. Handy during early setup, risky once qualifier ids matter for display/legend behavior — most production configs leave itfalseor omit it.<child>+<group>(since 2014.02) let you build a qualifier tree for UI selection;groupfurther constrains that only one qualifier from the same group can be attached to a series at once.
See also
Section titled “See also”- Related reference: ID map file (external ↔ internal qualifier translation)
- Schema:
qualifiers.xsd