Zum Inhalt

Erstellen einer JSON-Datei

In diesem Kapitel wird erklärt, wie Sie Ihre JSON-Dateien mit Veranstaltungsdaten erstellen können.

Hinweis: Obwohl zwei Möglichkeiten angeboten werden, weisen wir darauf hin, dass ausschließlich die automatisierte Erstellung von Dateien empfohlen wird. Die Anweisungen zur manuellen Erstellung dienen nur zum Testen des Formats oder als vorübergehende Notfall-Alternative. In beiden Fällen gilt jedenfalls, dass die JSON-Datei als UTF-8 kodiert sein muss.

JSON-Datei automatisch erstellen

Das Austauschformat wurde primär für die maschinelle Verarbeitung entwickelt, um Veranstaltungsdaten aus einem bestehenden System möglichst einfach und schnell in die Suchmaschine zu überführen. Der genaue Ablauf der automatisierten Übertragung hängt vom jeweiligen System ab. Als Beispiele von Lösungen verweisen wir auf die öffentlich zugänglichen GitHub-Repositorien der Pädagogischen Hochschule Salzburg oder der Medizinischen Universität Graz.

Die automatische Erstellung von Dateien hat unter anderem folgende Vorteile: - Sicherstellung der Vollständigkeit von Daten - Sicherstellung der täglichen Aktualität von Daten - Vermeidung der durch menschliche Hand verursachten Fehler.

Wie Sie die generierten Dateien an unsere Suchmaschine übermitteln, erfahren Sie im Abschnitt Bereitstellung der Daten.

JSON-Datei manuell erstellen

Bis zur Inbetriebnahme des automatischen Exports können Sie eine JSON-Datei alternativ auch manuell erstellen und warten.

Hinweis: Der manuelle Vorgang ist ausschließlich für Testzwecke und als Notfall-Alternative zu betrachten. Wir raten dringend davon ab, diesen Vorgang auf Dauer anzuwenden. Es liegt in der Verantwortung der Veranstaltungsanbieter*innen, die Daten korrekt zu übermitteln.

  1. Um mögliche Formatfehler zu vermeiden, empfehlen wir, die folgende Beispieldatei herunterzuladen und diese mit einem Texteditor an die eigenen Veranstaltungen anzupassen:

    Beispiel JSON-Datei

  2. Öffnen Sie die JSON-Datei mit einem einfachen Texteditor:

    Achten Sie dabei bitte darauf, dass keine Formatierungsprogramme wie WordPad, Word, Pages, etc. verwendet werden, da diese die Datei mit zusätzlichen Informationen versehen und somit die JSON-Datei unbrauchbar machen.

    Zum Öffnen der Datei kann zum Beispiel auf Windows-Rechnern das Standardprogramm Notepad verwendet werden, oder TextEdit auf macOS. Für eine bessere Übersichtlichkeit bieten sich jedoch spezielle Texteditoren an, wie etwa Notepad++ oder Visual Studio Code.

  3. Der Inhalt der Datei kann nun an die eigene Veranstaltung angepasst werden. Die Datei besteht aus zwei Beispieleinträgen für Veranstaltungen. Bitte passen Sie nur die Beispielwerte an, und ändern Sie nicht die Namen der Datenfelder. Die Datenfelder sind in der Dokumentation beschrieben. Dort ist auch angegeben, welche Felder notwendig sind und welche nur optional. Optionale Datenfelder dürfen also beim Anpassen der Beispiele auch gelöscht werden.

  4. Überprüfen Sie die Konformität der angepassten Datei mit dem Online-Validator. Eine regelmäßige Überprüfung der Datei bei größeren Änderungen kann dabei helfen, Fehler und Probleme frühzeitig zu erkennen und zu beheben.

  5. Falls Ihre Datei überprüft, als UTF-8 kodiert und valide ist, können Sie diese an die Suchmaschine übermitteln. Wie Sie das machen können, ist im Abschnitt Bereitstellung der Daten beschrieben.