How to Create and Deliver Intelligent Information

Warum Validierung?

Dieser Artikel wird zu einer Zeit geschrieben, in der zwar immer häufiger iiRDS-Pakete vom Kunden verlangt werden und erste Zielsysteme (z.B. CDP) iiRDS interpretieren können, aber die wenigsten Erstellsysteme (z.B. CMS) in der Lage sind, iiRDS-Pakte im Standard zu generieren.

Da die meisten iiRDS-Export-Strecken noch Eigenentwicklungen und Systemerweiterungen sind, kann man nicht immer sicher sein, dass das Paket auch korrekt ist und vom Zielsystem richtig interpretiert wird.

Welche Szenarien sind denkbar?

Beispiel 1 – Systemhersteller entwickelt eine iiRDS-Strecke

Der Hersteller eines CMS ist dabei, eine eigene iiRDS-Strecke für den Export zu entwickeln. Hierbei werden Testversionen veröffentlicht, damit der Kunde sie testen kann. Du – als Kunde – wünschst dir nun eine schnelle Möglichkeit, um die Ergebnisse zu überprüfen.

Beispiel 2 – selbst gebaute iiRDS-Strecke

Der Hersteller deines CMS ist noch nicht so weit mit der Entwicklung und du hast dich entschlossen, selbst (oder mit Hilfe eines Dienstleisters) eine iiRDS-Strecke zu entwickeln. Hierbei möchtest du die Ergebnisse überprüfen.

Beispiel 3 – Hersteller des Zielsystems entwickelt einen iiRDS-Importer

Du nutzt ein Zielsystem (CDP), dessen Hersteller derzeit eine Importfunktion für iiRDS-Pakete entwickelt. Du willst den Importer überprüfen, kannst dir aber nicht ganz sicher sein, dass deine Testdaten korrekt sind.

Welche Probleme ergeben sich, wenn ich mein iiRDS-Paket validieren möchte?

Für alle diese Szenarien benötigst du eine Möglichkeit, iiRDS-Pakete zu validieren. Doch wie gehst du dabei vor und welche Möglichkeiten stehen dir zur Verfügung?

Es ergeben sich folgende Probleme:

  • iiRDS bietet viele „Formulierungsmöglichkeiten“. Diese können nur schwer von Hand geprüft werden. Bei konkretem Verdacht an einer Stelle kann man in der Spec nachlesen. Aber jede Zeile Code mit der Spec abzugleichen, ist zu aufwändig.
  • Es gibt noch kein offizielles Validierungstool für iiRDS-Pakete (das iiRDS-Konsortium arbeitet momentan daran).

Validierung über Software

Das Einfachste ist natürlich, ein Paket zu prüfen, indem man es in eine Software lädt und die Fehlermeldungen liest. Da es noch kein offizielles Validierungstool gibt, muss man auf am Markt verfügbare Software setzen. Das Gute ist ja, dass man ein iiRDS-Paket nicht nur zum Spaß erstellt: zumeist möchte man es doch in ein CDP laden.

Dadurch ergeben sich für die oben aufgeführten Beispiele folgende Möglichkeiten:

Beispiel 1+2: iiRDS-Export testen

Wenn du deinen iiRDS-Export testen willst, kannst du das Paket in ein CDP laden und hoffen, dass die Fehlermeldungen verständlich sind.

  • Wenn du ein CDP zur Verfügung hast, nutze es zur Fehlersuche.
  • Wenn du kein eigenes CDP hast, das iiRDS-Paket aber für einen Kunden erstellst, ist der Kunde unter Umständen auch bereit, dir einen Zugang zu seinem CDP für die Fehlersuche zur Verfügung zu stellen.
  • Nun musst du noch die Fehler interpretieren. In der Hoffnung, dass die Fehlermeldungen verständlich formuliert sind – und natürlich vorausgesetzt, dass der Fehler in deinem Paket liegt, und nicht im empfangenden System.

