ckanext-stadtzh-harvest

Harvester for the City of Zurich. The data is loaded from so called "dropzones", which are mounted network drives. Each folder in a dropzone is considered a dataset.

Content

Configuration
Metadata
- meta.xml
- link.xml

Configuration

The harvest configuration must be provided as a valid JSON string.

Example:

{
    "data_path": "/home/liip/dropzones/GEO",
    "metafile_dir": "DEFAULT",
    "update_datasets": false,
    "update_date_last_modified": true,
    "dataset_prefix": "",
    "delete_missing_datasets": false
}

`data_path`

The path to the dropzone

`metafile_dir`

The name of the directory where the meta.xml is located. The GEO dropzone has a subdirectory for the meta.xml, all other dropzones should provide an empty string here.

`update_datasets`

Boolean flag (true/false) to determine if this harvester should update existing datasets or not. If the flag is false no updates will be performed, only new datasets will be added.

`update_date_last_modified`

Boolean flag (true/false) to determine if the field date_last_modified of a dataset should be updated by the harvester or not. If the flag is true the date will be updated if the content of any resource of a dataset has changed.

`dataset_prefix`

Defines a prefix for all dataset names harvested by this harvester. This is useful if a test harvester imports the same dataset as a regular harvester and it should be ensured, that the they can co-exists without overriding each others dataset.

E.g. if a harvester imports a dataset "velowege", it will be imported as "velowege"; if dataset_prefix is set to "test_", it will be imported as test_velowege.

`delete_missing_datasets`

Boolean flag (true/false) to determine if this harvester should delete existing datasets that are no longer included in the harvest-source.

Metadata

Each dataset consists of a folder containing a meta.xml (required!) and an arbitrary number of resources.

You can find examples for meta.xml and link.xml files in the fixtures directory of this repository.

You can use the meta.xsd and link.xsd for validation. Either use a free online XML Validator or validate on the command line using e.g. XMLStarlet:

xmlstarlet val -e --xsd meta.xsd /path/to/meta.xml

meta.xml

Folder structure:

DWH/bev_zuz_jahr_quartier
├── 1993-2012_bev_zuz_jahr_quartier.csv
├── bev_zuz_jahr_quartier.csv
└── meta.xml

`titel`

Data type: String
Cardinality: 1
Description: Title of this dataset
Values: any literal
Example:

<titel>Alterswohnung</title>

`beschreibung`

Data type: String
Cardinality: 1
Description: Description of this dataset
Values: any literal
Example:

<beschreibung>Liste der städtischen Alterswohnungen</beschreibung>

`rechtsgrundlage`

Data type: String
Cardinality: 0..1
Description: Description of the legal basis of this dataset
Values: any literal
Example:

<rechtsgrundlage>Stadtratsbeschluss DGA</rechtsgrundlage>

`lizenz`

Data type: String
Cardinality: 0..1
Description: Description of the license of this dataset
Values: "notspecified", "odc-pddl", "odc-odbl", "odc-by", "cc-zero", "cc-by", "cc-by-sa", "gfdl", "other-open", "other-pd", "other-at", "uk-ogl", "cc-nc", "other-nc", "other-closed"
Example:

<lizenz>cc-by</lizenz>

`raeumliche_beziehung`

Data type: String
Cardinality: 0..1
Description: Spatial relationship of this dataset
Values: any literal
Example:

<raeumliche_beziehung>Stadt Zürich</raeumliche_beziehung>

`aktualisierungsintervall`

Data type: String
Cardinality: 0..1
Description: Update interval of this dataset
Values: " ", "alle 4 Jahre", "Echtzeit", "halbjaehrlich", "jaehrlich", "keines", "laufend", "monatlich", "quartalsweise", "sporadisch oder unregelmaessig", "stuendlich", "taeglich", "vierzehntaeglich", "woechentlich", "laufende Nachfuehrung", "keine Nachfuehrung"
Example:

