Page tree
Skip to end of metadata
Go to start of metadata

The FewsPiService.properties file can be used to make service specific configurations available. This is a property file that is located in the FEWS configuration in the directory:

%REGION_HOME%/Config/PiClientConfigFiles/FewsPiService.properties

# Optional filter id. Only the timeseries defined under this filter id will be visible to the FewsPiService
FILTER_ID=MY_CUSTOM_FILTER_ID
 
# Identifier of the flag conversion file to use when extracting timeseries from the FewsPiService (type = string).
# If omitted no flag conversion takes place
EXPORT_FLAGCONVERSION_ID=My_Export_FlagConversion
 
# Identifier of the unit conversion file to use when extracting timeseries from the FewsPiService (type = string).
# If omitted no unit conversion takes place
EXPORT_UNITCONVERSION_ID=My_Export_UnitConversion
 
# Identifier of the id map file to use when extracting timeseries from the FewsPiService (type = string).
# If omitted no id mapping takes place
#EXPORT_IDMAP_ID=My_Export_IdMap
 
# Identifier of the unit conversion file to use when writing timeseries to the FewsPiService (type = string).
# If omitted no unit conversion takes place
IMPORT_UNITCONVERSION_ID=My_Import_UnitConversion
 
# Identifier of the id map file to use when writing timeseries to the FewsPiService (type = string).
# If omitted no id mapping takes place
IMPORT_IDMAP_ID=My_Import_IdMap
 
# Export missing value. All internal NaN values will be mapped to this value (type = float).
# If omitted the default value \-999 will be used.
MISSING_VALUE=-999
 
# Option to skip the export of missing values when reading timeseries from the FewsPiService (type = true/false).
# If omitted the default value 'true' is used.
OMIT_MISSING_VALUES=true
 
# Default time zone.
# If omitted, GMT-0 is used.
TIME_ZONE=GMT
 
# Option to return timeseries with value type SAMPLE in the getTimeSeries method.
# If omittedthe default value 'false' is used resulting in only SCALAR value types being returned.
SHOW_SAMPLE_TIMESERIES=true
 
# Readonly mode can be set to true if no only read access is allowed for FEWS WebServices methods.
# When set to true no create, write, update or execute functionality is allowed.
# default set to false in 2017.02
# Since 2018.02 the default is set to true
READONLY_MODE=false

# option to limit the grid plot groups that can be accessed by the webservice
#WMS_ALLOWED_GRID_PLOT_GROUP_ID=


# option to specify the time in seconds between a on the fly synchronziation of archive parameters and locations. Default is 10 minutes. Since 2020.01, only for FEWS configurations without a default filter.
UPDATE_FREQUENCY_ARCHIVE_SYNCHRONIZER=600

 

Here follows a explanation of these properties. All property names are case sensitive:

  • FILTER_ID = This must be one of the filter ids from the Filters.xml file located in the RegionConfigFiles directory. Only the timeseries defined under this filter id will be visible to the FewsPiService. If this option is omitted then it is necessary to define a defaultFilterId in the filters configuration file, otherwise no timeseries will be visible to the FewsPiService.
  • EXPORT_FLAG_CONVERSION_ID = This must be equal to the name of a flag conversion file located in the FlagConversionsFiles directory. All timeserie values have a 'flag' assigned indicating the quality of the value. However the quality values outside of FEWS can be different that the values assigned by FEWS. With this option the FEWS flags can be translated to external flags. This option can be omitted resulting in no conversion.
  • EXPORT_UNITCONVERSION_ID = This must be equal to the name of a unit conversion file located in the UnitConversionsFiles directory. Each timeseries represents a parameter variable such as water height or discharge. As is the case with the flags, the FEWS unit used to define the parameter variable can differ from the external unit. With this option the FEWS units can be converted to external units. This option can be omitted resulting in no conversion.
  • EXPORT_IDMAP_ID = This mus be equal to the name of a id map file located in the IdMapFiles directory. Each timeseries in FEWS is represented by a combination of; location id, parameter id and 0-n qualifier ids. FEWS again uses its own id values to define locations, parameters and such. In cases where the outside world ids differ this option enables one to translate the internal FEWS ids to external ids. This option can be omitted resulting in the export of the FEWS ids.
  • IMPORT_FLAG_CONVERSION_ID = Identical to the export option except that with this option the external flags are mapped to FEWS flags. This option can be omitted resulting in no conversion. If the flags are unknown to FEWS they will not be imported.
  • IMPORT_UNITCONVERSION_ID = Identical to the export option except that with this option the external units can be converted to FEWS units. This option can be omitted resulting in no conversion. If the units are unknown to FEWS then it is assumed that the values are in the same unit as the import parameter.
  • *IMPORT_IDMAP_ID = *Identical to the export option except that with this option external id are translated to internal FEWS ids. This option can be omitted resulting in the export of the FEWS ids. If the external ids are unknown to FEWS then it will not be possible to map the timeseries and the values will be discarded.
  • READONLY_MODE = Only read access is allowed to the FEWS Web Services methods if set to true. No create, write, update or execute functionality is allowed.
  • WMS_ALLOWED_GRID_PLOT_GROUP_ID = This must be one of the plotgroupids from the Griddisplau.xml (or SpatialDisplay.xml) file located in the DisplayConfigFiles directory. Only the spatial plots defined under this plotgroupid will be visible to the FewsPiService. 
  • UPDATE_FREQUENCY_ARCHIVE_SYNCHRONIZER = Option to specify the time in seconds between a on the fly synchronziation of archive parameters and locations. Default is 10 minutes. Since 2020.01, only for FEWS configurations without a default filter.




  • No labels