Beispiel 3: iiRDS-Import testen

Wenn du einen iiRDS-Import testen willst, weil du selbst einen Konsumenten programmierst, empfiehlt es sich, zunächst vertrauenswürdige Testdaten zu nutzen und diese dann stetig zu erweitern.

  • Das iiRDS-Konsortium hat bereits ein Beispiel-Paket entwickelt: Der Sample Content ist nach Login kostenfrei abrufbar.
  • Die Beispieldaten kannst du zum Testen verwenden und stückweise erweitern.
  • Bei Fehlern solltest du die Spezifikation der aktuellen Version zu Rate ziehen.

Basics sicherstellen

Zunächst einmal sollte man versuchen, alles, was man von Hand prüfen kann, zu prüfen.

  • Ist das Paket korrekt?
    Das iiRDS-Paket muss bestimmte Bedingungen bezüglich des Aufbaus, des Formats und der Verzeichnisstruktur erfüllen. Mehr Informationen dazu findest du in Kapitel 5 „iiRDS Package and Container“ der Spezifikation.
  • Ist das XML der metadata.rdf wohlgeformt?
    Dies kann mit einem einfachen XML-Editor geprüft werden.
  • Ist die metadata.rdf valide?
    Nähere Informationen hierzu erfährst du im zweiten Artikel zur iiRDS-Validierung auf dem iiBlog.
  • Entsprechen die Kardinalitäten den in der Spec beschriebenen Regeln?
    Dies kann manuell durch einen gründlichen Vergleich geprüft werden oder über SHACL-Regeln – mehr dazu ebenfalls im oben erwähnten Blog-Beitrag.

Die syntaktische Korrektheit der Metadaten heißt leider nicht, dass es nicht trotzdem falsch sein kann, da die Validatoren nur auf syntaktische Korrektheit des RDFS prüfen, also beispielsweise, ob auch alle verwendeten Tags wieder geschlossen werden. Ob die Beschreibung auch inhaltlich korrekt ist, kann von einem Validator nicht geprüft werden.

Häufige Fehler und Fazit

Hier noch eine kleine Auflistung von verschiedenen Fehlern in Form einer Checkliste. Diese Auflistung an Fehlern ist jedoch nicht abschließend – die Regeln von RDF sind schließlich komplex und können für Einsteiger durchaus eine Hürde darstellen:

  • Ist die Verzeichnisstruktur korrekt?
  • Ist das XML wohlgeformt?
  • Verweisen die Pfade in den Dateien tatsächlich auf das Ziel?
  • Ist das Inhaltsverzeichnis (wenn vorhanden) korrekt aufgebaut?
  • Werden Erweiterungen zu iiRDS korrekt deklariert?
  • Liegen die referenzierten Dateien an den richtigen Pfaden?
  • Sind alle Hierarchie-Ebenen eines Inhaltsverzeichnisses geschlossen?

Wenn du nun ein Gefühl für die Komplexität des Themas bekommen hast und noch weitere Unterstützung benötigst, kannst du natürlich gerne Kontakt mit den iiRDS-Konsorten und den Consultants aufnehmen.


Noch mehr zu iiRDS gibt’s auf der tekom-Jahrestagung 2021

+175 Sessions auf Deutsch und Englisch zu aktuellen Trends und Dauerbrennern der Technischen Kommunikation wie Inhaltserstellung, Terminologie, intelligente Bereitstellung von Nutzerinformationen, CMS, Softwaredokumentation uvm.

Experten vermitteln ihr Fachwissen und schaffen Raum zum Austausch.

Natürlich kommt auch das Networking nicht zu kurz – dafür sorgt die funktionsstarke Tagungsplattform ‚tekom live‘ mit tollen Features.

Jetzt Ticket sichern

Letzte Artikel von Philipp Tschöke (Alle anzeigen)

Like it? Share it! Spread the Word...

Sag uns jetzt deine Meinung per Kommentar!