Introduction

(Since 2024.01)

Data Analysis Displays can be configured in the DataAnalysisDisplays.xml. 

A Data Analysis Display contains 2 to 4 panels, depending on the configuration:

  1. Data Selection
  2. Analysis (if configured in Toolboxes)
  3. Analysis Workflows (if configured in Toolboxes)
  4. Settings

General & Data selection

The relativeViewPeriod controls the default view period, can be changed by the user in the Settings panel.

The data selection panel is configured through:

  • Referencing filterIds (should be the or child of the filterId as configured in the WebServices.xml)
  • Configuration of the selection panel. Through the selection panel configuration the default names for the location-, parameter-, module instance selection panels can be provided. Optionally locationAttributes can be added to filter on.


Data Selection 
 		<relativeViewPeriod unit="day" start="-30" end="3"/>
		<filters>
			<filterId>hazard_map_saws</filterId>
			<filterId>viewer_water_levels</filterId>
		</filters>
		<selectionPanel>
			<locationSelection name="Location"/>
			<parameterSelection name="Parameter"/>
			<moduleInstanceSelection name="Model"/>
			<locationAttributeSelection attributeId="type_name" name="Location type"/>
			<locationAttributeSelection attributeId="parent_id" name="Parent Location"/>
		</selectionPanel>


Analytics Toolboxes

There are two types of analytical functions available:

  1. On-the-fly analytics
  2. Workflows running a analysis

They are configured in the toolboxes panel

On-the-fly analytics 

At this moment there are two toolboxes available:

  1. Resampling toolbox
  2. Correlation & regression toolbox 


Resampling

Configured through:

  1.  adding <resampling/> in the <toolBoxes> element
  2. requires that resampling functions in the TimeSeriesDisplays.xml is configured, 02 Time Series Display Configuration#02TimeSeriesDisplayConfiguration-Resampling. Based on timeSteps in available in the Timesteps.xml

Correlation & regression toolbox

Configured through adding <correlation/>

Provides correlation toolbox with 6 regression functions and possibility to apply lower and upper threshold to the data on the y-axis.


Analysis Workflows

Workflows that run custom analytics can be configured. The workflow should have a coupled What-if template. At the moment only What-if properties are supported, not modifiers. The output of the workflow can be either (a) timeserie(s) visualised in a filter or archive products, see the Documents.xml documentation on how to configure this. Only the timeseries generated by the taskrun of the workflow will be visualised for a user. This is the case both for the filter as for the archiveProducts.



Toolbox example 
		<toolBoxes>
			<resampling/>
			<correlation/>
			<workflow id="return_period_historical" name="Return Period Historical">
				<workflowId>CalculateReturnPeriodsHistorical</workflowId>
				<results>
					<filterId>return_period</filterId>
					<archiveProductId>return_period_graph</archiveProductId>
					<archiveProductId>return_period_table</archiveProductId>
				</results>
				<iconId>mdi-clock-time-four-outline</iconId>
			</workflow>
        </toolBoxes>



Couple to the archive

If the FEWS application has a Deltares Open Archive coupled, than results of an analysis can be uploaded to the archive by user. For this <exportArchiveProducts> should be configured.


Complete xml example

Please find a example of a feature complete Data Analysis Display below.


Data Analysis Display Configuration Example 
<dataAnalysisDisplays xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews https://fewsdocs.deltares.nl/schemas/version1.0/dataAnalysisDisplays.xsd">
	<dataAnalysisDisplay id="data_analytics_display" name="Data Analysis Display">
		<relativeViewPeriod unit="day" start="-30" end="3"/>
		<filters>
			<filterId>hazard_map_saws</filterId>
			<filterId>viewer_water_levels</filterId>
		</filters>
		<selectionPanel>
			<locationSelection name="Location"/>
			<parameterSelection name="Parameter"/>
			<moduleInstanceSelection name="Model"/>
			<locationAttributeSelection attributeId="type_name" name="Location type"/>
			<locationAttributeSelection attributeId="parent_id" name="Parent Location"/>
		</selectionPanel>
		<toolBoxes>
			<resampling/>
			<correlation/>
			<workflow id="return_period_historical" name="Return Period Historical">
				<workflowId>CalculateReturnPeriodsHistorical</workflowId>
				<results>
					<archiveProductId>return_period_graph</archiveProductId>
					<archiveProductId>return_period_table</archiveProductId>
				</results>
				<iconId>mdi-clock-time-four-outline</iconId>
			</workflow>
        </toolBoxes>
		<exportArchiveProducts enabled="true">
			<metaData>
				<properties>
					<areaId>products</areaId>
					<sourceId>dataAnalysis</sourceId>
				</properties>
				<attributes>
					<attribute key="Attribute1" value="Analysis"/>
				</attributes>
			</metaData>
		</exportArchiveProducts>
    </dataAnalysisDisplay>
</dataAnalysisDisplays>


  • No labels

Disclaimer