Versions Compared

Key

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

...

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>
    	<dataTypeImportWorkflows>                
                <statesWorkflowId>ImportArchivedStates</statesWorkflowId>
        </dataTypeImportWorkflows>
	<searchDataTypes>
		<type>simulated</type>
		<type>observed</type>
	</searchDataTypes>
</archiveModuleDisplay>

Custom configuration

If the archive is not installed according to the conventions described 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.


Code Block
xml
xml
<archiveServer>
	<archiveWebService>http://dummy_server:8080/deltares-archive-server</archiveWebService>
	<archiveConfigFileUrl>http://dummy_server:8080/thredds/fileServer/Config</archiveConfigFileUrl>
	<eventsFileServerUrl>http://dummy_server:8080/thredds/fileServer/Events</eventsFileServerUrl>
	<dataFileServerUrl>http://dummy_server:8080/thredds/fileServer/archive</dataFileServerUrl>
</archiveServer>

Below a more advanced example of a ArchiveModuleDisplay.xml is shown.

Code Block
xml
xml
<?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>
    	<dataTypeImportWorkflows>                
                <statesWorkflowId>ImportArchivedStates</statesWorkflowId>
        </dataTypeImportWorkflows>
	<searchDataTypes>
		<type>simulated</type>
		<type>observed</type>
	</searchDataTypes>
</archiveModuleDisplay>


Archive panel

The archive display has several tabs which as shown in the picture below.

Image Added

The functionality of each tab is explained in the paragraphs below:

Search and download datasets

Archive panel

The archive display has several tabs which as shown in the picture below.

Image Removed

The functionality of each tab is explained in the paragraphs below:

Search and download datasets

Events panel

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 events panel. By default every user can delete or create events.

...

Code Block
languagexml
linenumberstrue
<?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>MIN</levelThresholdId>
	</levelThresholds>
	<workFolder>$ARCHIVE_DOWNLOAD_FOLDER$/work</workFolder>
	<createEventPermission>Admin</createEventPermission>
	<deleteEventPermission>Admin</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$/ForecasterNotes</downloadFolderForecasterNotes>
		<downloadFolderConfiguration>$ARCHIVE_DOWNLOAD_FOLDER$/Configuration</downloadFolderConfiguration>
		<downloadFolderEventAttachments>$ARCHIVE_DOWNLOAD_FOLDER$/Attachments</downloadFolderEventAttachments>
		<downloadFolderSnapShots>$ARCHIVE_DOWNLOAD_FOLDER$/SnapShots</downloadFolderSnapShots>
		<downloadFolderProducts>$ARCHIVE_DOWNLOAD_FOLDER$/Products</downloadFolderProducts>
	</downloadFolders>
	<archiveImportWorkflowId>Archive_Import</archiveImportWorkflowId>
	<hideDownloadDataSetsTab>true</hideDownloadDataSetsTab>
	<hideCreateEventTab>true</hideCreateEventTab>
	<hideSearchEventTab>true</hideSearchEventTab>
	<hideArchiveDatabaseTab>true</hideArchiveDatabaseTab>
	<hideArchiveUploadTab>true</hideArchiveUploadTab>
	<archiveUploadIdMapId>id</archiveUploadIdMapId>
	<initialSearchTimePeriod start="-1000" end="1" unit="day"></initialSearchTimePeriod>
	<dataSearchProperty>
		<propertyId>aVeryLongPropertyId</propertyId>
		<displayName>propertyA</displayName>
	</dataSearchProperty>
	<dataSearchProperty>
		<propertyId>propertyB</propertyId>
	</dataSearchProperty>
</archiveModuleDisplay>

Custom configuration

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.

Code Block
xmlxml
<archiveServer>
	<archiveWebService>http://dummy_server:8080/deltares-archive-server</archiveWebService>
	<archiveConfigFileUrl>http://dummy_server:8080/thredds/fileServer/Config</archiveConfigFileUrl>
	<eventsFileServerUrl>http://dummy_server:8080/thredds/fileServer/Events</eventsFileServerUrl>
	<dataFileServerUrl>http://dummy_server:8080/thredds/fileServer/archive</dataFileServerUrl>
</archiveServer>
		<downloadFolderSnapShots>$ARCHIVE_DOWNLOAD_FOLDER$/SnapShots</downloadFolderSnapShots>
		<downloadFolderProducts>$ARCHIVE_DOWNLOAD_FOLDER$/Products</downloadFolderProducts>
	</downloadFolders>
	<archiveImportWorkflowId>Archive_Import</archiveImportWorkflowId>
	<hideDownloadDataSetsTab>true</hideDownloadDataSetsTab>
	<hideCreateEventTab>true</hideCreateEventTab>
	<hideSearchEventTab>true</hideSearchEventTab>
	<hideArchiveDatabaseTab>true</hideArchiveDatabaseTab>
	<hideArchiveUploadTab>true</hideArchiveUploadTab>
	<archiveUploadIdMapId>id</archiveUploadIdMapId>
	<initialSearchTimePeriod start="-1000" end="1" unit="day"></initialSearchTimePeriod>
	<dataSearchProperty>
		<propertyId>aVeryLongPropertyId</propertyId>
		<displayName>propertyA</displayName>
	</dataSearchProperty>
	<dataSearchProperty>
		<propertyId>propertyB</propertyId>
	</dataSearchProperty>
</archiveModuleDisplay>


Archive Database

A mongo database plugin can be added to the archives to store scalar data. This tab is only available if you added a <archiveDatabase> to your config. To search for or download data from the database, different filters can (or must be used). The list of areas available is loaded from the configuration.

...