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 know were the archive web server is located.
The Archives.xml is explained in detail in the section seamless integration.
Below is an example of the content of this file 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 Archive installation the configuration shown above is all you need!
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 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 required tags.
<?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 to download the files of the archive to.
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 seconds option
downloads the data and runs an import workflow directly after finishing the download. The id configured in the tag archiveImportWorkflowId identifies which workflow should be ran.
<?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 configuration file for this display resides in the DisplayConfigFiles folder. It primarily contains references to the archive server, while it also specifies tte download folders, i.e. the destination folders for data being downloaded.
While the xsd is mostly self explaining some remarks can be made:
- it is recommended to use global properties to define the server details and the download folders.
- When Historical Events are defined as an event type, the defaultHistoricalEventTimeStep needs to be defined. This time step becomes part of the historical event definition as the system needs to know which of the archived observed timeseries has the proper timestep for use as a histroical event.
- Not all archive systems will hold/store all dataset types. To prevent confusion with the user, the search options can be restricted to a limited list of dataset types that can be searched for, using element searchDataTypes.
