Livingdocs Fehlerbehandlung

Über das Schnittstellen-Log besteht die Möglichkeit HTTP-Fehler beim Livingdocs-Import eigenständig zu identifizieren. Bei inhaltlichen Fehlern werden Fehlerartikel in PRINT NGEN angelegt.

Inhaltsverzeichnis

1 Allgemeine Beschreibung
2 HTTP-Fehler
- 2.1 404 “Not Found”
- 2.2 500 “Internal Server Error“
- 2.3 Weitere HTTP-Fehler
3 Inhaltliche Fehler
4 Verwandte Seiten

Allgemeine Beschreibung

Das Schnittstellen-Log der Livingdocs-Schnittstelle kann über den Menüpunkt “Schnittstellen-Log öffnen” im Drop-Down-Menü neben dem Button “Livingdocs” in der Standardwerkzeugleiste geöffnet werden.

Menüpunkt zum Öffnen des Schnittstellen-Log

Das Log wird in einem Browserfenster in der Cloud geöffnet und protokolliert jeden HTTP-Fehler in XML-Form. Pro Fehler wird das Tag “<WFAktivierung>” und darunter der Zeitpunkt des versuchten Imports (“<WFAktivierungsZeit>”), der ausführende Dämon (“<Daemon>”) und die Fehlermeldung inklusive der Livingdocs-ID des betroffenen Artikels (“<WFFehler>”) ausgegeben.

Beispiel-Fehler im Log:

<WFAktivierung>
<WFAktivierungsZeit>04.09.2024 13:25:06</WFAktivierungsZeit>
<Daemon>workflow_01</Daemon>
<WFFehler>
ActiveX-Meldung: 'LD-API liefert NotFound, id=12345678
<?ZE ?>
'
</WFFehler>
</WFAktivierung>

In diesem Beispiel handelt es sich um den HTTP-Fehler 404 “Not Found”. Der Livingdocs-Artikel mit der ID=12345678 kann nicht gefunden und daher nicht importiert werden.

Die Fehler sind in absteigender Reihenfolge aufgeführt. Die neueste Meldung steht an oberster Stelle. Die Liste ist begrenzt auf eine festgelegte Textlänge von 10.000 Zeichen.

Das Log aktualisiert sich nicht selbstständig. Ein Neuladen des Browsertabs ist erforderlich, um die Meldungen seit dem letzten Aufruf der URL zu laden.

Das Log ist über die URL von extern aufrufbar.

Falls es getrennte Importe je nach Objekt gibt (aufgrund bspw. unterschiedlicher API-Token), wird das Schnittstellen-Log pro Objekt in einem separaten Browsertab geöffnet.

Wenn Livingdocs-seitig kein Fehler zu dem im Log angegebenen Artikel gefunden werden kann, wenden Sie sich mit den vorliegenden Informationen aus dem Log (ID, Zeitpunkt, Dämon, Fehlermeldung) zur weiteren Analyse an das PEIQ Support Team.

HTTP-Fehler

HTTP-Fehler, die beim Abfragen der Artikel über die Livingdocs-API zurückgeliefert werden, werden im Schnittstellen-Log protokolliert.

404 “Not Found”

Bei der Livingdocs-Schnittstelle wird zuerst eine Liste der IDs der neusten Printartikel abgefragt. Im nächsten Schritt wird zu jeder Livingdocs-Artikel-ID das Artikel-JSON mit dem Inhalt und den Metadaten des Artikels abgefragt. Beim HTTP-Fehler 404 kann der Artikel zu der jeweiligen ID nicht in der Livingdocs Datenbank gefunden werden, da er vermutlich in Livingdocs gelöscht wurde. Die Schnittstelle überspringt diesen Artikel und ruft den nächsten Artikel aus der Liste der neusten Printartikel ab.

Falls ein Artikel, bei dem der Fehlercode 404 zurück geliefert wurde, in PRINT NGEN vermisst wird, kann in Livingdocs geprüft werden, ob zu der ID ein Artikel existiert. Ist das der Fall, kann der Artikel erneut publiziert werden, sodass er wieder in der Liste der neusten Printartikel enthalten ist.

500 “Internal Server Error“

Bei diesem Fehler handelt es sich um ein serverseitiges Problem, das die Verarbeitung der Abfragen verhindert. Normalerweise ist der Server nur kurzfristig nicht erreichbar, z. B. aufgrund von Neustart oder Wartung des Servers. Wenn dieser Fehler für einen Artikel zurückgegeben wird, wird der Artikel nicht übersprungen, sondern PRINT NGEN versucht erneut, den Artikel abzurufen bis der Fehlercode 500 nicht mehr zurück geliefert wird und der Server wieder erreichbar ist.

Wenn ein Fehler 500 den Import der Livingdocs-Artikel für eine längere Zeit blockiert, sollte bei Livingdocs nach der Fehlerursache gesucht werden. Der Fehlercode sollte nicht für einzelne fehlerhafte Artikel sondern nur bei allgemeinen serverseitigen Problemen zurück geliefert werden.

Weitere HTTP-Fehler

Auch bei anderen HTTP-Fehlern wird der Artikel nicht übersprungen, sondern die Schnittstelle versucht den Artikel immer wieder abzurufen, bis der Fehler nicht mehr zurück geliefert wird.

Wenn der Livingdocs-Import nicht durch einen Fehler 500 sondern einem anderen HTTP-Fehler blockiert wird, wenden Sie sich mit den vorliegenden Informationen aus dem Schnittstellen-Log (ID, Zeitpunkt, Dämon, Fehlermeldung) an das PEIQ Support Team.

Inhaltliche Fehler

Bei inhaltlichen/syntaktischen Fehlern im Artikel-JSON, ist das XML nicht gültig und kann damit nicht verarbeitet werden. Das XSLT zum Umwandeln der Bereiche und Tags kann nicht ablaufen und der Artikel kann somit nicht importiert werden. Es wird ein Fehlerartikel in PRINT NGEN angelegt, der in der Artikelsuche mit der gleichen Namenskonvention “livingdocs-{Livingdocs-Document-ID}” gefunden werden kann. In dem Fehlerartikel steht die Ursache, weshalb der Import fehlgeschlagen hat.

Beispiel:

Fehler bei der Verarbeitung des Inhalts: Fehler beim Ausführen des Xslt 'Default#Master.Livingdocs':'„' is an unexpected token. The expected token is '"' or '''. Line 1, position 1496.

Hier wurden Links mit deutschen Anführungszeichen (unten und oben) übergeben. Diese müssen jedoch mit " oder ' übergeben werden. Nur so ist das übertragene XML gültig und Links (“<a href>“) können richtigerweise ignoriert bzw. herausgefiltert werden.

Der Syntax-Fehler muss Livingdocsseitig korrigiert werden. In diesem Beispiel kann als kurzfristiger Workaround der Link im Livingdocs-Artikel entfernt und der Artikel erneut nach nach PRINT NGEN übergeben werden.

Nähere Informationen dazu, welche Textformate übernommen werden, finden Sie unter Produktübergreifender Standard: Tags/Makros/Bereiche für XSLT Stylesheets.