Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: adjust column width, fix typo, adjust line spacing

...

Version 0.1

Repository Schema

...

Code Block
languagebash
. <repo>
|-- admin.*
|
|-- <label>
|   |-- admin.*
|   |
|   |-- _styles/<SLD files>
|   |-- _resources/<resource files>
|   |
|   `-- <service>
|       |-- owner.service.toml
|       |-- admin.*
|       |
|       |-- _resources/<resource files>
|       |
|       `-- <layer>
|           |-- owner.resources.toml
|           |-- owner.layer.toml
|           |-- admin.*
|           |
|           `-- _resources
|               |-- popup.md
|               |-- sidebar.md
|               |-- gallery.mapping.json
|               `-- filter.mapping.json
|
|-- _resources/<resource files> 
|
`-- _other
    |
    `-- <arbitrary-service-id>
        |-- owner.urls
        |
        |-- _resources/<resource files>
        |
        `-- <layer>/_resources/<resource files>

...

  • VEF Metadata Template files (*.md), to configure presentation of your data in popups and sidebar → (documentation coming soon) https://spaces.awi.de/x/7QkQH
  • VEF Filter Mapping files (*.mapping.json) → (documentation coming soon)
  • VEF Gallery Mapping files (*.mapping.json) → see https://spaces.awi.de/x/TQLeGw

In general files with specific names inside resources folders will get used automatically. These names are:

  • popup.md (VEF Metadata Template for popups)
  • sidebar.md (VEF Metadata Template for the sidebar)
  • filter.mapping.json (VEF Filter Mapping)
  • gallery.mapping.json (VEF Gallery Mapping)

For each layer used in VEF-based viewers, the file within its own _recources folder is prioritised of over that in its serversevice-level _resources folder and so on. This boils down to this priority list:

  1. <label>/<service>/<layer>/_resources/<file-by-convention>
  2. <label>/<service>/_resources/<file-by-convention>
  3. <label>/_resources/<file-by-convention>
  4. _resources/<file-by-convention>

...

  1. <label>/<service>/<layer>/_resources/<file-from-layer-configuration-if-existing>
  2. <label>/<service>/_resources/<file-from-layer-configuration-if-existing>
  3. <label>/_resources/<file-from-layer-configuration-if-existing>
  4. _resources/<file-from-layer-configuration-if-existing>
  5. <label>/<service>/<layer>/_resources/<file-by-convention>
  6. <label>/<service>/_resources/<file-by-convention>
  7. <label>/_resources/<file-by-convention>
  8. _resources/<file-by-convention>

...

SERVICE
sectionkeyvalue typerequired/optional/defaultvalue description

titlestringyeshuman-readable title of the workspace (used as title for all contained OWS: WMS, WFS, WCS)
abstract

string

yesabstract, describing the service's content. VEF (Marine Data Viewer) supports Markdown URL representation (<http://www.marine-data.de>, [Marine Data](http://www.marine-data.de>)) and HTML (like <br><br>, <a></a>)
keywordsstring listno  

owner.layer.toml
Anchor
owner.layer
owner.layer

A layer folder results in a layer of the same name withing the OWS representet by its parent service-layer folder. A layer has a human-readable title, an abstract and optional keywords – just like a scientific paper. These metadata can be specified in <label>/<service>/<layer>/owner.layer.toml. Additionally default and alternative styles (referencing SLD files in <label>/_styles/) and VEF resources can be specified. If desired the default mechanism of auto-deploying changes to the GeoServer (styles, metadata) and/or VEF (recoures) can be deactivated.

sectionkeyvalue typerequired/optional/defaultvalue description
LAYER

titlestringyeshuman-readable title of the layer
abstract

string

yesabstract, describing the layer's content. VEF (Marine Data Viewer) supports Markdown URL representation (<http://www.marine-data.de>, [Marine Data](http://www.marine-data.de>)) and HTML (like <br><br>, <a></a>)
keywordsstring listno
LAYER_

SETTINGSstyle_default

string

yesname of the SLD file (including file extension) to use as default style. The filename
need
needs to match the actual style name. SLD files need to go here:
 
<label>/_styles/*.sld
style_alternativesstring listno

names of SLD files (including file extension) to use as alternative styles. The

filename

filenames need to match the actual style name. SLD files need to go here:

 

<label>/_styles/*.sld.

RESOURCESgallery_mappingstringno
(defaults
to
to gallery.mapping.json)

name of gallery mapping file. Only required if deviating from gallery.mapping.json.


filter_mappingstringno
(defaults
to
to filter.mapping.json)

name of gallery mapping file. Only required if deviating from filter.mapping.json.


popup

string

no
(defaults
to
to popup.md)
nam  of

name of popup metadata template file. Only required if deviating from popup.md.


sidebarstringno
(defaults
to
to sidebar.md)

name of sidebar metadata template file. Only required if deviating from sidebar.md.

AUTODEPLOYresourcesbooleanno
(defaults to true)

whether to autodeploy (accepted merge requests will trigger instant updates in AWI-hosted VEF-based viewers, applying changes in resource files) changes for this layer to production.

If set to false, triggering updates otherwise is encouraged. Talk to your SDI admins!

 geoserver
booleanno
(defaults to true)

whether to autodeploy (accepted merge requests will trigger instant updates in O2A GeoServers, applying changes in styles, service/layer metadata) changes for this layer in production.

If set to false, triggering updates otherwise is encouraged. Talk to your SDI admins!

_other Folder

The _other subfolder is the place to store resources for services/layers which are not hosted in the GeoServer part of the O2A SDI to be used within VEF-based viewers. This subtree only contains resource files (see above for specs), owner.urls files but neither SLD nor any other configuration files.

...

Code Block
languagebash
titleFolder Structrure
. https://gitlab.awi.de/software-engineering/sdi/de.awi.sdi.o2a_spatial.dataproducts
|
`-- common
    |
    |-- _styles
    |   |-- marehubPhotos.sld 
    |   `-- marehubPhotosPreview.sld 
    |
    `-- media
        |-- owner.service.toml
        |-- admin.service.toml
        |
        `-- photos
            |-- owner.layer.toml
            |-- admin.layer.toml
            |-- admin.databasestore.toml
            |
            `-- _resources
                |-- popup.md
                |-- sidebar.md
                |-- gallery.mapping.json
                `-- filter.mapping.json
Code Block
languageyml
titlecommon/media/owner.service.toml
linenumberstrue
[SERVICE]

title = "Media OWS"
abstract = '''
Media service with photo and video data provided by AWI, Geomar and Hereon. Curated metadata is extracted from image FAIR Digital Objects (iFDOs) (<https://marine-imaging.com/fair/>) or automatically harvested from data products in Pangaea (<https://pangaea.de/>).
'''
keywords = [ "WMS", "WFS", "MareHUB", "videos", "photos", "image", "iFDO", "PANGAEA" ]
Code Block
languageyml
titlecommon/media/photos/owner.layer.toml
linenumberstrue
[LAYER]

title = "Photos"
abstract = "Layer with data provided by the three marine research centers AWI, Geomar and Hereon. It includes data collected during marine research projects as well as data enriched for this layer, i.e., technical metadata taken directly from the file, such as EXIF data. Depending on the data set, the provided metadata varies for each data product. Preview photos that are provided via urls are lossy processed to make them accessible for the web. This results in a loss of data information, even if not visible."
keywords = [ "MareHUB", "photos", "image", "PANGAEA" ]


[LAYER_SETTINGS]

style_default = "marehubPhotos.sld"
style_alternatives = [ "marehubPhotosPreview.sld" ]


[AUTODEPLOY]

resources = false

...