...
The Archives.xml is explained in more detail in the section seamless integration.
Below an example is shown.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?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.
...
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.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?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> |
...
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.
...
are used by the archive panel. This custom configuration can be done in the tag "archiveServer", below an example is given.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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> |
Archive Database
A mongo database plugin can be added to the archives to store scalar data.
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.
When the user selects both an area and a time series type, the list of sources available will be populated. When a source is selected, the available time steps, parameters and module instance ids will be loaded from the database.
To search for data sets, area, time series type and source need to be selected. You can also filter the results by time steps, parameters and module instance ids, but these fields aren’t mandatory: if nothing is selected, data for all of the available options will be included in the search result. To search for data, klick the magnifying glass on the left side of the panel.
The summary of the available data sets will be displayed in the text field at the bottom of the panel.
You can download the selected data by clicking the download button (under the search button). When the download is complete, the summary will be logged and also displayed in the panel.
When you are downloading data from the search and download datasets panel, if part or all of the time series are stored in the mongo database, it will be automatically downloaded along with the data stored in the open archive.
Config example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?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>url</catalogueUrl>
<elasticSearchUrl>url</elasticSearchUrl>
<archiveDatabase>
<archiveDatabaseUrl>url</archiveDatabaseUrl>
<user>user</user>
<password>pass</password>
<pluginClass>nl.fews.archivedatabase.mongodb.MongoDbArchiveDatabase</pluginClass>
<pluginFactoryMethod>create</pluginFactoryMethod>
<openDatabasePluginPanelBinDir>d:\mongdb-plugin\</openDatabasePluginPanelBinDir>
</archiveDatabase>
</archives> |