<aktualisierungsintervall>woechentlich</aktualisierungsintervall>

`aktualisierungsdatum`

Data type: String
Cardinality: 1
Description: Date of the last update of this dataset
Values: date dd.mm.yyyy
Example:

<aktualisierungsdatum>20.10.2015</aktualisierungsdatum>

`datentyp`

Data type: String
Cardinality: 1
Description: Type of data in this dataset
Values: " ", "Bilddatei", "Datenaggregat", "Einzeldaten", "Web-Service"
Example:

<datentyp>Datenaggregat</datentyp>

`erstmalige_veroeffentlichung`

Data type: String
Cardinality: 0..1
Description: Publication date of this dataset
Values: dd.mm.yyyy
Example:

<erstmalige_veroeffentlichung>21.01.2015</erstmalige_veroeffentlichung>

`kategorie`

Data type: String
Cardinality: 0..1
Description: List of categories of this dataset
Values: comma-seperated list of category-titles "Arbeit und Erwerb", "Basiskarten", "Bauen und Wohnen", "Bevölkerung", "Bildung", "Energie", "Finanzen", "Freizeit", "Gesundheit", "Kriminalität", "Kultur", "Mobilität", "Politik", "Preise", "Soziales", "Tourismus", "Umwelt", "Verwaltung", "Volkswirtschaft"
Example:

<kategorie>Basiskarten, Bevölkerung, Bauen und Wohnen</kategorie>

`lieferant`

Data type: String
Cardinality: 0..1
Description: Publisher of this dataset
Values: any literal
Example:

<lieferant>Geomatik und Vermessung Zürich, Tiefbau- und Entsorgungsdepartement</lieferant>

`zeitraum`

Data type: String
Cardinality: 0..1
Description: Temporal relationship of this dataset
Values: any literal
Example:

<zeitraum>laufende Nachführung</zeitraum>

`quelle`

Data type: String
Cardinality: 1
Description: Source of this dataset
Values: any literal
Example:

<quelle>Gesundheits- und Umweltdepartement</quelle>

`datenqualitaet`

Data type: String
Cardinality: 0..1
Description: Quality of this dataset
Values: any literal
Example:

<datenqualitaet>gut</datenqualitaet>

`aktuelle_version`

Data type: String
Cardinality: 0..1
Description: Version of this dataset
Values: version number
Example:

<aktuelle_version>1.0</aktuelle_version>

`bemerkungen`

Data type: complex
Cardinality: 0..1
Description: List of comments related to this dataset
Values: <bemerkung>-elements with:
- <titel> (title of the comment, required)
- <text> (text of the comment, required)
- <link> (link of the comment, optional) with:
  - <label> (lable of the link, optional)
  - <url> (url of the link, optional)
Example:

