Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Akvo import function (<importType>Akvo</importType>) imports from the Akvo FLow REST service: https://github.com/akvo/akvo-flow/wiki/Akvo-FLOW-API

During the import all registration site id's are logged by FEWS. They can be used to register the FEWS location ids.

 

Currently the following Akvo Flow question types are supported by the import:

Number: questions of type number will be stored as a fews parameter with the question name as parameter name. In this example the pH parameter is configured as a Number.

 

Option: questions of type Option will be stored as a fews qualifier with the question name followed by the option value. For example: colour_Red.

 

Caddisfly tests will be stored as parameter values.

...

In this example the site monitoring survey id = 170003 and the registration survey id = 1100001.

To connect with akvo an access key and secret is required. They can be created on the akvo flow interface and should be set as the username and password password in the general section.

In the following configuration all locations are configured one by one for demonstration purposes. A locationSet would be more appropriated. The location id's can be found in the Akvo app. They are also logged by FEWS during the import

Code Block
xml
xml
<?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">
	<import>
		<general>
			<importType>Akvo</importType>
			<serverUrl>https://akvoflow-141.appspot.com/api/v1</serverUrl>
			<user>AKVO_ACCESS_KEY</user> <!-- akvo access key -->
			<password>AKVO_SECRET</password> <!-- akvo secret -->
			<relativeViewPeriod unit="day" start="-20" end="0" startOverrulable="true" endOverrulable="false"/> <!-- read all survey instances of the last 20 days -->
			<idMapId>idAkvo</idMapId>
		</general>
		<properties>
			<string value="1100001" key="siteRegistrationSurveyId"></string>
			<string value="170003" key="siteMonitoringSurveyId"></string>
		</properties>
		<timeSeriesSet>
			<moduleInstanceId>ImportAkvo</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>pH</parameterId>
			<locationId>b1b2-8xh1-pt21</locationId>
			<timeSeriesType>external historical</timeSeriesType>
			<timeStep unit="nonequidistant" />
			<readWriteMode>add originals</readWriteMode>
		</timeSeriesSet>
		<timeSeriesSet>
			<moduleInstanceId>ImportAkvo</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>pH</parameterId>
			<locationId>4yes-fjqk-ceh5</locationId>
			<timeSeriesType>external historical</timeSeriesType>
			<timeStep unit="nonequidistant" />
			<readWriteMode>add originals</readWriteMode>
		</timeSeriesSet>
		<timeSeriesSet>
			<moduleInstanceId>ImportAkvo</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>pH</parameterId>
			<locationId>ycwm-vu8j-2ts1</locationId>
			<timeSeriesType>external historical</timeSeriesType>
			<timeStep unit="nonequidistant" />
			<readWriteMode>add originals</readWriteMode>
		</timeSeriesSet>
	</import>
</timeSeriesImportRun>

...