Handbuch Interoperabilitätsplattform I14Y – Datensatz erfassen

Publikation: Open Government Data erfassen

Mon, 01 Jan 0001 00:00:00 +0000

Sie möchten Ihre offenen Behördendaten auf opendata.swiss publizieren? Nutzen Sie für die manuelle Datenerfassung I14Y. In diesem Kapitel wird detailliert erklärt, wie sie Open Government Data auf der Interoperabilitätsplattform erfassen und auf opendata.swiss publizieren.

Ein Input-Bereich, zwei Plattformen

Damit die Metadaten nicht auf zwei Plattformen bewirtschaftet werden müssen, bieten opendata.swiss und die Interoperabilitätsplattform i14y.ch einen gemeinsamen Input-Bereich an.

Sollten Sie zum ersten Mal Datensätze auf I14Y und opendata.swiss publizieren, führen wir Sie durch den Prozess und unterstützen Sie dabei, die Metadaten korrekt zu erfassen und zu übermitteln. Kontaktieren Sie uns, um einen Termin zu vereinbaren. Falls Ihre Organisation noch kein Konto auf I14Y oder auf opendata.swiss hat, melden Sie sich bei der Interoperabilitätsstelle. Bitte teilen Sie uns die E-Mail-Adresse, mit der Sie sich registriert haben, sowie die erforderlichen Informationen zu Ihrer Organisation mit.

Beschreibung eines Datensatzes erstellen