<bemerkungen>
    <bemerkung>
        <titel>Vorschau WMS (statisches Bild):</titel>
        <text>Es werden nur Wohnungen angezeigt, welche mindestens drei Mal vorkommen</text>
        <link>
          <label>Layer Alterswohnung</label>
          <url><![CDATA[http://www.gis.stadt-zuerich.ch/maps/services/wms/WMS-ZH-STZH-OGD/MapServer/WMSServer?VERSION=1.3.0&REQUEST=GetMap&CRS=EPSG:21781&Styles=&FORMAT=image/png&BGCOLOR=0xFFFFFF&TRANSPARENT=FALSE&bbox=676000,241000,690000,255000&WIDTH=800&HEIGHT=800&Layers=Stadtplan,Alterswohnung"]]></url>
      </link>
    </bemerkung>
</bemerkungen>

`attributliste`

Data type: complex
Cardinality: 0..1
Description: List of attributes to describe the fields of this dataset
Values: <attributelement technischerfeldname="{fieldname}"> (name of the attribute-field, required) elements with:
- <sprechenderfeldname> (label of the attribute, required)
- <feldbeschreibung> (description of the attribute, required)
Example:

<attributliste> 
   <attributelement technischerfeldname="ADRESSE">
        <sprechenderfeldname>Adresse</sprechenderfeldname>
        <feldbeschreibung>Adresse des Objektes, CHAR 70 Zeichen lang</feldbeschreibung>
   </attributelement>
</attributliste>

`schlagworte`

Data type: String
Cardinality: 0..1
Description: List of tags of this dataset
Values: comma-seperated list of tag-titles
Example:

<schlagworte>geodaten, vektordaten, punktdaten, standort</schlagworte>

`ressourcen`

Data type: complex
Cardinality: 0..1
Description: List of resources with their metadata
Values: <ressource dateiname="{filename}"> (name of the resource, required) elements with:
- <beschreibung> (description of the resource, optional)
Example:

<ressourcen>
    <ressource dateiname="test.json">
        <beschreibung>This is a test description</beschreibung>
    </ressource>
</ressourcen>

link.xml

Optionally a dataset may contain a link.xml to describe APIs or services. This is mostly used in the "GEO" dropzone.

Folder structure:

GEO/alterswohnung
├── ARCHIVE
└── DEFAULT
    ├── alterswohnung.json
    ├── alterswohnung.kmz
    ├── alterswohnung.zip
    ├── link.xml
    └── meta.xml

Full example of a link.xml:

<?xml version="1.0" encoding="utf-8"?>
<linklist>
	<link>
		<lable>Web Map Service</lable>
		<url><![CDATA[http://www.gis.stadt-zuerich.ch/maps/services/wms/WMS-ZH-STZH-OGD/MapServer/WMSServer?]]></url>
		<type>WMS</type>
		<description>Further details about the resource</description>
	</link>
	<link>
		<lable>Web Feature Service</lable>
		<url><![CDATA[http://www.gis.stadt-zuerich.ch/maps/services/wms/WMS-ZH-STZH-OGD/MapServer/WFSServer?]]></url>
		<type>WFS</type>
		<description>Further details about the resource</description>
	</link>
</linklist>

`link`

Data type: complex
Cardinality: 0..n
Description: Describes resources that are available as a URL (APIs, services)
Values:
- <lable> (name of the resource, required)
- <url> (URL of the resource, required)
- <type> (format of the resource, required)
- <description> (description of the resource, optional)
Example:

<link>
    <lable>Web Feature Service</lable>
    <url><![CDATA[http://www.gis.stadt-zuerich.ch/maps/services/wms/WMS-ZH-STZH-OGD/MapServer/WFSServer?]]></url>
    <type>WFS</type>
    <description>Projektion CH1903+ / LV95 (EPSG:2056)</description>
</link>

Name		Name	Last commit message	Last commit date
Latest commit History 420 Commits
.github/workflows		.github/workflows
bin		bin
ckanext		ckanext
solr		solr
.gitignore		.gitignore
.isort.cfg		.isort.cfg
LICENSE		LICENSE
README.md		README.md
conftest.py		conftest.py
dev-requirements.txt		dev-requirements.txt
link.xsd		link.xsd
meta.xsd		meta.xsd
requirements.txt		requirements.txt
setup.cfg		setup.cfg
setup.py		setup.py
test.ini		test.ini

License

opendatazurich/ckanext-stadtzh-harvest

Folders and files

Latest commit

History

Repository files navigation

ckanext-stadtzh-harvest

Content

Configuration

data_path

metafile_dir

update_datasets

update_date_last_modified

dataset_prefix

delete_missing_datasets

Metadata

meta.xml

titel

beschreibung

rechtsgrundlage

lizenz

raeumliche_beziehung

aktualisierungsintervall

aktualisierungsdatum

datentyp

erstmalige_veroeffentlichung

kategorie

lieferant

zeitraum

quelle

datenqualitaet

aktuelle_version

bemerkungen

attributliste

schlagworte

ressourcen