Struktur beschreiben

Die Struktur beschreibt den Aufbau eines Datenangebots – also welche Datenelemente (z.B. Spalten, Felder, Attribute) enthalten sind und in welcher Beziehung diese zueinander stehen. Während der zuvor erstellte Katalogeintrag primär dokumentiert, dass ein Datenangebot existiert, zeigt die Struktur wie es aussieht.

Das Hinterlegen der Struktur ist eine zentrale Voraussetzung für die Datenharmonisierung. Diese ermöglicht es, Datenelemente über mehrere Datenangebote hinweg zu vergleichen und – wenn gewünscht – auf gemeinsame Definitionen abzustützen. Ziel ist es, möglichst alle relevanten Strukturen zu erfassen. Sobald diese grundlegende Dokumentation abgeschlossen ist, können Arbeiten zur Datenharmonisierung begonnen werden.

Typische Inhalte einer Struktur umfassen Namen und Beschreibungen der Datenelemente (z.B. “Gemeindenummer”, “Gemeindename”, “Wohnbevölkerung_total”), Datentypen und Formate (z.B. Zahl, Text, Datum), Referenzen und Beziehungen, optionale Einschränkungen oder Regeln (z.B. Pflichtfelder, Wertebereiche) sowie Verweise auf verwendete Definitionen.

Die Struktur kann auf I14Y nicht direkt erfasst werden. Stattdessen muss sie ausserhalb der Plattform beschrieben werden. Wie Sie dabei vorgehen können, wird unter Strukturdatei erstellen erläutert. Akzeptiert werden Dateien in drei Formaten: TTL (Turtle/SHACL), RDF und JSON-LD.

Sobald die Strukturdatei bereit liegt, kann sie in I14Y einem Datensatz zuwiesen werden: Öffnen Sie dazu den betreffenden Eintrag im internen Bereich von I14Y. Wechseln Sie ins Register Struktur. Laden Sie anschliessend die Strukturdatei über die Weboberfläche hoch. Strukturen lassen sich auf I14Y noch nicht direkt im Browser editieren. Falls eine Struktur angepasst werden muss, wird sie heruntergeladen, lokal angepasst und dann wieder hochgeladen.

Strukturen auf I14Y bestehen aus drei Hauptobjekten: Klassen, Attributen und Assoziationen. Am Beispiel einer Tabelle zu Gemeinden: Die Klasse entspricht der Tabelle. Bei den einzelnen Spalten der Tabelle (z.B. den Spalten Gemeindenummer oder Gemeindename) handelt es sich um Attribute. Eine Assoziation hingegen beschreibt die Beziehung zwischen zwei Klassen. So lässt sich etwa zeigen, dass jede Gemeindenummer genau einem Kanton zugeordnet ist.

Strukturdatei erstellen

Strukturen lassen sich auf drei verschiedene Arten produzieren: Sie können entweder direkt in einem Code-Editor modelliert werden. Alternativ lassen sich die Strukturen, wie sie auf I14Y verwendet werden, aus vorhandenen Schemata ableiten, etwa aus jenem in einer XSD-Datei. Oder die Struktur wird anhand der eigentlichen Daten erstellt.

I14Y stellt in der Toolbox den Data Structure Editor bereit. Dieses Hilfsprogramm unterstützt Sie beim Erstellen oder Extrahieren von Strukturen. Für die Umwandlung von Schemas oder Datendateien steht in der Toolbox zudem das Hilfsprogramm Convert to SHACL zur Verfügung; die darin verwendeten Python-Skripte können auf Github bezogen werden.

Allenfalls können auch externe Werkzeuge hilfreich sein, wenn SHACL-Strukturen erstellt und geprüft werden müssen. Einige dieser externen Hilfsprogramme sind nachfolgend aufgelistet.

Hinweise zur Erstellung von SHACL-Strukturen

Turtle-Beispiel

Das folgende Beispiel zeigt eine einfache SHACL-Struktur in Turtle-Notation mit einer Klasse, zwei Attributen und einer Assoziation:

@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix dcterms: <http://purl.org/dc/terms/> .
@prefix i14y: <https://www.i14y.admin.ch/resources/datasets/MY_DATASET/structure/> .

# Klasse
i14y:localUnitMasterDataType
    rdf:type sh:NodeShape ;
    rdfs:label "localUnitMasterDataType"@en,
               "Lokale Einheit Stammdaten"@de ;
    sh:closed true ;
    sh:property i14y:localId, i14y:statusDate, i14y:additionalAddress .

# Einfaches Attribut
i14y:localId
    rdf:type sh:PropertyShape ;
    sh:name "localId"@en, "Lokale ID"@de ;
    sh:path i14y:localId ;
    sh:datatype xsd:string ;
    sh:pattern "^[A-B][1-9][0-9]{7}$" ;
    sh:minLength 9 ;
    sh:maxLength 9 ;
    sh:minCount 1 ;
    sh:maxCount 1 .

i14y:statusDate
    rdf:type sh:PropertyShape ;
    sh:name "statusDate"@en ;
    sh:path i14y:statusDate ;
    sh:datatype xsd:date .

# Assoziation (Verweis auf eine andere Klasse)
i14y:additionalAddress
    rdf:type sh:PropertyShape ;
    sh:name "additionalAddress"@en ;
    sh:path i14y:additionalAddress ;
    sh:node i14y:addressType .

Die Struktur kann u.a. mit dem Tool SHACL Play! als UML-Diagramm visualisiert werden.

Weitere Hinweise

Sprachmarkierungen (Language Tags): Für sprachabhängige String-Felder wie sh:name oder rdfs:label ist pro Sprache nur ein Wert erlaubt. Das folgende Beispiel ist ungültig und wird abgelehnt:

sh:name "Vacances"@fr,
        "Vacances administratives & congés"@fr ;

Namen und Beschreibungen: Verschiedene Vokabulare können für Bezeichnungen und Beschreibungen verwendet werden. Auf I14Y gilt folgende Empfehlung:

Zur Maximierung der Kompatibilität werden auf I14Y sowohl rdfs:label als auch sh:name für Namen akzeptiert.