The Forecaster Aid Selection Panel (aka Document List panel) can be used to show a list of reports.
Configuration
- Add forecasterAidSelectionPanel.xml to your DisplayConfigFiles
- Configure attributes as needed (<explorerLocationDocumentAttributeId>, since 2027.02)
- When an explorer location is selected the ForecasterAidSelectionPanel will select the document listed in this attribute, if applicable.
- If more than one location is selected, the document selection remains unchanged.
- If the attribute is not defined for the selected location or the document listed in the attribute is not currently visible in the ForecasterAidSelectionPanel, the document selection remains unchanged as well.
- Configure attributes as needed (<explorerLocationDocumentAttributeId>, since 2027.02)
- In Explorer.xml, add an explorerTask using <displayConfigFileName> to refer to this file
- In LocationSets.xml, add the configured attributes (i.e. key) to locations for which a report document is available.
The value of the attribute should contain the name of the file which should be selected (case-sensitive, including the file extension).
See an example below.
Used together with Topology
See the user guide section, for how this side panel works together with the Topology (or Interactive Forecast Display), Document Viewer and embedded webbrowser: 23 Interactive Forecasting Displays - DELFT-FEWS Documentation - Deltares Public Wiki
Configuration example
forecasterAidSelectionPanel.xml
<forecasterAidSelectionPanel 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/forecasterAidSelectionPanel.xsd"> <explorerLocationDocumentAttributeId>MyDocumentAttributeKey</explorerLocationDocumentAttributeId> </forecasterAidSelectionPanel>
Explorer Task
<explorerTask name="List of Reports"> <displayConfigFileName>forecasterAidSelectionPanel</displayConfigFileName> <!-- deprecrated configuration: <taskClass>nl.wldelft.fews.gui.plugin.information.ForecasterAidSelectionPanel</taskClass> --> </explorerTask>
LocationSets.xml
<locationSet id="my_loc_set"> <csvFile> <file>my_loc_set.csv</file> <id>%ID%</id> <x>%X%</x> <y>%Y%</y> <attribute id="MyDocumentAttributeKey"> <text>%DOC%</text> </attribute> </csvFile> </locationSet>
my_loc_set.csv
ID,X,Y, DOC loc1,0,0, loc1_report.html loc2,1,1, loc2_report.html ...
Additional configuration
For more information about the use and configuration of the Forecaster Aid selection Panel (or Document Panel) please check the FEWS user guide, section 23, Forecaster help (aka Document Viewer).