This is an import for time series published by the Digital Delta web service. Note that the Digital Delta web service is still subject to regular changes, therefore this import may be subject to regular changes as well.
FEWS configuration
In order to activate the Digital Delta import as a FEWS import, it is required to set up a TimeSeriesImportRun module configuration file and an accompanying IdMap file.
The Digital Delta import will take the serverUrl specified in the import configuration file and append it with "?start=...&end=...&locationCode=...&observationTypeUuid=...". It will fill in the start and end fields using the relativeViewPeriod found in the import configuration file. For the locationCode and observationTypeUuid it will use the externalLocation and externalParameter as found in the IdMap file, respectively. From the resulting json, the import will read all events (as given in the "events" field of the json) and add them to a time series with parameterId and locationId as specified in the IdMap file. For each event, only the "value" and "timeStamp" fields are read. The import assumes that all values given are floats.
Since 2017.01 the Digital Delta import assumes that authentication is required for the given serverUrl, the properties clientId and clientSecret are required in the import configuration file. When using the google authentication service, the property refreshToken is also needed. By default the import will use "https://accounts.google.com/o/oauth2/token" as tokenUrl, optionally, a tokenUrl property can be specified. Note that other authentication services have not yet been tested.
Example Import configuration file:
<?xml version="1.0" encoding="UTF-8"?>
<timeSeriesImportRun xmlns="http://www.wldelft.nl/fews"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/timeSeriesImportRun.xsd">
<!-- This is an example import configuration file for importing Observations and Measurements data from a service -->
<import>
<general>
<importType>DigitalDelta</importType>
<serverUrl>http://host:port/FewsWebServices/rest/digitaledelta/v1/timeseries</serverUrl>
<relativeViewPeriod unit="hour" start="-5" end="0" startOverrulable="true" endOverrulable="true"/>
<idMapId>IdImportDD</idMapId>
</general>
<properties>
<!-- Required: These properties are used to get an authentication token from the authentication service -->
<string key="clientId" value="XXXX"/>
<string key="clientSecret" value="XXXX"/>
<!-- Optional: The refresh_token used by the Google authentication service -->
<string key="refreshToken" value="XXXX"/>
<!-- Optional: The url used to obtain an authentication token, by default the Google authentication service is used -->
<string key="tokenUrl" value="https://accounts.google.com/o/oauth2/token"/>
</properties>
<timeSeriesSet>
<moduleInstanceId>ImportDD</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>MyPar</parameterId>
<locationSetId>MyLocSet</locationSetId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="nonequidistant"/>
<readWriteMode>add originals</readWriteMode>
<synchLevel>1</synchLevel>
</timeSeriesSet>
</import>
</timeSeriesImportRun>
Example IdMap file:
<?xml version="1.0" encoding="UTF-8"?>
<idMap version="1.1" xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/idMap.xsd">
<!--
map internal timeseries directly to external timeseries
externalLocation should be set to the locationCode
externalParameter should be set to the observationTypeUuid
The Digital Delta parser queries each timeseries separately.
-->
<map internalLocation="MyLoc1" internalParameter="MyPar1" externalLocation="10160355000" externalParameter="44656c7461726573404645575340542e6f62732e6d65616e" />
<map internalLocation="MyLoc2" internalParameter="MyPar1" externalLocation="10160360000" externalParameter="44656c7461726573404645575340542e6f62732e6d65616e" />
</idMap>