Um Metadaten zu einem Datensatz zu erfassen, müssen Sie sich in den Input-Bereich von I14Y](https://input.i14y.admin.ch/) einloggen. Falls Ihnen mehrere Rollen zugewiesen sind, wählen Sie bitte das für Sie zutreffende Profil für die Publikation und Pflege von OGD aus.

Sie befinden sich nun im Input-Bereich. Hier sehen Sie drei Kacheln, über die Sie zu den verschiedenen Arbeitsbereichen gelangen: Katalog pflegen, Konzepte pflegen und Interoperabilitätsplattform I14Y. Unterhalb dieser Kacheln finden Sie die Kachel Meine Daten. Dort werden Aufgaben aufgelistet, die Sie betreffen.

Um einen Datensatz in ihrem Katalog zu erfassen, klicken Sie auf die Kachel Katalog pflegen. Nun sehen Sie eine Liste der Datensätze Ihrer Organisation sowie alle öffentlich publizierten Beschreibungen anderer Organisationen. Für jeden Datensatz werden Titel, Identifikator, Herausgeber, Typ, Status und der Publikationskanal auf I14Y angezeigt.

Nicht alle Felder sind auf opendata.swiss zu sehen

Gewisse Metadatenfelder im Input-Bereich von I14Y sind für die Veröffentlichung von OGD nicht erforderlich. Die entsprechenden Felder müssen nicht ausgefüllt werden. Es wird jedoch empfohlen, die Felder zu nutzen, damit die Beschreibung, die auch auf I14Y zu finden ist, möglichst vollständig ist. Zudem können viele dieser Felder für das organisationsinterne Datenmanagement hilfreich sein.

Auf dem Portal opendata.swiss und auf der Interoperabilitätsplattform I14Y werden Datensätze gemäss den Vorgaben des DCAT-Standards in der aktuell gültigen Version mit dem Applikationsprofil für die Schweiz beschrieben (DCAT-AP CH 2.0). Die I14Y bietet einige optionale Zusatzfelder an, die im aktuellen DCAT-Standard nicht vorgesehen sind. Damit lassen sich die Datenangebote noch detaillierter beschreiben. Darüber hinaus können in I14Y auch die Struktur sowie die einzelnen Datenkonzepte beschrieben werden. DCAT-AP ist ein Anwendungsprofil des Data Catalog Vocabulary (DCAT) und dient zur Beschreibung der in Datenportalen verzeichneten Daten. Es richtet sich insbesondere an die Betreiber von Open-Data-Portalen und deren Datenpublizierende. Die Schweizerische Ableitung DCAT-AP-CH wird im Rahmen der eCH Fachgruppe OGD kontinuierlich weiterentwickelt.

Klicken Sie nun auf die Schaltfläche «Erstellen». Es öffnet sich ein Dropdown-Menü mit drei verschiedenen Auswahlmöglichkeiten. Für die Beschreibung eines Datensatzes wählen Sie die Option Neuen Datensatz erfassen.

Um sicherzustellen, dass der Datensatz gefunden und wiederverwendet werden kann, werden verschiedene Metadaten zum Datensatz erfasst und auf I14Y sowie opendata.swiss veröffentlicht. Metadatenfelder, die mit einem Stern gekennzeichnet sind, müssen ausgefüllt werden. Bitte beachten Sie: Je mehr Informationen Sie in den Metadaten angeben, desto leichter wird der Datensatz gefunden und desto besser kann er wiederverwendet werden.

Bitte geben Sie im Feld Titel und im Feld Beschreibung einen aussagekräftigen Titel und eine Beschreibung Ihres Datensatzes an. Für die Bundesstellen sind diese Angaben in zwei Landessprachen obligatorisch. Für alle anderen Organisationen ist mindestens eine Landessprache erforderlich – wünschenswert wären alle vier Sprachen. Eine Beschreibung auf Englisch erleichtert das Auffinden Ihres Datensatzes im europäischen Datenportal.

Im Feld Identifikator geben Sie den Identifikator des Datensatzes ein. Sie können dafür die ID aus Ihrem Quellsystem verwenden oder eine beliebige ID definieren. Bitte beachten Sie, dass der Datensatz-Identifikator innerhalb der Datensätze Ihrer Organisation eindeutig sein muss. Es wird empfohlen, die ID aus dem Quellsystem des Herausgebers zu verwenden. Sie kann die folgenden Zeichen A-Za-z, 0-9, - und _ enthalten. Wichtig: Verändern Sie den Identifikator nicht mehr, nachdem der Datensatz publiziert ist. Ansonsten können Ihre Daten nicht mehr eindeutig zugeordnet werden.

Im Feld Herausgeber erscheint als Dropdown Ihre Organisation in der Auswahlliste.

Wählen Sie unter Zugriffsrechte die Option «Öffentlich» für die OGD-Datensätze.

Die folgenden Felder Data Owner, Responsible Person und Responsible Person Deputy werden auf opendata.swiss nicht angezeigt, sind jedoch für das interne Datenmanagement wichtig.

Informationen zu den Rollen finden Sie im Abschnitt zu den Prozessen und Rollen.

Das Feld Publikationsdatum muss ausgefüllt werden. Es handelt sich um das Datum der ersten Publikation im Quellsystem dieses Datensatzes. Ist dieses nicht bekannt, ist das Datum der geplanten Erstpublikation auf I14Y oder opendata.swiss zu verwenden.

Im Feld Änderungsdatum wird nach der Publikation das Datum der letzten Aktualisierung oder Änderung des Datensatzes angegeben.

Im Bereich Kontaktstellen können Sie die Kontaktstelle hinterlegen, die bei Fragen zum vorliegenden Datensatz zuständig ist. Für die Publikation auf opendata.swiss muss mindestens das Feld Organisation in zwei Landessprachen (Bund) oder in mindestens einer Sprache (Andere) ausgefüllt sowie eine E-Mailadresse hinterlegt werden. Wenn Sie weitere Kontaktstellen hinzufügen möchten, können Sie dies über die Schaltfläche Neue Kontaktstelle tun.

Das Feld Sprachen zeigt an, in welchen Sprachen der Datensatz verfügbar ist. Zur Auswahl stehen die Sprachen Deutsch, Französisch, Italienisch, Rätoromanisch (wird auf opendata.swiss nicht angezeigt) und Englisch. Ist der Datensatz sprachunabhängig, lassen Sie das Feld leer.

Im Feld Kataloge und Themen geben Sie den Themenbereich Ihres Datensatzes an. In einem ersten Schritt wählen Sie aus der Liste der Themen von I14Y. Damit Sie Ihren Datensatz auf opendata.swiss publizieren können, müssen Sie ihn zuerst speichern. Klicken Sie dazu auf die Schaltfläche Speichern und schliessen, die im unteren Rand des Webformulars eingeblendet wird.

Um den Opendata-Katalog hinzuzufügen, öffnen Sie die Beschreibung Ihres Datensatzes, indem Sie auf die Schaltfläche Bearbeiten klicken. Kehren Sie zum Bereich Kataloge und Themen zurück. Klicken Sie nun auf die Schaltfläche Katalog verknüpfen. Der Opendata-Katalog Ihrer Organisation Opendata + Name der Organisation erscheint. Wählen Sie diesen aus. Sollte keine Auswahlmöglichkeit eingeblendet werden, kontaktieren Sie die Interoperabilitätsstelle.

Im Bereich Kataloge und Themen erscheint nun ein weiteres Feld mit Ihrem Opendata-Katalog. Klicken Sie auf das Dropdown-Menü und wählen Sie den entsprechenden Bereich aus der Liste der Opendata-Themen. Es handelt sich dabei um die EU-Themenliste, die im Standard DCAT-AP CH Version 2.0.0 definiert ist. Die hier ausgewählten Bereiche werden auf opendata.swiss angezeigt.

Unterschiedliche Themen

Die Themenvokabulare von I14Y und opendata.swiss unterscheiden sich in einigen Punkten sowie in der Anzahl der Auswahlmöglichkeiten. Kategorisierung und Anzahl der Bereiche sind daher nicht deckungsgleich.

Ihr Datensatz ist jetzt mit Ihrem Opendata-Katalog verknüpft. Die Plattform opendata.swiss wird die Metadaten in regelmässigen Abständen auslesen (Harvesting).

Die Felder im Bereich Schutzbedarf sind für die Publikation auf I14Y relevant. Informationen zum Ausfüllen dieser Felder finden Sie im entsprechenden Abschnitt dieses Handbuchs.

Geben Sie nun Schlüsselwörter in die entsprechenden Sprachfelder ein. Falls vorhanden, sollte auch die URI des betreffenden Objekts in der Termdat-Datenbank des Bundes, dem europäischen Umwelt-Thesaurus GEMET oder der kollaborativen Datenplattform Wikidata erfasst werden. Fügen Sie weitere Schlüsselwörter hinzu, indem Sie auf das Plus-Symbol klicken. Der Schlüsselwort-Eintrag wird dadurch direkt gespeichert; ein Klick auf den Speichern-Knopf unten ist nicht nötig. Um Schlüsselwörter zu löschen, wählen Sie das Papierkorb—Symbol. Vergessen Sie nicht, die entsprechende Zeile zu markieren.

Tragen Sie unter Landing Page den Link zu der Webseite Ihrer Organisation ein, auf der weitere Informationen zu dem betreffenden Datenangebot zu finden sind oder über die die Originaldaten abgerufen werden können.

Das Feld Räumliche Abdeckung beschreibt das geographische Gebiet, das von den Daten abgedeckt wird. Einige Beispiele: Schweiz, Kanton Solothurn, Aarau. Zurzeit kann Freitext eingegeben werden. Für Gebiete, die in den folgenden Vokabularen enthalten sind, müssen die entsprechenden Begriffe verwendet werden: VOCAB-EU-CONTINENT, VOCAB-EU-COUNTRY, VOCAB-EU-PLACE, GEONAMES.

Das Feld GeoIV ID wird nicht auf opendata.swiss angezeigt. Informationen zu diesem Feld finden Sie im Überblick über die Eingabefelder in diesem Handbuch.

Im Feld Zeitliche Abdeckung können Sie den Zeitraum angeben, den der Datensatz umfasst. Wählen Sie dazu im Kalender das Datum «Von» und «Bis». Im Feld Frequenz können Sie aus der Dropdown-Liste die Häufigkeit auswählen, mit der der Datensatz aktualisiert wird.

Im Feld Konform zu werden technische Spezifikationen erfasst. Setzen Sie dazu einen Link auf das entsprechende Dokument, z.B. auf die Beschreibung eines Standards bei eCH.

Im Feld Dokumente können Sie weitere Dokumente eintragen, die in direktem Zusammenhang mit Ihrem Angebot stehen, z.B. einen Link zu einem wissenschaftlichen Artikel, einer Anleitung oder einem Hintergrundtext.

Die Felder Wird referenziert von und Qualifizierte Rollenzuordnung werden auf opendata.swiss nicht angezeigt.

Im Feld Qualifizierte Beziehung können Sie aus allen auf opendata.swiss verfügbaren Datensätzen diejenigen auswählen, die einen thematischen Bezug zu Ihrem Datensatz haben. Dadurch können Datennutzende über Ihren Datensatz auf andere Datensätze aufmerksam gemacht werden, die für sie von Interesse sein könnten. Wählen Sie dazu in der Dropdown-Liste «Hatte Rolle» die Option «Verwandt». Im Feld URL geben Sie den Perma-Link des Datensatzes an, auf den Sie verlinken möchten. Es ist wichtig, dass es sich um den permanenten Link handelt. Gehen Sie dazu auf die Seite des Datensatzes auf opendata.swiss, den Sie verlinken möchten. Unter Zusätzliche Informationen finden Sie das Feld Identifier. Bewegen Sie die Maus über den Identifier (zum Beispiel «lustat-grwahlen-lu@lustat»), klicken Sie mit der rechten Maustaste und wählen Sie die Option «Link kopieren». Kopieren Sie diesen ins Eingabefeld URL. Der Perma-Link hat die Form [https://opendata.swiss/perma/lustat-grwahlen-lu@lustat]. Im Pfad der URL sehen Sie perma gefolgt vom entsprechenden Identifier des Datensatzes.

In diesem Bereich werden allfällige gesetzliche Grundlagen zum betreffenden Datenangebot erfasst, also etwa Gesetze und Verordnungen. Handelt es sich um die gesetzliche Grundlage, setzen sie bitte in die Sprachfelder die folgende Terme: “Rechtliche Grundlagen”(DE), “Base légale”(FR), “Basi legali” (IT) und “legal basis”(EN). Setzen Sie dazu einen Link zum betreffenden Dokument auf Fedlex oder auf die entsprechende Online-Ressource, die den Text enthält. Zudem lassen sich verwandte Ressourcen verlinken, die nicht zum Feld Qualifizierte Beziehungen passen, etwa zusätzliches Material wie einen Artikel, ein Beispiel oder eine Dokumentation.

Die Felder Bild und Version und Versionshinweise werden auf opendata.swiss nicht verwendet.

Sie sind am Ende der Eingabe der Metadatenfelder zur Beschreibung des Datensatzes angelangt. Sie können nun die Eingabe der Metadatenfelder speichern und schliessen.

Distribution erfassen

Nun müssen sie noch eine oder mehrere Distributionen zu Ihrem Datensatz hinzufügen. Wichtig: Jeder Datensatz, der auf opendata.swiss veröffentlicht werden soll, muss mindestens eine Distribution haben. Bitte berücksichtigen Sie bei der Publikation von Distributionen die OGD-Richtlinien.

Wählen Sie den Reiter Distributionen und klicken Sie auf die Schaltfläche Erstellen, um zum Webformular für die Beschreibung der Distribution zu gelangen.

Die Erfassung einer Distribution funktioniert ähnlich wie die beim Datensatz: Wählen Sie einen geeigneten Identifikator aus Ihrem Quellsystem aus, geben Sie Titel und Beschreibung ein. Für die Sprachversionen gelten die gleichen Regeln wie beim Datensatz: Alle Bundesstellen müssen die Angaben mindestens auf Deutsch und Französisch eingeben – wünschenswert wären allerdings alle vier Sprachen. Andere Organisationen müssen Titel und Beschreibung in mindestens einer Sprache eingeben. Falls die Distribution sprachunabhängig ist, wählen Sie unter dem Feld Sprache keine Sprache aus. Auch hier ist im Pflichtfeld Publikationsdatum das Veröffentlichungsdatum der Distribution anzugeben.

Was ist eine Distribution?

Eine Distribution ist eine spezifische Darstellung eines Datensatzes. Ein Datensatz kann in mehreren Serialisierungen vorliegen, die sich vielerlei Hinsicht unterscheiden können, z.B. hinsichtlich der natürlichen Sprache, des Medientyps oder des Formats, der schematischen Organisation, der zeitlichen und räumlichen Auflösung, des Detaillierungsgrads oder der Profile (die eines oder alle der oben genannten Merkmale enthalten können).

Für jede Distribution müssen Sie unter Zugangs-URL eine URL angeben, über welche auf die Distribution zugegriffen werden kann. Falls sich hinter der URL ein direkter Download verbirgt, muss die URL auch als Download-URL eingetragen werden. Klicken Sie hierzu auf das Kästchen bei Download-URL. Optional kann die Grösse der Distribution in Bytes angegeben werden. Unter Format wählen Sie das Format Ihrer Distribution. Bei Bedarf kann der Medientyp (früher MIME-Typ) spezifiziert werden. Die Felder Komprimierungsformat, Prüfsummenalgorithmus, und Prüfsumme werden derzeit nicht auf opendata.swiss angezeigt.

Im Feld Lizenz müssen Sie die Nutzungsbedingung des Datensatzes gemäss den Nutzungsbedingungen von opendata.swiss angeben. Diese stehen Ihnen in der Dropdown-Liste zur Auswahl. Wählen Sie den zutreffenden, mit «Opendata» gekennzeichneten Menüpunkt aus.

Die Felder Rights und Verfügbarkeit werden nicht auf opendata.swiss angezeigt.

Zeitliche Abdeckung: Die Distribution kann nach Zeitraum gekennzeichnet werden. Geben Sie hierzu im Kalender das Datum «Von» und «Bis» ein. Im Feld Zeitliche Auflösung kann der Mindestzeitraum erfasst werden, der in der Distribution aufgelöst werden kann. Handelt es sich beim Datensatz um eine Zeitreihe, sollte dies dem Abstand zwischen den Elementen der Reihe entsprechen.

Bei anderen Arten von Datensätzen gibt diese Eigenschaft in der Regel die kleinste zeitliche Differenz zwischen den Elementen im Datensatz an. Bevorzugt wird eine einheitliche Notation gemäss W3.org, z.B.: P1D (Auflösung 1 Tag), P1M (ein Monat), P1Y (ein Jahr).

Im Feld Konform zu werden technische Spezifikationen zur entsprechenden Distribution erfasst. Setzen Sie dazu einen Link auf das entsprechende Dokument, z.B. auf die Beschreibung eines Standards bei eCH.

Im Feld Dokumente können Sie weitere Dokumente eintragen, die in direktem Zusammenhang mit der entsprechenden Distribution stehen, z.B. einen Link zu einem wissenschaftlichen Artikel, einer Anleitung oder einem Hintergrundtext.

Sie haben nun Ihre erste Distribution erstellt und können entweder über die Schaltfläche Speichern und schliessen die Distribution speichern. Weitere Distributionen können Sie über die Schaltfläche Erstellen hinzufügen. Das Hinzufügen weiterer Distributionen ist jederzeit möglich.

Datensatz prüfen und veröffentlichen

Schauen Sie sich die Beschreibung des Datensatzes und seiner Distributionen in der Detailansicht an: Wenn alle Felder wie erwartet ausgefüllt sind, können Sie Ihren Datensatz veröffentlichen. Die folgende Beschreibung gilt für Personen in der Rolle Local Data Steward. Wenn das Setzen des Registrierungsstatus nicht möglich ist, kontaktieren Sie eine Person in der Rolle Local Data Steward Ihrer Organisation.

In der Detailansicht sehen Sie den Status Ihrer Beschreibung. Der aktuelle Status ist Initial. Sie müssen diesen Status ändern, indem Sie auf die Schaltfläche Registrierungsstatus vorschlagen klicken und die Option Kandidat auswählen.

Danach kann der Eintrag auf Registriert gesetzt werden. Schlagen Sie nun die Publikation auf I14Y vor, indem Sie den Kanal von Intern auf I14Y umstellen. Die Interoperabilitätsstelle wird die Metadaten prüfen und dann freischalten. Bei Problemen oder Verzögerungen kontaktieren Sie die Interoperabilitätsstelle. Ob der Datensatz auf I14Y veröffentlicht wurde, erkennen Sie rechts oben am Status der Publikation. Dieser wird als Aktuell I14Y angezeigt.

Bitte informieren Sie die Geschäftsstelle Open Government Data, wenn der Datensatz zur Begutachtung bereit sind. Wir werden Ihre Datensätze dann überprüfen. Bitte beachten Sie, dass der Datensatz während der Begutachtungsphase nicht bearbeitet werden kann.

Beschreibung im Frontend prüfen

Sobald Ihr Datensatz auf I14Y publiziert und von opendata.swiss geharvested wurde, kann sie auch im Frontend von opendata.swiss angesehen werden. Wenn Sie Ihre Datensätze zum ersten Mal auf opendata.swiss publizieren, haben Sie die Möglichkeit, diese zuerst in der Abnahmeumgebung aufzuschalten und zu begutachten. Besprechen Sie mit dem Team der Geschäftsstelle OGD, ob die Datensätze direkt auf der Produktionsumgebung oder zuerst auf der Abnahmeumgebung aufgeschaltet werden.

Publikation: Struktur beschreiben

Mon, 01 Jan 0001 00:00:00 +0000

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 teilweise direkt im Browser editieren. Bei kleinen Änderungen (Titel oder Typ eines Attributs) erfolgt die Änderung direkt in der Benutzeroberfläche. Bei größeren Änderungen (Hinzufügen einer Klasse oder eines Attributs) wird die Struktur heruntergeladen, lokal angepasst und dann wieder hochgeladen.

Formate zur Beschreibung von Strukturen

Turtle (TTL) ist eine kompakte, menschenlesbare Serialisierungssprache für RDF-Daten, die vom World Wide Web Consortium (W3C) standardisiert wurde. In Kombination mit SHACL eignet sie sich besonders gut zur Definition von Validierungsregeln und Datenstrukturen. Dank ihrer übersichtlichen Syntax lässt sich Turtle leicht von Hand schreiben und im Code-Editor bearbeiten. Turtle ist daher das empfohlene Format auf I14Y.

RDF (Resource Description Framework) ist das vom W3C entwickelte Datenmodell zur Beschreibung von Ressourcen im Web und bildet die Grundlage des semantischen Web. Informationen werden als Tripel (Subjekt – Prädikat – Objekt) strukturiert, was RDF besonders gut für Linked-Data-Anwendungen geeignet macht. Die manuelle Bearbeitung ist jedoch weniger intuitiv als bei Turtle.

JSON-LD ist ein auf JSON basierendes Format zur Darstellung von Linked Data. Es ermöglicht die Einbettung semantischer Metadaten in bestehende JSON-Strukturen und wird häufig in modernen elektronischen Schnittstellen (APIs) eingesetzt. Entsprechend ist das Format den meisten Entwicklerinnen und Entwicklern vertraut. Gegenüber Turtle ist das JSON-LD jedoch weniger kompakt. Deshalb ist es aufwändiger Daten in diesem Format manuell zu editieren.

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.

Klassen, Attribute und Assoziationen im Detail

Klasse: Eine Klasse beschreibt einen Entitätstyp. In vielen Fällen entspricht sie einer Tabelle. In SHACL wird sie als sh:NodeShape definiert. Für den Namen einer Klasse wird rdfs:label verwendet; Beschreibungen werden mit dcterms:description oder rdfs:comment hinterlegt. Zusätzlich können folgende Eigenschaften definiert werden: sh:property (Liste der Attribute und Assoziationen), sh:targetClass (optionale Validierungszielklasse) und sh:closed (definiert, ob nur die angegebenen Eigenschaften erlaubt sind).

Attribut: Ein Attribut ist ein einfaches Datenelement (ein Feld oder eine Spalte) ohne Verweis auf eine andere Klasse. Es wird in SHACL als sh:PropertyShape modelliert. Wichtige Felder sind: sh:path (Pflicht), sh:datatype, sh:name (menschenlesbarer Name), sh:description (ausführliche Beschreibung), Kardinalitäten (sh:minCount, sh:maxCount), sh:order (Reihenfolge der Eigenschaften), Validierungsregeln (sh:pattern, sh:minLength, sh:maxLength, sh:in für Enumerationen) sowie dcterms:conformsTo (Verweis auf ein I14Y-Konzept). Mit sh:in lassen sich Enumerationen definieren, um die zulässigen Werte auf eine vordefinierte Liste zu beschränken.

Assoziation: Eine Assoziation ist eine Beziehung zwischen zwei Klassen. Sie wird ebenfalls als sh:PropertyShape modelliert, jedoch mit sh:class oder sh:node als Ziel-Klasse. In I14Y wird sh:node gegenüber sh:class bevorzugt, da sh:node gegen die Struktur (d.h. gegen eine andere sh:NodeShape) validiert, während sh:class lediglich den RDF-Typ prüft. Beide Varianten werden unterstützt. Wichtige Felder sind: sh:path (Pflicht), sh:node oder sh:class, sh:name, sh:description, Kardinalitäten (sh:minCount, sh:maxCount), sh:order sowie dcterms:conformsTo.

Für Attribute und Assoziationen kann mit dcterms:conformsTo angegeben werden, dass sich das Element auf ein I14Y-Konzept abstützt. Daten, die sich auf dieselben grundlegenden Definitionen beziehen, sind (teilweise) harmonisiert.

Eine ausführliche Beschreibung aller Felder für Klassen, Attribute und Assoziationen findet sich im Anhang.

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.

Werkzeug	Beschreibung
SHACL Play!	Validierung, UML-Visualisierung, HTML-Dokumentation, SHACL aus RDF generieren, JSON Schema / JSON-LD exportieren
SKOS Play!	Konvertierung von Excel-Vorlagen in RDF (unterstützt SKOS, SHACL, RDF)
SHACL Playground	Online-Editor und Validator
SHACL Online Editor	Online-Editor mit Tutorial
SHACL Validator (EU)	SHACL-Validierung
XSD2SHACL	Generiert SHACL-Shapes aus XML Schema (XSD)
W3C RDF Validator	Syntaxvalidierung von RDF/Turtle-Dateien

Hinweise zur Erstellung von SHACL-Strukturen

Turtle-Beispiel

Das folgende Beispiel zeigt eine einfache SHACL-Struktur in Turtle-Notation mit zwei Klassen, drei 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://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/> .

i14y:SurgicalProcedure
 rdf:type sh:NodeShape ;
 rdfs:label "SurgicalProcedure"@en,
 "Chirurgischer Eingriff"@de ;
 dcterms:description "Beschreibung eines chirurgischen Eingriffs"@de ;
 sh:property <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/procedureType>,
 <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/date>,
 <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/performedBy> ;
 sh:targetClass i14y:SurgicalProcedure .

<https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/procedureType>
 rdf:type sh:PropertyShape ;
 sh:path <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/procedureType> ;
 sh:name "procedureType"@en, "Eingriffstyp"@de ;
 sh:description "Klassifikation des Eingriffs gemäss CHOP-Nomenklatur"@de ;
 sh:datatype xsd:string ;
 sh:minCount 1 ;
 sh:maxCount 1 ;
 sh:order 0 ;
 dcterms:conformsTo <https://register.ld.admin.ch/i14y/concept/DV_CHOP/version/2024.99.0> .

<https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/date>
 rdf:type sh:PropertyShape ;
 sh:path <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/date> ;
 sh:name "date"@en, "Datum"@de ;
 sh:description "Datum des chirurgischen Eingriffs"@de ;
 sh:datatype xsd:date ;
 sh:minCount 1 ;
 sh:maxCount 1 ;
 sh:order 1 .

<https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/performedBy>
 rdf:type sh:PropertyShape ;
 sh:path <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/SurgicalProcedure/performedBy> ;
 sh:name "performedBy"@en, "Durchgeführt von"@de ;
 sh:description "Arztpraxis, die den Eingriff durchgeführt hat"@de ;
 sh:node i14y:MedicalPractice ;
 sh:minCount 1 ;
 sh:maxCount 1 ;
 sh:order 2 .

i14y:MedicalPractice
 rdf:type sh:NodeShape ;
 rdfs:label "MedicalPractice"@en,
 "Arztpraxis"@de ;
 dcterms:description "Beschreibung einer Arztpraxis"@de ;
 sh:property <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/MedicalPractice/practiceId>,
 <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/MedicalPractice/practiceType> ;
 sh:targetClass i14y:MedicalPractice .

<https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/MedicalPractice/practiceId>
 rdf:type sh:PropertyShape ;
 sh:path <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/MedicalPractice/practiceId> ;
 sh:name "practiceId"@en, "Praxis-ID"@de ;
 sh:description "Eindeutiger Identifikator der Arztpraxis"@de ;
 sh:datatype xsd:string ;
 sh:pattern "^[0-9]{6}\\.[0-9]{3}$" ;
 sh:minCount 1 ;
 sh:maxCount 1 ;
 sh:order 0 .

<https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/MedicalPractice/practiceType>
 rdf:type sh:PropertyShape ;
 sh:path <https://register.ld.admin.ch/i14y/dataset/MY_DATASET/structure/MedicalPractice/practiceType> ;
 sh:name "practiceType"@en, "Praxistyp"@de ;
 sh:description "Rechtsform der Arztpraxis"@de ;
 sh:datatype xsd:string ;
 sh:in ( "0220" "0221" "0222" ) ;
 sh:minCount 0 ;
 sh:maxCount 1 ;
 sh:order 1 ;
 dcterms:conformsTo <https://register.ld.admin.ch/i14y/concept/legalForm/version/1.2.0> .

Das Präfix i14y verweist auf den Basis-URI des eigenen Datensatzes auf I14Y. MY_DATASET muss durch den tatsächlichen Identifikator des Datensatzes ersetzt werden. Alle Klassen und Attribute des Datensatzes erhalten damit eine stabile, eindeutige IRI (International Resource Identifier) nach folgendem Schema:

Objekt	IRI-Schema	Beispiel
Klasse	`.../dataset/{id}/structure/{KlassenName}`	`.../dataset/MY_DATASET/structure/localUnitMasterDataType`
Attribut	`.../dataset/{id}/structure/{KlassenName}/{AttributName}`	`.../dataset/MY_DATASET/structure/localUnitMasterDataType/localId`

Diese IRIs sind auf der I14Y-Plattform für alle Objekttypen eingeführt worden – neben Datensätzen auch für Konzepte, Codelist-Einträge, Datenservices und Public Services. Sie dienen als stabile, maschinenlesbare Adressen und werden z.B. in RDF-Exporten verwendet. Weitere Informationen zu I14Y-IRIs finden Sie unter I14Y-URIs und Identifikatoren.

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:

Prädikat	Verwendung
`rdfs:label`	Name einer Klasse (`sh:NodeShape`)
`dcterms:description`	Beschreibung einer Klasse
`sh:name`	Name eines Attributs (`sh:PropertyShape`)
`sh:description`	Beschreibung eines Attributs

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

Publikation: Distributionen hinzufügen

Mon, 01 Jan 0001 00:00:00 +0000

Bei einer Distribution handelt es sich um einen Export des Datensatzes in einem spezifischen Format, also etwa um eine CSV-Datei, die aus einer Datenbank generiert wird. Dabei können auch unterschiedliche Formen angeboten werden: Exporte in mehreren Sprachen etwa oder unterschiedliche räumliche oder örtliche Auflösungen. Entsprechend ist es nicht zwingend, dass jeder Export alle Informationen des betreffenden Datensatzes enthält. Eine Distribution kann etwa alle Daten über die Anzahl Einwohnerinnen und Einwohner der Schweiz enthalten. Sie kann sich aber auch auf ein einzelnes Jahr oder eine einzelne Gemeinde beschränken.

Auf der Interoperabilitätsplattform I14Y können Links zu solchen Datenangeboten hinterlegt werden. Direkt auf der Metadaten-Plattform lassen sich die Daten aber nicht speichern.

Zum Erfassen des Weblinks zu einem Datenexport öffnen Sie im internen Bereich im Katalog den betreffenden Eintrag. Klicken Sie auf die Registerkarte “Distributionen” und anschliessend auf “Erstellen”. Füllen Sie die Felder zum Titel und der Beschreibung aus – analog zum Vorgehen beim Erfassen der Grundinformationen zum Datensatz.

Zwingend auszufüllen ist zudem das Feld mit der URL zum Datenangebot. Die Internetadresse wird komplett eingegeben, also inklusive der Protokollinformationen wie “https://”. Liegt die Website in mehreren Sprachversionen vor, verwenden Sie – wenn immer möglich – eine URL ohne Sprachhinweis, also beispielsweise ohne “/de/” am Schluss. Wenn Sie die Titel-Felder bei den einzelnen Links leer lassen, wird der eingetragene Weblink publiziert. Ansonsten wird aus dem Titel und der URL ein Textlink generiert. Wenn Sie einen Direktlink zur betreffenden Datendatei setzen, wählen Sie “Download-URL” aus. Verweisen Sie hingegen auf eine Website, von wo die Daten bezogen werden können, aktivieren Sie das Kästchen nicht.

Wählen Sie im Feld Dateiformat das passende Format aus. Hinterlegt ist hier eine Liste mit Auswahloptionen. Sollte der Typ Ihrer Distribution nicht angezeigt werden, wenden Sie sich ans I14Y-Team.

Publikation: Qualitätsinformationen

Mon, 01 Jan 0001 00:00:00 +0000

Auf der Interoperabilitätsplattform I14Y werden zudem Angaben zur Qualität des Datensatzes erfasst. Dank diesen können Nutzerinnen und Nutzer rasch abschätzen, ob der Datensatz für die eigenen Zwecke hilfreich ist oder nicht. Sollen die Metainformationen zu einem Datensatz öffentlich publiziert werden, sind die Fragen zur Qualität zwingend auszufüllen.

Dank der Qualitätsinformationen ist etwa auf einen Blick ersichtlich, ob der Datensatz über einen Primärschlüssel verfügt, anhand dessen die Daten mit Informationen aus einer anderen Quelle zusammengeführt werden können. Hilfreich können auch etwa die Angaben zum Aktualisierungsintervall sein.

Um die Fragen zur Qualität des Datensatzes zu beantworten, klicken Sie auf die Registerkarte “Qualitätsinformationen” und anschliessend auf “Bearbeiten”. Beantworten Sie nun die Fragen. Ein Zwischenspeichern ist bei diesem Arbeitsschritt nicht möglich.

Frage	Hinweise
Besitzt dieser Datensatz einen Primärschlüssel? Wenn ja welche(n)?	Wählen Sie “Ja”, wenn ein Primärschlüssel existiert, also etwa wenn jeder Eintrag über einen eindeutigen Index verfügt. Bei den meisten Datensätzen ist dies der Fall. Geben Sie zudem an, um welches Merkmal es sich handelt. Verwenden Sie dazu den Titel des zuvor erfassten Datenelements.
Gibt es eine Nachverfolgung bei Änderung von Werten, d. h. wenn ein Wert geändert wird, ist der alte Wert noch verfügbar?	Bei Datensätzen, die versioniert sind, ist dies der Fall. Wählen Sie in diesem Fall “Ja”. Falls die Daten bei der Aktualisierung überschrieben werden, wählen Sie “Nein”. Alternativ haben Sie die Möglichkeit anzugeben, dass diese Frage fürs betreffende Datenangebot nicht relevant ist.
Ist es möglich einen Auszug von Werten für ein bestimmtes Datum zu erstellen, d.h. wenn ein Wert geändert wird, wird das Datum der Änderung registriert?	Wählen Sie “Ja” aus, falls die Änderungshistorie an ihren Daten detailliert aufgezeichnet wird, so dass sich nachträglich bestimmen lässt, wer zu welchem Zeitpunkt welche Änderung vorgenommen hat.
Wann sind die Inhalte der Änderungen verfügbar, d.h. gibt es einen regelmässigen und definierten Prozess der Datenverfügbarkeit?	Wählen Sie “Sofort”, wenn nach der Änderung der Daten unmittelbar die entsprechende Distribution aktualisiert wird. Wählen Sie “Fallweise”, wenn manuell eine neue Distribution generiert wird – abhängig von der Einschätzung zur Wichtigkeit der gemachten Änderung. Wählen Sie “Regelmässig”, wenn die Distribution zu im Voraus festgelegten Zeitpunkten aktualisiert wird. Und wählen Sie “Nicht relevant”, wenn die Frage nicht beantwortet werden kann.

Unter Dokumente / Links können Sie weiterführende Dokumente zur Qualität Ihres Datenangebots hinterlegen – etwa einen Prüfbericht oder ein Qualitätskonzept.

Sobald alle nötigen Metadaten erfasst sind, können Sie vorschlagen, dass der Status des Eintrags von “Inital” auf “Kandidat” umgestellt wird. Eine Person in der Rolle des Local Data Steward wird den Eintrag anschliessend prüfen und freigeben (siehe Workflow).