Overview
The archive display can be used to interact with the FEWS-archive.
The main functions which are supported by this display are:
- management of events in the archive,
- search for events and download data related to events from the archive,
- search for data in the archive
Configuration
To use the archive display, configure it as <explorerTask> in Explorer.xml. For example:
<explorerTask name="Archive Catalogue"> <iconFile>Archive.png</iconFile> <mnemonic>A</mnemonic> <displayConfigFileName>ArchiveModuleDisplay</displayConfigFileName> <toolbarTask>false</toolbarTask> <menubarTask>true</menubarTask> <accelerator>ctrl A</accelerator> <loadAtStartup>false</loadAtStartup> </explorerTask>
The ArchiveModuleDisplay configuration
The archive display uses the file Archives.xml file in the SystemConfigFiles directory to identify were the archive web server is located.
The Archives.xml is explained in more detail in the section seamless integration.
Below an example is shown.
<?xml version="1.0" encoding="UTF-8"?> <archives 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/archives.xsd"> <catalogueUrl>http://servername:portname/deltares-archive-server/catalogue</catalogueUrl> </archives>
If the archive is installed following the conventions described in Installation of the Deltares OpenArchive (earlier versions) the configuration shown above is sufficient.
Note however that when you start using the seamless integration in the pi-webservice that more configuration is required in the Archives.xml file.
The archives.xml will be used by the archive display panel to identify were the webservices of the archive are located.
In addition you will need to configure a file called ArchiveModuleDisplay.xml in the DisplayConfigFiles folder.
Below an example of this file containing the most important tags is shown.
<?xml version="1.0" encoding="UTF-8"?> <archiveModuleDisplay 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/archiveModuleDisplay.xsd"> <workFolder>$ARCHIVE_DOWNLOAD_FOLDER$/workdir</workFolder> <downloadFolders> <downloadFolderObserved>$ARCHIVE_DOWNLOAD_FOLDER$/observed</downloadFolderObserved> <downloadFolderSimulated>$ARCHIVE_DOWNLOAD_FOLDER$/simulated</downloadFolderSimulated> <downloadFolderExternalForecasts>$ARCHIVE_DOWNLOAD_FOLDER$/externalforecasts</downloadFolderExternalForecasts> <downloadFolderRatingCurves>$ARCHIVE_DOWNLOAD_FOLDER$/ratingcurves</downloadFolderRatingCurves> <downloadFolderHistoricalEvents>$ARCHIVE_DOWNLOAD_FOLDER$/historicalevents</downloadFolderHistoricalEvents> <downloadFolderForecasterNotes>$ARCHIVE_DOWNLOAD_FOLDER$/messages</downloadFolderForecasterNotes> <downloadFolderConfiguration>$ARCHIVE_DOWNLOAD_FOLDER$/configuration</downloadFolderConfiguration> <downloadFolderEventAttachments>$ARCHIVE_DOWNLOAD_FOLDER$/attachments</downloadFolderEventAttachments> </downloadFolders> <archiveImportWorkflowId>ArchiveImport</archiveImportWorkflowId> </archiveModuleDisplay>
The $ARCHIVE_DOWNLOAD_FOLDER$ should be configured in your global.properties file and should point to the folder were the panel should download the files of the archive to.
The tag workFolder configures which folder will be used as the workfolder. The workfolder is used by the event-panels.
The archiveImportWorkflowId is used to configure the id of the import workflow. The panel offers two options for downloading data. The first option only downloads the data. The second option
downloads the data first and runs an import workflow directly after finishing the download. The id configured in the tag archiveImportWorkflowId identifies which workflow should be ran.
Below a more advanced example of a ArchiveModuleDisplay.xml is shown.
<?xml version="1.0" encoding="UTF-8"?> <archiveModuleDisplay 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/archiveModuleDisplay.xsd"> <levelThresholds> <levelThresholdId>threshold id</levelThresholdId> <levelThresholdId>second threshold id</levelThresholdId> </levelThresholds> <defaultHistoricalEventTimeStep unit="hour"></defaultHistoricalEventTimeStep> <workFolder>$ARCHIVE_DOWNLOAD_FOLDER$/workdir</workFolder> <createEventPermission>create permission</createEventPermission> <deleteEventPermission>delete permisson</deleteEventPermission> <disableDataDownloadAtOperatorClient>true</disableDataDownloadAtOperatorClient> <downloadFolders> <downloadFolderObserved>$ARCHIVE_DOWNLOAD_FOLDER$/observed</downloadFolderObserved> <downloadFolderSimulated>$ARCHIVE_DOWNLOAD_FOLDER$/simulated</downloadFolderSimulated> <downloadFolderExternalForecasts>$ARCHIVE_DOWNLOAD_FOLDER$/externalforecasts</downloadFolderExternalForecasts> <downloadFolderRatingCurves>$ARCHIVE_DOWNLOAD_FOLDER$/ratingcurves</downloadFolderRatingCurves> <downloadFolderHistoricalEvents>$ARCHIVE_DOWNLOAD_FOLDER$/historicalevents</downloadFolderHistoricalEvents> <downloadFolderForecasterNotes>$ARCHIVE_DOWNLOAD_FOLDER$/messages</downloadFolderForecasterNotes> <downloadFolderConfiguration>$ARCHIVE_DOWNLOAD_FOLDER$/configuration</downloadFolderConfiguration> <downloadFolderEventAttachments>$ARCHIVE_DOWNLOAD_FOLDER$/attachments</downloadFolderEventAttachments> </downloadFolders> <archiveImportWorkflowId>ArchiveImport</archiveImportWorkflowId> <searchDataTypes> <type>simulated</type> <type>observed</type> </searchDataTypes> </archiveModuleDisplay>
The events-panel can be used to search for events in the archive. It is possible to search for events in which certain thresholds were crossed.
The tag levelThresholds can be used to configure for which thresholds can be searched in the eventspanel.
By default every user can delete or create events. The tags createEventPermission and deleteEventPermission can be used to restrict those actions to users which have the required permissions.
The "Search and download datasets"-panel can be used to search for data in the archive. The dropdown-box in this panel shows by default all possible datasets-types.
To restrict this list, for example when not all datasets-types are exported by FEWS to the archive, the tag searchDataTypes can be used.
If the archive is not installed according to the conventions desribed in the installation manual than it might be needed to configure custom endpoint for the archive-webservices which
are used by the archive panel. This custom configuration can be done in the tag "archiveServer", below an example is given.
<archiveServer> <archiveWebService>http://server-name:8080/deltares-archive-server</archiveWebService> <archiveConfigFileUrl>http://server-name:8080/thredds/fileServer/Config</archiveConfigFileUrl> <eventsFileServerUrl>http://server-name:8080/thredds/fileServer/Events</eventsFileServerUrl> <dataFileServerUrl>http://server-name:8080/thredds/fileServer/archive</dataFileServerUrl> </archiveServer>
